InputBinding InputBinding InputBinding InputBinding Class

Definition

Stellt eine Bindung zwischen einer InputGesture und einen Befehl.Represents a binding between an InputGesture and a command. Der Befehl ist potenziell ein 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
Vererbung
Abgeleitet
Implementiert

Beispiele

Das folgende Beispiel zeigt, wie Sie mit einer KeyBinding binden ein KeyGesture auf die Open Befehl.The following example shows how to use a KeyBinding to bind a KeyGesture to the Open command. Wenn die Tastenkombination ausgeführt wird, wird der Befehl zum Öffnen aufgerufen.When the key gesture is performed, the Open command is invoked.

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

Die folgenden Beispiele zeigen, wie Sie einen benutzerdefinierten Befehl zu binden InputBinding Objekte.The following examples show how to bind a custom command to InputBinding objects. Diese Beispiele erstellen Sie eine Anwendung, die dem Benutzer ermöglicht, die die Hintergrundfarbe ändern, indem Sie eine der folgenden Aktionen ausführen:These examples create an application that enables the user to change the background color by performing one of the following actions:

  • Klicken Sie auf eine Schaltfläche.Clicking a button.

  • STRG + C drücken.Pressing CTRL+C.

  • Mit der rechten Maustaste ein StackPanel (außerhalb der ListBox).Right-clicking a StackPanel (outside the ListBox).

Im erste Beispiel wird eine Klasse namens SimpleDelegateCommand.The first example creates a class named SimpleDelegateCommand. Diese Klasse akzeptieren einen Delegaten, sodass das Objekt, das den Befehl erstellt die Aktion definieren kann, die auftritt, wenn der Befehl ausgeführt wird.This class accepts a delegate so that the object creating the command can define the action that occurs when the command executes. SimpleDelegateCommand definiert außerdem Eigenschaften, die angeben, welche Taste, und bewegen Sie den Mauszeiger Eingabe Ruft den Befehl.SimpleDelegateCommand also defines properties that specify what key and mouse input invokes the command. GestureKey und GestureModifier Geben Sie die Tastatureingaben; MouseGesture gibt an, die Mauseingabe.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

Das folgende Beispiel erstellt und initialisiert die ColorChangeCommand, d.h. eine SimpleDelegateCommand.The following example creates and initializes the ColorChangeCommand, which is a SimpleDelegateCommand. Im Beispiel definiert auch die Methode, die ausgeführt wird, wenn der Befehl aufgerufen wird, und legt die GestureKey, GestureModifier, und MouseGesture Eigenschaften.The example also defines the method that executes when the command is invoked and sets the GestureKey, GestureModifier, and MouseGesture properties. Eine Anwendung aufrufen würde die InitializeCommand Methode, wenn das Programm beginnt, z. B. in den Konstruktor des eine 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

Im folgende Beispiel wird schließlich die Benutzeroberfläche erstellt.Finally, the following example creates the user interface. Im Beispiel wird eine KeyBinding und ein MouseBinding auf eine StackPanel , enthält eine Button und ListBox.The example adds a KeyBinding and a MouseBinding to a StackPanel that contains a Button and a ListBox. Wenn der Benutzer wählt ein Element in der ListBox, er oder sie können die Farbe des Hintergrunds ändern, mit der ausgewählten Farbe.When the user selects an item in the ListBox, he or she can change the color of the background to the selected color. In jedem Fall die CommandParameter Eigenschaft gebunden ist, um das ausgewählte Element in der ListBox, und die Command Eigenschaft gebunden ist die 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. Die KeyBinding.Key, KeyBinding.Modifiers, und MouseBinding.MouseAction Eigenschaften in den entsprechenden Eigenschaften gebunden sind, auf die SimpleDelegateCommand Klasse.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>

Hinweise

Sie können angeben, dass die Eingabe des Benutzers einen Befehl aufruft, durch das Erstellen einer InputBinding.You can specify that user input invokes a command by creating a InputBinding. Wenn der Benutzer die angegebene Eingabe ausführt der ICommand , festgelegt ist, um die Command Eigenschaft ausgeführt wird.When the user performs the specified input, the ICommand that is set to the Command property is executed.

Sie können angeben, die InputBinding Ruft einen Befehl aus, die für ein Objekt definiert ist, durch das Erstellen einer Bindung auf den Command, CommandParameter, und CommandTarget Eigenschaften.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. Dadurch können Sie definieren einen benutzerdefinierten Befehl und Benutzereingaben zuordnen.This enables you to define a custom command and associate it with user input. Weitere Informationen finden Sie in das zweite Beispiel im Abschnitt "Beispiele".For more information, see the second example in the Examples section.

Ein InputBinding kann auf ein bestimmtes Objekt oder auf Klassenebene definiert werden, durch die Registrierung einer RegisterClassInputBinding mit der CommandManager.An InputBinding can be defined on a specific object or at the class level by registering a RegisterClassInputBinding with the CommandManager.

Die InputBinding Klasse selbst unterstützt keine XAML-Verwendung, weil sie keinen öffentlichen Standardkonstruktor verfügbar macht (es ist ein Standardkonstruktor, aber es geschützt ist).The InputBinding class itself does not support XAML usage because it does not expose a public default constructor (there is a default constructor, but it is protected). Jedoch abgeleitete Klassen einen öffentlichen Konstruktor verfügbar machen, und aus diesem Grund können Eigenschaften festlegen, für die abgeleitete Klasse, die von übernommenen InputBinding mit einer XAML-Verwendung.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. Zwei vorhandene InputBinding-abgeleitete Klassen, die in XAML instanziiert werden und die Eigenschaften in XAML festlegen können, sind KeyBinding und MouseBinding.Two existing InputBinding-derived classes that can be instantiated in XAML and can set properties in XAML are KeyBinding and MouseBinding. Die Eigenschaft in der WPFWPF programmieren, legen Sie im XAML und übernimmt eine oder mehrere InputBinding Objekte als Werte der UIElement.InputBindings Eigenschaft.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.

Verwendung von XAML-ObjektelementenXAML Object Element Usage

<inputBindingDerivedClass…/><inputBindingDerivedClass…/>

XAML-WerteXAML Values

inputBindingDerivedClass
Eine abgeleitete Klasse von InputBinding , unterstützt die Objektelementsyntax, z. B. KeyBinding oder MouseBinding.A derived class of InputBinding that supports object element syntax, such as KeyBinding or MouseBinding. Siehe Hinweise.See Remarks.

Konstruktoren

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

Stellt die basisinitialisierung bereit, für die abgeleitete Klassen von InputBinding.Provides base initialization for classes derived from InputBinding.

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

Initialisiert eine neue Instanz der dem InputBinding Klasse mit dem angegebenen Befehl und der eingabestiftbewegung.Initializes a new instance of the InputBinding class with the specified command and input gesture.

Felder

CommandParameterProperty CommandParameterProperty CommandParameterProperty CommandParameterProperty

Bezeichnet die CommandParameter-Abhängigkeitseigenschaft.Identifies the CommandParameter dependency property.

CommandProperty CommandProperty CommandProperty CommandProperty

Bezeichnet die Command-Abhängigkeitseigenschaft.Identifies the Command dependency property.

CommandTargetProperty CommandTargetProperty CommandTargetProperty CommandTargetProperty

Bezeichnet die CommandTarget-Abhängigkeitseigenschaft.Identifies the CommandTarget dependency property.

Eigenschaften

Command Command Command Command

Ruft die dieser Eingabebindung zugeordnete ICommand-Klasse ab oder legt diese fest.Gets or sets the ICommand associated with this input binding.

CommandParameter CommandParameter CommandParameter CommandParameter

Übernimmt oder bestimmt die befehlsspezifischen Daten für einen bestimmten Befehl.Gets or sets the command-specific data for a particular command.

CommandTarget CommandTarget CommandTarget CommandTarget

Übernimmt oder bestimmt das Zielelement des Befehls.Gets or sets the target element of the command.

DependencyObjectType DependencyObjectType DependencyObjectType DependencyObjectType

Ruft den DependencyObjectType ab, der den CLRCLR-Typ dieser Instanz umschließt.Gets the DependencyObjectType that wraps the CLRCLR type of this instance.

(Inherited from DependencyObject)
Dispatcher Dispatcher Dispatcher Dispatcher

Ruft die Dispatcher dies DispatcherObject zugeordnet ist.Gets the Dispatcher this DispatcherObject is associated with.

(Inherited from DispatcherObject)
Gesture Gesture Gesture Gesture

Ruft die dieser Eingabebindung zugeordnete InputGesture-Klasse ab oder legt diese fest.Gets or sets the InputGesture associated with this input binding.

IsSealed IsSealed IsSealed IsSealed

Ruft einen Wert ab, der angibt, ob diese Instanz derzeit versiegelt (schreibgeschützt) ist.Gets a value that indicates whether this instance is currently sealed (read-only).

(Inherited from DependencyObject)

Methoden

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

Bestimmt, ob der aufrufende Thread den Zugriff auf diese kann DispatcherObject.Determines whether the calling thread has access to this DispatcherObject.

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

Löscht den lokalen Wert einer Eigenschaft.Clears the local value of a property. Die Eigenschaft, deren Wert gelöscht werden soll, wird durch einen DependencyProperty-Bezeichner angegeben.The property to be cleared is specified by a DependencyProperty identifier.

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

Löscht den lokalen Wert einer schreibgeschützten Eigenschaft.Clears the local value of a read-only property. Die Eigenschaft, deren Wert gelöscht werden soll, wird durch einen DependencyPropertyKey angegeben.The property to be cleared is specified by a DependencyPropertyKey.

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

Kopiert die Basiswerte (nicht animiert) die Eigenschaften des angegebenen Objekts.Copies the base (non-animated) values of the properties of the specified object.

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

Kopiert die aktuellen Werte der Eigenschaften des angegebenen Objekts.Copies the current values of the properties of the specified object.

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

Erzwingt den Wert der angegebenen Abhängigkeitseigenschaft.Coerces the value of the specified dependency property. Dies erfolgt durch den Aufruf einer beliebigen CoerceValueCallback-Funktion, die in den Metadaten für die Abhängigkeitseigenschaft angegeben ist, während sie beim aufrufenden DependencyObject beendet wird.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()

Erstellt eine Instanz einer InputBinding.Creates an instance of an InputBinding.

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

Bestimmt, ob ein angegebenes DependencyObject dem aktuellen DependencyObject entspricht.Determines whether a provided DependencyObject is equivalent to the current DependencyObject.

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

Definiert die Instanz als fixierten Klon des angegebenen Freezable mithilfe von Basiseigenschaftswerten (nicht animiert).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)

Macht diese aktuelle Instanz zu einem fixierten Klon des angegebenen Freezable-Objekts.Makes the current instance a frozen clone of the specified Freezable. Wenn das Objekt über animierte Abhängigkeitseigenschaften verfügt, werden die aktuellen animierten Werte kopiert.If the object has animated dependency properties, their current animated values are copied.

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

Ruft einen Hashcode für diesen DependencyObject ab.Gets a hash code for this DependencyObject.

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

Erstellt einen spezialisierten Enumerator, mit dem bestimmt wird, welche Abhängigkeitseigenschaften dieses DependencyObject über lokal festgelegte Werte verfügen.Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.

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

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

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

Gibt den aktuellen effektiven Wert einer Abhängigkeitseigenschaft für diese Instanz eines DependencyObject zurück.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)

Berechnet den effektiven Wert für die angegebene Abhängigkeitseigenschaft neuRe-evaluates the effective value for the specified dependency property

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

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

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

Wird immer dann aufgerufen, wenn der effektive Wert einer Abhängigkeitseigenschaft für dieses DependencyObject aktualisiert wurde.Invoked whenever the effective value of any dependency property on this DependencyObject has been updated. Die spezifische Abhängigkeitseigenschaft, die sich geändert hat, wird in den Ereignisdaten angegeben.The specific dependency property that changed is reported in the event data.

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

Gibt, sofern vorhanden, den lokalen Wert einer Abhängigkeitseigenschaft zurück.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)

Legt den Wert einer Abhängigkeitseigenschaft fest, ohne die Wertquelle zu ändern.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)

Legt den lokalen Wert einer Abhängigkeitseigenschaft fest, die über ihren Bezeichner angegeben wird.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)

Legt den lokalen Wert einer schreibgeschützten Abhängigkeitseigenschaft fest, die durch den DependencyPropertyKey-Bezeichner der Abhängigkeitseigenschaft angegeben ist.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)

Gibt einen Wert zurück, der angibt, ob Serialisierungsprozesse den Wert der bereitgestellten Abhängigkeitseigenschaft serialisieren sollen.Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.

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

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

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

Erzwingt, dass der aufrufende Thread den Zugriff auf diese DispatcherObject.Enforces that the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)

Gilt für:

Siehe auch