NameCollection

Inheritance: java.lang.Object, com.aspose.cells.CollectionBase

public class NameCollection extends CollectionBase

Represents a collection of all the Name objects in the spreadsheet.

Methods

Method	Description
add(Object o)	Adds an item to the CollectionBase instance.
add(String text)	Defines a new name.
clear()	Remove all defined names which are not referenced by the formulas and data source.
contains(Object o)	Return whether instance contains this object
equals(Object arg0)
filter(int type, int sheetIndex)	Gets all defined name by scope.
get(int index)	Gets the Name element at the specified index.
get(String text)	Gets the Name element with the specified name.
getClass()
getCount()	Gets the number of elements contained in the CollectionBase instance.
hashCode()
indexOf(Object o)	Determines the index of a specific item in the CollectionBase instance.
iterator()	Returns an enumerator that iterates through the CollectionBase instance.
notify()
notifyAll()
remove(String text)	Remove the name.
remove(String[] names)	Remove an array of name
removeAt(int index)	Remove the name at the specific index.
removeDuplicateNames()	Remove the duplicate defined names
sort()	Sorts defined names.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

add(Object o)

public int add(Object o)

Adds an item to the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	The Object to add to the CollectionBase instance.

Returns: int - The position into which the new element was inserted.

add(String text)

public int add(String text)

Defines a new name.

Remarks

Name cannot include spaces and cannot look like cell references.

Parameters:

Parameter	Type	Description
text	java.lang.String	The text to use as the name.

Returns: int - Name object index.

clear()

public void clear()

Remove all defined names which are not referenced by the formulas and data source. If the defined name is referred, we only set Name.ReferTo as null and hide them.

contains(Object o)

public boolean contains(Object o)

Return whether instance contains this object

Parameters:

Parameter	Type	Description
o	java.lang.Object	test object

Returns: boolean - Whether instance contains this object

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

filter(int type, int sheetIndex)

public Name[] filter(int type, int sheetIndex)

Gets all defined name by scope.

Parameters:

Parameter	Type	Description
type	int	NameScopeType. The scope type.
sheetIndex	int	The sheet index. Only effects when scope type is NameScopeType.WORKSHEET

Returns: com.aspose.cells.Name[] -

get(int index)

public Name get(int index)

Gets the Name element at the specified index.

Parameters:

Parameter	Type	Description
index	int	The zero based index of the element.

Returns: Name - The element at the specified index.

get(String text)

public Name get(String text)

Gets the Name element with the specified name.

Parameters:

Parameter	Type	Description
text	java.lang.String	Name text.

Returns: Name - The element with the specified name.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCount()

public int getCount()

Gets the number of elements contained in the CollectionBase instance.

Returns: int - The number of elements contained in the CollectionBase instance.

hashCode()

public native int hashCode()

Returns: int

indexOf(Object o)

public int indexOf(Object o)

Determines the index of a specific item in the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	Determines the index of a specific item in the CollectionBase instance.

Returns: int - The index of value if found in the list; otherwise, -1.

iterator()

public Iterator iterator()

Returns an enumerator that iterates through the CollectionBase instance.

Returns: java.util.Iterator - An iterator for the CollectionBase instance.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

remove(String text)

public void remove(String text)

Remove the name.

Parameters:

Parameter	Type	Description
text	java.lang.String	The name text.

remove(String[] names)

public void remove(String[] names)

Remove an array of name

Parameters:

Parameter	Type	Description
names	java.lang.String[]	The names’ text.

removeAt(int index)

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, setting Name.RefersTo as null is better.

Parameters:

Parameter	Type	Description
index	int	index of the Name to be removed.

removeDuplicateNames()

public void removeDuplicateNames()

Remove the duplicate defined names

sort()

public void sort()

Sorts defined names.

Remarks

If you create a large amount of named ranges in the Excel file, please call this method after all named ranges are created and before saving

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int