InputBinding 类

定义

命名空间:

System.Windows.Input

程序集:

PresentationCore.dll

表示 InputGesture 和命令之间的绑定。 此命令可能是 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

继承

Object

DispatcherObject

DependencyObject

Freezable

InputBinding

派生

System.Windows.Input.KeyBinding

System.Windows.Input.MouseBinding

实现

ICommandSource

示例

以下示例演示如何使用 KeyBinding 将 绑定到 KeyGestureOpen 命令。 执行关键手势时，将调用 Open 命令。

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

以下示例演示如何将自定义命令绑定到 InputBinding 对象。 这些示例创建一个应用程序，使用户能够通过执行以下操作之一来更改背景色：

• 单击按钮。

• 按 Ctrl+C。

• 右键单击 StackPanel) 外的 ListBox (。

第一个示例创建一个名为 的 SimpleDelegateCommand类。 此类接受委托，以便创建命令的对象可以定义执行命令时发生的操作。 SimpleDelegateCommand 还定义指定调用命令的键和鼠标输入的属性。 GestureKey 并 GestureModifier 指定键盘输入; MouseGesture 指定鼠标输入。

 // 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。 该示例还定义在调用 命令并设置 GestureKey、 GestureModifier和 MouseGesture 属性时执行的方法。 应用程序会在程序开始时调用 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

最后，以下示例创建用户界面。 该示例将 和 MouseBinding 添加到KeyBindingStackPanel包含 Button 和 的 ListBox。 当用户选择 中的 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 。

可以通过在 、 CommandParameter和 CommandTarget 属性上创建绑定Command来InputBinding指定 调用对 对象定义的命令。 这使你可以定义自定义命令并将其与用户输入相关联。 有关详细信息，请参阅示例部分中的第二个示例。

InputBinding可以在特定对象上或通过向 注册RegisterClassInputBindingCommandManager在类级别定义 。

类 InputBinding 本身不支持 XAML 用法，因为它不公开公共无参数构造函数 (无参数构造函数，但它) 受保护。 但是，派生类可以公开公共构造函数，因此可以在使用 XAML 用法继承的 InputBinding 派生类上设置属性。 可以在 XAML 中实例化并且可以在 XAML 中设置属性的两个现有 InputBinding派生类是 KeyBinding 和 MouseBinding。 WPF 编程中在 XAML 中设置并采用一个或多个 InputBinding 对象作为值的典型属性是 UIElement.InputBindings 属性。

XAML 对象元素用法

<inputBindingDerivedClass.../>

XAML 值

inputBindingDerivedClass
的派生类 InputBinding ，它支持对象元素语法，例如 KeyBinding 或 MouseBinding。 请参阅“备注”。

构造函数

InputBinding()	提供从 InputBinding 派生的类的基初始化。
InputBinding(ICommand, InputGesture)	用指定的命令和输入笔势初始化 InputBinding 类的新实例。

字段

CommandParameterProperty	标识 CommandParameter 依赖项属性。
CommandProperty	标识 Command 依赖项属性。
CommandTargetProperty	标识 CommandTarget 依赖项属性。

属性

CanFreeze	获取一个值，该值指示是否可将对象变为不可修改。 (继承自 Freezable)
Command	获取或设置与此输入绑定关联的 ICommand。
CommandParameter	获取或设置特定命令的命令特定数据。
CommandTarget	获取或设置命令的目标元素。
DependencyObjectType	DependencyObjectType获取包装此实例的 CLR 类型的 。 (继承自 DependencyObject)
Dispatcher	获取与此 Dispatcher 关联的 DispatcherObject。 (继承自 DispatcherObject)
Gesture	获取或设置与此输入绑定关联的 InputGesture。
IsFrozen	获取一个值，该值指示对象当前是否可修改。 (继承自 Freezable)
IsSealed	获取一个值，该值指示此实例当前是否为密封的（只读）。 (继承自 DependencyObject)

方法

CheckAccess()	确定调用线程是否可以访问此 DispatcherObject。 (继承自 DispatcherObject)
ClearValue(DependencyProperty)	清除属性的本地值。 要清除的属性由 DependencyProperty 标识符指定。 (继承自 DependencyObject)
ClearValue(DependencyPropertyKey)	清除只读属性的本地值。 要清除的属性由 DependencyPropertyKey 指定。 (继承自 DependencyObject)
Clone()	创建 Freezable 的可修改克隆，以制作该对象值的深层副本。 在复制此对象的依赖属性时，此方法会复制表达式（可能不再解析），但不复制动画或其当前值。 (继承自 Freezable)
CloneCore(Freezable)	复制指定对象的属性的基（未经过动画处理的）值。
CloneCurrentValue()	使用 Freezable 的当前值创建其可修改复本（深层副本）。 (继承自 Freezable)
CloneCurrentValueCore(Freezable)	复制指定对象的属性的当前值。
CoerceValue(DependencyProperty)	对指定依赖属性的值进行强制。 通过对调用方 DependencyObject 上存在的依赖属性的属性元数据中所指定的任何 CoerceValueCallback 函数进行调用来完成此操作。 (继承自 DependencyObject)
CreateInstance()	初始化 Freezable 类的新实例。 (继承自 Freezable)
CreateInstanceCore()	创建 InputBinding 的实例。
Equals(Object)	确定提供的 DependencyObject 是否等效于当前 DependencyObject。 (继承自 DependencyObject)
Freeze()	使当前对象不可修改，并且将其 IsFrozen 属性设置为 true。 (继承自 Freezable)
FreezeCore(Boolean)	使 Freezable 对象变为不可修改或测试是否可将其变为不可修改。 (继承自 Freezable)
GetAsFrozen()	使用基（未经过动画处理的）属性值创建 Freezable 的冻结副本。 由于副本已冻结，因此将通过引用复制任何冻结的子对象。 (继承自 Freezable)
GetAsFrozenCore(Freezable)	使用基（未经过动画处理的）属性值使该实例成为指定的 Freezable 的冻结复本。
GetCurrentValueAsFrozen()	使用当前属性值创建 Freezable 的冻结副本。 由于副本已冻结，因此将通过引用复制任何冻结的子对象。 (继承自 Freezable)
GetCurrentValueAsFrozenCore(Freezable)	使当前实例成为指定 Freezable 的冻结克隆。 如果对象具有动画依赖属性，则复制其当前的动画值。
GetHashCode()	获取此 DependencyObject 的哈希代码。 (继承自 DependencyObject)
GetLocalValueEnumerator()	创建一个专用的枚举数，用于确定哪些依赖项属性在此 DependencyObject 上具有以本地方式设置的值。 (继承自 DependencyObject)
GetType()	获取当前实例的 Type。 (继承自 Object)
GetValue(DependencyProperty)	对 DependencyObject 的此实例返回依赖属性的当前有效值。 (继承自 DependencyObject)
InvalidateProperty(DependencyProperty)	重新评估指定依赖属性的有效值。 (继承自 DependencyObject)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
OnChanged()	修改当前 Freezable 对象时调用。 (继承自 Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject)	确保为刚刚设置的 DependencyObjectType 数据成员建立适当的上下文指针。 (继承自 Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)	此成员支持Windows Presentation Foundation (WPF) 基础结构，不应直接从代码使用。 (继承自 Freezable)
OnPropertyChanged(DependencyPropertyChangedEventArgs)	重写 OnPropertyChanged(DependencyPropertyChangedEventArgs) 的 DependencyObject 实现，以同时调用任何响应类型 Freezable 不断变化的依赖属性的 Changed 处理程序。 (继承自 Freezable)
ReadLocalValue(DependencyProperty)	如果存在，则返回依赖属性的本地值。 (继承自 DependencyObject)
ReadPreamble()	确保正在从有效的线程访问 Freezable。 Freezable 的继承者必须在任何 API 一开始读取不属于依赖项对象的数据成员时调用此方法。 (继承自 Freezable)
SetCurrentValue(DependencyProperty, Object)	设置依赖属性的值而不更改其值源。 (继承自 DependencyObject)
SetValue(DependencyProperty, Object)	设置依赖属性的本地值，该值由其依赖属性标识符指定。 (继承自 DependencyObject)
SetValue(DependencyPropertyKey, Object)	设置一个只读依赖属性的本地值，该值由依赖属性的 DependencyPropertyKey 标识符指定。 (继承自 DependencyObject)
ShouldSerializeProperty(DependencyProperty)	返回一个值，该值指示序列化进程是否应序列化所提供的依赖属性的值。 (继承自 DependencyObject)
ToString()	返回表示当前对象的字符串。 (继承自 Object)
VerifyAccess()	强制调用线程具有此 DispatcherObject 的访问权限。 (继承自 DispatcherObject)
WritePostscript()	引发 Freezable 的 Changed 事件并调用其 OnChanged() 方法。 从 Freezable 派生的类应在修改的类成员不存储为依赖属性的任何 API 的末尾调用此方法。 (继承自 Freezable)
WritePreamble()	验证 Freezable 是否未被冻结，并且是否正在从有效的线程上下文中访问它。 Freezable 的继承项应当在任何 API 一开始写入不属于依赖项属性的数据成员时调用此方法。 (继承自 Freezable)

事件

Changed

在修改 Freezable 或其包含的对象时发生。 (继承自 Freezable)

另请参阅

• InputBindings
• CommandBinding