ToolPane.GetShowToolPaneEvent Method (WebPart, WebPartDisplayMode)

Returns a string of ECMAScript (such as JavaScript) which, if executed on the client, causes a tool pane to open in the specified view for the specified Web Part.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
Public Shared Function GetShowToolPaneEvent ( _
    webPart As WebPart, _
    displayMode As WebPartDisplayMode _
) As String
'Usage
Dim webPart As WebPart
Dim displayMode As WebPartDisplayMode
Dim returnValue As String

returnValue = ToolPane.GetShowToolPaneEvent(webPart, _
    displayMode)

public static string GetShowToolPaneEvent(
    WebPart webPart,
    WebPartDisplayMode displayMode
)

Parameters

• webPart
  Type: Microsoft.SharePoint.WebPartPages.WebPart

  The Web Part for which the properties tool pane is displayed. It can be a null reference (Nothing in Visual Basic) for views that do not require a Web Part, such as the Browse pane.

• displayMode
  Type: System.Web.UI.WebControls.WebParts.WebPartDisplayMode

  The display mode which defines the view in which to display the tool pane.

Return Value

Type: System.String
A string of ECMAScript (such as JavaScript) that, if executed on the client, causes the tool pane to open in the specified display mode for the specified Web Part.

Remarks

Ecma International develops standards for information and communication systems. For more information, see the official Web site for Ecma International at http://www.ecma-international.org/.

See Also

Reference

ToolPane Class

ToolPane Members

GetShowToolPaneEvent Overload

Microsoft.SharePoint.WebPartPages Namespace