MenuGroup Class

Represents a group of menu items.

Namespace:  Microsoft.Windows.Design.Interaction
Assembly:  Microsoft.Windows.Design.Extensibility (in Microsoft.Windows.Design.Extensibility.dll)

Syntax

'Declaration
Public Class MenuGroup _
    Inherits MenuBase

'Usage
Dim instance As MenuGroup

public class MenuGroup : MenuBase

public ref class MenuGroup : public MenuBase

public class MenuGroup extends MenuBase

Remarks

Menu items are represented by the MenuAction class. A menu group can have a collection of menu items directly on the menu or as a submenu, which is also called a flyout menu. Set the HasDropDown property to display menu items in a submenu.

To show context menu items, inherit from the PrimarySelectionContextMenuProvider class and create MenuAction items and an associated MenuGroup.

Examples

The following code example shows how to set up two MenuAction items and assign them to a MenuGroup. For more information, see Walkthrough: Creating a MenuAction.

' The provider's constructor sets up the MenuAction objects  
' and the the MenuGroup which holds them. 
Public Sub New()

    ' Set up the MenuAction which sets the control's  
    ' background to Blue.
    setBackgroundToBlueMenuAction = New MenuAction("Blue")
    setBackgroundToBlueMenuAction.Checkable = True 
    AddHandler setBackgroundToBlueMenuAction.Execute, AddressOf SetBackgroundToBlue_Execute

    ' Set up the MenuAction which sets the control's  
    ' background to its default value.
    clearBackgroundMenuAction = New MenuAction("Cleared")
    clearBackgroundMenuAction.Checkable = True 
    AddHandler clearBackgroundMenuAction.Execute, AddressOf ClearBackground_Execute

    ' Set up the MenuGroup which holds the MenuAction items. 
    Dim backgroundFlyoutGroup As New MenuGroup("SetBackgroundsGroup", "Set Background")

    ' If HasDropDown is false, the group appears inline,  
    ' instead of as a flyout. Set to true.
    backgroundFlyoutGroup.HasDropDown = True
    backgroundFlyoutGroup.Items.Add(setBackgroundToBlueMenuAction)
    backgroundFlyoutGroup.Items.Add(clearBackgroundMenuAction)
    Me.Items.Add(backgroundFlyoutGroup)

    ' The UpdateItemStatus event is raised immediately before  
    ' this provider shows its tabs, which provides the opportunity  
    ' to set states. 
    AddHandler UpdateItemStatus, AddressOf CustomContextMenuProvider_UpdateItemStatus

End Sub

// The provider's constructor sets up the MenuAction objects  
// and the the MenuGroup which holds them. 
public CustomContextMenuProvider()
{   
    // Set up the MenuAction which sets the control's  
    // background to Blue.
    setBackgroundToBlueMenuAction = new MenuAction("Blue");
    setBackgroundToBlueMenuAction.Checkable = true;
    setBackgroundToBlueMenuAction.Execute += 
        new EventHandler<MenuActionEventArgs>(SetBackgroundToBlue_Execute);

    // Set up the MenuAction which sets the control's  
    // background to its default value.
    clearBackgroundMenuAction = new MenuAction("Cleared");
    clearBackgroundMenuAction.Checkable = true;
    clearBackgroundMenuAction.Execute += 
        new EventHandler<MenuActionEventArgs>(ClearBackground_Execute);

    // Set up the MenuGroup which holds the MenuAction items.
    MenuGroup backgroundFlyoutGroup = 
        new MenuGroup("SetBackgroundsGroup", "Set Background");

    // If HasDropDown is false, the group appears inline,  
    // instead of as a flyout. Set to true.
    backgroundFlyoutGroup.HasDropDown = true;
    backgroundFlyoutGroup.Items.Add(setBackgroundToBlueMenuAction);
    backgroundFlyoutGroup.Items.Add(clearBackgroundMenuAction);
    this.Items.Add(backgroundFlyoutGroup);

    // The UpdateItemStatus event is raised immediately before  
    // this provider shows its tabs, which provides the opportunity  
    // to set states.
    UpdateItemStatus += 
        new EventHandler<MenuActionEventArgs>(
            CustomContextMenuProvider_UpdateItemStatus);
}

Inheritance Hierarchy

System.Object
  Microsoft.Windows.Design.Interaction.MenuBase
    Microsoft.Windows.Design.Interaction.MenuGroup

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

MenuGroup Members

Microsoft.Windows.Design.Interaction Namespace

MenuAction

PrimarySelectionContextMenuProvider

Other Resources

Walkthrough: Creating a MenuAction