RoutedUICommand Class (System.Windows.Input)

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

RoutedUICommand Class

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

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

Syntax

Visual Basic (Declaration)

<TypeConverterAttribute("System.Windows.Input.CommandConverter, PresentationFramework, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, Custom=null")> _
Public Class RoutedUICommand _
    Inherits RoutedCommand

Visual Basic (Usage)

Dim instance As RoutedUICommand

[TypeConverterAttribute("System.Windows.Input.CommandConverter, PresentationFramework, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, Custom=null")]
public class RoutedUICommand : RoutedCommand

Visual C++

[TypeConverterAttribute(L"System.Windows.Input.CommandConverter, PresentationFramework, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, Custom=null")]
public ref class RoutedUICommand : public RoutedCommand

JScript

public class RoutedUICommand extends RoutedCommand

XAML Object Element Usage

<RoutedUICommand .../>

XAML Attribute Usage

<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.
prefix: The xlmns prefix that maps customClassName.customCommandName to the .NET class. For more information, see XAML Namespaces and Namespace Mapping.
customClassName: A custom class that contains the custom command.
customCommandName: A custom command.

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.

Inheritance Hierarchy

System..::.Object
System.Windows.Input..::.RoutedCommand
System.Windows.Input..::.RoutedUICommand

Thread Safety

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

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

RoutedUICommand Members

System.Windows.Input Namespace

RoutedUICommand

Other Resources

Commanding Overview

Input Overview