com.mindoo.remote.api.symphony.spreadsheet
Interface IRemoteNames

public interface IRemoteNames

This class represents a collection of all the named ranges in a spreadsheet.

Access

• To get all the named ranges of a spreadsheet, use the Names property in the Spreadsheet class.

Method Summary

IRemoteName	add(java.lang.String name, java.lang.String refersTo, boolean visible) This method adds a named range.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getCount() This property represents the number of named ranges in a spreadsheet.
java.lang.String[]	getNames() This method returns a string array containing the names of all the named ranges in a spreadsheet.
IRemoteName	item(java.lang.String name) This method returns a named range by its name.

Method Detail

getCount

int getCount()
             throws RemoteEclipseAPIException

This property represents the number of named ranges in a spreadsheet.

Returns:

count

Throws:

RemoteEclipseAPIException

add

IRemoteName add(java.lang.String name,
                java.lang.String refersTo,
                boolean visible)
                throws RemoteEclipseAPIException

This method adds a named range.

Parameters:

name - Specifies the name of the range.

refersTo - Specifies the range that the named range refers to. For example, the format "$A.$A$1:$E$11" specifies the range(A1:E11) on sheet A.

visible - Specifies whether the named range is visible. A value of true means that the range is visible. A value of false means that the range is not visible.

Returns:

A Name object that represents a named range.

Throws:

RemoteEclipseAPIException

getNames

java.lang.String[] getNames()
                            throws RemoteEclipseAPIException

This method returns a string array containing the names of all the named ranges in a spreadsheet.

Returns:

A string array containing all the names of all named ranges.

Throws:

RemoteEclipseAPIException

item

IRemoteName item(java.lang.String name)
                 throws RemoteEclipseAPIException

This method returns a named range by its name.

Parameters:

name - Specifies the name of the range. If the range with the specified name does not exist, this method throws an exception.

Returns:

A Name object that represents a named range.

Throws:

RemoteEclipseAPIException

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException