Class KeyProcessor.KeyCommandBinderImpl

Implementation of the IKeyCommandBinder interface. Used to keep information about single key=command binding.

Inheritance

System.Object

KeyProcessor.KeyCommandBinderImpl

KeyProcessor.KeyCommandListBinderImpl

Implements

IKeyCommandBinder

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Syncfusion.Shared.Utils.KeyBinding.Implementation

Assembly: Syncfusion.Edit.Windows.dll

Syntax

public class KeyCommandBinderImpl : IKeyCommandBinder

Constructors

KeyCommandBinderImpl()

Constructor for XML serialization.

Declaration

public KeyCommandBinderImpl()

KeyCommandBinderImpl(KeyProcessor, IKeyCommandListBinder, IKeyCommand, Keys)

Creates new instance of the class and initializes it.

Declaration

public KeyCommandBinderImpl(KeyProcessor processor, IKeyCommandListBinder parent, IKeyCommand command, Keys key)

Parameters

Type	Name	Description
KeyProcessor	processor	Key process, the binding belongs to.
IKeyCommandListBinder	parent	Parent list of the binding.
IKeyCommand	command	Command, the binding is linked to.
System.Windows.Forms.Keys	key	Key, the binding is linked to.

Fields

m_Key

Key, that is binded.

Declaration

protected Keys m_Key

Field Value

Type
System.Windows.Forms.Keys

Properties

Command

Gets command, that is binded.

Declaration

public IKeyCommand Command { get; }

Property Value

Type
IKeyCommand

CommandName

Gets or sets command name, just for XML Serialization support.

Declaration

public string CommandName { get; set; }

Property Value

Type
System.String

Key

Gets key, that is binded.

Declaration

public Keys Key { get; }

Property Value

Type
System.Windows.Forms.Keys

KeyXML

Gets or sets key value. Intended for XML Serialization only.

Declaration

public string KeyXML { get; set; }

Property Value

Type
System.String

Parent

Gets or sets parent list.

Declaration

public IKeyCommandListBinder Parent { get; set; }

Property Value

Type
IKeyCommandListBinder

Processor

Gets or sets key processor.

Declaration

public virtual KeyProcessor Processor { get; set; }

Property Value

Type
KeyProcessor

Methods

GetCombinationName()

Gets full name of the combination, current binding is related to.

Declaration

public string GetCombinationName()

Returns

Type	Description
System.String	String that represents currently used combination.

ProcessKey(Keys)

Tries to process key.

Declaration

public virtual bool ProcessKey(Keys key)

Parameters

Type	Name	Description
System.Windows.Forms.Keys	key	Key to be processed.

Returns

Type	Description
System.Boolean	True if key was processed, otherwise false.

ResetCommandLinks()

Reset links to commands, and leaves only by-name references.

Declaration

public virtual void ResetCommandLinks()

ToString()

Return combination name.

Declaration

public override string ToString()

Returns

Type	Description
System.String	String, that represents current key sequence.

Overrides

System.Object.ToString()

Implements

IKeyCommandBinder