PageAreaRedaction Leave feedback
On this page
Inheritance: java.lang.Object, com.groupdocs.redaction.Redaction, com.groupdocs.redaction.redactions.TextRedaction, com.groupdocs.redaction.redactions.RegexRedaction
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 | 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 | Description |
|---|---|
| getImageOptions() | Gets the RegionReplacementOptions options with color and area parameters. |
| applyTo(DocumentFormatInstance formatInstance) | Applies the redaction to a given format instance. |
public PageAreaRedaction(Pattern regex, ReplacementOptions options)
Initializes a new instance of PageAreaRedaction class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| regex | java.util.regex.Pattern | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options (textual, color) |
public PageAreaRedaction(Pattern regex, ReplacementOptions options, RegionReplacementOptions imageOptions)
Initializes a new instance of PageAreaRedaction class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| regex | java.util.regex.Pattern | Regular expression to search and replace |
| options | ReplacementOptions | Replacement options (textual, color) |
| imageOptions | RegionReplacementOptions | Replacement options (image area) |
public final RegionReplacementOptions getImageOptions()
Gets the RegionReplacementOptions options with color and area parameters.
Returns: RegionReplacementOptions - The RegionReplacementOptions options with color and area 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.
