ToolPart Class
The ToolPart class defines custom tool parts which display a customized user interface for defining the properties of a Web Part inside of the tool pane.
System.Object
System.Web.UI.Control
Microsoft.SharePoint.WebPartPages.ToolPart
Public Constructors
The following table shows the constructors of the ToolPart class and a brief description of each.
| Name | Description |
|---|---|
| ToolPart | Initializes a new instance of the ToolPart class. |
Public Methods
The following table shows the public methods of the ToolPart class and a brief description of each.
| Name | Description |
|---|---|
| ApplyChanges | Called when the user clicks the OK or the Apply button in the tool pane. |
| CancelChanges | Called when the user clicks the Cancel button in the tool pane. |
| SyncChanges | Called after all other tool parts have called the ApplyChanges method. |
Protected Methods
The following table shows the protected methods of the ToolPart class and a brief description of each.
| Name | Description |
|---|---|
| RenderToolPart | Sends the tool part content to the specified HtmlTextWriter object, which writes the content to be rendered on the client. |
Public Properties
The following table shows the properties of the ToolPart class, the data type of each property, and a brief description of each.
| Name | Data Type | Description |
|---|---|---|
| AllowMinimize | Boolean | A value indicating whether the tool part can be minimized by the user. |
| FrameState | Microsoft.SharePoint.WebPartPages.FrameState | The frame state of the tool part. |
| FrameType | Microsoft.SharePoint.WebPartPages.FrameType | The type of frame that surrounds the tool part. |
| ParentToolPane | Microsoft.SharePoint.WebPartPages.ToolPane | The tool pane that contains the tool part. |
| Qualifier | String | A unique identifier for the tool part. |
| Title | String | The title of the tool part. |
| UseDefaultStyles | Boolean | A value indicating whether the tool part uses the default themes and styles for its body. |
Requirements
Namespace: Microsoft.SharePoint.WebPartPages
Platforms: Microsoft Windows Server 2003
Assembly: Microsoft Windows SharePoint Services (in Microsoft.SharePoint.dll)
Security: Code Access Security