TifMerge_MergeImages

Syntax

bool TifMerge_MergeImages (sPageType)

Parameters

String value indicating either:

1. All if the multi-Image file is to contain images of all pages without regard to Page Type.
2. The Page Type(s) of the images to be included (comma-separated list, if the parameter includes more than one Page Type.)

Smart parameters are supported.

Returns

False if the action cannot create the multi-Image file. Otherwise, True.

Level

Batch or Document.

Details

This action merges the images associated with the object to which the action’s rule applies into a single, multi-Image file.

At the Batch level, the action merges all Image files in the batch into one multi-Image file – or those Image files representing pages of the Page Type you specify as a parameter. At the Document level, the action assembles a new multi-Image file for each document in the batch. If you specify a Page Type, the multi-Image file for each document will include only images of pages of that type.

Actions TifMerge_SetFileName and TifMerge_SetFilePath must be called before TifMerge_MergeImages.

Example

TifMerge_SetFileName("@BATCHID+@DATE(dd.mm.yyyy)")
TifMerge_SetFilePath("C:\ParentDir\Invoice\batches\MultiImage")
TifMerge_MergeImages("All")

TifMerge_SetFileName("Doc_+@ID+@DATE(dd.mm.yyyy)")
TifMerge_SetFilePath("C:\ParentDir\Invoice\MultiImage")
TifMerge_MergeImages("Invoice,Attachment")      

The first example merges all images into a multi-Image file that uses the Batch ID and the processing Date for its name.

The second example applies to a Document object of the Document Hierarchy. It assembles a multi-Image file for each document in the batch; the images in a file are limited to Invoice and Attachment pages.