Edit

Share via

RoutedUICommand Class

  • Reference

Definition

Namespace:
System.Windows.Input
Assembly:
PresentationCore.dll

Defines an ICommand that is routed through the element tree and contains a text property.

public ref class RoutedUICommand : System::Windows::Input::RoutedCommand
[System.ComponentModel.TypeConverter("System.Windows.Input.CommandConverter, PresentationFramework, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, Custom=null")]
public class RoutedUICommand : System.Windows.Input.RoutedCommand
[System.ComponentModel.TypeConverter("System.Windows.Input.CommandConverter, PresentationFramework, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, Custom=null")]
public class RoutedUICommand : System.Windows.Input.RoutedCommand
[<System.ComponentModel.TypeConverter("System.Windows.Input.CommandConverter, PresentationFramework, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, Custom=null")>]
type RoutedUICommand = class
    inherit RoutedCommand
[<System.ComponentModel.TypeConverter("System.Windows.Input.CommandConverter, PresentationFramework, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, Custom=null")>]
type RoutedUICommand = class
    inherit RoutedCommand
Public Class RoutedUICommand
Inherits RoutedCommand
Inheritance
Object
RoutedCommand
RoutedUICommand
Attributes
TypeConverterAttribute

Remarks

The difference between a RoutedUICommand and RoutedCommand is that RoutedUICommand includes a Text property.

The Execute and CanExecute methods on a RoutedCommand do not contain the command logic for the command, as is the case with a typical ICommand. 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.

XAML attribute usage

<object-property="predefined-command-name"/>
- or -
<object-property="predefined-class-name.predefined-command-name"/>
- or -
<object-property="{x:Static custom-class-name.custom-command-name}"/>

XAML values

predefined-class-name
One of the predefined command classes.

predefined-command-name
One of the predefined commands.

prefix
The xlmns prefix that maps customClassName.customCommandName to the .NET class. For more information, see XAML Namespaces and Namespace Mapping for WPF XAML.

custom-class-name
A custom class that contains the custom command.

custom-command-name
A custom command.

Constructors

RoutedUICommand()

Initializes a new instance of the RoutedUICommand class.
RoutedUICommand(String, String, Type)

Initializes a new instance of the RoutedUICommand class, using the specified descriptive text, declared name, and owner type.
RoutedUICommand(String, String, Type, InputGestureCollection)

Initializes a new instance of the RoutedUICommand class, using the specified descriptive text, declared name, owner type, and input gestures.

Properties

InputGestures

Gets the collection of InputGesture objects that are associated with this command.

(Inherited from RoutedCommand)
Name

Gets the name of the command.

(Inherited from RoutedCommand)
OwnerType

Gets the type that is registered with the command.

(Inherited from RoutedCommand)
Text

Gets or sets the text that describes this command.

Methods

CanExecute(Object, IInputElement)

Determines whether this RoutedCommand can execute in its current state.

(Inherited from RoutedCommand)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Execute(Object, IInputElement)

Executes the RoutedCommand on the current command target.

(Inherited from RoutedCommand)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Events

CanExecuteChanged

Occurs 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.

(Inherited from RoutedCommand)

Explicit Interface Implementations

ICommand.CanExecute(Object)

For a description of this members, see CanExecute(Object).

(Inherited from RoutedCommand)
ICommand.Execute(Object)

For a description of this members, see Execute(Object).

(Inherited from RoutedCommand)

Applies to

See also