CustomPropertyToolPart class
Represents the default tool part that is displayed in the tool pane for a Web Part that implements one or more custom properties (properties other than those provided by the WebPart base class).
System.Web.UI.Control
System.Web.UI.WebControls.WebControl
System.Web.UI.WebControls.Panel
System.Web.UI.WebControls.WebParts.Part
System.Web.UI.WebControls.WebParts.EditorPart
Microsoft.SharePoint.WebPartPages.EditorPartAdapter
Microsoft.SharePoint.WebPartPages.ToolPart
Microsoft.SharePoint.WebPartPages.CustomPropertyToolPart
Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
A custom property will be automatically displayed using an instance of the CustomPropertyToolPart class in the default property pane if the property is of type String, Boolean, Integer, or Enum. The following table describes how each of these property types is displayed in the CustomPropertyToolPart class in the property pane.
Property type | Displayed in property pane as |
|---|---|
Boolean | Check box |
Enum | Drop down |
Integer | Text box |
String | Text box |
DateTime | Text box |
The following simple Web Part example demonstrates the use of the WebPartToolPart class and the CustomPropertyToolPart class to customize the display of Web Part properties in the tool pane. The example overrides the GetToolParts method of the WebPart base class in order to display the Web Part's standard properties in the tool pane followed by its custom properties, and then to expand specific sections of each tool part and to hide specific standard properties. The WebPartToolPart class automatically displays the Web Part's standard properties, and the CustomPropertyToolPart class automatically displays the Web Part's custom properties.