InputBinding Classe

Definição

Namespace:

System.Windows.Input

Assembly:

PresentationCore.dll

Representa uma associação entre um InputGesture e um comando. O comando é potencialmente um 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

Herança

Object

DispatcherObject

DependencyObject

Freezable

InputBinding

Derivado

System.Windows.Input.KeyBinding

System.Windows.Input.MouseBinding

Implementações

ICommandSource

Exemplos

O exemplo a seguir mostra como usar um KeyBinding para associar um KeyGesture ao Open comando . Quando o gesto de chave é executado, o comando Abrir é invocado.

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

Os exemplos a seguir mostram como associar um comando personalizado a InputBinding objetos. Esses exemplos criam um aplicativo que permite que o usuário altere a cor da tela de fundo executando uma das seguintes ações:

• Clicando em um botão.

• Pressionando CTRL+C.

• Clicando com o botão direito do mouse em um StackPanel (fora do ListBox).

O primeiro exemplo cria uma classe chamada SimpleDelegateCommand. Essa classe aceita um delegado para que o objeto que cria o comando possa definir a ação que ocorre quando o comando é executado. SimpleDelegateCommand também define propriedades que especificam qual chave e entrada do mouse invoca o comando. GestureKey e especificar GestureModifier a entrada do teclado; MouseGesture especifica a entrada do mouse.

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

O exemplo a seguir cria e inicializa o ColorChangeCommand, que é um SimpleDelegateCommand. O exemplo também define o método que é executado quando o comando é invocado e define as GestureKeypropriedades , GestureModifiere MouseGesture . Um aplicativo chamaria o InitializeCommand método quando o programa iniciasse, como no construtor de um 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

Por fim, o exemplo a seguir cria a interface do usuário. O exemplo adiciona um KeyBinding e um MouseBinding a um StackPanel que contém um Button e um ListBox. Quando o usuário seleciona um item no ListBox, ele pode alterar a cor da tela de fundo para a cor selecionada. Em cada caso, a CommandParameter propriedade é associada ao item selecionado no ListBoxe a Command propriedade está associada ao ColorChangeCommand. As KeyBinding.Keypropriedades , KeyBinding.Modifierse MouseBinding.MouseAction são associadas às propriedades correspondentes na SimpleDelegateCommand classe .

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

Comentários

Você pode especificar que a entrada do usuário invoca um comando criando um InputBinding. Quando o usuário executa a entrada especificada, o ICommand que é definido como a Command propriedade é executado.

Você pode especificar que o InputBinding invoca um comando definido em um objeto criando uma associação nas Commandpropriedades , CommandParametere CommandTarget . Isso permite definir um comando personalizado e associá-lo à entrada do usuário. Para obter mais informações, consulte o segundo exemplo na seção Exemplos.

Um InputBinding pode ser definido em um objeto específico ou no nível da classe registrando um RegisterClassInputBinding com o CommandManager.

A InputBinding classe em si não dá suporte ao uso de XAML porque não expõe um construtor público sem parâmetros (há um construtor sem parâmetros, mas está protegido). No entanto, classes derivadas podem expor um construtor público e, portanto, podem definir propriedades na classe derivada que são herdadas de InputBinding com um uso de XAML. Duas classes derivadas de existentes InputBindingque podem ser instanciadas em XAML e podem definir propriedades em XAML são KeyBinding e MouseBinding. A propriedade típica na programação do WPF que é definida em XAML e usa um ou mais InputBinding objetos como valores é a UIElement.InputBindings propriedade .

Uso de elemento Object do XAML

< inputBindingDerivedClass.../>

Valores XAML

inputBindingDerivedClass
Uma classe derivada de InputBinding que dá suporte à sintaxe de elemento de objeto, como KeyBinding ou MouseBinding. Consulte Observações.

Construtores

InputBinding()	Fornece a inicialização de base para classes derivadas de InputBinding.
InputBinding(ICommand, InputGesture)	Inicializa uma nova instância da classe InputBinding com o comando e o gesto de entrada especificados.

Campos

CommandParameterProperty	Identifica a propriedade de dependência CommandParameter.
CommandProperty	Identifica a propriedade de dependência Command.
CommandTargetProperty	Identifica a propriedade de dependência CommandTarget.

Propriedades

CanFreeze	Obtém um valor que indica se o objeto pode se tornar não modificável. (Herdado de Freezable)
Command	Obtém ou define o ICommand associado a esta associação de entrada.
CommandParameter	Obtém ou define os dados específicos do comando para um determinado comando.
CommandTarget	Obtém ou define o elemento de destino do comando.
DependencyObjectType	Obtém o DependencyObjectType que encapsula o tipo CLR dessa instância. (Herdado de DependencyObject)
Dispatcher	Obtém o Dispatcher ao qual este DispatcherObject está associado. (Herdado de DispatcherObject)
Gesture	Obtém ou define o InputGesture associado a esta associação de entrada.
IsFrozen	Obtém um valor que indica se o objeto pode ser modificado no momento. (Herdado de Freezable)
IsSealed	Obtém um valor que indica se essa instância está validada no momento (somente leitura). (Herdado de DependencyObject)

Métodos

CheckAccess()	Determina se o thread de chamada tem acesso a este DispatcherObject. (Herdado de DispatcherObject)
ClearValue(DependencyProperty)	Limpa o valor local de uma propriedade. A propriedade a ser limpa é especificada por um identificador DependencyProperty. (Herdado de DependencyObject)
ClearValue(DependencyPropertyKey)	Limpa o valor local de uma propriedade somente leitura. A propriedade a ser limpa é especificada por um DependencyPropertyKey. (Herdado de DependencyObject)
Clone()	Cria um clone modificável do Freezable, fazendo cópias em profundidade dos valores do objeto. Ao copiar as propriedades de dependência do objeto, esse método copia as expressões (que talvez não possam mais ser resolvidas), mas não as animações nem seus valores atuais. (Herdado de Freezable)
CloneCore(Freezable)	Copia os valores base (não animados) das propriedades do objeto especificado.
CloneCurrentValue()	Cria um clone modificável (cópia profunda) do Freezable usando seus valores atuais. (Herdado de Freezable)
CloneCurrentValueCore(Freezable)	Copia os valores atuais das propriedades do objeto especificado.
CoerceValue(DependencyProperty)	Converte o valor da propriedade de dependência especificada. Isso é feito invocando qualquer função CoerceValueCallback especificada nos metadados de propriedade para a propriedade de dependência, visto que ela existe na chamada a DependencyObject. (Herdado de DependencyObject)
CreateInstance()	Inicializa uma nova instância da classe Freezable. (Herdado de Freezable)
CreateInstanceCore()	Cria uma instância de um InputBinding.
Equals(Object)	Determina se um DependencyObject fornecido é equivalente ao DependencyObject atual. (Herdado de DependencyObject)
Freeze()	Torna o objeto atual não modificável e define sua propriedade IsFrozen para true. (Herdado de Freezable)
FreezeCore(Boolean)	Torna o objeto Freezable não modificável ou testa se ele pode ser transformado em não modificável. (Herdado de Freezable)
GetAsFrozen()	Cria uma cópia congelada o Freezable usando valores de propriedade base (não animadas). Já que a cópia está congelada, quaisquer subobjetos congelados são copiados por referência. (Herdado de Freezable)
GetAsFrozenCore(Freezable)	Torna a instância um clone congelado do Freezable especificado usando valores de propriedade base (não animados).
GetCurrentValueAsFrozen()	Cria uma cópia congelada do Freezable usando valores de propriedade atuais. Já que a cópia está congelada, quaisquer subobjetos congelados são copiados por referência. (Herdado de Freezable)
GetCurrentValueAsFrozenCore(Freezable)	Torna a instância atual um clone congelado do Freezable especificado. Se o objeto tiver propriedades de dependência animadas, seus valores animados atuais serão copiados.
GetHashCode()	Obtém o código hash para esse DependencyObject. (Herdado de DependencyObject)
GetLocalValueEnumerator()	Cria um enumerador especializado para determinar quais propriedades de dependência têm valores definidos localmente nessa DependencyObject. (Herdado de DependencyObject)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
GetValue(DependencyProperty)	Retorna o valor efetivo atual de uma propriedade de dependência nessa instância de um DependencyObject. (Herdado de DependencyObject)
InvalidateProperty(DependencyProperty)	Reavalia o valor efetivo para a propriedade de dependência especificada. (Herdado de DependencyObject)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
OnChanged()	Chamado quando o objeto Freezable atual é modificado. (Herdado de Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject)	Garante que os ponteiros de contexto apropriados sejam estabelecidos para um membro de dados DependencyObjectType que foi recém-definido. (Herdado de Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)	Esse membro dá suporte à infraestrutura de Windows Presentation Foundation (WPF) e não se destina a ser usado diretamente do seu código. (Herdado de Freezable)
OnPropertyChanged(DependencyPropertyChangedEventArgs)	Substitui a implementação DependencyObject de OnPropertyChanged(DependencyPropertyChangedEventArgs) para também invocar quaisquer manipuladores Changed em resposta à alteração de uma propriedade de dependência do tipo Freezable. (Herdado de Freezable)
ReadLocalValue(DependencyProperty)	Retorna o valor local de uma propriedade de dependência, local, se houver. (Herdado de DependencyObject)
ReadPreamble()	Garante que o Freezable esteja sendo acessado de um thread válido. Herdeiros do Freezable devem chamar esse método no início de qualquer API que lê membros de dados que não são propriedades de dependência. (Herdado de Freezable)
SetCurrentValue(DependencyProperty, Object)	Define o valor da propriedade de dependência sem alterar a origem do valor. (Herdado de DependencyObject)
SetValue(DependencyProperty, Object)	Define o valor local de uma propriedade de dependência, especificada pelo identificador da propriedade de dependência. (Herdado de DependencyObject)
SetValue(DependencyPropertyKey, Object)	Define o valor de uma propriedade de dependência somente leitura, especificada pelo identificador DependencyPropertyKey da propriedade de dependência. (Herdado de DependencyObject)
ShouldSerializeProperty(DependencyProperty)	Retorna um valor que indica se os processos de serialização devem serializar o valor da propriedade de dependência fornecida. (Herdado de DependencyObject)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
VerifyAccess()	Impõe que o thread de chamada tenha acesso a este DispatcherObject. (Herdado de DispatcherObject)
WritePostscript()	Aciona o evento Changed para o Freezable e invoca o respectivo método OnChanged(). Classes que derivam de Freezable devem chamar este método no final de qualquer API que modifica os membros de classe que não são armazenados como propriedades de dependência. (Herdado de Freezable)
WritePreamble()	Verifica se o Freezable não está congelado e está sendo acessado de um contexto de threading válido. Herdeiros do Freezable devem chamar esse método no início de qualquer API que grava em membros de dados que não são propriedades de dependência. (Herdado de Freezable)

Eventos

Changed

Ocorre quando o Freezable ou um objeto nele contido é modificado. (Herdado de Freezable)

Confira também

• InputBindings
• CommandBinding