ToolPane.GetShowExtensibleToolPaneEvent - Méthode

Article
05/12/2015

Retourne une chaîne d'ECMAScript (tel que JavaScript) qui, si exécutée sur le client, entraîne le volet outil extensible pour ouvrir pour le composant spécifié.

Espace de noms : Microsoft.SharePoint.WebPartPages
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Shared Function GetShowExtensibleToolPaneEvent ( _
    uniqueID As String _
) As String
'Utilisation
Dim uniqueID As String
Dim returnValue As String

returnValue = ToolPane.GetShowExtensibleToolPaneEvent(uniqueID)

public static string GetShowExtensibleToolPaneEvent(
    string uniqueID
)

Paramètres

uniqueID
Type : System.String

Identificateur unique pour le composant WebPart actuel.

Valeur renvoyée

Type : System.String
Chaîne de ECMAScript (tel que JavaScript) qui, si exécutée sur le client, entraîne le volet outil extensible pour ouvrir pour le composant spécifié.

Remarques

Dans la plupart des cas, vous devez passer dans l'ID du composant Web entourée de caractères guillemets dans l'argument uniqueID , comme illustré dans l'exemple de code ci-dessous.

Exemples

L'exemple suivant illustre l'utilisation de la méthode GetShowExtensibleToolPaneEvent pour fournir le code ECMAScript (tel que JavaScript) qui est exécuté pour ouvrir le volet des outils lorsque l'utilisateur clique sur un bouton dans le composant WebPart personnalisé.

    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>");
}

Voir aussi

Référence

ToolPane classe

ToolPane - Membres

Microsoft.SharePoint.WebPartPages - Espace de noms

Partager via