This documentation is archived and is not being maintained.

RoutedCommand Class

Defines a command that implements ICommand and is routed through the element tree.

Namespace:  System.Windows.Input
Assembly:  PresentationCore (in PresentationCore.dll)

<TypeConverterAttribute("System.Windows.Input.CommandConverter, PresentationFramework, Version=, Culture=neutral, PublicKeyToken=31bf3856ad364e35, Custom=null")> _
Public Class RoutedCommand _
	Implements ICommand
<RoutedCommand .../>
<object property="predefinedCommandName"/>- or -<object property="predefinedClassName.predefinedCommandName"/>- or -<object property="{x:Static customClassName.customCommandName}"/>

XAML Values


One of the predefined command classes.


One of the predefined commands.


A custom class which contains the custom command. Custom classes generally require an xlmns prefix mapping; see XAML Namespaces and Namespace Mapping for WPF XAML.


A custom command.

The RoutedCommand type exposes the following members.

Public methodRoutedCommandInitializes a new instance of the RoutedCommand class.
Public methodRoutedCommand(String, Type)Initializes a new instance of the RoutedCommand class with the specified name and owner type.
Public methodRoutedCommand(String, Type, InputGestureCollection)Initializes a new instance of the RoutedCommand class with the specified name, owner type, and collection of gestures.

Public propertyInputGesturesGets the collection of InputGesture objects that are associated with this command.
Public propertyNameGets the name of the command.
Public propertyOwnerTypeGets the type that is registered with the command.

Public methodCanExecuteDetermines whether this RoutedCommand can execute in its current state.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodExecuteExecutes the RoutedCommand on the current command target.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Public eventCanExecuteChangedOccurs when changes to the command source are detected by the command manager. These changes often affect whether the command should execute on the current command target.

Explicit interface implemetationPrivate methodICommand.CanExecuteFor a description of this members, see CanExecute.
Explicit interface implemetationPrivate methodICommand.ExecuteFor a description of this members, see Execute.

The Execute and CanExecute methods on a RoutedCommand do not contain the application logic for the command as is the case with a typical ICommand, but rather, these methods raise events that traverse the element tree looking for an object with a CommandBinding. The event handlers attached to the CommandBinding contain the command logic.

The Execute method raises the PreviewExecuted and Executed events. The CanExecute method raises the PreviewCanExecute and CanExecute events.

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 Shared CustomRoutedCommand As New RoutedCommand()

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

		Private Sub ExecutedCustomCommand(ByVal sender As Object, ByVal e As ExecutedRoutedEventArgs)
			MessageBox.Show("Custom Command Executed")
		End Sub

		' CanExecuteRoutedEventHandler that only returns true if
		' the source is a control.
		Private Sub CanExecuteCustomCommand(ByVal sender As Object, ByVal e As CanExecuteRoutedEventArgs)
			Dim target As Control = TryCast(e.Source, Control)

			If target IsNot Nothing Then
				e.CanExecute = True
				e.CanExecute = False
			End If
		End Sub

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" />

			Dim customCommandBinding As New CommandBinding(CustomRoutedCommand, AddressOf ExecutedCustomCommand, AddressOf 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
			Dim CustomCommandStackPanel As New StackPanel()
			Dim CustomCommandButton As 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.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.