SetMergeFileName

Sets the name of the multi-Image file (.tif) to be created.

Syntax

bool SetMergeFileName (string MultiPageFileName)

Parameters

MultiPageFileName: The name of the new image file to create. If the destination directory has not been set by calling the action SetMergeOutputDirectory, then the file will be created in the current batch directory by default.
Smart parameters are supported.

Returns

Always True

Level

All

Details

This action sets the name of the multi-Image TIFF file to be created by the action AddCurrentPageImageToMultiplePageTIFFImage and MergeToMultiplePageTIFFImage. Smart parameters can be used allowing the file name to be a combination of text and data evaluated at runtime. If not provided, the action automatically adds the “.tif” extension to the file.

Once set, the name is in effect for the remainder of the task, unless the action is called again to change the output name. Once the task completes, the name will have to be configured again in a following ruleset if more images are merged.

Example 1

SetMergeFileName("Doc_+@ID+@DATE(dd.mm.yyyy)")
SetMergeOutputDirectory("c:\ParentDir\Invoice\MultiImage")
MergeToMultiplePageTIFFImage("")

The example above assumes that the rules with these actions are attached to a Document object. The names combine text values such as “Doc_” with values assigned to variables by using smart parameters to concatenate the current document ID and current date as the name of the output file.

Example 2

SetMergeFileName("MultiTif_+@ID")

This example combines "MultiTif_" with the ID of the Document Hierarchy object to which the ruleset is associated.