Class
RadDockCommandManager

Manages all the commands registered with a RadDock instance.

Definition

Constructors

RadDockCommandManager(RadDock)

Constructs a new instance of the RadDockCommandManager class.

Declaration

cs-api-definition
public RadDockCommandManager(RadDock dockManager)

Parameters

dockManager

RadDock

The RadDock instance this manager is associated with.

Properties

Commands

Gets all the registered commands with this manager.

Declaration

cs-api-definition
public IEnumerable<RadDockCommand> Commands { get; }

Property Value

IEnumerable<RadDockCommand>

Enabled

Determines whether the command manager is currently enabled.

Declaration

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

Property Value

bool

Methods

CanProcessMessage(Message)

Determines whether the manager should process keyboard messages

Declaration

cs-api-definition
protected virtual bool CanProcessMessage(Message msg)

Parameters

msg

Message

Returns

bool

DisposeManagedResources()

Unregisters this instance from the global RadMessageFilter instance.

Declaration

cs-api-definition
protected override void DisposeManagedResources()

Overrides RadDockObject.DisposeManagedResources()

ExecuteCommand(string)

Attempts to execute the RadDockCommand which matches the specified name.

Declaration

cs-api-definition
public void ExecuteCommand(string name)

Parameters

name

string

FindCommandByName(string)

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

Declaration

cs-api-definition
public RadDockCommand FindCommandByName(string name)

Parameters

name

string

Returns

RadDockCommand

IsModifierKey(Keys)

Determines whether the specified Key is a modifier.

Declaration

cs-api-definition
protected virtual bool IsModifierKey(Keys currKey)

Parameters

currKey

Keys

Returns

bool

OnDockManagerLoaded()

The manager gets notified that the associated

Declaration

cs-api-definition
protected virtual void OnDockManagerLoaded()

OnEnabledChanged()

Notifies for a change in the Enabled state.

Declaration

cs-api-definition
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.

Declaration

cs-api-definition
public virtual bool ProcessKeyDown(KeyEventArgs keys)

Parameters

keys

KeyEventArgs

Returns

bool

RegisterCommand(RadDockCommand)

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

Declaration

cs-api-definition
public void RegisterCommand(RadDockCommand command)

Parameters

command

RadDockCommand

UnregisterCommand(string)

Removes an already registered command with the specified name.

Declaration

cs-api-definition
public void UnregisterCommand(string name)

Parameters

name

string