Data Tools: Mail Merge

  • 2 minutes to read

The commands available in the Mail Merge section of the Data Tools toolbar are divided into the following categories.

Data

Command

Large Icon

Small Icon

Description

Data Source

icon-toolbar-mail-merge-data-source

icon-small-toolbar-mail-merge-data-source

Enables mail merge for a connected data source.

After enabling this mode, the data source icon is displayed in green in the Data Explorer.

snap-data-source-enable-mail-merge-reporting

There is no functionality for disabling mail merge once it has been implemented.

Filter

icon-toolbar-mail-merge-filter

icon-small-toolbar-mail-merge-filter

Invokes the FilterString Editor to filter data in a mail merge document.

snap-dialog-filter-string

Sort

icon-toolbar-mail-merge-sort

icon-small-toolbar-mail-merge-sort

Invokes the Sort dialog to sort data in a mail merge document.

snap-dialog-sort-mail-merge

Current Record

Command

Description

icon-toolbar-mail-merge-current-record

Current Record

Allows you to navigate through records in a mail merge document. You can navigate to the Next Page, the Previous Page, the First Page or the Last Page.

Publish

Command

Large Icon

Small Icon

Description

Finish & Merge

icon-toolbar-mail-merge-finish-and-merge

icon-small-toolbar-mail-merge-merge

Finalizes a mail merge document by supplying actual values to data elements added to a document template.

This command invokes a drop-down menu to select the publishing format of a document. The following options are available.

  • Export - exports the created document to a selected third-party format;

  • Print - invokes the print dialog to adjust the page options of the document before sending it to a printer;

  • Print Preview - displays the created document in a print preview window that provides options to navigate, print and/or export the document.

After selecting the document's output format, the Export Range dialog is invoked to specify the range of data records that the document should include.

snap-mail-merge-export-range-dialog

In this dialog, you can choose from the following separators to isolate different data records.

  • None;

  • Page Break;

  • Section (Next Page);

  • Section (Even Page);

  • Section (Odd Page);

  • Paragraph.

To learn how to provide custom separators, refer to the following online code example: How to provide custom separators for records of a mail-merge document.

After clicking OK, Snap starts assembling the document. To avoid application lock-ups, the document is assembled in a separate background thread.

snap-mail-merge-background-performing-separate-thread

To implement a custom progress indicator, refer to the following online code example: How to add a custom progress indicator to a Snap application.

See Also