ButtonBase.CommandParameter Property

Definition

Namespace:

System.Windows.Controls.Primitives

Assembly:

PresentationFramework.dll

Gets or sets the parameter to pass to the Command property.

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

[System.ComponentModel.Bindable(true)]
[System.Windows.Localizability(System.Windows.LocalizationCategory.NeverLocalize)]
public object CommandParameter { get; set; }

[<System.ComponentModel.Bindable(true)>]
[<System.Windows.Localizability(System.Windows.LocalizationCategory.NeverLocalize)>]
member this.CommandParameter : obj with get, set

Public Property CommandParameter As Object

Property Value

Object

Parameter to pass to the Command property.

Attributes

BindableAttribute LocalizabilityAttribute

Remarks

Most existing commands from the command libraries do not use a command parameter. Of the commands that do use a command parameter, most of these take a parameter with some primitive type value, such as an integer or a string. However, it is possible to create a custom command where that command expects a nonprimitive type as its command parameter. For a custom command case like this, setting CommandParameter in code might require a new or existing object instance. Setting CommandParameter in markup might require property element syntax, where the object element filling the property element syntax is a new element of the type expected by that command. Alternatively, setting in markup might require a reference through a markup extension to an existing object (typically these references are made with Binding Markup Extension or StaticResource Markup Extension).

XAML Attribute Usage

<object CommandParameter="commandParameter" />  

XAML Values

commandParameter
A value of the same type as the particular command specified in the Command property expects. If you use an existing command library command, see that command library's documentation for XAML usage information, including which type of CommandParameter the command expects. If you use a custom command, see Remarks.

Dependency Property Information

Identifier field	CommandParameterProperty
Metadata properties set to true	None

See also

• ICommand