com.groupdocs.redaction.redactions

Class DeleteAnnotationRedaction

java.lang.Object

com.groupdocs.redaction.Redaction

com.groupdocs.redaction.redactions.DeleteAnnotationRedaction

public class DeleteAnnotationRedaction
extends Redaction

Represents a text redaction that deletes annotations if text is matching given regular expression (optionally deletes all annotations).

Learn more

• More details about applying redactions: Redaction basics
• More details about document annotation redactions: Annotation redactions

The following example demonstrates how to remove all annotations containing words "use", "show" or "describe" from document (and leave others).

try (Redactor redactor = new Redactor("D:\\test.docx"))
 {
    redactor.apply(new DeleteAnnotationRedaction("(?im:(use|show|describe))"));
    redactor.save()
 }
  

Constructor Summary

Constructors

Constructor and Description
DeleteAnnotationRedaction() Initializes a new instance of DeleteAnnotationRedaction class, with settings to delete all annotations (matching everything).
DeleteAnnotationRedaction(Pattern regex) Initializes a new instance of DeleteAnnotationRedaction class, deleting annotations matching given expression.
DeleteAnnotationRedaction(String pattern) Initializes a new instance of DeleteAnnotationRedaction class, deleting annotations matching given expression.

Method Summary

Modifier and Type	Method and Description
RedactorLogEntry	applyTo(DocumentFormatInstance formatInstance) Applies the redaction to a given format instance.
String	getDescription() Returns a string, describing the redaction and its parameters.
Pattern	getExpression() Gets the regular expression to match.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteAnnotationRedaction

public DeleteAnnotationRedaction()

Initializes a new instance of DeleteAnnotationRedaction class, with settings to delete all annotations (matching everything).

DeleteAnnotationRedaction

public DeleteAnnotationRedaction(Pattern regex)

Initializes a new instance of DeleteAnnotationRedaction class, deleting annotations matching given expression.

Parameters:

regex - Regular expression

DeleteAnnotationRedaction

public DeleteAnnotationRedaction(String pattern)

Initializes a new instance of DeleteAnnotationRedaction class, deleting annotations matching given expression.

Parameters:

pattern - Regular expression

Method Detail

applyTo

public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)

Applies the redaction to a given format instance.

Specified by:

applyTo in class Redaction

Parameters:

formatInstance - An instance of a document to apply redaction

Returns:

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

getDescription

public String getDescription()

Returns a string, describing the redaction and its parameters.

Overrides:

getDescription in class Redaction

Returns:

Text, containing redaction name and parameters.

getExpression

public final Pattern getExpression()

Gets the regular expression to match.

Returns:

The regular expression to match.