PSPDFRedactionAnnotation

Objective-C


@interface PSPDFRedactionAnnotation : PSPDFAnnotation <PSPDFOverridable>

Swift

class RedactionAnnotation : Annotation, Overridable

Redaction Annotation

Used to remove content from a document.

color can be used to change the color of the overlay text. It has no effect if there is no overlay text specified. Defaults to a red color. fillColor specifies the background color of the redaction area after is has been applied. The color is drawn on all the specified rects. Defaults to black. lineWidth can be set to change the border width of the redaction in its marked state. Defaults to 5.

Note

Supports redacting text, images, paths, annotations, and forms.

Note

Redaction annotations need to be applied, after they were created and added to a document, to remove the content beneath them. See PSPDFProcessorConfiguration or PSPDFDocumentSaveOptionApplyRedactions for further information.

Warning

When programmatically creating a redaction annotation, both boundingBox and rects need to be set. The rects array contains boxed variants of CGRect (NSValue).

  • Specifies the color used for the redaction’s border in its marked state. Defaults to a red color.

    Declaration

    Objective-C

    @property (nullable) NSColor *outlineColor;

    Swift

    var outlineColor: NSColor? { get set }

  • Can be used to set the text that should be displayed at the specified rects when a redaction has been applied. Defaults to nil.

    Declaration

    Objective-C

    @property (copy, nullable) NSString *overlayText;

    Swift

    var overlayText: String? { get set }

  • Defines if the overlay text should be drawn only once, or repeated to fill the whole bounding box. Defaults to disabled, which means the overlay text is only drawn once.

    Note

    This property has no effect if there is no overlay text set.

    Declaration

    Objective-C

    @property BOOL repeatOverlayText;

    Swift

    var repeatOverlayText: Bool { get set }