New to Telerik UI for WinForms? Start a free 30-day trial

RadDockCommandManager

Class

Manages all the commands registered with a RadDock instance.

Definition

Namespace:Telerik.WinControls.UI.Docking

Assembly:Telerik.WinControls.RadDock.dll

Syntax:

public class RadDockCommandManager : RadDockObject, IDisposable, INotifyPropertyChanged, INotifyPropertyChangingEx, IMessageListener

Inheritance: objectRadDockObjectRadDockCommandManager

Implements: IDisposableIMessageListenerINotifyPropertyChangedINotifyPropertyChangingEx

Inherited Members RadDockObject.Dispose()RadDockObject.Dispose(bool)RadDockObject.DisposeUnmanagedResources()RadDockObject.OnPropertyChanging(string)RadDockObject.OnPropertyChanged(string)RadDockObject.ShouldSerializeProperty(string)RadDockObject.EventsRadDockObject.DisposingRadDockObject.IsDisposedRadDockObject.DisposedRadDockObject.PropertyChangingRadDockObject.PropertyChanged...

Constructors

RadDockCommandManager(RadDock)

Constructs a new instance of the RadDockCommandManager class.

public RadDockCommandManager(RadDock dockManager)

Parameters:dockManagerRadDock

The RadDock instance this manager is associated with.

Properties

Commands

IEnumerable<RadDockCommand>

Gets all the registered commands with this manager.

public IEnumerable<RadDockCommand> Commands { get; }

Enabled

bool

Determines whether the command manager is currently enabled.

public bool Enabled { get; set; }

Methods

CanProcessMessage(Message)

Determines whether the manager should process keyboard messages

protected virtual bool CanProcessMessage(Message msg)

Parameters:msgMessageReturns:

bool

DisposeManagedResources()

Unregisters this instance from the global RadMessageFilter instance.

protected override void DisposeManagedResources()

Overrides: RadDockObject.DisposeManagedResources()

ExecuteCommand(string)

Attempts to execute the RadDockCommand which matches the specified name.

public void ExecuteCommand(string name)

Parameters:namestring

FindCommandByName(string)

Finds the RadDockCommand instance which name equals the specified one. May be null if no such command is registered.

public RadDockCommand FindCommandByName(string name)

Parameters:namestringReturns:

RadDockCommand

IsModifierKey(Keys)

Determines whether the specified Key is a modifier.

protected virtual bool IsModifierKey(Keys currKey)

Parameters:currKeyKeysReturns:

bool

OnDockManagerLoaded()

The manager gets notified that the associated

protected virtual void OnDockManagerLoaded()

OnEnabledChanged()

Notifies for a change in the Enabled state.

protected virtual void OnEnabledChanged()

ProcessKeyDown(KeyEventArgs)

Processes a WM_KEYDOWN message that comes into the UI thread. Default implementation will attempt to execute a command that matches completely or partially the keys combination.

public virtual bool ProcessKeyDown(KeyEventArgs keys)

Parameters:keysKeyEventArgsReturns:

bool

RegisterCommand(RadDockCommand)

Registers the specified command, using the command's Name as a key.

public void RegisterCommand(RadDockCommand command)

Parameters:commandRadDockCommand

UnregisterCommand(string)

Removes an already registered command with the specified name.

public void UnregisterCommand(string name)

Parameters:namestring