TitleBarWebPart Class

The TitleBarWebPart class implements the title Web Part for a Web Part Page and renders the SettingsLink.

Microsoft.SharePoint.WebPartPages.WebPart

Microsoft.SharePoint.WebPartPages.TitleBarWebPart

Public Constructors

The following table shows the constructors of the TitleBarWebPart class and a brief description of each.

Name Description
TitleBarWebPart Initializes a new instance of the TitleBarWebPart class.

Public Methods

The following table shows the public methods of the TitleBarWebPart class and a brief description of each.

Name Description
CreateWebPartMenu Overrides WebPart.CreateWebPartMenu.
GetDesignTimeHtml Gets the HTML that is used to represent the control at design time.
GetToolParts Determines which tool parts are displayed in the tool pane of the web-based Web Part design user interface, and the order in which they are displayed.

Protected Methods

The following table shows the protected methods of the TitleBarWebPart class and a brief description of each.

Name Description
CreateChildControls Overrides the WebPart.CreateChildControls method.
RenderWebPart(System.Web.UI.HtmlTextWriter) Overrides the Microsoft.SharePoint.WebPartPages.WebPart.RenderWebPartmethod to implement rendering for this Web Part.

Public Properties

The following table shows the properties of the TitleBarWebPart class, the data type of each property, and a brief description of each.

Name Data Type Description
HeaderCaption String Gets and sets the caption that is displayed above the title in the title bar of the Web Part page.
HeaderDescription String Gets and sets the description that appears as a tool tip for the title bar.
HeaderTitle String Gets and sets the title in the TitleBarWebPart.
Image String Gets and sets a link to the Image to display for the icon in the TitleBarWebPart.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread safe.

Remarks

If anonymous access is turned on, the AuthenticationButton is rendered in the titlebar.

The TitleBarWebPart Web Part does not appear in the site Gallery by default. If you are creating a new Web Part Page and want a Title Bar on your page, you can add this Web Part to the site Gallery by going to Site Settings, and then Go to Site Administration. In the Site Collection Galleries section, click on Manage Web Part Gallery, then click New Web Part, check the TitleBarWebPart, and then click Populate Gallery.

Requirements

Namespace: Microsoft.SharePoint.WebPartPages

Platforms: Windows Server 2003

Assembly: Windows SharePoint Services (in Microsoft.SharePoint.dll)

Security: Code Access Security