ImageAreaRedaction - GroupDocs.Redaction for Java - API Reference

Packages

java.lang.Object
- com.groupdocs.redaction.Redaction
- - com.groupdocs.redaction.redactions.ImageAreaRedaction

```
public class ImageAreaRedaction
extends Redaction
```
Represents a redaction that places colored rectangle in given area of an image document.

Learn more
- More details about applying redactions: Redaction basics
- More details about image redactions: Image redactions

Constructor Summary

Constructors
Constructor and Description
`ImageAreaRedaction(Point topLeft, RegionReplacementOptions options)` Initializes a new instance of ImageAreaRedaction class for redacting specific area size.

Method Summary

Methods
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.
`RegionReplacementOptions`	`getOptions()` Gets the `RegionReplacementOptions` options with color and area parameters.
`Point`	`getTopLeft()` Gets the top-left position of the area to remove

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ImageAreaRedaction
```
public ImageAreaRedaction(Point topLeft,
                  RegionReplacementOptions options)
```
    Initializes a new instance of ImageAreaRedaction class for redacting specific area size.
    
    Parameters:
    topLeft - Top-left area coordinates
    options - Area size and color
- Method Detail
  - getOptions
```
public final RegionReplacementOptions getOptions()
```
    Gets the RegionReplacementOptions options with color and area parameters.
    
    Returns:
    The RegionReplacementOptions options with color and area parameters.
  - getTopLeft
```
public final Point getTopLeft()
```
    Gets the top-left position of the area to remove
    
    Returns:
    The top-left position of the area to remove
  - 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.
  - 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