ExternalLink module

class ExternalLink.ExternalLink

Bases: XlsObject

Represents an external link in an Excel workbook.

This class provides functionality to manage external links to other workbooks or data sources. External links allow data to be referenced from external sources and updated when the workbook is opened or when links are refreshed.

AddExternalName(text: str, referTo: str)

Adds an external name to the external link.

External names are defined names that reference cells or ranges in external workbooks.

Parameters:

• text (str) – The name of the external reference.

• referTo (str) – The formula or reference that the external name points to.

property DataSource: str

Gets or sets the data source path for the external link.

The data source typically represents the path to the external workbook or data file.

Returns:

The path to the external data source.

Return type:

str

property IsReferred: bool

Gets whether the external link is being referenced by any formulas or other elements.

Returns:

True if the external link is being referenced; otherwise, False.

Return type:

bool

property IsVisible: bool

Gets whether the external link is visible in the workbook.

Returns:

True if the external link is visible; otherwise, False.

Return type:

bool