com.aspose.cells

Class NameCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.NameCollection

All Implemented Interfaces:

java.lang.Iterable

public class NameCollection
extends CollectionBase

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

Method Summary

Methods

Modifier and Type	Method and Description
int	add(java.lang.String text) Defines a new name.
void	clear() Remove all defined names which are not referenced by the formulas and data source.
Name[]	filter(int type, int sheetIndex) Gets all defined name by scope.
Name	get(int index) Gets the Name element at the specified index.
Name	get(java.lang.String text) Gets the Name element with the specified name.
void	remove(java.lang.String text) Remove the name.
void	remove(java.lang.String[] names) Remove an array of name
void	removeAt(int index) Remove the name at the specific index.
void	removeDuplicateNames() Remove the duplicate defined names
void	sort() Sorts defined names.

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(java.lang.String text)

Defines a new name.

Remarks

Name cannot include spaces and cannot look like cell references.

Parameters:

text - The text to use as the name.

Returns:

Name object index.

get

public Name get(int index)

Gets the Name 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.

filter

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

Gets all defined name by scope.

Parameters:

type - NameScopeType. The scope type.

sheetIndex - The sheet index. Only effects when scope type is NameScopeType.WORKSHEET

Returns:

get

public Name get(java.lang.String text)

Gets the Name element with the specified name.

Parameters:

text - Name text.

Returns:

The element with the specified name.

remove

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

Remove an array of name

Parameters:

names - The names' text.

remove

public void remove(java.lang.String text)

Remove the name.

Parameters:

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

Overrides:

removeAt in class CollectionBase

Parameters:

index - index of the Name to be removed.

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.

Overrides:

clear in class CollectionBase

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