com.groupdocs.redaction.redactions

Class TextRedaction

java.lang.Object

com.groupdocs.redaction.Redaction

com.groupdocs.redaction.redactions.TextRedaction

Direct Known Subclasses:

CellColumnRedaction, ExactPhraseRedaction, RegexRedaction

public abstract class TextRedaction
extends Redaction

Represents a base abstract class for document text redactions.

Learn more

• More details about applying redactions: Redaction basics
• More details about document text redactions: Text redactions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TextRedaction(ReplacementOptions actionOptions) Initializes a new instance of TextRedaction class.

Method Summary

Modifier and Type	Method and Description
ReplacementOptions	getActionOptions() Gets the ReplacementOptions instance, specifying type of text replacement.
IOcrConnector	getOcrConnector() Gets the IOcrConnector implementation, required to extract text from graphic content.
protected RedactorLogEntry	processAsTextual(DocumentFormatInstance formatInstance, Pattern regex) This method applies a given Regular Expression to an instance of the doucument, if it implements ITextualFormatInstance interface and returns RedactionStatus.Skipped otherwise.
void	setOcrConnector(IOcrConnector value) Sets the IOcrConnector implementation, required to extract text from graphic content.

Methods inherited from class com.groupdocs.redaction.Redaction

applyTo, getDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

TextRedaction

protected TextRedaction(ReplacementOptions actionOptions)

Initializes a new instance of TextRedaction class. This constructor requires ReplacementOptions as a parameter.

Parameters:

actionOptions - Text replacement options (exemption code or box color)

Method Detail

getActionOptions

public final ReplacementOptions getActionOptions()

Gets the ReplacementOptions instance, specifying type of text replacement.

Returns:

The ReplacementOptions instance, specifying type of text replacement.

getOcrConnector

public final IOcrConnector getOcrConnector()

Gets the IOcrConnector implementation, required to extract text from graphic content.

Returns:

The IOcrConnector implementation, required to extract text from graphic content.

processAsTextual

protected final RedactorLogEntry processAsTextual(DocumentFormatInstance formatInstance,
                                                  Pattern regex)

This method applies a given Regular Expression to an instance of the doucument, if it implements ITextualFormatInstance interface and returns RedactionStatus.Skipped otherwise.

Parameters:

formatInstance - An instance of a document

regex - Regular expression to search and replace

Returns:

Text replacement result

setOcrConnector

public final void setOcrConnector(IOcrConnector value)

Sets the IOcrConnector implementation, required to extract text from graphic content.

Parameters:

value - The IOcrConnector implementation, required to extract text from graphic content.