RedactParameters
Overlays a black or white rectangle on the image to redact the current field or the specified region of a page.
Syntax
bool RedactParameters (string FillColor, string NewText, string TopLeftX, string TopLeftY, string BottomRightX, string BottomRightY)Parameters
stringstring FillColor
string NewText
string TopLeftX
string TopLeftY
string BottomRightX
string BottomRightY
Parameters
- FillColor The fill color to use. Must be either White, or Black.
- NewText Optional - The text to include in the overlay.
- TopLeftX The upper left X coordinate in pixels.
- TopLeftY The upper left Y coordinate in pixels.
- BottomRightX The lower right X coordinate in pixels.
- BottomRightY The lower right Y coordinate in pixels.
Smart parameters are supported for all parameters.
Returns
True, if the area is redacted. Otherwise, False.Level
Page and Field level.Details
This action overlays a black, or white rectangle on the image. A default text value might optionally be applied to the overlay.If run on the field level, the entire field is redacted and the last four X/Y parameters are ignored.
If run on the page level the last four parameters to specify the location must be provided.
- Example:
Redact("black","","0","0","100","100")Called at the page level, this applies a black square overlay on the upper left of the image.
Redact("White","Hello","","","","")Called at the field level, this applies a white square overlay on the coordinates for the current field, and imprint the word "Hello".