InputBinding Класс

Определение

Представляет привязку между 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 для KeyGesture привязки Open к команде.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и. MouseGestureThe example also defines the method that executes when the command is invoked and sets the GestureKey, GestureModifier, and MouseGesture properties. Приложение вызовет InitializeCommand метод при запуске программы, например в конструкторе Window.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 и ListBox.The 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 свойство привязано к выбранному элементу ListBoxв, а Command свойство привязано к 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.Key SimpleDelegateCommand , KeyBinding.Modifiersи привязаныксоответствующимсвойствамклассаMouseBinding.MouseAction .The 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 что метод вызывает команду, определенную для объекта, создав привязку Commandдля свойств, CommandParameterи CommandTarget .You 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. Дополнительные сведения см. во втором примере в разделе "примеры".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. Два существующих InputBindingпроизводных класса, которые можно создать в XAML и могут задавать свойства в XAML, — KeyBinding это MouseBindingи.Two existing InputBinding-derived classes that can be instantiated in XAML and can set properties in XAML are KeyBinding and MouseBinding. Типичное свойство в WPFWPF программировании, заданное в XAML и принимающее один InputBinding или несколько UIElement.InputBindings объектов в качестве значений, является свойством.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.

Использование элемента объекта XAMLXAML Object Element Usage

<Инпутбиндингдериведкласс.../><inputBindingDerivedClass…/>

Значения XAMLXAML Values

inputBindingDerivedClass
Производный класс InputBinding , который поддерживает синтаксис элементов объекта, KeyBinding например или MouseBinding.A derived class of InputBinding that supports object element syntax, such as KeyBinding or MouseBinding. См. заметки.See Remarks.

Конструкторы

InputBinding()

Предоставляет базовую инициализацию для производных от InputBinding классов.Provides base initialization for classes derived from InputBinding.

InputBinding(ICommand, InputGesture)

Инициализирует новый экземпляр класса InputBinding с указанным именем команды и жестом ввода.Initializes a new instance of the InputBinding class with the specified command and input gesture.

Поля

CommandParameterProperty

Идентифицирует свойство зависимостей CommandParameter.Identifies the CommandParameter dependency property.

CommandProperty

Идентифицирует свойство зависимостей Command.Identifies the Command dependency property.

CommandTargetProperty

Идентифицирует свойство зависимостей CommandTarget.Identifies the CommandTarget dependency property.

Свойства

Command

Возвращает или задает объект ICommand, связанный с этой входной привязкой.Gets or sets the ICommand associated with this input binding.

CommandParameter

Получает или задает специфические для команды данные для конкретной команды.Gets or sets the command-specific data for a particular command.

CommandTarget

Получает или задает для команды целевой элемент.Gets or sets the target element of the command.

DependencyObjectType

Возвращает DependencyObjectType, который создает обертку для типа CLRCLR данного экземпляра.Gets the DependencyObjectType that wraps the CLRCLR type of this instance.

(Унаследовано от DependencyObject)
Dispatcher

Возвращает объект Dispatcher, с которым связан этот объект DispatcherObject.Gets the Dispatcher this DispatcherObject is associated with.

(Унаследовано от DispatcherObject)
Gesture

Возвращает или задает объект InputGesture, связанный с этой входной привязкой.Gets or sets the InputGesture associated with this input binding.

IsSealed

Получает значение, указывающее, является ли этот экземпляр в данный момент запечатанным (доступным только для чтения).Gets a value that indicates whether this instance is currently sealed (read-only).

(Унаследовано от DependencyObject)

Методы

CheckAccess()

Определяет, имеет ли вызывающий поток доступ к этому DispatcherObject.Determines whether the calling thread has access to this DispatcherObject.

(Унаследовано от DispatcherObject)
ClearValue(DependencyProperty)

Очищает локальное значение свойства.Clears the local value of a property. Очищаемое свойство задается идентификатором DependencyProperty.The property to be cleared is specified by a DependencyProperty identifier.

(Унаследовано от DependencyObject)
ClearValue(DependencyPropertyKey)

Очищает локальное значение свойства, доступного только для чтения.Clears the local value of a read-only property. Очищаемое свойство задается ключом DependencyPropertyKey.The property to be cleared is specified by a DependencyPropertyKey.

(Унаследовано от DependencyObject)
CloneCore(Freezable)

Копирует базовые (не анимационные) значения свойств заданного объекта.Copies the base (non-animated) values of the properties of the specified object.

CloneCurrentValueCore(Freezable)

Копирует текущие значения свойств заданного объекта.Copies the current values of the properties of the specified object.

CoerceValue(DependencyProperty)

Приводит значение указанного свойства зависимостей.Coerces the value of the specified dependency property. Это осуществляется путем вызова какой-либо функции CoerceValueCallback, указанной в метаданных свойства зависимостей, которое существует в вызывающем объекте DependencyObject.This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.

(Унаследовано от DependencyObject)
CreateInstanceCore()

Создает экземпляр класса InputBinding.Creates an instance of an InputBinding.

Equals(Object)

Определяет, является ли указанный DependencyObject эквивалентом текущего DependencyObject.Determines whether a provided DependencyObject is equivalent to the current DependencyObject.

(Унаследовано от DependencyObject)
GetAsFrozenCore(Freezable)

Создает экземпляр замороженной копии заданного объекта Freezable, используя базовые (не анимационные) значения свойства.Makes the instance a frozen clone of the specified Freezable by using base (non-animated) property values.

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()

Возвращает хэш-код для данного объекта DependencyObject.Gets a hash code for this DependencyObject.

(Унаследовано от DependencyObject)
GetLocalValueEnumerator()

Создает специализированный перечислитель для определения свойств зависимостей, которые локально установили значения для данного DependencyObject.Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.

(Унаследовано от DependencyObject)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
GetValue(DependencyProperty)

Возвращает текущее действующее значение свойства зависимостей в этом экземпляре DependencyObject.Returns the current effective value of a dependency property on this instance of a DependencyObject.

(Унаследовано от DependencyObject)
InvalidateProperty(DependencyProperty)

Повторно вычисляет действующее значение для указанного свойства зависимостей.Re-evaluates the effective value for the specified dependency property.

(Унаследовано от DependencyObject)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
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.

(Унаследовано от DependencyObject)
ReadLocalValue(DependencyProperty)

Возвращает локальное значение свойства зависимостей, если таковое существует.Returns the local value of a dependency property, if it exists.

(Унаследовано от DependencyObject)
SetCurrentValue(DependencyProperty, Object)

Задает значение свойства зависимостей, не меняя источник значения.Sets the value of a dependency property without changing its value source.

(Унаследовано от DependencyObject)
SetValue(DependencyProperty, Object)

Задает локальное значение свойства зависимостей, указанного идентификатором этого свойства.Sets the local value of a dependency property, specified by its dependency property identifier.

(Унаследовано от DependencyObject)
SetValue(DependencyPropertyKey, Object)

Задает локальное значение свойства зависимости только для чтения, определяемое идентификатором DependencyPropertyKey свойства зависимостей.Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.

(Унаследовано от DependencyObject)
ShouldSerializeProperty(DependencyProperty)

Возвращает значение, которое указывает, следует ли процессам сериализации выполнять сериализацию значения для предоставленного свойства зависимостей.Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.

(Унаследовано от DependencyObject)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)
VerifyAccess()

Обеспечивает наличие у вызывающего потока доступ к этому DispatcherObject.Enforces that the calling thread has access to this DispatcherObject.

(Унаследовано от DispatcherObject)

Применяется к

Дополнительно