WindowsUIButton.CommandParameter Property

Gets or sets the parameter that is passed to the command specified by the Command property.

Namespace: DevExpress.XtraBars.Docking2010

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[Bindable(true)]
[Browsable(false)]
[DXCategory("Action")]
public object CommandParameter { get; set; }

VB.NET

<Bindable(True)>
<Browsable(False)>
<DXCategory("Action")>
Public Property CommandParameter As Object

Property Value

Type	Description
Object	The parameter.

Remarks

C#

Func<int, bool> canExecute = (p) => (2 + 2 == p);
// Creates a parameterized command with the `canExecute` parameter.
DelegateCommand<int> command = new DelegateCommand<int>((v) => {
    XtraMessageBox.Show(string.Format(
        "Hello! The command parameter is {0}." + Environment.NewLine +
        "The command is running because the `canExecute` condition is `True`.", v));
}, canExecute);
// Binds the Command property of a button.
commandButton.Command = command;
commandButton.CommandParameter = 4;

VB.NET

Dim canExecute As Func(Of Integer, Boolean) = Function(p) (2 + 2 = p)
' Creates a parameterized command with the `canExecute` parameter.
Dim command As DelegateCommand(Of Integer) = New DelegateCommand(Of Integer)(Sub(v)
    XtraMessageBox.Show(String.Format("Hello! The command parameter is {0}." & Environment.NewLine & "The command is running because the `canExecute` condition is `True`.", v))
End Sub, canExecute)
' Binds the Command property of a button.
commandButton.Command = command
commandButton.CommandParameter = 4

Run Demo: Parameterized Command Run Demo: Simple Command

Read the following topics for additional information:

• Commands
• Using Command Binding in Windows Forms apps to go Cross-Platform