Class
InputBindingsCollection

Represents a collection of input bindings that can be used to manage keyboard shortcuts and commands. Provides functionality to add, remove, and search for input bindings within the collection.

Definition

Namespace:Telerik.WinControls.Keyboard

Assembly:Telerik.WinControls.dll

Syntax:

cs-api-definition
[ListBindable(BindableSupport.No)]
public class InputBindingsCollection : CollectionBase, IList, ICollection, IEnumerable

Inheritance: objectCollectionBaseInputBindingsCollection

Implements: ICollectionIEnumerableIList

Inherited Members CollectionBase.Clear()CollectionBase.RemoveAt(int)CollectionBase.GetEnumerator()CollectionBase.OnSet(int, object, object)CollectionBase.OnInsert(int, object)CollectionBase.OnClear()CollectionBase.OnRemove(int, object)CollectionBase.OnValidate(object)CollectionBase.OnSetComplete(int, object, object)CollectionBase.OnInsertComplete(int, object)CollectionBase.OnClearComplete()CollectionBase.OnRemoveComplete(int, object)CollectionBase.InnerListCollectionBase.ListCollectionBase.CapacityCollectionBase.Count

Constructors

InputBindingsCollection()

Initializes a new instance of the InputBindingsCollection class.

Declaration

cs-api-definition
public InputBindingsCollection()

InputBindingsCollection(InputBinding[])

Initializes a new instance of InputBindingsCollection containing any array of InputBinding objects.

Declaration

cs-api-definition
public InputBindingsCollection(InputBinding[] value)

Parameters

value

InputBinding[]

A array of InputBinding objects with which to intialize the collection

InputBindingsCollection(InputBindingsCollection)

Initializes a new instance of InputBindingsCollection based on another InputBindingsCollection.

Declaration

cs-api-definition
public InputBindingsCollection(InputBindingsCollection value)

Parameters

value

InputBindingsCollection

A InputBindingsCollection from which the contents are copied

InputBindingsCollection(Shortcuts)

Initializes a new instance of the InputBindingsCollection class with the specified owner.

Declaration

cs-api-definition
public InputBindingsCollection(Shortcuts owner)

Parameters

owner

Shortcuts

The Shortcuts instance that owns this collection.

Properties

this[int]

Represents the entry at the specified index of the InputBinding.

Declaration

cs-api-definition
public InputBinding this[int index] { get; set; }

Parameters

index

int

The zero-based index of the entry to locate in the collection.

Property Value

InputBinding

The entry at the specified index of the collection.

Exceptions

ArgumentOutOfRangeException

index is outside the valid range of indexes for the collection.

Methods

Add(InputBinding)

Adds a InputBinding with the specified value to the InputBindingsCollection .

Declaration

cs-api-definition
public int Add(InputBinding value)

Parameters

value

InputBinding

The InputBinding to add.

Returns

int

The index at which the new element was inserted.

AddRange(InputBinding[])

Copies the elements of an array to the end of the InputBindingsCollection.

Declaration

cs-api-definition
public void AddRange(InputBinding[] value)

Parameters

value

InputBinding[]

An array of type InputBinding containing the objects to add to the collection.

AddRange(InputBindingsCollection)

Adds the contents of another InputBindingsCollection to the end of the collection.

Declaration

cs-api-definition
public void AddRange(InputBindingsCollection value)

Parameters

value

InputBindingsCollection

A InputBindingsCollection containing the objects to add to the collection.

Contains(InputBinding)

Gets a value indicating whether the InputBindingsCollection contains the specified InputBinding.

Declaration

cs-api-definition
public bool Contains(InputBinding value)

Parameters

value

InputBinding

The InputBinding to locate.

Returns

bool

true if the InputBinding is contained in the collection; otherwise, false.

CopyTo(InputBinding[], int)

Copies the InputBindingsCollection values to a one-dimensional Array instance at the specified index.

Declaration

cs-api-definition
public void CopyTo(InputBinding[] array, int index)

Parameters

array

InputBinding[]

The one-dimensional Array that is the destination of the values copied from InputBindingsCollection .

index

int

The index in array where copying begins.

Exceptions

ArgumentException

array is multidimensional.

-or-

The number of elements in the InputBindingsCollection is greater than the available space between index and the end of array.

ArgumentNullException

array is null.

ArgumentOutOfRangeException

index is less than array's lowbound.

GetBindingByComponent(IComponent)

Gets all input bindings associated with the specified component.

Declaration

cs-api-definition
public InputBindingsCollection GetBindingByComponent(IComponent component)

Parameters

component

IComponent

The component to search for bindings.

Returns

InputBindingsCollection

A collection of input bindings associated with the component, or null if none found.

IndexOf(InputBinding)

Returns the index of a InputBinding in the InputBindingsCollection .

Declaration

cs-api-definition
public int IndexOf(InputBinding value)

Parameters

value

InputBinding

The InputBinding to locate.

Returns

int

The index of the InputBinding of value in the InputBindingsCollection, if found; otherwise, -1.

Insert(int, InputBinding)

Inserts a InputBinding into the InputBindingsCollection at the specified index.

Declaration

cs-api-definition
public void Insert(int index, InputBinding value)

Parameters

index

int

The zero-based index where value should be inserted.

value

InputBinding

The InputBinding to insert.

Remove(InputBinding)

Removes a specific InputBinding from the InputBindingsCollection .

Declaration

cs-api-definition
public void Remove(InputBinding value)

Parameters

value

InputBinding

The InputBinding to remove from the InputBindingsCollection .

Exceptions

ArgumentException

value is not found in the Collection.

RemoveBindingByComponent(IComponent)

Removes all input bindings associated with the specified component from the collection.

Declaration

cs-api-definition
public void RemoveBindingByComponent(IComponent component)

Parameters

component

IComponent

The component whose bindings should be removed.