InputBinding クラス

定義

public ref class InputBinding : System::Windows::DependencyObject, System::Windows::Input::ICommandSource

public ref class InputBinding : System::Windows::Freezable, System::Windows::Input::ICommandSource

public class InputBinding : System.Windows.DependencyObject, System.Windows.Input.ICommandSource

public class InputBinding : System.Windows.Freezable, System.Windows.Input.ICommandSource

type InputBinding = class
    inherit DependencyObject
    interface ICommandSource

type InputBinding = class
    inherit Freezable
    interface ICommandSource

Public Class InputBinding
Inherits DependencyObject
Implements ICommandSource

Public Class InputBinding
Inherits Freezable
Implements ICommandSource

継承

Object

DispatcherObject

DependencyObject

InputBinding

継承

Object

DispatcherObject

DependencyObject

Freezable

InputBinding

派生

System.Windows.Input.KeyBinding

System.Windows.Input.MouseBinding

実装

ICommandSource

例

次の例では、 を使用 KeyBinding して をコマンドにバインド KeyGesture する方法を Open 示します。 キー ジェスチャが実行されると、Open コマンドが呼び出されます。

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

次の例では、カスタム コマンドを オブジェクトにバインドする方法を InputBinding 示します。 次の例では、次のいずれかの操作を実行して、ユーザーが背景色を変更できるようにするアプリケーションを作成します。

• ボタンをクリックしています。

• Ctrl + C キーを押します。

• を右クリックします StackPanel (の ListBox外側)。

最初の例では、 という名前 SimpleDelegateCommandのクラスを作成します。 このクラスは、コマンドを作成するオブジェクトがコマンドの実行時に発生するアクションを定義できるように、デリゲートを受け入れます。 SimpleDelegateCommand また、コマンドを呼び出すキーとマウス入力を指定するプロパティも定義します。 GestureKeyキーボード入力MouseGestureを指定しますGestureModifier。マウス入力を指定します。

 // 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

次の例では、 である をColorChangeCommandSimpleDelegateCommand作成して初期化します。 この例では、コマンドが呼び出されたときに実行されるメソッドも定義し、および プロパティをGestureKeyGestureModifierMouseGesture設定します。 アプリケーションは、 の InitializeCommand コンストラクターなど、プログラムの開始時に メソッドを 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

最後に、次の例では、ユーザー インターフェイスを作成します。 この例では、 KeyBinding と をMouseBinding含む に StackPanel と をButtonListBox追加します。 ユーザーが で ListBox項目を選択すると、背景の色を選択した色に変更できます。 いずれの場合も、 CommandParameter プロパティは 内の ListBox選択した項目にバインドされ、 Command プロパティは に ColorChangeCommandバインドされます。 、KeyBinding.KeyKeyBinding.Modifiers、および MouseBinding.MouseAction プロパティは、 クラスの対応するプロパティにSimpleDelegateCommandバインドされます。

<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することで、ユーザー入力がコマンドを呼び出すように指定できます。 ユーザーが指定した入力を実行すると、 ICommand プロパティに Command 設定されている が実行されます。

オブジェクトInputBindingで定義されているコマンドを呼び出すように指定するには、 プロパティCommandParameter、、および CommandTarget プロパティにバインドをCommand作成します。 これにより、カスタム コマンドを定義し、ユーザー入力に関連付けることができます。 詳細については、「例」セクションの 2 番目の例を参照してください。

は InputBinding 、 を に登録 RegisterClassInputBinding することで、特定のオブジェクトまたはクラス レベルで CommandManager定義できます。

クラス自体は InputBinding 、パブリックパラメーターなしのコンストラクターを公開しないため、XAML の使用をサポートしていません (パラメーターなしのコンストラクターがありますが、保護されています)。 ただし、派生クラスはパブリック コンストラクターを公開できるため、XAML を使用して継承される InputBinding 派生クラスのプロパティを設定できます。 XAML でインスタンス化でき、XAML でプロパティを設定できる 2 つの既存InputBindingの派生クラスは と MouseBindingですKeyBinding。 XAML で設定され、値が プロパティとして 1 つ以上 InputBinding のオブジェクトを受け取る WPF プログラミングの UIElement.InputBindings 一般的なプロパティ。

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

< inputBindingDerivedClass.../>

XAML 値

inputBindingDerivedClass
や MouseBindingなどのKeyBindingオブジェクト要素構文InputBindingをサポートする の派生クラス。 「解説」を参照してください。

コンストラクター

フィールド

プロパティ

メソッド

イベント

適用対象

こちらもご覧ください

• InputBindings
• CommandBinding