MailMergeTabCommandId Enum

Lists commands contained in the Mail Merge tab.

Declaration

export enum MailMergeTabCommandId {
    CreateFieldMenu = 442,
    CreateField = 178,
    CreateDateField = 203,
    CreateTimeField = 204,
    CreatePageField = 205,
    CreateNumPagesField = 236,
    CreateEmptyMergeField = 372,
    CreateEmptyDocVariableField = 373,
    CreateEmptyIfField = 459,
    ShowInsertMergeFieldDialog = 214,
    ToggleViewMergedData = 213,
    ShowAllFieldCodes = 186,
    ShowAllFieldResults = 187,
    UpdateAllFields = 200,
    GoToFirstDataRecord = 209,
    GoToPreviousDataRecord = 210,
    GoToNextDataRecord = 211,
    GoToLastDataRecord = 212,
    ShowMailMergeDialog = 216
}

Members

Name	Description
CreateDateField	A command that adds the DATE field at the current position in the document.
CreateEmptyDocVariableField	A command that adds the DOCVARIABLE field at the current position in the document.
CreateEmptyIfField	A command that adds the IF field at the current position.
CreateEmptyMergeField	A command that adds the MERGE field at the current position.
CreateField	A command that adds a field at the current position.
CreateFieldMenu	A command that shows the Create Field menu.
CreateNumPagesField	A command that adds the NUMPAGES field at the current position in the document.
CreatePageField	A command that adds the PAGE field at the current position in the document.
CreateTimeField	A command that adds the TIME field at the current position.
GoToFirstDataRecord	A command that navigates to the first data record.
GoToLastDataRecord	A command that navigates to the last data record.
GoToNextDataRecord	A command that navigates to the next data record.
GoToPreviousDataRecord	A command that navigates to the previous data record.
ShowAllFieldCodes	A command that displays all the field codes in the document.
ShowAllFieldResults	A command that displays all field results in the document.
ShowInsertMergeFieldDialog	A command that shows the Insert Merge Field dialog.
ShowMailMergeDialog	A command that shows the Mail Merge dialog.
ToggleViewMergedData	A command that displays (or hides) actual data in merge fields.
UpdateAllFields	A command that updates all fields in the document.

Remarks

Pass the MailMergeTabCommandId‘s field to the executeCommand(commandId) method to execute a command:

JS

richEdit.executeCommand(DevExpress.RichEdit.MailMergeTabCommandId.UpdateAllFields);

The MailMergeTabItemId enum contains identifiers of the Mail Merge tab’s ribbon items. Use an identifier to get the corresponding item and then insert it into a tab or remove the item from the Mail Merge tab.