Share via


CommandMetadata Class

Definition

The metadata required to create a command.

[System.Runtime.Serialization.DataContract]
public class CommandMetadata
[<System.Runtime.Serialization.DataContract>]
type CommandMetadata = class
Public Class CommandMetadata
Inheritance
CommandMetadata
Derived
Attributes

Constructors

CommandMetadata(IReadOnlyDictionary<String,String>)

Initializes a new instance of the CommandMetadata class.

CommandMetadata(String, String)

Initializes a new instance of the CommandMetadata class.

CommandMetadata(String, String, String, Nullable<CommandFlags>, String, UInt32)

Initializes a new instance of the CommandMetadata class.

Properties

DisplayName

Gets the display name of the command.

Flags

Gets or sets the flags associated with the command.

IconName

Gets or sets the name of the icon for the command.

Id

Gets the unique identifier of the command. It is best practice to fully qualify this id with the extension namespace as well as with the command set it belongs to. i.e. MyCompany.CommandSetName.CommandName.

RelativeSortOrder

Gets or sets the relative sort order of the command.

TooltipText

Gets or sets the tooltip text of the command.

Methods

Equals(Object)
GetHashCode()

Serves as the default hash function.

Applies to