How to: Create a RoutedCommand


This example shows how to create a custom RoutedCommand and how to implement the custom command by creating a ExecutedRoutedEventHandler and a CanExecuteRoutedEventHandler and attaching them to a CommandBinding. For more information on commanding, see the Commanding Overview.

The first step in creating a RoutedCommand is defining the command and instantiating it.

        public static RoutedCommand CustomRoutedCommand = new RoutedCommand();

In order to use the command in an application, event handlers which define what the command does must be created

        private void ExecutedCustomCommand(object sender,
            ExecutedRoutedEventArgs e)
            MessageBox.Show("Custom Command Executed");

        // CanExecuteRoutedEventHandler that only returns true if
        // the source is a control.
        private void CanExecuteCustomCommand(object sender, 
            CanExecuteRoutedEventArgs e)
            Control target = e.Source as Control;
            if(target != null)
                e.CanExecute = true;
                e.CanExecute = false;

Next, a CommandBinding is created which associates the command with the event handlers. The CommandBinding is created on a specific object. This object defines the scope of the CommandBinding in the element tree

<Window x:Class="SDKSamples.Window1"
    Height="600" Width="800"
    <CommandBinding Command="{x:Static custom:Window1.CustomRoutedCommand}"
                    CanExecute="CanExecuteCustomCommand" />

            CommandBinding customCommandBinding = new CommandBinding(
                CustomRoutedCommand, ExecutedCustomCommand, CanExecuteCustomCommand);

            // attach CommandBinding to root window

The final step is invoking the command. One way to invoke a command is to associate it with a ICommandSource, such as a Button.

      <Button Command="{x:Static custom:Window1.CustomRoutedCommand}"

            // create the ui
            StackPanel CustomCommandStackPanel = new StackPanel();
            Button CustomCommandButton = new Button();

            CustomCommandButton.Command = CustomRoutedCommand;

When the Button is clicked, the Execute method on the custom RoutedCommand is called. The RoutedCommand raises the PreviewExecuted and Executed routed events. These events traverse the element tree looking for a CommandBinding for this particular command. If a CommandBinding is found, the ExecutedRoutedEventHandler associated with CommandBinding is called.

Commanding Overview