CellFilter Leave feedback
On this page
Inheritance: java.lang.Object
public class CellFilter
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
| Constructor | Description |
|---|---|
| CellFilter() | Initializes a new instance. |
| Field | Description |
|---|---|
| NoIndex | Represents a default value for filter, which is -1. |
| Method | Description |
|---|---|
| getWorkSheetName() | Gets a worksheet name (if applicable). |
| setWorkSheetName(String value) | Sets a worksheet name (if applicable). |
| getWorkSheetIndex() | Gets a worksheet index (zero-based). |
| setWorkSheetIndex(int value) | Sets a worksheet index (zero-based). |
| hasWorkSheetIndex() | Gets a value indicating whether the WorkSheetIndex is set or not. |
| getColumnIndex() | Gets a column index (zero-based). |
| setColumnIndex(int value) | Sets a column index (zero-based). |
public CellFilter()
Initializes a new instance.
public static final int NoIndex
Represents a default value for filter, which is -1.
public final String getWorkSheetName()
Gets a worksheet name (if applicable).
Returns: java.lang.String - A worksheet name (if applicable).
public final void setWorkSheetName(String value)
Sets a worksheet name (if applicable).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | A worksheet name (if applicable). |
public final int getWorkSheetIndex()
Gets a worksheet index (zero-based).
Returns: int - A worksheet index (zero-based).
public final void setWorkSheetIndex(int value)
Sets a worksheet index (zero-based).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | A worksheet index (zero-based). |
public final boolean hasWorkSheetIndex()
Gets a value indicating whether the WorkSheetIndex is set or not.
Returns: boolean - A value indicating whether the WorkSheetIndex is set or not.
public final int getColumnIndex()
Gets a column index (zero-based).
Returns: int - A column index (zero-based).
public final void setColumnIndex(int value)
Sets a column index (zero-based).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | A column index (zero-based). |
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.
