MailMerge Members (Word)

GitHub-Mark-64px

Contribute to this content

Use GitHub to suggest and submit changes. See our guidelines for contributing to VBA documentation.

Represents the mail merge functionality in Word.

Methods

Name

Description

Check

Simulates the mail merge operation, pausing to report each error as it occurs.

CreateDataSource

Creates a Microsoft Word document that uses a table to store data for a mail merge.

CreateHeaderSource

Creates a Microsoft Word document that stores a header record that is used instead of the data source header record in a mail merge.

EditDataSource

Opens or switches to the mail merge data source.

EditHeaderSource

Opens the header source attached to a mail merge main document, or activates the header source if it is already open.

EditMainDocument

Activates the mail merge main document associated with the specified header source or data source document.

Execute

Performs the specified mail merge operation.

OpenDataSource

Attaches a data source to the specified document, which becomes a main document if it is not one already.

OpenHeaderSource

Attaches a mail merge header source to the specified document.

ShowWizard

Displays the Mail Merge Wizard in a document.

Properties

Name

Description

Application

Returns an Application object that represents the Microsoft Word application.

Creator

Returns a 32-bit integer that indicates the application in which the specified object was created. Read-only Long.

DataSource

Returns a MailMergeDataSource object that refers to the data source attached to a mail merge main document. Read-only.

Destination

Returns or sets the destination of the mail merge results. Read/write WdMailMergeDestination.

Fields

Returns a read-only MailMergeFields collection that represents all the mail merge fields in the specified document.

HighlightMergeFields

True to highlight the merge fields in a document. Read/write Boolean.

MailAddressFieldName

Returns or sets the name of the field that contains e-mail addresses that are used when the mail merge destination is electronic mail. Read/write String.

MailAsAttachment

True if the merge documents are sent as attachments when the mail merge destination is an e-mail message or a fax. Read/write Boolean.

MailFormat

Returns a WdMailMergeMailFormat constant that represents the format to use when the mail merge destination is an e-mail message. Read/write.

MailSubject

Returns or sets the subject line used when the mail merge destination is electronic mail. Read/write String.

MainDocumentType

Returns or sets the mail merge main document type. Read/write WdMailMergeMainDocType.

Parent

Returns an Object that represents the parent object of the specified MailMerge object.

ShowSendToCustom

Returns or sets a String corresponding to the caption on a custom button on the Complete the merge step (step six) of the Mail Merge Wizard. Read/write.

State

Returns the current state of a mail merge operation. Read-only WdMailMergeState.

SuppressBlankLines

True if blank lines are suppressed when mail merge fields in a mail merge main document are empty. Read/write Boolean.

ViewMailMergeFieldCodes

True if merge field names are displayed in a mail merge main document. False if information from the current record is displayed. Read/write Long.

WizardState

Returns or sets a Long indicating the current Mail Merge Wizard step for a document. The WizardState method returns a number that equates to the current Mail Merge Wizard step; a zero (0) means the Mail Merge Wizard is closed. Read/write.