com.aspose.gridweb

Class GridHyperlinkCollection

java.lang.Object

com.aspose.gridweb.GridHyperlinkCollection

public class GridHyperlinkCollection
extends java.lang.Object

Encapsulates a collection of GridHyperlink objects.

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 cellName, java.lang.String address) Adds a hyperlink to a specified cell .
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.
GridHyperlink	get(int index) Gets the GridHyperlink element at the specified index.
int	getCount() Gets the size of enumerator
GridHyperlink	getHyperlink(GridCell cell) Gets the cell's Hyperlink object.
GridHyperlink	getHyperlink(int row, int column) Gets the cell's Hyperlink object.
void	remove(GridCellArea area) Remove the hyperlink at the specified area.
void	removeAt(int index) Remove the hyperlink at the specified index.

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.

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:

GridHyperlink 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:

GridHyperlink object index.

add

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

Adds a hyperlink to a specified cell .

Parameters:

cellName - Cell name.

address - Address of the hyperlink.

Returns:

GridHyperlink 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:

GridHyperlink object index.

getHyperlink

public GridHyperlink getHyperlink(GridCell cell)

Gets the cell's Hyperlink object. If there is no Hyperlink of the cell, returns null.

Parameters:

cell - The GridCell object.

Returns:

GridHyperlink the GridHyperlink object.

getHyperlink

public GridHyperlink getHyperlink(int row,
                         int column)

Gets the cell's Hyperlink object. If there is no Hyperlink of the cell, returns null.

Parameters:

row - The row of the cell.

column - The column of the cell.

Returns:

GridHyperlink the GridHyperlink object.

clear

public void clear()

Clears all hyperlinks.

removeAt

public void removeAt(int index)

Remove the hyperlink at the specified index.

Parameters:

index - The zero based index of the element.

remove

public void remove(GridCellArea area)

Remove the hyperlink at the specified area.

Parameters:

area - The area which contains hyperlink.

get

public GridHyperlink get(int index)

Gets the GridHyperlink element at the specified index.

Parameters:

index - The zero based index of the element.

Returns:

The element at the specified index.

getCount

public int getCount()

Gets the size of enumerator