com.aspose.cells

Class ExternalLinkCollection

java.lang.Object

com.aspose.cells.ExternalLinkCollection

All Implemented Interfaces:

java.lang.Iterable

public class ExternalLinkCollection
extends java.lang.Object
implements java.lang.Iterable

Represents external links collection in a workbook.

Example

 
         //Open a file with external links
         Workbook workbook = new Workbook("book1.xls");
 
         //Change external link data source
         workbook.getWorksheets().getExternalLinks().get(0).setDataSource("d:\\link.xls");
 

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int directoryType, java.lang.String fileName, java.lang.String[] sheetNames) Add an external link .
int	add(java.lang.String fileName, java.lang.String[] sheetNames) Adds an external link.
void	clear() Removes all external links.
void	clear(boolean updateReferencesAsLocal) Removes all external links.
ExternalLink	get(int index) Gets the ExternalLink element at the specified index.
int	getCount() Gets the number of elements actually contained in the collection.
java.util.Iterator	iterator() Get an enumerator that iterates through this collection.
void	removeAt(int index) Removes the specified external link from the workbook.
void	removeAt(int index, boolean updateReferencesAsLocal) Removes the specified external link from the workbook.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCount

public int getCount()

Gets the number of elements actually contained in the collection.

add

public int add(java.lang.String fileName,
      java.lang.String[] sheetNames)

Adds an external link.

Parameters:

fileName - The external file name.

sheetNames - All sheet names of the external file.

Returns:

The position of the external name in this list.

add

public int add(int directoryType,
      java.lang.String fileName,
      java.lang.String[] sheetNames)

Add an external link .

Parameters:

directoryType - DirectoryType. The directory type of the file name.

fileName - the file name.

sheetNames - All sheet names of the external file.

Returns:

The position of the external name in this list.

get

public ExternalLink get(int index)

Gets the ExternalLink element at the specified index.

Parameters:

index - The zero based index of the element.

Returns:

The element at the specified index.

clear

public void clear()

Removes all external links.

Remarks

When removing external links, all formulas that reference to them will be removed too because the references become invalid.

clear

public void clear(boolean updateReferencesAsLocal)

Removes all external links.

Remarks

If references are required to be updated, those references of external links in formulas will be changed to current workbook when it is possible. For example, one cell's original formula is "='externalsource.xlam'!customfunction()", after removing external links, the formula will become "=customfunction()"; When the original formula is "='[externalsource.xlam]Sheet1'!$A$1", according to whether there is one sheet with name "Sheet1" in current workbook: if true, the formula will become "=Sheet1!$A$1"; if false, the formula will become "=#REF!$A$1".

If references are not required to be updated, all formulas with references to external links will be removed too because those references become invalid.

Parameters:

updateReferencesAsLocal - Whether update all references of external links in formulas to references of current workbook itself.

removeAt

public void removeAt(int index)

Removes the specified external link from the workbook.

Remarks

When removing the external link, all formulas that reference to it will be removed too because the references become invalid.

Parameters:

index - the index of the external link to be removed.

removeAt

public void removeAt(int index,
            boolean updateReferencesAsLocal)

Removes the specified external link from the workbook.

Parameters:

index - the index of the external link to be removed.

updateReferencesAsLocal - Whether update all references of given external link to reference of current workbook itself. Check clear(boolean) to get more details about this parameter.

iterator

public java.util.Iterator iterator()

Get an enumerator that iterates through this collection.

Specified by:

iterator in interface java.lang.Iterable

Returns: