Class CellColumnRedaction - groupdocs.redaction for Java - API Reference

Packages

java.lang.Object
- com.groupdocs.redaction.Redaction
- - com.groupdocs.redaction.redactions.TextRedaction
  - - com.groupdocs.redaction.redactions.CellColumnRedaction

```
public class CellColumnRedaction
extends TextRedaction
```
Represents a text redaction that replaces text in a spreadsheet documents (CSV, Excel, etc.).

Constructor Summary

Constructors
Constructor and Description
`CellColumnRedaction(CellFilter filter, Pattern regEx, ReplacementOptions options)` Initializes a new instance of CellColumnRedaction class.

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.
`CellFilter`	`getFilter()` Gets the column and worksheet filter.
`Pattern`	`getPattern()` Gets the regular expression to match.

Methods inherited from class com.groupdocs.redaction.redactions.TextRedaction
getActionOptions

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

- Constructor Detail
  - CellColumnRedaction
```
public CellColumnRedaction(CellFilter filter,
                   Pattern regEx,
                   ReplacementOptions options)
```
    Initializes a new instance of CellColumnRedaction class.
    
    Parameters:
    filter - Column and worksheet filter
    regEx - Regular expression to search and replace
    options - Replacement options
- Method Detail
  - getPattern
```
public final Pattern getPattern()
```
    Gets the regular expression to match.
    
    Returns:
    The regular expression to match.
  - getFilter
```
public final CellFilter getFilter()
```
    Gets the column and worksheet filter.
    
    Returns:
    The column and worksheet filter.
  - 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