ReferRangeArea module

class ReferRangeArea.ListReferRangeAreas(ptr)

Bases: IList[ReferRangeArea]

Represents a collection of ReferRangeArea objects.

This class implements the IList interface for ReferRangeArea objects, providing standard collection functionality for working with multiple range references. It is typically used to manage multiple range references in formulas or named ranges.

class ReferRangeArea.ReferRangeArea

Bases: SpireObject

Represents a referenced range area in an Excel worksheet.

This class encapsulates information about a range reference in Excel, including the sheet name, start and end positions of the range, and whether it’s an external reference. It is typically used in formulas and named ranges to identify cell ranges.

property EndColumn: int

Gets the ending column index of the referenced range.

Returns:

The zero-based index of the last column in the range.

Return type:

int

property EndRow: int

Gets the ending row index of the referenced range.

Returns:

The zero-based index of the last row in the range.

Return type:

int

property ExternalFileName: str

Gets the file name of the external workbook when IsExternalLink is True.

Returns:

The file name of the external workbook, or an empty string if not applicable.

Return type:

str

Gets whether this range reference links to an external workbook.

Returns:

True if the range reference is to an external workbook; otherwise, False.

Return type:

bool

property SheetName: str

Gets the name of the worksheet containing the referenced range.

Returns:

The name of the worksheet.

Return type:

str

property StartColumn: int

Gets the starting column index of the referenced range.

Returns:

The zero-based index of the first column in the range.

Return type:

int

property StartRow: int

Gets the starting row index of the referenced range.

Returns:

The zero-based index of the first row in the range.

Return type:

int