aspose.cells

aspose.cells

Class ExternalLink

Represents an external link in a workbook.

Example:

//Open a file with external links
$workbook = new cells\Workbook("book1.xls");
//Get External Link 
$externalLink = $workbook->getWorksheets()->getExternalLinks()->get(0);
//Change External Link's Data Source
$externalLink->setDataSource("link.xls");

Property Getters/Setters Summary
functiongetDataSource()
function
setDataSource(value)
           Represents data source of the external link.
functionisReferred()
Indicates whether this external link is referenced by others.
functionisVisible()
Indicates whether this external link is visible in MS Excel.
functiongetOriginalDataSource()
function
setOriginalDataSource(value)
           Represents stored data source of the external link.
functiongetType()
Gets the type of external link. The value of the property is ExternalLinkType integer constant.
 
Method Summary
functionaddExternalName(text, referTo)
Adds an external name.
 

    • Property Getters/Setters Detail

      • getType : Number 

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

      • getOriginalDataSource/setOriginalDataSource : String 

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

      • getDataSource/setDataSource : String 

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

      • isReferred : boolean 

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

      • isVisible : boolean 

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

    • Method Detail

      • addExternalName

        function 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.