StandardUICommand Class

Definition

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

Equivalent WinUI class: Microsoft.UI.Xaml.Input.StandardUICommand.

/// [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
Attributes

Windows 10 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 XAML Controls 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?text=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.

Equivalent WinUI constructor: Microsoft.UI.Xaml.Input.StandardUICommand.StandardUICommand.

StandardUICommand(StandardUICommandKind)

Initializes a new instance of the StandardUICommand class of the specified kind.

Equivalent WinUI constructor: Microsoft.UI.Xaml.Input.StandardUICommand.StandardUICommand.

Properties

AccessKey

Gets or sets the access key (mnemonic) for this element.

Equivalent WinUI property: Microsoft.UI.Xaml.Input.XamlUICommand.AccessKey.

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

Equivalent WinUI property: Microsoft.UI.Xaml.Input.XamlUICommand.Command.

(Inherited from XamlUICommand)
Description

Gets or sets a description for this element.

Equivalent WinUI property: Microsoft.UI.Xaml.Input.XamlUICommand.Description.

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

Equivalent WinUI property: Microsoft.UI.Xaml.DependencyObject.Dispatcher.

(Inherited from DependencyObject)
IconSource

Gets or sets a glyph from the Segoe MDL2 Assets font for this element.

Equivalent WinUI property: Microsoft.UI.Xaml.Input.XamlUICommand.IconSource.

(Inherited from XamlUICommand)
KeyboardAccelerators

Gets or sets the collection of key combinations for this element that invoke an action using the keyboard.

Equivalent WinUI property: Microsoft.UI.Xaml.Input.XamlUICommand.KeyboardAccelerators.

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

Equivalent WinUI property: Microsoft.UI.Xaml.Input.StandardUICommand.Kind.

KindProperty

Identifies the Kind dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Input.StandardUICommand.KindProperty.

Label

Gets or sets the label for this element.

Equivalent WinUI property: Microsoft.UI.Xaml.Input.XamlUICommand.Label.

(Inherited from XamlUICommand)

Methods

CanExecute(Object)

Retrieves whether the command can execute in its current state.

Equivalent WinUI method: Microsoft.UI.Xaml.Input.XamlUICommand.CanExecute.

(Inherited from XamlUICommand)
ClearValue(DependencyProperty)

Clears the local value of a dependency property.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ClearValue.

(Inherited from DependencyObject)
Execute(Object)

Invokes the command.

Equivalent WinUI method: Microsoft.UI.Xaml.Input.XamlUICommand.Execute.

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

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetAnimationBaseValue.

(Inherited from DependencyObject)
GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetValue.

(Inherited from DependencyObject)
NotifyCanExecuteChanged()

Notifies the system that the command state has changed.

Equivalent WinUI method: Microsoft.UI.Xaml.Input.XamlUICommand.NotifyCanExecuteChanged.

(Inherited from XamlUICommand)
ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ReadLocalValue.

(Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.RegisterPropertyChangedCallback.

(Inherited from DependencyObject)
SetValue(DependencyProperty, Object)

Sets the local value of a dependency property on a DependencyObject.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.SetValue.

(Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.UnregisterPropertyChangedCallback.

(Inherited from DependencyObject)

Events

CanExecuteChanged

Occurs whenever something happens that affects whether the command can execute.

Equivalent WinUI event: Microsoft.UI.Xaml.Input.XamlUICommand.CanExecuteChanged.

(Inherited from XamlUICommand)
CanExecuteRequested

Occurs when a CanExecute call is made.

Equivalent WinUI event: Microsoft.UI.Xaml.Input.XamlUICommand.CanExecuteRequested.

(Inherited from XamlUICommand)
ExecuteRequested

Occurs when an Execute call is made.

Equivalent WinUI event: Microsoft.UI.Xaml.Input.XamlUICommand.ExecuteRequested.

(Inherited from XamlUICommand)

Applies to

See also