Skip to main content

MailMergeTabItemId Enum

Lists commands contained in the Mail Merge tab.

Declaration

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

Members

Name Description
CreateDateField

Identifies the Create DATE Field command.

CreateEmptyDocVariableField

Identifies the Create Empty DOCVARIABLE Field command.

CreateEmptyMergeField

Identifies the Create Empty MEGREFIELD command.

CreateField

Identifies the Create Field command.

CreateFieldMenu

Identifies the Create Field menu.

CreateNumPagesField

Identifies the Create NUMPAGES Field command.

CreatePageField

Identifies the Create PAGE Field command.

CreateTimeField

Identifies the Create TIME Field command.

GoToFirstDataRecord

Identifies the Go To First Data Record command.

GoToLastDataRecord

Identifies the Go To Last Data Record command.

GoToNextDataRecord

Identifies the Go To Next Data Record command.

GoToPreviousDataRecord

Identifies the Go To Previous Data Record command.

ShowAllFieldCodes

Identifies the Show All Field Codes command.

ShowAllFieldResults

Identifies the Show All Field Results command.

ShowInsertMergeFieldDialog

Identifies the Show Insert Merge Field Dialog command.

ShowMailMergeDialog

Identifies the Show Mail Merge Dialog command.

ToggleViewMergedData

Identifies the Toggle View Merged Data command.

UpdateAllFields

Identifies the Update All Fields command.

Remarks

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.

The example below moves the UpdateAllFields item to the first position in the Mail Merge tab:

var options = DevExpress.RichEdit.createOptions();
var tab = options.ribbon.getTab(DevExpress.RichEdit.RibbonTabType.MailMerge);
var ribbonItem = tab.getItem(DevExpress.RichEdit.MailMergeTabItemId.UpdateAllFields);
tab.removeItem(ribbonItem);
tab.insertItem(ribbonItem, 0);
var richContainer = document.getElementById("rich-container");
const richEdit = DevExpress.RichEdit.create(richContainer, options);

To execute the Mail Merge tab’s command, pass the MailMergeTabCommandId‘s field to the executeCommand(commandId) method.

See Also