Class
Shortcuts

Provides keyboard shortcut management and input binding functionality for RadControls and RadItems.

Definition

Namespace:Telerik.WinControls.Keyboard

Assembly:Telerik.WinControls.dll

Syntax:

cs-api-definition

[ToolboxBitmap(typeof(ResFinder), "Resources.Shortcuts.bmp")]
[Browsable(false)]
public class Shortcuts : Component, IComponent, IDisposable, IExtenderProvider

Inheritance: objectMarshalByRefObjectComponentShortcuts

Implements: IComponentIDisposableIExtenderProvider

Inherited Members Component.Dispose()Component.GetService(Type)Component.ToString()Component.CanRaiseEventsComponent.EventsComponent.SiteComponent.ContainerComponent.DesignModeComponent.DisposedMarshalByRefObject.MemberwiseClone(bool)MarshalByRefObject.GetLifetimeService()MarshalByRefObject.InitializeLifetimeService()MarshalByRefObject.CreateObjRef(Type)

Constructors

Shortcuts()

Initializes a new instance of the Shortcuts class.

Declaration

cs-api-definition

public Shortcuts()

Shortcuts(Control)

Initializes a new instance of the Shortcuts class with the specified owner control.

Declaration

cs-api-definition

public Shortcuts(Control owner)

Parameters

owner

Control

The control that owns this shortcuts instance.

Shortcuts(IContainer)

Initializes a new instance of the Shortcuts class and adds it to the specified container.

Declaration

cs-api-definition

public Shortcuts(IContainer container)

Parameters

container

IContainer

The container to add this component to.

Properties

InputBindings

Gets the collection of input bindings that define keyboard shortcuts and their associated commands.

Declaration

cs-api-definition

public InputBindingsCollection InputBindings { get; }

Property Value

InputBindingsCollection

An InputBindingsCollection containing the input bindings.

Owner

Gets or sets the control that owns this shortcuts instance.

Declaration

cs-api-definition

public Control Owner { get; set; }

Property Value

Control

The owner control.

Methods

AddCommandBindings(InputBinding)

Adds a command binding to the input bindings collection.

Declaration

cs-api-definition

public void AddCommandBindings(InputBinding binding)

Parameters

binding

InputBinding

The input binding to add.

AddCommandBindings(InputBindingsCollection)

Adds command bindings from an existing collection to the input bindings collection.

Declaration

cs-api-definition

public void AddCommandBindings(InputBindingsCollection bindings)

Parameters

bindings

InputBindingsCollection

The input bindings collection to add.

AddCommandBindings(List<InputBinding>)

Adds multiple command bindings to the input bindings collection.

Declaration

cs-api-definition

public void AddCommandBindings(List<InputBinding> bindings)

Parameters

bindings

List<InputBinding>

The list of input bindings to add.

AddShortcutsSupport()

Adds keyboard shortcuts support by initializing the chord message filter.

Declaration

cs-api-definition

public virtual void AddShortcutsSupport()

CanExtend(object)

Determines whether this extender provider can extend the specified object.

Declaration

cs-api-definition

public bool CanExtend(object extendee)

Parameters

extendee

object

The object to test for extensibility.

Returns

bool

true if the object can be extended; otherwise, false.

Implements IExtenderProvider.CanExtend(object)

Dispose(bool)

Clean up any resources being used.

Declaration

cs-api-definition

protected override void Dispose(bool disposing)

Parameters

disposing

bool

true if managed resources should be disposed; otherwise, false.

Overrides Component.Dispose(bool)

GetCommandBinding(IComponent)

Gets the command binding associated with the specified component.

Declaration

cs-api-definition

[TypeConverter(typeof(ExpandableObjectConverter))]
public InputBinding GetCommandBinding(IComponent component)

Parameters

component

IComponent

The component to get the binding for.

Returns

InputBinding

The input binding associated with the component, or null if none exists.

OnActivate(ChordEventArgs)

Raises the Activate event.

Declaration

cs-api-definition

protected virtual void OnActivate(ChordEventArgs e)

Parameters

ChordEventArgs

A ChordEventArgs that contains the event data.

ResetCommandBinding(InputBinding)

Resets the specified command binding to its default state.

Declaration

cs-api-definition

public void ResetCommandBinding(InputBinding value)

Parameters

value

InputBinding

The input binding to reset.

SetCommandBinding(IComponent, InputBinding)

Sets the command binding for the specified component.

Declaration

cs-api-definition

public void SetCommandBinding(IComponent component, InputBinding value)

Parameters

component

IComponent

The component to set the binding for.

value

InputBinding

The input binding to associate with the component.

Events

Activate

Occurs when a keyboard shortcut is activated.

Declaration

cs-api-definition

public event ChordsEventHandler Activate

Event Value

ChordsEventHandler

ClassShortcuts

Class
Shortcuts