Command.Description Property

Gets the text description of a command.

Namespace: DevExpress.Utils.Commands

Assembly: DevExpress.Data.v22.1.dll

Declaration

C#

public abstract string Description { get; }

VB.NET

Public MustOverride ReadOnly Property Description As String

Property Value

Type	Description
String	A string containing the command’s description.

Remarks

The Description property enables you to inform the end-user of the action that the command performs.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Description property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-determine-a-ui-command-executed-in-richeditcontrol-in-response-to-a-user-action-t371666/CS/DXApplication9/CustomCommandExecutionListenerService.cs#L31

{
    RaiseCommandExecutedEvent(new CommandEventArgs(command.ToString(), command.Description));
}

VB.NET

how-to-determine-a-ui-command-executed-in-richeditcontrol-in-response-to-a-user-action-t371666/VB/DXApplication9/CustomCommandExecutionListenerService.vb#L23

If Not RichEditControl.IsUpdateLocked Then
    RaiseCommandExecutedEvent(New CommandEventArgs(command.ToString(), command.Description))
End If