com.aspose.gridweb

Class GridNameCollection

java.lang.Object

com.aspose.gridweb.GridNameCollection

public class GridNameCollection
extends java.lang.Object

Encapsulates a collection of GridName objects.

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int sheetIndex, java.lang.String text, java.lang.String refersTo) Defines a new name in the specified sheet.
int	add(java.lang.String text, java.lang.String refersTo) Defines a new global name.
void	clear() Removes all Names;
GridName	get(int index) Gets the GridName element at the specified index.
int	getCount() Gets the size of enumerator
java.util.Iterator	iterator() Gets the rows enumerator
void	remove(java.lang.String[] names) Remove an array of name
void	removeAt(int index) Remove the name at the specific index.

Methods inherited from class java.lang.Object

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

Method Detail

get

public GridName get(int index)

Gets the GridName 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

iterator

public java.util.Iterator iterator()

Gets the rows enumerator

Returns:

The rows enumerator

add

public int add(java.lang.String text,
      java.lang.String refersTo)

Defines a new global name.

Parameters:

text - Name text.It can have sheetname .

refersTo - The formula that the name is defined to refer to.It must have a sheetname .eg.'sheet hello!'A1:B2.

Returns:

Name object index.

add

public int add(int sheetIndex,
      java.lang.String text,
      java.lang.String refersTo)

Defines a new name in the specified sheet.

Parameters:

sheetIndex - The sheet index that the name is applyed in.

text - Name text.It can not have sheetname .

refersTo - The formula that the name is defined to refer to.It must have sheetname .eg.'sheet hello!'A1:B2.

Returns:

Name object index.

remove

public void remove(java.lang.String[] names)

Remove an array of name

Parameters:

names - The names' text.

removeAt

public void removeAt(int index)

Remove the name at the specific index.

Remarks

Please make sure that the name is not referred by the other formulas before calling the method. And if the name is referred,please only set Name.RefersTo as null.

Parameters:

index -

clear

public void clear()

Removes all Names;