StandardUICommand Class

Reference

Definition

Namespace:: Windows.UI.Xaml.Input

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Derives from XamlUICommand, adding a set of standard platform commands with pre-defined properties.

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class StandardUICommand : XamlUICommand

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class StandardUICommand : XamlUICommand

Public Class StandardUICommand
Inherits XamlUICommand

Inheritance: Object IInspectable DependencyObject XamlUICommand StandardUICommand

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v7.0)

Examples

Tip

For more info, design guidance, and code examples, see Command design basics.

If you have the WinUI 2 Gallery app installed, click here to open the app and see the StandardUICommand in action.

Remarks

XamlUICommand implements the ICommand interface (Windows.UI.Xaml.Input.ICommand for C++ or System.Windows.Input.ICommand for C#), adding various UI properties, methods, and events.

The platform provides the following set of commands.

Command	Icon	Keyboard shortcut	Label	Description
Cut
Copy
Paste
Select All
Delete
Share
Save
Open
Close
Pause
Play
Stop
Forward
Backward
Undo
Redo

Constructors

StandardUICommand()	Initializes a new instance of the StandardUICommand class.
StandardUICommand(StandardUICommandKind)	Initializes a new instance of the StandardUICommand class of the specified kind.

Properties

AccessKey	Gets or sets the access key (mnemonic) for this element. (Inherited from XamlUICommand)
Command	Gets or sets the command behavior of an interactive UI element that performs an action when invoked, such as sending an email, deleting an item, or submitting a form. (Inherited from XamlUICommand)
Description	Gets or sets a description for this element. (Inherited from XamlUICommand)
Dispatcher	Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject)
IconSource	Gets or sets a glyph from the Segoe MDL2 Assets font for this element. (Inherited from XamlUICommand)
KeyboardAccelerators	Gets or sets the collection of key combinations for this element that invoke an action using the keyboard. (Inherited from XamlUICommand)
Kind	Gets the platform command (with pre-defined properties such as icon, keyboard accelerator, and description) that can be used with a StandardUICommand.
KindProperty	Identifies the Kind dependency property.
Label	Gets or sets the label for this element. (Inherited from XamlUICommand)

Methods

CanExecute(Object)	Retrieves whether the command can execute in its current state. (Inherited from XamlUICommand)
ClearValue(DependencyProperty)	Clears the local value of a dependency property. (Inherited from DependencyObject)
Execute(Object)	Invokes the command. (Inherited from XamlUICommand)
GetAnimationBaseValue(DependencyProperty)	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
NotifyCanExecuteChanged()	Notifies the system that the command state has changed. (Inherited from XamlUICommand)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)	Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)	Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)

Events

CanExecuteChanged	Occurs whenever something happens that affects whether the command can execute. (Inherited from XamlUICommand)
CanExecuteRequested	Occurs when a CanExecute call is made. (Inherited from XamlUICommand)
ExecuteRequested	Occurs when an Execute call is made. (Inherited from XamlUICommand)

Applies to