WebPartDescription.Title Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the title text of a corresponding WebPart control.

Namespace:   System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

Public ReadOnly Property Title As String

Property Value

Type: System.String

A string that contains the title of the corresponding control. The default value is a calculated string supplied by the .NET Framework.

The value of the Title property corresponds directly to the WebPart.DisplayTitle property. Whatever the corresponding WebPart control has for its DisplayTitle property, that becomes the value of the Title property; otherwise, the title is a calculated value.

The Title property applies only when a page is in catalog display mode, and a WebPart control is being displayed in a catalog of controls. Whatever title is assigned to a WebPart control appears next to the control in the catalog.

The following code example demonstrates programmatic use of the Title property. For the full code required to run this code example, see the Example section of the WebPartDescription class overview topic.

The following code in the Button1_Click method of a Web page demonstrates how to get the collection of WebPartDescription objects in a catalog using the GetAvailableWebPartDescriptions method, and then to display the details of each WebPart control in the catalog by looping through the WebPartDescription objects. Note that the Title property value is retrieved in the following code.

Protected Sub Button1_Click(ByVal sender As Object, _
  ByVal e As System.EventArgs)

  Label1.Text = String.Empty

  Dim descriptions As WebPartDescriptionCollection = _
   DeclarativeCatalogPart1.GetAvailableWebPartDescriptions()

  Dim desc As WebPartDescription

  For Each desc In descriptions
    Label1.Text += "ID: " & desc.ID & "<br />" & _
      "Title: " & desc.Title & "<br />" & _
      "Description: " & desc.Description & "<br />" & _
      "ImageUrl: " & desc.CatalogIconImageUrl & "<br />" & _
      "<hr />"
  Next

End Sub

.NET Framework
Available since 2.0
Return to top
Show: