InputBindingCollection.Add(InputBinding) Method

Reference

Definition

Namespace:: System.Windows.Input

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds the specified InputBinding to this InputBindingCollection.

public:
 int Add(System::Windows::Input::InputBinding ^ inputBinding);

public int Add (System.Windows.Input.InputBinding inputBinding);

member this.Add : System.Windows.Input.InputBinding -> int

Public Function Add (inputBinding As InputBinding) As Integer

Parameters

inputBinding: InputBinding

The binding to add to the collection.

Returns

Int32

Always returns 0. This deviates from the standard IList implementation for Add, which should return the index where the new item was added to the collection.

Exceptions

NotSupportedException

inputBinding is null.

Examples

The following example creates a KeyGesture and associates it with a KeyBinding. The KeyBinding is added to the InputBindingCollection on a Window.

<Window.InputBindings>
  <KeyBinding Key="B"
              Modifiers="Control" 
              Command="ApplicationCommands.Open" />
</Window.InputBindings>

KeyGesture OpenKeyGesture = new KeyGesture(
    Key.B,
    ModifierKeys.Control);

KeyBinding OpenCmdKeybinding = new KeyBinding(
    ApplicationCommands.Open,
    OpenKeyGesture);

this.InputBindings.Add(OpenCmdKeybinding);

Dim OpenKeyGesture As New KeyGesture(Key.B, ModifierKeys.Control)

Dim OpenCmdKeybinding As New KeyBinding(ApplicationCommands.Open, OpenKeyGesture)

Me.InputBindings.Add(OpenCmdKeybinding)

The XAML example does not literally use Add, but Add is called implicitly by the XAML processing support for collections. For details on XAML and collections, see XAML Overview (WPF).

Applies to