Redact (deprecated)

Important: This action is deprecated and scheduled to be removed in a future release. Use the RedactParameters action in the Imprint library. For more information, see RedactParameters.

Syntax

(StrParam)

Parameters

Six comma-separated parameters:
  1. The fill color to use. Must be either White, or Black.
  2. Optional - The text to include in the overlay.
  3. The upper left X coordinate in pixels.
  4. The upper left Y coordinate in pixels.
  5. The lower right X coordinate in pixels.
  6. The lower right Y coordinate in pixels.

Returns

True, if the area is redacted. Otherwise, False.

Level

Page and Field

Details

This action overlays a black or white rectangle on the image. A default text value can optionally be applied to the overlay. If run on the field level, the entire field is redacted and the last four parameters are ignored. If run on the page level, the last four parameters to specify the location must be included.

Example:
Redact("white,") - Applies a white overlay using the current field position

Redact("black,,0,0,100,100") - Applies a black square overlay on the top left of the image