RegexRedaction Leave feedback
On this page
Inheritance: java.lang.Object, com.groupdocs.redaction.Redaction, com.groupdocs.redaction.redactions.TextRedaction
public class RegexRedaction extends TextRedaction
Represents a text redaction that searches and replaces text in the document by matching provided regular expression.
Learn more
- More details about applying redactions: Redaction basics
- More details about document text redactions: Text redactions
| Constructor | Description |
|---|---|
| RegexRedaction(String pattern, ReplacementOptions options) | Initializes a new instance of RegexRedaction class. |
| RegexRedaction(Pattern regex, ReplacementOptions options) | Initializes a new instance of RegexRedaction class. |
| Method | Description |
|---|---|
| getRegularExpression() | Gets the regular expression to match. |
| getDescription() | Returns a string, describing the redaction and its parameters. |
| applyTo(DocumentFormatInstance formatInstance) | Applies the redaction to a given format instance. |
public RegexRedaction(String pattern, ReplacementOptions options)
Initializes a new instance of RegexRedaction class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pattern | java.lang.String | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options (textual, color) |
public RegexRedaction(Pattern regex, ReplacementOptions options)
Initializes a new instance of RegexRedaction class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| regex | java.util.regex.Pattern | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options (textual, color) |
public final Pattern getRegularExpression()
Gets the regular expression to match.
Returns: java.util.regex.Pattern - The regular expression to match.
public String getDescription()
Returns a string, describing the redaction and its parameters.
Returns: java.lang.String - Text, containing redaction name and parameters.
public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)
Applies the redaction to a given format instance.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| formatInstance | DocumentFormatInstance | An instance of a document to apply redaction |
Returns: RedactorLogEntry - Status of the redaction: success/failure and error message if any
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
