0 out of 1 rated this helpful - Rate this topic

ContextMenuService Class

Provides the system implementation for displaying a ContextMenu.

System.Object
  System.Windows.Controls.ContextMenuService

Namespace:  System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)
public static class ContextMenuService

The ContextMenuService type exposes the following members.

  Name Description
Public attached property ContextMenu Gets or sets the content of a ContextMenu.
Public attached property HasDropShadow Gets or sets a value that indicates whether the ContextMenu has the drop shadow effect enabled.
Public attached property HorizontalOffset Gets or sets a value that indicates where along the x-direction to place the ContextMenu with respect to the parent control.
Public attached property IsEnabled Gets or sets a value that indicates whether the ContextMenu can be shown.
Public attached property Placement Gets or sets a value that specifies the placement of the ContextMenu relative to the PlacementTarget or PlacementRectangle.
Public attached property PlacementRectangle Gets or sets the area relative to which the context menu is positioned when it opens.
Public attached property PlacementTarget Gets or sets the parent control of the ContextMenu.
Public attached property ShowOnDisabled Gets or sets a value that indicates whether the ContextMenu should be shown when its parent is grayed out.
Public attached property VerticalOffset Gets or sets a value that indicates where along the y-direction to place the ContextMenu with respect to the parent control.
Top
  Name Description
Public method Static member GetContextMenu Gets the value of the ContextMenu property of the specified object.
Public method Static member GetHasDropShadow Gets a value that indicates whether the ContextMenu has a drop shadow.
Public method Static member GetHorizontalOffset Gets the value of the HorizontalOffset property of the specified object.
Public method Static member GetIsEnabled Gets the value of the IsEnabled property of the specified object.
Public method Static member GetPlacement Gets the value of the Placement property of the specified object.
Public method Static member GetPlacementRectangle Gets the value of the PlacementRectangle property of the specified object.
Public method Static member GetPlacementTarget Gets the value of the PlacementTarget property of the specified object.
Public method Static member GetShowOnDisabled Gets the value of the ShowOnDisabled property of the specified object.
Public method Static member GetVerticalOffset Gets the value of the VerticalOffset property of the specified object.
Public method Static member SetContextMenu Sets the value of the ContextMenu property of the specified object.
Public method Static member SetHasDropShadow Sets a value that indicates whether the ContextMenu has a drop shadow.
Public method Static member SetHorizontalOffset Sets the value of the HorizontalOffset property of the specified object.
Public method Static member SetIsEnabled Sets the value of the IsEnabled property of the specified object.
Public method Static member SetPlacement Sets the value of the Placement property of the specified object.
Public method Static member SetPlacementRectangle Sets the value of the PlacementRectangle property of the specified object.
Public method Static member SetPlacementTarget Sets the value of the PlacementTarget property of the specified object.
Public method Static member SetShowOnDisabled Sets the value of the ShowOnDisabled property of the specified object.
Public method Static member SetVerticalOffset Sets the value of the VerticalOffset property of the specified object.
Top
  Name Description
Public field Static member ContextMenuClosingEvent Identifies the ContextMenuClosing routed event, as exposed on classes that implement this event.
Public field Static member ContextMenuOpeningEvent Identifies the ContextMenuOpening routed event, as exposed on classes that implement this event.
Public field Static member ContextMenuProperty Identifies the ContextMenu attached property.
Public field Static member HasDropShadowProperty Identifies the HasDropShadow attached property.
Public field Static member HorizontalOffsetProperty Identifies the HorizontalOffset attached property.
Public field Static member IsEnabledProperty Identifies the IsEnabled attached property.
Public field Static member PlacementProperty Identifies the Placement attached property.
Public field Static member PlacementRectangleProperty Identifies the PlacementRectangle attached property.
Public field Static member PlacementTargetProperty Identifies the PlacementTarget attached property.
Public field Static member ShowOnDisabledProperty Identifies the ShowOnDisabled attached property.
Public field Static member VerticalOffsetProperty Identifies the VerticalOffset attached property.
Top

The ContextMenuService class provides attached properties that can be used to specify the appearance and position of a context menu. Many of the properties in the ContextMenuService class are also defined by the ContextMenu. Sometimes it is more convenient to set the properties by using the ContextMenuService class than by setting the properties on a ContextMenu. For example, you can create a ContextMenu to be shared by multiple elements, but use the ContextMenuService class to specify a different position of the ContextMenu for each element. The following properties are defined by the ContextMenu and ContextMenuService classes. If any of these properties are set on both ContextMenu and the ContextMenuService, the property value from the ContextMenuService is used.

You can also use the ContextMenuService to display menus on disabled items.

The following example assigns the same ContextMenu to two buttons and sets the HasDropShadow, Placement, PlacementRectangle, HorizontalOffset, and VerticalOffset properties to set the ContextMenu to different positions for each button.


<StackPanel>
  <StackPanel.Resources>
    <ContextMenu x:Key="myContextMenu">
      <MenuItem Header="Item"/>
    </ContextMenu>
  </StackPanel.Resources>

  <!--Both buttons use the same ContextMenu but use the
    properties on ContextMenuService to position them
    differently.-->
  <Button ContextMenu="{StaticResource myContextMenu}" 
          ContextMenuService.HasDropShadow="False" 
          ContextMenuService.Placement="Relative"
          ContextMenuService.HorizontalOffset="50"
          ContextMenuService.VerticalOffset="-10">
    button 1
  </Button>

  <Button ContextMenu="{StaticResource myContextMenu}" 
          ContextMenuService.HasDropShadow="True"
          ContextMenuService.Placement="Right"
          ContextMenuService.PlacementRectangle="0,0,30,30">
    button 2
  </Button>
</StackPanel>


The following example shows how to use the service to display a ContextMenu on a disabled button. Notice that you set the ShowOnDisabled property on the button that is the parent of the context menu.


<Button Height="30" Content="Disabled Button" IsEnabled="False" 
     ContextMenuService.ShowOnDisabled="True">
  <Button.ContextMenu>
    <ContextMenu>
      <MenuItem Header="Item 1"/>
      <MenuItem Header="Item 2"/>
      <MenuItem Header="Item 3"/>
    </ContextMenu>
  </Button.ContextMenu>
</Button>


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ