WebPart.CreateWebPartMenu - Méthode

Appelé après l'événement Load Microsoft ASP.NET et permet de modifier ou de remplacer le menu par défaut.

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

Syntaxe

'Déclaration
Public Overridable Sub CreateWebPartMenu
'Utilisation
Dim instance As WebPart

instance.CreateWebPartMenu()

public virtual void CreateWebPartMenu()

Remarques

La méthode CreateWebPartMenu est appelée après que l'événement héritées System.Web.UI.Control.Load s'est produite pour notifier le composant WebPart pour définir la propriété WebPartMenu .

Exemples

L'exemple de code suivant illustre une méthode substituée CreateWebPartMenu qui ajoute un élément de menu parent et les deux éléments de menu dans le menu du composant WebPart par défaut. Il suppose que cette méthode fait partie d'une classe WebPart qui inclut deux propriétés de type Boolean personnalisées, ParentItemIsVisible et EnableItem1, qui vous permettent de contrôler quand ces éléments de menu sont visibles et activés. Un gestionnaire d'événements nommé EventHandlerForItem1 doit également être créé.

Public Overrides Sub CreateWebPartMenu()
    ' Declare variables for menu items.
    Dim ParentItem As MenuItem
    Dim Item1 As MenuItem
    Dim Item2 As MenuItem

    ' Create three menu items:
    ' One parent item, and two submenu items.
    ' Create the parent item.
    ParentItem = New MenuItem("ParentItem", "", "ParentItemID")

    ' Create a submenu item with a server event on click.
    Item1 = New MenuItem("Item1", "Item1ID", New EventHandler(AddressOf EventHandlerForItem1))

    ' Create a submenu item with a client event on click. 
    Item2 = New MenuItem("Item2", "javascript:alert('Item2 was clicked.');", "Item2ID")

    ' Add the submenu items to the parent item.
    ParentItem.MenuItems.Add(Item1)
    ParentItem.MenuItems.Add(Item2)

    ' Add the parent item after the "Modify Shared/Personal Web Part"
    ' command in the default menu. 
    ' Retrieve the index of the "Modify Shared/Personal Web Part" command.
    Dim EditIndex As Integer = Me.WebPartMenu.MenuItems.IndexOf(Me.WebPartMenu.MenuItems.ItemFromID("MSOMenu_Edit"))

    ' Insert the parent item after the "Modify Shared/Personal Web Part" command.
    Me.WebPartMenu.MenuItems.Insert(EditIndex + 1, ParentItem)

    ' Add a separator above the parent item.
    ParentItem.BeginSection = True

    ' Check the "ParentItemIsVisible" custom Boolean property to decide whether to display the parent menu.
    If Me.ParentItemIsVisible = True Then
    ParentItem.Visible = True

    Else
       ParentItem.Visible = False
    End If

    ' Check the "EnableItem1" custom Boolean property to decide which menu item to enable. 
    ' within the parent item.
    If Me.EnableItem1 = True Then
       Item1.Enabled = True
       Item2.Enabled = False

    Else
       Item1.Enabled = False
       Item2.Enabled = True
    End If
End Sub

public override void CreateWebPartMenu()
{
    // Declare variables for menu items.
    MenuItem ParentItem;
    MenuItem Item1;
    MenuItem Item2;

    // Create three menu items:
    // One parent item, and two submenu items.

    // Create the parent item.
    ParentItem = new MenuItem("ParentItem", "", "ParentItemID");

    // Create a submenu item with a server event on click.
    Item1 = new MenuItem("Item1", "Item1ID", new EventHandler(EventHandlerForItem1));

    // Create a submenu item with a client event on click. 
    Item2 = new MenuItem("Item2", "javascript:alert('Item2 was clicked.');", "Item2ID");

    // Add the submenu items to the parent item.
    ParentItem.MenuItems.Add(Item1);
    ParentItem.MenuItems.Add(Item2);

    // Add the parent item after the "Modify Shared/Personal Web Part"
    // command in the default menu. 

    // Retrieve the index of the "Modify Shared/Personal Web Part" command.
    int EditIndex = this.WebPartMenu.MenuItems.IndexOf(this.WebPartMenu.MenuItems.ItemFromID("MSOMenu_Edit"));

    // Insert the parent item after the "Modify Shared/Personal Web Part" command.
    this.WebPartMenu.MenuItems.Insert(EditIndex + 1, ParentItem); 

    // Add a separator above the parent item.
    ParentItem.BeginSection = true;

    // Check the "ParentItemIsVisible" custom Boolean property to decide whether to display the parent menu.
    if (this.ParentItemIsVisible == true)
    {
        ParentItem.Visible = true;
    }

    else
    {
        ParentItem.Visible = false;
    }

    // Check the "EnableItem1" custom Boolean property to decide which menu item to enable. 
    // within the parent item.
    if (this.EnableItem1 == true)
    {
        Item1.Enabled=true;
        Item2.Enabled=false;
    }

    else
    {
        Item1.Enabled=false;
        Item2.Enabled=true;
    }
}

Voir aussi

Référence

WebPart classe

WebPart - Membres

Microsoft.SharePoint.WebPartPages - Espace de noms