ToolPane.GetShowExtensibleToolPaneEvent 方法

返回一个 string 类型的 ECMAScript (例如 JavaScript) 这,如果执行客户端,会导致可扩展的工具窗格中打开指定的 Web 部件。

命名空间:  Microsoft.SharePoint.WebPartPages
程序集:  Microsoft.SharePoint(位于 Microsoft.SharePoint.dll 中)

语法

声明
Public Shared Function GetShowExtensibleToolPaneEvent ( _
    uniqueID As String _
) As String
用法
Dim uniqueID As String
Dim returnValue As String

returnValue = ToolPane.GetShowExtensibleToolPaneEvent(uniqueID)
public static string GetShowExtensibleToolPaneEvent(
    string uniqueID
)

参数

  • uniqueID
    类型:System.String

    当前的 Web 部件的唯一标识符。

返回值

类型:System.String
其中,如果在客户端上,执行将导致可扩展的工具窗格中打开指定的 Web 部件 (如 JavaScript) ECMAScript 一个字符串。

备注

在大多数情况下,您需要在括在单引号字符在uniqueID参数中,Web 部件 ID 中传递,如下面的代码示例中所示。

示例

下面的示例演示使用GetShowExtensibleToolPaneEvent方法,以提供执行以打开工具窗格中,当用户单击自定义 Web 部件中的一个按钮 (例如 JavaScript) ECMAScript 代码。

    Protected Overrides Sub RenderWebPart(ByVal output As System.Web.UI.HtmlTextWriter)
        output.Write("Web Part with an extensible tool pane.<br><br>")
        output.Write("<input type=""button"" class=""ms-SPButton"" value=""Show Extensible ToolPane"" ")
        output.Write("onclick=""" & ToolPane.GetShowExtensibleToolPaneEvent("'" & Me.UniqueID & "'"))
        output.Write("""/><br><br>")
    End Sub
    protected void RenderToolPart(System.Web.UI.HtmlTextWriter output)
        {
        output.Write("Web Part with an extensible tool pane.<br><br>");
        output.Write("<input type=\"button\" class=\"ms-SPButton\" value=\"Show Extensible ToolPane\" ");
        output.Write("onclick=\"" & ToolPane.GetShowExtensibleToolPaneEvent(\'" & this.UniqueID & \'"));
        output.Write(\""/><br><br>");
}

另请参阅

引用

ToolPane 类

ToolPane 成员

Microsoft.SharePoint.WebPartPages 命名空间