RichEditControl.CreateCommand(RichEditCommandId) Method

Creates a RichEditCommand object by the command identifier.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v20.2.dll

NuGet Package: DevExpress.Win.RichEdit

Declaration

C#

public virtual RichEditCommand CreateCommand(
    RichEditCommandId commandId
)

VB.NET

Public Overridable Function CreateCommand(
    commandId As RichEditCommandId
) As RichEditCommand

Parameters

Name	Type	Description
commandId	RichEditCommandId	A RichEditCommandId structure member indicating a command.

Returns

Type	Description
RichEditCommand	A Rich Text Control command.

Example

The following code creates commands by their RichEditCommandId using the RichEditControl.CreateCommand method. Each command is executed by calling the ForceExecute method. The Command.CreateDefaultCommandUIState method returns the command UI state.

The RichEditControl instance is passed to the BarItem.ItemClick event handler using the BarItem.Tag property.

View Example

RichEditControlActions.cs

static void buttonCustomAction_ItemClick_Commands(object sender, ItemClickEventArgs e) {
    RichEditControl richEdit = e.Item.Tag as RichEditControl;
    richEdit.SelectAll();

    RichEditCommand capCommand = richEdit.CreateCommand(RichEditCommandId.CapitalizeEachWordTextCase);
    capCommand.ForceExecute(capCommand.CreateDefaultCommandUIState());

    RichEditCommand boldCommand = richEdit.CreateCommand(RichEditCommandId.ToggleFontBold);
    boldCommand.ForceExecute(boldCommand.CreateDefaultCommandUIState());

    RichEditCommand changeFontColorCommand = richEdit.CreateCommand(RichEditCommandId.ChangeFontBackColor);
    DevExpress.Utils.Commands.ICommandUIState state = changeFontColorCommand.CreateDefaultCommandUIState();
    state.EditValue = Color.Yellow;
    changeFontColorCommand.ForceExecute(state);

    RichEditCommand previewCommand = richEdit.CreateCommand(RichEditCommandId.PrintPreview);
    previewCommand.ForceExecute(previewCommand.CreateDefaultCommandUIState());

    richEdit.DeselectAll();
}

RichEditControlActions.vb

Private Shared Sub buttonCustomAction_ItemClick_Commands(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    Dim richEdit As RichEditControl = TryCast(e.Item.Tag, RichEditControl)
    richEdit.SelectAll()

    Dim capCommand As RichEditCommand = richEdit.CreateCommand(RichEditCommandId.CapitalizeEachWordTextCase)
    capCommand.ForceExecute(capCommand.CreateDefaultCommandUIState())

    Dim boldCommand As RichEditCommand = richEdit.CreateCommand(RichEditCommandId.ToggleFontBold)
    boldCommand.ForceExecute(boldCommand.CreateDefaultCommandUIState())

    Dim changeFontColorCommand As RichEditCommand = richEdit.CreateCommand(RichEditCommandId.ChangeFontBackColor)
    Dim state As DevExpress.Utils.Commands.ICommandUIState = changeFontColorCommand.CreateDefaultCommandUIState()
    state.EditValue = System.Drawing.Color.Yellow
    changeFontColorCommand.ForceExecute(state)


    Dim previewCommand As RichEditCommand = richEdit.CreateCommand(RichEditCommandId.PrintPreview)
    previewCommand.ForceExecute(previewCommand.CreateDefaultCommandUIState())

    richEdit.DeselectAll()
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CreateCommand(RichEditCommandId) method.

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#

winforms-the-richeditcontrols-common-api-t210437/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L539

RichEditCommand capCommand = richEdit.CreateCommand(RichEditCommandId.CapitalizeEachWordTextCase);
capCommand.ForceExecute(capCommand.CreateDefaultCommandUIState());

how-to-bind-richedit-commands-to-buttons-check-boxes-and-other-ui-elements-e1774/CS/RichEditCommandExample/CommandUIBindings.cs#L76

    return control.CreateCommand(commandId);
}

VB.NET

winforms-the-richeditcontrols-common-api-t210437/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L548

Dim capCommand As RichEditCommand = richEdit.CreateCommand(RichEditCommandId.CapitalizeEachWordTextCase)
capCommand.ForceExecute(capCommand.CreateDefaultCommandUIState())

how-to-bind-richedit-commands-to-buttons-check-boxes-and-other-ui-elements-e1774/VB/RichEditCommandExample/CommandUIBindings.vb#L85

    Return control.CreateCommand(commandId_Renamed)
End Function