com.groupdocs.redaction.redactions

Class PageAreaRedaction

java.lang.Object

com.groupdocs.redaction.Redaction

com.groupdocs.redaction.redactions.TextRedaction

com.groupdocs.redaction.redactions.RegexRedaction

com.groupdocs.redaction.redactions.PageAreaRedaction

public class PageAreaRedaction
extends RegexRedaction

Represents a complex textual redaction that affects text, images and annotations in an area of the page.

Learn more

• More details about document metadata redactions: Redaction basics
• More details about PageAreaRedaction: Use PageAreaRedaction

Constructor Summary

Constructors

Constructor and Description
PageAreaRedaction(Pattern regex, ReplacementOptions options) Initializes a new instance of PageAreaRedaction class.
PageAreaRedaction(Pattern regex, ReplacementOptions options, RegionReplacementOptions imageOptions) Initializes a new instance of PageAreaRedaction class.

Method Summary

Modifier and Type	Method and Description
RedactorLogEntry	applyTo(DocumentFormatInstance formatInstance) Applies the redaction to a given format instance.
RegionReplacementOptions	getImageOptions() Gets the RegionReplacementOptions options with color and area parameters.

Methods inherited from class com.groupdocs.redaction.redactions.RegexRedaction

getDescription, getRegularExpression

Methods inherited from class com.groupdocs.redaction.redactions.TextRedaction

getActionOptions, getOcrConnector, processAsTextual, setOcrConnector

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PageAreaRedaction

public PageAreaRedaction(Pattern regex,
                         ReplacementOptions options)

Initializes a new instance of PageAreaRedaction class.

Parameters:

regex - Regular expression to search and replace

options - Replacement options (textual, color)

PageAreaRedaction

public PageAreaRedaction(Pattern regex,
                         ReplacementOptions options,
                         RegionReplacementOptions imageOptions)

Initializes a new instance of PageAreaRedaction class.

Parameters:

regex - Regular expression to search and replace

options - Replacement options (textual, color)

imageOptions - Replacement options (image area)

Method Detail

applyTo

public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
                         throws Exception

Applies the redaction to a given format instance.

Overrides:

applyTo in class RegexRedaction

Parameters:

formatInstance - An instance of a document to apply redaction

Returns:

Status of the redaction: success/failure and error message if any

Throws:

Exception

getImageOptions

public final RegionReplacementOptions getImageOptions()

Gets the RegionReplacementOptions options with color and area parameters.

Returns:

The RegionReplacementOptions options with color and area parameters.