com.groupdocs.redaction.integration

Interface 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

Method Summary

Modifier and Type	Method and Description
int	getSheetIndex(String sheetName) Gets the worksheet index by worksheet name, if possible.
RedactionResult	replaceInColumn(Pattern regularExpression, String replacement, int column) Replaces all matches with a given replacement in the specified column on all worksheets.
RedactionResult	replaceInColumn(Pattern regularExpression, String replacement, int column, int sheet) Replaces all matches with a given replacement in the specified column and worksheet.

Method Detail

getSheetIndex

int getSheetIndex(String sheetName)

Gets the worksheet index by worksheet name, if possible.

Parameters:

sheetName - Worksheet name

Returns:

Worksheet index or -1 if not found

replaceInColumn

RedactionResult replaceInColumn(Pattern regularExpression,
                                String replacement,
                                int column)

Replaces all matches with a given replacement in the specified column on all worksheets.

Parameters:

regularExpression - Regular expression to search and replace

replacement - Textual replacement

column - Zero-based column index

Returns:

Replacement result

replaceInColumn

RedactionResult replaceInColumn(Pattern regularExpression,
                                String replacement,
                                int column,
                                int sheet)

Replaces all matches with a given replacement in the specified column and worksheet.

Parameters:

regularExpression - Regular expression to search and replace

replacement - Textual replacement

column - Zero-based column index

sheet - Zero-based worksheet index

Returns:

Replacement result