asposecells.api

asposecells.api

Class ExternalLink

Represents an external link in a workbook.

Example:

# Open a file with external links
workbook = Workbook("ExternalFormula.xlsx")

# Get External Link 
externalLink = workbook.getWorksheets().getExternalLinks().get(0)

# Change External Link's Data Source
externalLink.setDataSource("Book1.xlsx")

Property Getters/Setters Summary
methodgetDataSource()
method
setDataSource(value)
           Represents data source of the external link.
methodisReferred()
Indicates whether this external link is referenced by others.
methodisVisible()
Indicates whether this external link is visible in MS Excel.
methodgetOriginalDataSource()
method
setOriginalDataSource(value)
           Represents stored data source of the external link.
methodgetType()
Gets the type of external link. The value of the property is ExternalLinkType integer constant.
 
Method Summary
methodaddExternalName(text, referTo)
Adds an external name.
 

    • Property Getters/Setters Detail

      • getType : int 

        int getType()
        Gets the type of external link. The value of the property is ExternalLinkType integer constant.

      • getOriginalDataSource/setOriginalDataSource : String 

        String getOriginalDataSource() / setOriginalDataSource(value)
        Represents stored data source of the external link.

      • getDataSource/setDataSource : String 

        String getDataSource() / setDataSource(value)
        Represents data source of the external link.

      • isReferred : boolean 

        boolean isReferred()
        Indicates whether this external link is referenced by others.

      • isVisible : boolean 

        boolean isVisible()
        Indicates whether this external link is visible in MS Excel.

    • Method Detail

      • addExternalName

         addExternalName(text, referTo)
        Adds an external name.
        Parameters:
        text: String - The text of the external name. If the external name belongs to a worksheet, the text should be as Sheet1!Text.
        referTo: String - The referTo of the external name. It must be a cell or the range.