Overlay
Combines the current image with the image file specified by the SetBackgroundImage action into a new image replacing the current image. This action is used to reinstate a form background that was dropped out during scanning.
Syntax
bool Overlay ()Parameters
None.- The parameter of the preceding SetBackgroundImage action can be a smart parameter that locates a file.
- Looks for a field type called Image_Offset or IMAGEOVERLAYOFFSET containing a comma separated value containing the amount of X and Y pixel offset for the overlay image.
These fields are automatically generated by running FindFingerprint, CalculateOffset, WordFind_Offset, CalculateLocalOffset, Autofield(), and most of the PatternMatch.rrx actions.
Returns
False if the action is not applied to a Page object; if it cannot locate the Background Image file; or if the action encounters an error of a different kind. Otherwise, True.Level
Page level only.Details
- Example:
SetBackgroundImage(c:\ParentDir\mclaims\process\hcfa\hcfa.tif) Overlay()In this example, the Overlay action uses the file name and path in the parameter of the SetBackgroundImage action to locate the Background Image file.
SetBackgroundImage((@APPPATH(formdir)+\+ub04.tif) Overlay()Here, the SetBackgroundImage action uses a smart parameter to load the file name with the directory path coming from the application service.
Note: SetBackgroundImagemust be called before Overlay. Other actions such as SetHaloBackground and SetDithering are optional and, if used, should precede the call to the Overlay action.