Share via

ICustomizeToolPane.ToolPaneTemplate Property

  • Article

Gets a String that contains an XML fragment that specifies a template for a custom tool pane.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

ReadOnly Property ToolPaneTemplate As String
    Get

Dim instance As ICustomizeToolPane
Dim value As String

value = instance.ToolPaneTemplate

string ToolPaneTemplate { get; }

Property Value

Type: System.String
An XML fragment that defines a template for a custom tool pane.

Remarks

The schema for the XML fragment is as follows.

<?xml version=”1.0”?>
<ToolPane>
    <Caption></Caption>
    <ErrorUI></ErrorUI>
    <NotifyUI></NotifyUI>
    <ToolParts></ToolParts>
    <Commands></Commands>
    <FixedArea></FixedArea>
</ToolPane>

Element

Description

Caption

The Caption element specifies the title of the tool pane, and whether to display the close button. This element must be empty tag (it may have no children). The attributes of the Caption element are described in the following table:

  • title   Specifies the text that appears in the title bar of the tool pane. Default value: Blank. Allowed value: HTML that specifies the title.

  • closeButton   Specifies whether the close button for the tool pane is displayed.
    Default value: true (button is displayed)
    Allowed value: false (no button)

ErrorUI

The ErrorUI element specifies the location of the error messages within the tool pane body. This element has no children and no attributes.

NotifyUI

The NotifyUI element specifies the location of various notifications within the tool pane body. This element has no children and no attributes.

ToolParts

The ToolParts element specifies the tool parts that are displayed in the tool pane. All tool parts are displayed in the order of appearance of the ToolPart elements it contains, which are the only acceptable child elements of the ToolParts element. This element has no attributes.

ToolPart

The ToolPart element specifies a single tool part and may only appear as a child of the ToolParts element. This element has no children. The attributes of the ToolPart element are described in the following list:

  • type   A string that specifies the fully qualified name of the tool part. This attribute must be present on the tag.

Commands

The Commands element specifies the command buttons that are displayed in the tool pane’s command area. This element can have no children. The attributes of the Commands element are described in the following table:

  • ok   Specifies whether the OK button is present.
    Default value: true
    Allowed value: false

  • apply   Specifies whether the Apply button is present.
    Default value: true
    Allowed value: false

  • cancel   Specifies whether the Cancel button is present.
    Default value: true
    Allowed value: false

FixedArea

The FixedArea element specifies an area within the tool pane that can contain links or controls like buttons that appear in the tool pane outside of the Commands area. This tag can have no children or attributes.

To view a code sample that specifies the ToolPaneTemplate property, see ToolPane.

See Also

Reference

ICustomizeToolPane Interface

ICustomizeToolPane Members

Microsoft.SharePoint.WebPartPages Namespace