com.grapecity.documents.excel

Interface INames

public interface INames

Represents a collection of all the IName objects in the workbook. Each Name object represents a defined name for a range of cells. Names can be either built-in names — such as Database, Print_Area, and Auto_Open — or custom names.

Method Summary

Modifier and Type	Method and Description
IName	add(java.lang.String name, java.lang.String refersTo) Defines a new name.
void	clear() Clears the IName collection.
boolean	contains(java.lang.String name) Determines whether name is contained in INames
void	fromJson(java.lang.String json) Generates a collection of defined name from the json string.
IName	get(int index) Returns the IName object from a collection.
IName	get(java.lang.String name) Returns the IName object from a collection.
int	getCount() Returns the number of objects in the collection.
java.lang.String	toJson() Generates the json string from the defined names.

Method Detail

getCount

int getCount()

Returns the number of objects in the collection.

add

IName add(java.lang.String name,
          java.lang.String refersTo)

Defines a new name. Returns the IName object.

Parameters:

name - The text to use as the name. Names cannot include spaces and cannot look like cell references.

refersTo - Required unless one of the other RefersTo arguments is specified. Describes what the name refers to (using A1-style notation).

Returns:

Returns a new IName object.

contains

boolean contains(java.lang.String name)

Determines whether name is contained in INames

Parameters:

name - The name.

Returns:

Whether iNames contains the name.

get

IName get(java.lang.String name)

Returns the IName object from a collection.

Parameters:

name - Specifies the name of an element in the collection.

get

IName get(int index)

Returns the IName object from a collection.

Parameters:

index - Specifies the index of an element in the collection.

clear

void clear()

Clears the IName collection.

fromJson

void fromJson(java.lang.String json)

Generates a collection of defined name from the json string.

Parameters:

json - the json string that contains defined names

toJson

java.lang.String toJson()

Generates the json string from the defined names.

Returns:

the json string