com.aspose.cells

Class HyperlinkCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.HyperlinkCollection

All Implemented Interfaces:

java.lang.Iterable

public class HyperlinkCollection
extends CollectionBase

Encapsulates a collection of Hyperlink objects.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
 
         //Obtaining the reference of the newly added worksheet by passing its sheet index
         Worksheet worksheet = workbook.getWorksheets().get(0);
 
         //Get Hyperlinks Collection
         HyperlinkCollection hyperlinks = worksheet.getHyperlinks();
 
         //Adding a hyperlink to a URL at "A1" cell
         hyperlinks.add("A1", 1, 1, "http://www.aspose.com");
 
         //Saving the Excel file
         workbook.save("book1.xls");
 

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int firstRow, int firstColumn, int totalRows, int totalColumns, java.lang.String address) Adds a hyperlink to a specified cell or a range of cells.
int	add(java.lang.String cellName, int totalRows, int totalColumns, java.lang.String address) Adds a hyperlink to a specified cell or a range of cells.
int	add(java.lang.String startCellName, java.lang.String endCellName, java.lang.String address, java.lang.String textToDisplay, java.lang.String screenTip) Adds a hyperlink to a specified cell or a range of cells.
void	clear() Clears all hyperlinks.
Hyperlink	get(int index) Gets the Hyperlink element at the specified index.
void	removeAt(int index) Remove the hyperlink at the specified index in this collection.

Methods inherited from class com.aspose.cells.CollectionBase

add, contains, getCount, indexOf, iterator

Methods inherited from class java.lang.Object

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

Method Detail

add

public int add(int firstRow,
      int firstColumn,
      int totalRows,
      int totalColumns,
      java.lang.String address)

Adds a hyperlink to a specified cell or a range of cells.

Example

 
         //Instantiating a Workbook object
         Workbook excel = new Workbook();
         Worksheet worksheet = excel.getWorksheets().get(0);
         worksheet.getHyperlinks().add("A4", 1, 1, "http://www.aspose.com");
         worksheet.getHyperlinks().add("A5", 1, 1, "c:\\book1.xls");
 

Parameters:

firstRow - First row of the hyperlink range.

firstColumn - First column of the hyperlink range.

totalRows - Number of rows in this hyperlink range.

totalColumns - Number of columns of this hyperlink range.

address - Address of the hyperlink.

Returns:

Hyperlink object index.

add

public int add(java.lang.String cellName,
      int totalRows,
      int totalColumns,
      java.lang.String address)

Adds a hyperlink to a specified cell or a range of cells.

Parameters:

cellName - Cell name.

totalRows - Number of rows in this hyperlink range.

totalColumns - Number of columns of this hyperlink range.

address - Address of the hyperlink.

Returns:

Hyperlink object index.

add

public int add(java.lang.String startCellName,
      java.lang.String endCellName,
      java.lang.String address,
      java.lang.String textToDisplay,
      java.lang.String screenTip)

Adds a hyperlink to a specified cell or a range of cells.

Parameters:

startCellName - The top-left cell of the range.

endCellName - The bottom-right cell of the range.

address - Address of the hyperlink.

textToDisplay - The text to be displayed for the specified hyperlink.

screenTip - The screenTip text for the specified hyperlink.

Returns:

Hyperlink object index.

get

public Hyperlink get(int index)

Gets the Hyperlink element at the specified index.

Overrides:

get in class CollectionBase

Parameters:

index - The zero based index of the element.

Returns:

The element at the specified index.

removeAt

public void removeAt(int index)

Remove the hyperlink at the specified index in this collection.

Overrides:

removeAt in class CollectionBase

Parameters:

index - The zero based index of the element.

clear

public void clear()

Clears all hyperlinks.

Overrides:

clear in class CollectionBase