dci_clipfield
During processing, clips the field on the Image file (.tif) of every source page represented by the bound Field object of the Document Hierarchy and generates a separate Image file (.tif) displaying the clipped field's contents.
Syntax
bool dci_clipfield (strParam)Parameters
Two comma-separated string values:- The Page Type that is to be assigned to the Image file containing
the clipped field and its value. Remember: The new Image file is represented by a new page in the current Page file. The Page Type value you assign will be used to identify pages with clipped fields.
- The Page Status to be assigned to pages with clipped images of
the bound Field object of the Document Hierarchy. Attention: Be sure that the status you assign conforms to Page Status specifications used throughout your application.
Returns
False if either parameter is invalid. Otherwise True.If the dci_clipfield action cannot locate the target field on a source page, the action will not generate an Image file for the clipped field and will not add a corresponding page to the current Page file (.xml).
Level
Field level only.Details
During processing, clips the field on the Image file (.tif) of every source page represented by the bound Field object of the Document Hierarchy and generates a separate Image file (.tif) displaying the clipped field's contents.The action also adds a page representing the new Image file to the current Page file.
Attention: If the Image ID assigned to the Image
file representing the source page has this format: tm000001.tif. The
Image ID of a clipped field's Image file adds one underscore character
and a two digit index and has this format: tm000001_01.tif
The second pair in the batch will have these ID's: tm000002.tif and tm000002_01.tif. This assumes that a source page has only one clipped field.
- Example
dci_clipfield(OfficePens_Page, 0)