Interface IKeyCommandListBinder
Provides the functionality for the collection of the bindings.
Inherited Members
Namespace: Syncfusion.Shared.Utils.KeyBinding
Assembly: Syncfusion.Edit.Windows.dll
Syntax
public interface IKeyCommandListBinder : IKeyCommandBinderRemarks
Command is always null and Key is always Keys.None.
Properties
Item[Keys]
Gets the binding for the key.
Declaration
IKeyCommandBinder this[Keys key] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.Keys | key |
Property Value
| Type | Description |
|---|---|
| IKeyCommandBinder |
Methods
BindToBinder(Keys)
Sets binding for the key to the new command.
Declaration
IKeyCommandListBinder BindToBinder(Keys key)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.Keys | key | Key to be binded. |
Returns
| Type | Description |
|---|---|
| IKeyCommandListBinder | Returns existing binder, or creates new if key was not binded before or was binded to command. |
BindToCommand(Keys, String)
Sets binding of the key to specified command.
Declaration
IKeyCommand BindToCommand(Keys key, string command)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.Keys | key | Key to be binded. |
| System.String | command | Name of the command, the key is to be binded to. |
Returns
| Type | Description |
|---|---|
| IKeyCommand | Command if binding completed successfully, or null of binding failed. |
Remarks
It is not necessary to create command before binding. If it does not exists, it will be created.
FindBinding(Keys[], Int32)
Searches for binding of the keys sequence.
Declaration
IKeyCommandBinder FindBinding(Keys[] keySequence, int iStart)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.Keys[] | keySequence | |
| System.Int32 | iStart |
Returns
| Type | Description |
|---|---|
| IKeyCommandBinder | Bindings, that are assigned to that command. |
FindBindings(String)
Searches for bindings of the command.
Declaration
IKeyCommandBinder[] FindBindings(string command)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | command | Name of the command. |
Returns
| Type | Description |
|---|---|
| IKeyCommandBinder[] | Bindings, that are assigned to that command. |
RemoveBinding(Keys)
Removes any associated binding for the specified key.
Declaration
void RemoveBinding(Keys key)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Forms.Keys | key | Key to be unbinded. |