ExecutedRoutedEventArgs.Parameter ExecutedRoutedEventArgs.Parameter ExecutedRoutedEventArgs.Parameter ExecutedRoutedEventArgs.Parameter Property

Definition

Gets data parameter of the command.

public:
 property System::Object ^ Parameter { System::Object ^ get(); };
public object Parameter { get; }
member this.Parameter : obj
Public ReadOnly Property Parameter As Object

Property Value

The command-specific data. The default value is null.

Examples

The following example creates an ExecutedRoutedEventHandler for a custom RoutedCommand. The handler updates a TextBox with the current time and the Value property of a Slider control that is passed to the handler through the ExecutedRoutedEventArgs.Parameter.

//  Executed Event Handler
//
//  Updates the output TextBox with the current seconds 
//  and the target second, which is passed through Args.Parameter.
private void CustomCommandExecuted(object sender, ExecutedRoutedEventArgs e)
{
    txtResults.Text = "Command Executed at " +
        DateTime.Now.Second + " seconds after the minute \n\n" +
        "The target second is set to " +
        e.Parameter;
}
'  Executed Event Handler
'
'  Updates the output TextBox with the current seconds 
'  and the target second, which is passed through Args.Parameter.
Private Sub CustomCommandExecuted(ByVal sender As Object, ByVal e As ExecutedRoutedEventArgs)
          txtResults.Text = "Command Executed at " & Date.Now.Second & " seconds after the minute " & vbLf & vbLf & "The target second is set to " & e.Parameter.ToString()
End Sub

Remarks

This property represents a generic data parameter that is defined by the particular command.

If this parameter is not needed, null can be passed.

Normally, the Parameter is used to pass specific information to the command when it is executed. The type of the data is defined by the command.

Applies to

See also