TitleUrl Property

WebPart.TitleUrl Property


Gets or sets a URL to supplemental information about a WebPart control.

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

public virtual string TitleUrl { get; set; }

Property Value

Type: System.String

A string that represents a URL to more information about the WebPart control. The default value is an empty string ("").

Exception Condition

The internal validation system has determined that the URL might contain script attacks.

When you assign a URL to the TitleUrl property, the title of the control becomes a link to supplemental information about the control. The URL is not rendered when the page is in a display mode where controls can be dragged, such as design, edit, or catalog mode.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins.

The personalization scope of this property is set to Shared and can be modified only by authorized users. For more information, see PersonalizableAttribute and Web Parts Personalization Overview.

Legacy Code Example

The following code example demonstrates how to set the TitleUrl property for a custom Web Parts control. This example assumes the use of a custom control, TextDisplayWebPart, which is found in the Example section of the WebPart class overview.

Notice that the <aspSample:TextDisplayWebPart> element contains the TitleUrl attribute with a fictitious URL. If you load the page in a browser, the title of the WebPart control is now a link to the resource pointed to by the TitleUrl property.

Code snippet is not found. Confirm that the code snippet name 'WebParts_WebPart_TitleUrl' is correct.

.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft