InputBinding InputBinding InputBinding InputBinding Class

定義

InputGesture とコマンドの間のバインディングを表します。Represents a binding between an InputGesture and a command. コマンドは、RoutedCommand の可能性があります。The command is potentially a RoutedCommand.

public ref class InputBinding : System::Windows::Freezable, System::Windows::Input::ICommandSource
public class InputBinding : System.Windows.Freezable, System.Windows.Input.ICommandSource
type InputBinding = class
    inherit Freezable
    interface ICommandSource
Public Class InputBinding
Inherits Freezable
Implements ICommandSource
継承
派生
実装

次の例は、を使用KeyBindingしてOpenKeyGestureコマンドにバインドする方法を示しています。The following example shows how to use a KeyBinding to bind a KeyGesture to the Open command. キージェスチャを実行すると、Open コマンドが呼び出されます。When the key gesture is performed, the Open command is invoked.

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

次の例は、カスタムコマンドをオブジェクトにInputBindingバインドする方法を示しています。The following examples show how to bind a custom command to InputBinding objects. これらの例では、ユーザーが次のいずれかの操作を実行して背景色を変更できるようにするアプリケーションを作成します。These examples create an application that enables the user to change the background color by performing one of the following actions:

  • ボタンをクリックします。Clicking a button.

  • CTRL + C キーを押します。Pressing CTRL+C.

  • (のStackPanel ListBox外側) を右クリックします。Right-clicking a StackPanel (outside the ListBox).

最初の例では、とSimpleDelegateCommandいう名前のクラスを作成します。The first example creates a class named SimpleDelegateCommand. このクラスは、コマンドを作成するオブジェクトがコマンドの実行時に発生するアクションを定義できるように、デリゲートを受け入れます。This class accepts a delegate so that the object creating the command can define the action that occurs when the command executes. SimpleDelegateCommandでは、コマンドを呼び出すキーとマウスの入力を指定するプロパティも定義されています。SimpleDelegateCommand also defines properties that specify what key and mouse input invokes the command. GestureKeyキーボード入力を指定します。 GestureModifier``MouseGestureマウス入力を指定します。GestureKey and GestureModifier specify the keyboard input; MouseGesture specifies the mouse input.

 // Create a class that implements ICommand and accepts a delegate.
public class SimpleDelegateCommand : ICommand
{
    // Specify the keys and mouse actions that invoke the command. 
    public Key GestureKey { get; set; }
    public ModifierKeys GestureModifier { get; set; }
    public MouseAction MouseGesture { get; set; }

    Action<object> _executeDelegate;

    public SimpleDelegateCommand(Action<object> executeDelegate)
    {
        _executeDelegate = executeDelegate;
    }

    public void Execute(object parameter)
    {
        _executeDelegate(parameter);
    }

    public bool CanExecute(object parameter) { return true; }
    public event EventHandler CanExecuteChanged;
}
' Create a class that implements ICommand and accepts a delegate. 
Public Class SimpleDelegateCommand
    Implements ICommand

    ' Specify the keys and mouse actions that invoke the command. 
    Private _GestureKey As Key
    Private _GestureModifier As ModifierKeys
    Private _MouseGesture As MouseAction

    Public Property GestureKey() As Key
        Get
            Return _GestureKey
        End Get
        Set(ByVal value As Key)
            _GestureKey = value
        End Set
    End Property

    Public Property GestureModifier() As ModifierKeys
        Get
            Return _GestureModifier
        End Get
        Set(ByVal value As ModifierKeys)
            _GestureModifier = value
        End Set
    End Property

    Public Property MouseGesture() As MouseAction
        Get
            Return _MouseGesture
        End Get
        Set(ByVal value As MouseAction)
            _MouseGesture = value
        End Set
    End Property

    Private _executeDelegate As Action(Of Object)

    Public Sub New(ByVal executeDelegate As Action(Of Object))
        _executeDelegate = executeDelegate
    End Sub

    Public Sub Execute(ByVal parameter As Object) _
        Implements ICommand.Execute

        _executeDelegate(parameter)
    End Sub

    Public Function CanExecute(ByVal parameter As Object) As Boolean _
        Implements ICommand.CanExecute

        Return True
    End Function

    Public Event CanExecuteChanged As EventHandler _
        Implements ICommand.CanExecuteChanged
End Class

次の例では、をColorChangeCommand作成して初期SimpleDelegateCommand化します。これはです。The following example creates and initializes the ColorChangeCommand, which is a SimpleDelegateCommand. また、この例では、コマンドが呼び出されたときに実行さGestureKeyれるGestureModifierメソッドをMouseGesture定義し、、、およびの各プロパティを設定します。The example also defines the method that executes when the command is invoked and sets the GestureKey, GestureModifier, and MouseGesture properties. アプリケーションは、 Windowのコンストラクター InitializeCommandなどで、プログラムの開始時にメソッドを呼び出します。An application would call the InitializeCommand method when the program begins, such as in the constructor of a Window.

public SimpleDelegateCommand ChangeColorCommand
{
    get { return changeColorCommand; }
}

private SimpleDelegateCommand changeColorCommand;

private void InitializeCommand()
{
    originalColor = this.Background;

    changeColorCommand = new SimpleDelegateCommand(x => this.ChangeColor(x));

    DataContext = this;
    changeColorCommand.GestureKey = Key.C;
    changeColorCommand.GestureModifier = ModifierKeys.Control;
    ChangeColorCommand.MouseGesture = MouseAction.RightClick;
}

private Brush originalColor, alternateColor;

// Switch the Background color between
// the original and selected color.
private void ChangeColor(object colorString)
{
    if (colorString == null)
    {
        return;
    }

    Color newColor = 
        (Color)ColorConverter.ConvertFromString((String)colorString);
    
    alternateColor = new SolidColorBrush(newColor);

    if (this.Background == originalColor)
    {
        this.Background = alternateColor;
    }
    else
    {
        this.Background = originalColor;
    }
}
Public ReadOnly Property ChangeColorCommand() As SimpleDelegateCommand
    Get
        Return _changeColorCommand
    End Get
End Property

Private _changeColorCommand As SimpleDelegateCommand
Private originalColor As Brush, alternateColor As Brush

Private Sub InitializeCommand()
    originalColor = Me.Background

    _changeColorCommand = New SimpleDelegateCommand(Function(x) Me.ChangeColor(x))

    DataContext = Me
    _changeColorCommand.GestureKey = Key.C
    _changeColorCommand.GestureModifier = ModifierKeys.Control
    _changeColorCommand.MouseGesture = MouseAction.RightClick
End Sub

' Switch the Background color between 
' the original and selected color. 
Private Function ChangeColor(ByVal colorString As Object) As Integer

    If colorString Is Nothing Then
        Return 0
    End If

    Dim newColor As Color = DirectCast(ColorConverter.ConvertFromString(DirectCast(colorString, [String])), Color)

    alternateColor = New SolidColorBrush(newColor)

    If Brush.Equals(Me.Background, originalColor) Then
        Me.Background = alternateColor
    Else
        Me.Background = originalColor
    End If

    Return 0
End Function

最後に、次の例では、ユーザーインターフェイスを作成します。Finally, the following example creates the user interface. この例ではKeyBinding 、とMouseBindingを含むStackPanel Buttonに、およびを追加します。ListBoxThe example adds a KeyBinding and a MouseBinding to a StackPanel that contains a Button and a ListBox. ユーザーが内ListBoxの項目を選択すると、背景の色を選択した色に変更できます。When the user selects an item in the ListBox, he or she can change the color of the background to the selected color. CommandParameterどちらの場合も、プロパティはListBoxCommandの選択された項目にバインドされ、プロパティはにColorChangeCommandバインドされます。In each case, the CommandParameter property is bound to the selected item in the ListBox, and the Command property is bound to the ColorChangeCommand. KeyBinding.KeyKeyBinding.ModifiersおよびSimpleDelegateCommandの各プロパティは、クラスの対応するプロパティにバインドされます。 MouseBinding.MouseActionThe KeyBinding.Key, KeyBinding.Modifiers, and MouseBinding.MouseAction properties are bound to the corresponding properties on the SimpleDelegateCommand class.

<StackPanel Background="Transparent">
  <StackPanel.InputBindings>
    
    <KeyBinding Command="{Binding ChangeColorCommand}"
                CommandParameter="{Binding ElementName=colorPicker, Path=SelectedItem}"
                Key="{Binding ChangeColorCommand.GestureKey}"
                Modifiers="{Binding ChangeColorCommand.GestureModifier}"/>

    <MouseBinding Command="{Binding ChangeColorCommand}"
                  CommandParameter="{Binding ElementName=colorPicker, Path=SelectedItem}"
                  MouseAction="{Binding ChangeColorCommand.MouseGesture}"/>
  
  </StackPanel.InputBindings>
  
  <Button Content="Change Color" 
          Command="{Binding ChangeColorCommand}" 
          CommandParameter="{Binding ElementName=colorPicker, Path=SelectedItem}">
  </Button>

  <ListBox Name="colorPicker"
           Background="Transparent"
           xmlns:sys="clr-namespace:System;assembly=mscorlib">
    <sys:String>Red</sys:String>
    <sys:String>Green</sys:String>
    <sys:String>Blue</sys:String>
    <sys:String>Yellow</sys:String>
    <sys:String>Orange</sys:String>
    <sys:String>Purple</sys:String>
  </ListBox>
</StackPanel>

注釈

ユーザー入力がをInputBinding作成することによってコマンドを呼び出すように指定できます。You can specify that user input invokes a command by creating a InputBinding. ユーザーが指定された入力ICommandを実行すると、 Commandプロパティに設定されたが実行されます。When the user performs the specified input, the ICommand that is set to the Command property is executed.

、、およびInputBinding CommandParameter Commandの各プロパティでバインディングを作成することによって、がオブジェクトで定義されているコマンドを呼び出すように指定できます。CommandTargetYou can specify that the InputBinding invokes a command that is defined on an object by creating a binding on the Command, CommandParameter, and CommandTarget properties. これにより、カスタムコマンドを定義し、ユーザー入力に関連付けることができます。This enables you to define a custom command and associate it with user input. 詳細については、「例」の2番目の例を参照してください。For more information, see the second example in the Examples section.

は、にをRegisterClassInputBinding CommandManager登録することによって、特定のオブジェクトまたはクラスレベルで定義できます。InputBindingAn InputBinding can be defined on a specific object or at the class level by registering a RegisterClassInputBinding with the CommandManager.

クラスInputBinding自体は、パブリックのパラメーターなしのコンストラクターを公開しないため、XAML の使用をサポートしていません (パラメーターなしのコンストラクターは存在しますが、保護されています)。The InputBinding class itself does not support XAML usage because it does not expose a public parameterless constructor (there is a parameterless constructor, but it is protected). ただし、派生クラスはパブリックコンストラクターを公開できるため、からInputBinding継承される派生クラスのプロパティを XAML 使用法で設定できます。However, derived classes can expose a public constructor and therefore can set properties on the derived class that are inherited from InputBinding with a XAML usage. Xaml でInputBindingインスタンス化でき、xaml でプロパティを設定できる2つの既存の派生KeyBindingクラスMouseBindingは、とです。Two existing InputBinding-derived classes that can be instantiated in XAML and can set properties in XAML are KeyBinding and MouseBinding. XAML で設定さWPFWPFれ、値がプロパティでUIElement.InputBindingsあるために1つInputBinding以上のオブジェクトを受け取る、プログラミングの一般的なプロパティ。The typical property in WPFWPF programming that is set in XAML and takes one or more InputBinding objects as values is the UIElement.InputBindings property.

XAML オブジェクト要素の使用方法XAML Object Element Usage

<inputBindingDerivedClass…/><inputBindingDerivedClass…/>

XAML 値XAML Values

inputBindingDerivedClass
KeyBinding InputBindingMouseBindingなどのオブジェクト要素構文をサポートするの派生クラス。A derived class of InputBinding that supports object element syntax, such as KeyBinding or MouseBinding. 「解説」を参照してください。See Remarks.

コンストラクター

InputBinding() InputBinding() InputBinding() InputBinding()

InputBinding から派生したクラスの基本の初期化を行います。Provides base initialization for classes derived from InputBinding.

InputBinding(ICommand, InputGesture) InputBinding(ICommand, InputGesture) InputBinding(ICommand, InputGesture) InputBinding(ICommand, InputGesture)

コマンドおよび入力ジェスチャを指定して、InputBinding クラスの新しいインスタンスを初期化します。Initializes a new instance of the InputBinding class with the specified command and input gesture.

フィールド

CommandParameterProperty CommandParameterProperty CommandParameterProperty CommandParameterProperty

CommandParameter 依存関係プロパティを識別します。Identifies the CommandParameter dependency property.

CommandProperty CommandProperty CommandProperty CommandProperty

Command 依存関係プロパティを識別します。Identifies the Command dependency property.

CommandTargetProperty CommandTargetProperty CommandTargetProperty CommandTargetProperty

CommandTarget 依存関係プロパティを識別します。Identifies the CommandTarget dependency property.

プロパティ

Command Command Command Command

この入力バインドに関連付けられる ICommand を取得または設定します。Gets or sets the ICommand associated with this input binding.

CommandParameter CommandParameter CommandParameter CommandParameter

特定のコマンドのコマンド固有のデータを取得または設定します。Gets or sets the command-specific data for a particular command.

CommandTarget CommandTarget CommandTarget CommandTarget

コマンドの対象要素を取得または設定します。Gets or sets the target element of the command.

DependencyObjectType DependencyObjectType DependencyObjectType DependencyObjectType

このインスタンスの CLRCLR 型をラップする DependencyObjectType を取得します。Gets the DependencyObjectType that wraps the CLRCLR type of this instance.

(Inherited from DependencyObject)
Dispatcher Dispatcher Dispatcher Dispatcher

この Dispatcher が関連付けられている DispatcherObject を取得します。Gets the Dispatcher this DispatcherObject is associated with.

(Inherited from DispatcherObject)
Gesture Gesture Gesture Gesture

この入力バインドに関連付けられる InputGesture を取得または設定します。Gets or sets the InputGesture associated with this input binding.

IsSealed IsSealed IsSealed IsSealed

このインスタンスが現在シールされている (読み取り専用である) かどうかを示す値を取得します。Gets a value that indicates whether this instance is currently sealed (read-only).

(Inherited from DependencyObject)

メソッド

CheckAccess() CheckAccess() CheckAccess() CheckAccess()

呼び出し元のスレッドがこの DispatcherObject にアクセスできるかどうかを確認します。Determines whether the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)
ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

プロパティのローカル値をクリアします。Clears the local value of a property. クリアするプロパティは DependencyProperty 識別子で指定されます。The property to be cleared is specified by a DependencyProperty identifier.

(Inherited from DependencyObject)
ClearValue(DependencyPropertyKey) ClearValue(DependencyPropertyKey) ClearValue(DependencyPropertyKey) ClearValue(DependencyPropertyKey)

読み取り専用プロパティのローカル値を消去します。Clears the local value of a read-only property. 消去するプロパティは、DependencyPropertyKey で指定します。The property to be cleared is specified by a DependencyPropertyKey.

(Inherited from DependencyObject)
CloneCore(Freezable) CloneCore(Freezable) CloneCore(Freezable) CloneCore(Freezable)

指定されたオブジェクトのプロパティの基本 (アニメーション化されていない) 値をコピーします。Copies the base (non-animated) values of the properties of the specified object.

CloneCurrentValueCore(Freezable) CloneCurrentValueCore(Freezable) CloneCurrentValueCore(Freezable) CloneCurrentValueCore(Freezable)

指定されたオブジェクトのプロパティの現在の値をコピーします。Copies the current values of the properties of the specified object.

CoerceValue(DependencyProperty) CoerceValue(DependencyProperty) CoerceValue(DependencyProperty) CoerceValue(DependencyProperty)

指定した依存関係プロパティの値を強制します。Coerces the value of the specified dependency property. これは、呼び出し元の DependencyObject の依存関係プロパティのプロパティ メタデータで指定されている CoerceValueCallback 関数を呼び出すことによって実現されます。This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.

(Inherited from DependencyObject)
CreateInstanceCore() CreateInstanceCore() CreateInstanceCore() CreateInstanceCore()

InputBinding のインスタンスを作成します。Creates an instance of an InputBinding.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定した DependencyObject が現在の DependencyObject と等しいかどうかを判断します。Determines whether a provided DependencyObject is equivalent to the current DependencyObject.

(Inherited from DependencyObject)
GetAsFrozenCore(Freezable) GetAsFrozenCore(Freezable) GetAsFrozenCore(Freezable) GetAsFrozenCore(Freezable)

基本プロパティ値 (アニメーション化されていない値) を使用して、このインスタンスを、指定した Freezable の固定された複製にします。Makes the instance a frozen clone of the specified Freezable by using base (non-animated) property values.

GetCurrentValueAsFrozenCore(Freezable) GetCurrentValueAsFrozenCore(Freezable) GetCurrentValueAsFrozenCore(Freezable) GetCurrentValueAsFrozenCore(Freezable)

現在のインスタンスを、指定した Freezable の固定された複製にします。Makes the current instance a frozen clone of the specified Freezable. オブジェクトに、アニメーション化された依存関係プロパティが存在する場合、現在アニメーション化されている値がコピーされます。If the object has animated dependency properties, their current animated values are copied.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

この DependencyObject のハッシュ コードを取得します。Gets a hash code for this DependencyObject.

(Inherited from DependencyObject)
GetLocalValueEnumerator() GetLocalValueEnumerator() GetLocalValueEnumerator() GetLocalValueEnumerator()

どの依存関係プロパティがこの DependencyObject 上にローカルに設定された値を持つかを確認するための、専用の列挙子を作成します。Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.

(Inherited from DependencyObject)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

DependencyObject のこのインスタンスにある依存関係プロパティの現在の有効値を返します。Returns the current effective value of a dependency property on this instance of a DependencyObject.

(Inherited from DependencyObject)
InvalidateProperty(DependencyProperty) InvalidateProperty(DependencyProperty) InvalidateProperty(DependencyProperty) InvalidateProperty(DependencyProperty)

指定した依存関係プロパティの有効値を再評価します。Re-evaluates the effective value for the specified dependency property

(Inherited from DependencyObject)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
OnPropertyChanged(DependencyPropertyChangedEventArgs) OnPropertyChanged(DependencyPropertyChangedEventArgs) OnPropertyChanged(DependencyPropertyChangedEventArgs) OnPropertyChanged(DependencyPropertyChangedEventArgs)

この DependencyObject の依存関係プロパティの有効値が更新された場合に必ず呼び出されます。Invoked whenever the effective value of any dependency property on this DependencyObject has been updated. 変更が発生した特定の依存関係プロパティがイベント データで報告されます。The specific dependency property that changed is reported in the event data.

(Inherited from DependencyObject)
ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

ローカルの依存関係プロパティの値を返します (存在する場合)。Returns the local value of a dependency property, if it exists.

(Inherited from DependencyObject)
SetCurrentValue(DependencyProperty, Object) SetCurrentValue(DependencyProperty, Object) SetCurrentValue(DependencyProperty, Object) SetCurrentValue(DependencyProperty, Object)

依存関係プロパティ値のソースを変更せずにその値を設定します。Sets the value of a dependency property without changing its value source.

(Inherited from DependencyObject)
SetValue(DependencyProperty, Object) SetValue(DependencyProperty, Object) SetValue(DependencyProperty, Object) SetValue(DependencyProperty, Object)

依存関係プロパティ識別子を指定して、該当する依存関係プロパティのローカル値を設定します。Sets the local value of a dependency property, specified by its dependency property identifier.

(Inherited from DependencyObject)
SetValue(DependencyPropertyKey, Object) SetValue(DependencyPropertyKey, Object) SetValue(DependencyPropertyKey, Object) SetValue(DependencyPropertyKey, Object)

依存関係プロパティの DependencyPropertyKey 識別子で指定した読み取り専用の依存関係プロパティのローカル値を設定します。Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.

(Inherited from DependencyObject)
ShouldSerializeProperty(DependencyProperty) ShouldSerializeProperty(DependencyProperty) ShouldSerializeProperty(DependencyProperty) ShouldSerializeProperty(DependencyProperty)

シリアル化プロセスが、指定された依存関係プロパティの値をシリアル化する必要があるかどうかを示す値を返します。Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.

(Inherited from DependencyObject)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)
VerifyAccess() VerifyAccess() VerifyAccess() VerifyAccess()

呼び出し元のスレッドがこの DispatcherObject にアクセスできるように強制します。Enforces that the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)

適用対象

こちらもご覧ください