com.groupdocs.redaction.redactions

Class CellFilter

java.lang.Object

com.groupdocs.redaction.redactions.CellFilter

public class CellFilter
extends Object

Provides an option to limit the scope of a CellColumnRedaction to a worksheet and a column.

Learn more

• More details about spreadsheet redactions: Spreadsheet redactions

Field Summary

Fields

Modifier and Type	Field and Description
static int	NoIndex Represents a default value for filter, which is -1.

Constructor Summary

Constructors

Constructor and Description
CellFilter() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
int	getColumnIndex() Gets a column index (zero-based).
int	getWorkSheetIndex() Gets a worksheet index (zero-based).
String	getWorkSheetName() Gets a worksheet name (if applicable).
boolean	hasWorkSheetIndex() Gets a value indicating whether the WorkSheetIndex is set or not.
void	setColumnIndex(int value) Sets a column index (zero-based).
void	setWorkSheetIndex(int value) Sets a worksheet index (zero-based).
void	setWorkSheetName(String value) Sets a worksheet name (if applicable).

Methods inherited from class java.lang.Object

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

Field Detail

NoIndex

public static final int NoIndex

Represents a default value for filter, which is -1.

See Also:

Constant Field Values

Constructor Detail

CellFilter

public CellFilter()

Initializes a new instance.

Method Detail

getColumnIndex

public final int getColumnIndex()

Gets a column index (zero-based).

Returns:

A column index (zero-based).

getWorkSheetIndex

public final int getWorkSheetIndex()

Gets a worksheet index (zero-based).

Returns:

A worksheet index (zero-based).

getWorkSheetName

public final String getWorkSheetName()

Gets a worksheet name (if applicable).

Returns:

A worksheet name (if applicable).

hasWorkSheetIndex

public final boolean hasWorkSheetIndex()

Gets a value indicating whether the WorkSheetIndex is set or not.

Returns:

A value indicating whether the WorkSheetIndex is set or not.

setColumnIndex

public final void setColumnIndex(int value)

Sets a column index (zero-based).

Parameters:

value - A column index (zero-based).

setWorkSheetIndex

public final void setWorkSheetIndex(int value)

Sets a worksheet index (zero-based).

Parameters:

value - A worksheet index (zero-based).

setWorkSheetName

public final void setWorkSheetName(String value)

Sets a worksheet name (if applicable).

Parameters:

value - A worksheet name (if applicable).