ZoneImage_SaveAs

Saves the current Objects Zone area of an image as a separate Image file.

Syntax

bool ZoneImage_SaveAs (StrFileName)

Parameters

A string that defines the file name.
You can use these options to format the file name:
  • +@BATCHID : Adds the BatchID to the Zone Image File Name
  • +@ID : Adds the Object ID to the Zone Image File Name
  • +@STATUS : Adds the Object Status to the Zone Image File Name
  • +@TYPE : Adds the Object Type to Zone Image File Name
  • +@DATE+mm/dd/yyyy : Adds a Date Stamp to the Zone Image File Name, the required trailing date format argument shows as the default, also '+*' can be used
  • +@TIME+HH:MM:SS : Adds a Time Stamp Value to the Zone Image File Name, the required trailing time format argument shows as the default, also '+*' can be used
  • +@VALUE : Adds Object Text to Zone Image File Name
  • +#name : Appends the value of a child name to the Image File Name
Smart parameters are supported.
Attention: +#name appends the value of child name to the image name.

Returns

False if an image cannot be saved. Otherwise, True.

Level

Page or Field level.

Details

Saves the current Objects Zone area of an image as a separate Image file. The Zone Image file is always placed in the Batches directory; saving to the current page creates a multi-page TIFF file with the additional image as its zone.
Example
ZoneImage_SaveAs("SAMMY+@TYPE+@DATE+JJJ")

As part of a rule bound to the Details Field object of the Document Hierarchy, the action produces this Image File Name: ...\SAMMYDETAILS243.tif.