RichEditControl.CreateCommand(RichEditCommandId) Method

Creates a RichEditCommand object by the command identifier.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v20.1.dll

Declaration

public virtual RichEditCommand CreateCommand(
    RichEditCommandId commandId
)
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.

Examples

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.

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();
}
See Also