RichEditControl.CreateCommand(RichEditCommandId) Method

Create a RichEditCommand object by the command identifier.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v18.1.dll

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, which specifies a command.

Returns

Type	Description
RichEditCommand	A RichEditCommand instance, representing a Rich Text Control command.

Example

The following code creates commands by its RichEditCommandId using the RichEditControl.CreateCommand method. Each command is executed by calling the ForceExecute method which is specific for each command. The command UI state required for the ForceExecute method is obtained from the Command.CreateDefaultCommandUIState method.

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

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-the-richeditcontrols-common-api-t210437

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#L538

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);
}

how-to-customize-the-insert-merge-field-menu-e4177/CS/CustomInsertMergeFieldItem.cs#L121

    if (RichEditControl != null)
        RichEditControl.CreateCommand(RichEditCommandId.ShowInsertMergeFieldForm).Execute();
}

how-to-remove-an-empty-paragraph-when-appending-a-content-to-a-document-e4154/CS/Form1.cs#L13

    richEditControl1.CreateCommand(RichEditCommandId.ToggleShowWhitespace).Execute();
}

VB.NET

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

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

how-to-customize-the-insert-merge-field-menu-e4177/VB/CustomInsertMergeFieldItem.vb#L150

If RichEditControl IsNot Nothing Then
    RichEditControl.CreateCommand(RichEditCommandId.ShowInsertMergeFieldForm).Execute()
End If

how-to-remove-an-empty-paragraph-when-appending-a-content-to-a-document-e4154/VB/Form1.vb#L15

    richEditControl1.CreateCommand(RichEditCommandId.ToggleShowWhitespace).Execute()
End Sub