Class
ContextMenuService

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:

cs-api-definition
public class ContextMenuService : RadDockService, IDisposable, INotifyPropertyChanged, INotifyPropertyChangingEx

Inheritance: objectRadDockObjectRadDockServiceContextMenuService

Implements: IDisposableINotifyPropertyChangedINotifyPropertyChangingEx

Inherited Members RadDockService.OnDockManagerChanged()RadDockService.OnEnabledChanged()RadDockService.CanOperate()RadDockService.DockManagerDesignModeRadDockService.DockManagerRadDockService.EnabledRadDockObject.Dispose()RadDockObject.Dispose(bool)RadDockObject.DisposeUnmanagedResources()RadDockObject.OnPropertyChanging(string)RadDockObject.OnPropertyChanged(string)RadDockObject.ShouldSerializeProperty(string)RadDockObject.EventsRadDockObject.DisposingRadDockObject.IsDisposedRadDockObject.DisposedRadDockObject.PropertyChangingRadDockObject.PropertyChanged

Constructors

ContextMenuService()

Declaration

cs-api-definition
public ContextMenuService()

Fields

ActivateWindow

Declaration

cs-api-definition
public const string ActivateWindow = "ActivateWindow"

Field Value

string

CloseAll

Declaration

cs-api-definition
public const string CloseAll = "CloseAll"

Field Value

string

CloseAllButPinned

Declaration

cs-api-definition
public const string CloseAllButPinned = "CloseAllButPinned"

Field Value

string

CloseAllButThis

Declaration

cs-api-definition
public const string CloseAllButThis = "CloseAllButThis"

Field Value

string

CloseWindow

Declaration

cs-api-definition
public const string CloseWindow = "CloseWindow"

Field Value

string

DockStateAutoHide

Declaration

cs-api-definition
public const string DockStateAutoHide = "AutoHide"

Field Value

string

DockStateDocked

Declaration

cs-api-definition
public const string DockStateDocked = "Docked"

Field Value

string

DockStateFloating

Declaration

cs-api-definition
public const string DockStateFloating = "Floating"

Field Value

string

DockStateHidden

Declaration

cs-api-definition
public const string DockStateHidden = "Hidden"

Field Value

string

DockStateTabbedDocument

Declaration

cs-api-definition
public const string DockStateTabbedDocument = "TabbedDocument"

Field Value

string

MoveToNextTabGroup

Declaration

cs-api-definition
public const string MoveToNextTabGroup = "MoveToNextTabGroup"

Field Value

string

MoveToPrevTabGroup

Declaration

cs-api-definition
public const string MoveToPrevTabGroup = "MoveToPrevTabGroup"

Field Value

string

NewHTabGroup

Declaration

cs-api-definition
public const string NewHTabGroup = "NewHTabGroup"

Field Value

string

NewVTabGroup

Declaration

cs-api-definition
public const string NewVTabGroup = "NewVTabGroup"

Field Value

string

Properties

AllowActiveWindowListContextMenu

Determines whether a context menu, listing all opened documents within a document strip, may be displayed.

Declaration

cs-api-definition
public bool AllowActiveWindowListContextMenu { get; set; }

Property Value

bool

AllowDocumentContextMenu

Determines whether context menus, associated with a document window may be displayed.

Declaration

cs-api-definition
public bool AllowDocumentContextMenu { get; set; }

Property Value

bool

AllowToolContextMenu

Determines whether context menus, associated with a tool window may be displayed.

Declaration

cs-api-definition
public bool AllowToolContextMenu { get; set; }

Property Value

bool

DisplayedMenu

Gets the currently displayed menu.

Declaration

cs-api-definition
[Browsable(false)]
public RadContextMenu DisplayedMenu { get; }

Property Value

RadContextMenu

IsMenuDisplayed

Determines whether a context menu is currently displayed.

Declaration

cs-api-definition
[Browsable(false)]
public bool IsMenuDisplayed { get; }

Property Value

bool

Methods

CanDisplayMenu(DockWindow)

Determines whether a context menu can be displayed for the specified window.

Declaration

cs-api-definition
protected virtual bool CanDisplayMenu(DockWindow window)

Parameters

window

DockWindow

Returns

bool

DisplayActiveWindowList(DocumentTabStrip, Point)

Displays a context menu, listing all currently active documents within the specified document strip.

Declaration

cs-api-definition
public void DisplayActiveWindowList(DocumentTabStrip strip, Point screenPos)

Parameters

strip

DocumentTabStrip

screenPos

Point

DisplayContextMenu(DockWindow, Point)

Displays a context menu at the specified screen position, associated with the provided DockWindow instance.

Declaration

cs-api-definition
public void DisplayContextMenu(DockWindow window, Point screenPos)

Parameters

window

DockWindow

screenPos

Point

DisplayContextMenu(RadElement, DockWindow, Point)

Displays a context menu at the specified screen position, associated with the provided DockWindow instance.

Declaration

cs-api-definition
public void DisplayContextMenu(RadElement owner, DockWindow window, Point screenPos)

Parameters

owner

RadElement

window

DockWindow

screenPos

Point

DisplayMenuCore(List<RadMenuItemBase>, Point)

Displays the context menu at the specified screen position, using the provided list of items.

Declaration

cs-api-definition
protected virtual void DisplayMenuCore(List<RadMenuItemBase> items, Point screenPos)

Parameters

items

List<RadMenuItemBase>

screenPos

Point

DisplayMenuCore(RadElement, List<RadMenuItemBase>, Point)

Displays the context menu at the specified screen position, using the provided list of items.

Declaration

cs-api-definition
protected virtual void DisplayMenuCore(RadElement menuOwner, List<RadMenuItemBase> items, Point screenPos)

Parameters

menuOwner

RadElement

items

List<RadMenuItemBase>

screenPos

Point

DisposeManagedResources()

Disposes any managed resources associated with this object.

Declaration

cs-api-definition
protected override void DisposeManagedResources()

Overrides RadDockObject.DisposeManagedResources()

GetContextMenuItems(DockWindow)

Gets the menu items, associated with the specified DockWindow.

Declaration

cs-api-definition
public List<RadMenuItemBase> GetContextMenuItems(DockWindow window)

Parameters

window

DockWindow

Returns

List<RadMenuItemBase>

GetContextMenuItems(DockWindow, bool)

Gets the menu items, associated with the specified DockWindow.

Declaration

cs-api-definition
public List<RadMenuItemBase> GetContextMenuItems(DockWindow window, bool defaultAction)

Parameters

window

DockWindow

defaultAction

bool

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.

Declaration

cs-api-definition
protected virtual void OnContextMenuItemClick(object sender, EventArgs e)

Parameters

sender

object

e

EventArgs

PerformMenuItemAction(DockWindow, RadMenuItemBase)

Performs the core action, depending on the clicked menu item.

Declaration

cs-api-definition
protected virtual void PerformMenuItemAction(DockWindow window, RadMenuItemBase menuItem)

Parameters

window

DockWindow

menuItem

RadMenuItemBase

Events

ContextMenuDisplaying

Notifies that a context menu is about to be displayed.

Declaration

cs-api-definition
public event ContextMenuDisplayingEventHandler ContextMenuDisplaying

Event Value

ContextMenuDisplayingEventHandler

ContextMenuItemClicked

Notifies that a context menu item has been clicked.

Declaration

cs-api-definition
public event ContextMenuItemClickEventHandler ContextMenuItemClicked

Event Value

ContextMenuItemClickEventHandler