Compartilhar via


GetShowToolPaneEvent(Microsoft.SharePoint.WebPartPages.WebPart, ToolPaneView) Method

The GetShowToolPaneEvent method of the ToolPane class returns a string of JavaScript which, if executed on the client, causes a tool pane to open in the specified view for the specified Web Part.

Parameters

webPart   The Web Part for which to display the properties tool pane. Can be null for views that do not require a web part, such as the Browse pane.

view   One of the ToolPane.ToolPaneView values that specifies the view to open.

Return Value

A string of JavaScript which, if executed on the client, causes a a tool pane to open in the specified view for the specified Web Part.

Example

The following overridden RenderWebPart method from a sample Web Part demonstrates the use of the GetShowToolPaneEvent method to create a list of links in the Web Part, using each available value from the ToolPane.ToolPaneView enumeration, to allow the user to invoke the various available tool pane views from the Web Part.

In the following example, "downlevel browser" refers to Microsoft Internet Explorer version 5.0 and earlier, and to non-Microsoft browsers.

Requirements

Platforms: Microsoft Windows Server 2003

Security: Code Access Security