ICellularFormatInstance
public interface ICellularFormatInstance
Defines methods that are required for access to spreadsheet formats, having one or many worksheets.
Learn more
- More details about applying redactions: Redaction basics
- More details about spreadsheet redactions: Spreadsheet redactions
- More details about implementing custom formats: Create custom format handler
Methods
| Method | Description |
|---|---|
| getSheetIndex(String sheetName) | Gets the worksheet index by worksheet name, if possible. |
| replaceInColumn(Pattern regularExpression, String replacement, int column, int sheet) | Replaces all matches with a given replacement in the specified column and worksheet. |
| replaceInColumn(Pattern regularExpression, String replacement, int column) | Replaces all matches with a given replacement in the specified column on all worksheets. |
getSheetIndex(String sheetName)
public abstract int getSheetIndex(String sheetName)
Gets the worksheet index by worksheet name, if possible.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| sheetName | java.lang.String | Worksheet name |
Returns: int - Worksheet index or -1 if not found
replaceInColumn(Pattern regularExpression, String replacement, int column, int sheet)
public abstract RedactionResult replaceInColumn(Pattern regularExpression, String replacement, int column, int sheet)
Replaces all matches with a given replacement in the specified column and worksheet.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| regularExpression | java.util.regex.Pattern | Regular expression to search and replace |
| replacement | java.lang.String | Textual replacement |
| column | int | Zero-based column index |
| sheet | int | Zero-based worksheet index |
Returns: RedactionResult - Replacement result
replaceInColumn(Pattern regularExpression, String replacement, int column)
public abstract RedactionResult replaceInColumn(Pattern regularExpression, String replacement, int column)
Replaces all matches with a given replacement in the specified column on all worksheets.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| regularExpression | java.util.regex.Pattern | Regular expression to search and replace |
| replacement | java.lang.String | Textual replacement |
| column | int | Zero-based column index |
Returns: RedactionResult - Replacement result