ClassContextMenuService
Provides methods for displaying a context menu for a document or tool window.
Definition
Namespace:Telerik.WinControls.UI.Docking
Assembly:Telerik.WinControls.RadDock.dll
Syntax:
public class ContextMenuService : RadDockService, IDisposable, INotifyPropertyChanged, INotifyPropertyChangingEx
Inheritance: objectRadDockObjectRadDockServiceContextMenuService
Implements:
Inherited Members
Constructors
ContextMenuService()
Declaration
public ContextMenuService()
Fields
ActivateWindow
Declaration
public const string ActivateWindow = "ActivateWindow"
Field Value
CloseAllButPinned
Declaration
public const string CloseAllButPinned = "CloseAllButPinned"
Field Value
CloseAllButThis
Declaration
public const string CloseAllButThis = "CloseAllButThis"
Field Value
DockStateTabbedDocument
Declaration
public const string DockStateTabbedDocument = "TabbedDocument"
Field Value
MoveToNextTabGroup
Declaration
public const string MoveToNextTabGroup = "MoveToNextTabGroup"
Field Value
MoveToPrevTabGroup
Declaration
public const string MoveToPrevTabGroup = "MoveToPrevTabGroup"
Field Value
Properties
AllowActiveWindowListContextMenu
Determines whether a context menu, listing all opened documents within a document strip, may be displayed.
Declaration
public bool AllowActiveWindowListContextMenu { get; set; }
Property Value
AllowDocumentContextMenu
Determines whether context menus, associated with a document window may be displayed.
Declaration
public bool AllowDocumentContextMenu { get; set; }
Property Value
AllowToolContextMenu
Determines whether context menus, associated with a tool window may be displayed.
DisplayedMenu
Gets the currently displayed menu.
Declaration
[Browsable(false)]
public RadContextMenu DisplayedMenu { get; }
Property Value
IsMenuDisplayed
Determines whether a context menu is currently displayed.
Declaration
[Browsable(false)]
public bool IsMenuDisplayed { get; }
Property Value
Methods
CanDisplayMenu(DockWindow)
Determines whether a context menu can be displayed for the specified window.
Declaration
protected virtual bool CanDisplayMenu(DockWindow window)
Parameters
window
Returns
DisplayActiveWindowList(DocumentTabStrip, Point)
Displays a context menu, listing all currently active documents within the specified document strip.
Declaration
public void DisplayActiveWindowList(DocumentTabStrip strip, Point screenPos)
Parameters
strip
screenPos
DisplayContextMenu(DockWindow, Point)
Displays a context menu at the specified screen position, associated with the provided DockWindow instance.
Declaration
public void DisplayContextMenu(DockWindow window, Point screenPos)
Parameters
window
screenPos
DisplayContextMenu(RadElement, DockWindow, Point)
Displays a context menu at the specified screen position, associated with the provided DockWindow instance.
Declaration
public void DisplayContextMenu(RadElement owner, DockWindow window, Point screenPos)
Parameters
owner
window
screenPos
DisplayMenuCore(List<RadMenuItemBase>, Point)
Displays the context menu at the specified screen position, using the provided list of items.
Declaration
protected virtual void DisplayMenuCore(List<RadMenuItemBase> items, Point screenPos)
Parameters
items
List<RadMenuItemBase>
screenPos
DisplayMenuCore(RadElement, List<RadMenuItemBase>, Point)
Displays the context menu at the specified screen position, using the provided list of items.
Declaration
protected virtual void DisplayMenuCore(RadElement menuOwner, List<RadMenuItemBase> items, Point screenPos)
Parameters
menuOwner
items
List<RadMenuItemBase>
screenPos
DisposeManagedResources()
Disposes any managed resources associated with this object.
Declaration
protected override void DisposeManagedResources()
Overrides
GetContextMenuItems(DockWindow)
Gets the menu items, associated with the specified DockWindow.
Declaration
public List<RadMenuItemBase> GetContextMenuItems(DockWindow window)
Parameters
window
Returns
List<RadMenuItemBase>
GetContextMenuItems(DockWindow, bool)
Gets the menu items, associated with the specified DockWindow.
Declaration
public List<RadMenuItemBase> GetContextMenuItems(DockWindow window, bool defaultAction)
Parameters
window
defaultAction
True to execute the default action, associated with each item, when an item is clicked.
Returns
List<RadMenuItemBase>
OnContextMenuItemClick(object, EventArgs)
The entry point used to handle menu item clicks.
PerformMenuItemAction(DockWindow, RadMenuItemBase)
Performs the core action, depending on the clicked menu item.
Declaration
protected virtual void PerformMenuItemAction(DockWindow window, RadMenuItemBase menuItem)
Parameters
window
menuItem
Events
ContextMenuDisplaying
Notifies that a context menu is about to be displayed.
Declaration
public event ContextMenuDisplayingEventHandler ContextMenuDisplaying
Event Value
ContextMenuItemClicked
Notifies that a context menu item has been clicked.
Declaration
public event ContextMenuItemClickEventHandler ContextMenuItemClicked
Event Value