RoutedCommand Class

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

Namespace:  System.Windows.Input
Assembly:  PresentationCore (in PresentationCore.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

[TypeConverterAttribute(L"System.Windows.Input.CommandConverter, PresentationFramework, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, Custom=null")]
public ref class RoutedCommand : ICommand
<RoutedCommand .../>
<object property="predefinedCommandName"/>- or -<object property="predefinedClassName.predefinedCommandName"/>- or -<object property="{x:Static customClassName.customCommandName}"/>

XAML Values

predefinedClassName

One of the predefined command classes.

predefinedCommandName

One of the predefined commands.

customClassName

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.

customCommandName

A custom command.

The RoutedCommand type exposes the following members.

  NameDescription
Public methodRoutedCommand()Initializes 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.
Top

  NameDescription
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.
Top

  NameDescription
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 the default hash function. (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.)
Top

  NameDescription
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.
Top

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

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.

No code example is currently available or this language may not be supported.

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

No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.

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"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:custom="clr-namespace:SDKSamples"
    Height="600" Width="800"
    >
  <Window.CommandBindings>
    <CommandBinding Command="{x:Static custom:Window1.CustomRoutedCommand}"
                    Executed="ExecutedCustomCommand"
                    CanExecute="CanExecuteCustomCommand" />
  </Window.CommandBindings>
No code example is currently available or this language may not be supported.

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

<StackPanel>
  <Button Command="{x:Static custom:Window1.CustomRoutedCommand}"
          Content="CustomRoutedCommand"/>
</StackPanel>
No code example is currently available or this language may not be supported.

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.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft