InputBinding.CommandParameter Свойство

Определение

Пространство имен:

System.Windows.Input

Сборка:

PresentationCore.dll

Возвращает или задает данные для конкретной команды.

public:
 property System::Object ^ CommandParameter { System::Object ^ get(); void set(System::Object ^ value); };

public object CommandParameter { get; set; }

member this.CommandParameter : obj with get, set

Public Property CommandParameter As Object

Значение свойства

Object

Данные, относящиеся к команде. Значение по умолчанию — null.

Комментарии

Свойство CommandParameter используется для передачи определенной информации команде при выполнении. Тип данных определяется командой. Многие команды не ожидают параметров команды; для этих команд все переданные параметры команд будут игнорироваться.

Если команда, с которой связана входная привязка, CommandParameter является , RoutedCommandвходная привязка передается RoutedCommand обработчикам через ExecutedRoutedEventArgs и CanExecuteRoutedEventArgs данные события при обработке команды.

Тип данных и назначение параметра команды определяются по-разному для каждой команды и могут быть null. Можно привязать CommandCommandParameterсвойства и CommandTarget свойства к ICommand определенному объекту. Это позволяет определить пользовательскую команду и связать ее с входными данными пользователя. Дополнительные сведения см. во втором примере InputBinding.

Класс InputBinding не поддерживает использование XAML, так как он не предоставляет открытый конструктор без параметров (он имеет конструктор без параметров, но он защищен). Однако производные классы могут предоставлять общедоступный конструктор и, следовательно, могут задавать свойства, унаследованные от InputBinding использования XAML. Два существующих InputBinding производных класса, которые можно создать в XAML, и могут задавать свойства в XAML KeyBinding и MouseBinding.

Использование атрибута XAML

<inputBindingDerivedClass CommandParameter="commandParameterString"/>

Использование элемента свойства XAML

<inputBindingDerivedClass>
  <inputBindingDerivedClass.CommandParameter>
    <commandParameterObject/>
  </inputBindingDerivedClass.CommandParameter>
</inputBindingDerivedClass>

Значения XAML

inputBindingDerivedClass Производный InputBinding класс, поддерживающий синтаксис элемента объекта, например KeyBinding или MouseBinding. См. раздел "Замечания".

commandParameterString Строка, обрабатываемая определенной командой. Строки являются общим типом, используемым для параметров команд, так как их можно легко задать в XAML. Ожидаемый формат строки и его назначение см. в документации по определенной команде, с которой связана входная привязка. Многие команды не ожидают параметров.

commandParameterObject Объект, обрабатываемый определенной командой. Все существующие команды WPF используют строки. Поэтому этот синтаксис элемента свойства относится только к пользовательским сценариям команд. Для поддержки этого синтаксиса commandParameterObject объект также должен поддерживать синтаксис элемента объекта (должен иметь открытый конструктор без параметров).