com.spire.xls.core
Interface INameRanges

All Superinterfaces:
java.lang.Iterable

public interface INameRanges
extends java.lang.Iterable

A collection of all the Name objects in the application or workbook. Each Name object represents a defined name for a range of cells.


Method Summary
 INamedRange add(INamedRange name)
          Defines a new name.
 INamedRange add(java.lang.String name)
          Defines a new name.
 INamedRange add(java.lang.String name, IXLSRange namedObject)
          Defines a new name.
 boolean contains(java.lang.String name)
           
 INamedRange get(int index)
          Returns a single Name object from a Names collection.
 INamedRange get(java.lang.String name)
          Returns a single Name object from a Names collection.
 INamedRange getByName(java.lang.String name)
          Returns a single Name object from a Names collection.
 int getCount()
          Returns the number of objects in the collection.
 java.lang.Object getParent()
          Returns the parent object for the specified object.
 IWorksheet getParentWorksheet()
          Returns parent worksheet of the collection.
 void remove(java.lang.String name)
          Removes Name object from the collection.
 void removeAt(int index)
          Removes the element at the specified index of the collection.
 

Method Detail

getCount

int getCount()
Returns the number of objects in the collection. Read-only Long.


getParent

java.lang.Object getParent()
Returns the parent object for the specified object.


get

INamedRange get(int index)
Returns a single Name object from a Names collection.


get

INamedRange get(java.lang.String name)
Returns a single Name object from a Names collection.


getByName

INamedRange getByName(java.lang.String name)
Returns a single Name object from a Names collection.


getParentWorksheet

IWorksheet getParentWorksheet()
Returns parent worksheet of the collection.


add

INamedRange add(java.lang.String name)
Defines a new name.

Parameters:
name - Name for the new name object.
Returns:
Returns a name object.

add

INamedRange add(java.lang.String name,
                IXLSRange namedObject)
Defines a new name.

Parameters:
name - Name for the new Name object.
namedObject - Range that will be associated with the name.

add

INamedRange add(INamedRange name)
Defines a new name.

Parameters:
name - Name object to add.

remove

void remove(java.lang.String name)
Removes Name object from the collection.

Parameters:
name - Name of the object to remove from the collection.

removeAt

void removeAt(int index)
Removes the element at the specified index of the collection.

Parameters:
index - The zero-based index of the element to remove.

contains

boolean contains(java.lang.String name)
Parameters:
name -
Returns: