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

public interface IRemoteSheets

This class represents a collection of all the sheets in a spreadsheet.

Access

To get all the sheets of a spreadsheet, use the Sheets property in the Spreadsheet class.

Usage

Sheets provides access to sheets and methods to insert new sheet and access a sheet.

Method Summary

void	addTo(IRemoteSheet sheet) This method creates a new sheet.
void	addTo(IRemoteSheet sheet, int count) This method creates a new sheet.
void	addTo(IRemoteSheet sheet_pos, int count, boolean beforeOrAfter) This method creates a new sheet.
IRemoteSymphonyApplication	getApplication() This property is read-only and represents the Lotus Symphony application.
int	getCount() This property represents the number of sheets in the spreadsheet.
IRemoteSheet	item(int index) This method returns a sheet according to the index.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property is read-only and represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

getCount

int getCount()
             throws RemoteEclipseAPIException

This property represents the number of sheets in the spreadsheet.

Returns:

count

Throws:

RemoteEclipseAPIException

addTo

void addTo(IRemoteSheet sheet)
           throws RemoteEclipseAPIException

This method creates a new sheet.

Parameters:

sheet -

Throws:

RemoteEclipseAPIException

addTo

void addTo(IRemoteSheet sheet,
           int count)
           throws RemoteEclipseAPIException

This method creates a new sheet.

Parameters:

sheet -

count - Specifies the number of sheets to be added. The default value is 1.

Throws:

RemoteEclipseAPIException

addTo

void addTo(IRemoteSheet sheet_pos,
           int count,
           boolean beforeOrAfter)
           throws RemoteEclipseAPIException

This method creates a new sheet.

Parameters:

sheet_pos - Specifies the target sheet before or after which the new sheet is added.

count - Specifies the number of sheets to be added. The default value is 1.

beforeOrAfter - Specifies true to add the new sheet before the parameter sheet_pos, or false to add the new sheet after the parameter sheet_pos. The default value is true.

Throws:

RemoteEclipseAPIException

item

IRemoteSheet item(int index)
                  throws RemoteEclipseAPIException

This method returns a sheet according to the index.

Parameters:

index - Specifies the index of the sheet, starting at 1.

Returns:

A Sheet object that represents a sheet.

Throws:

RemoteEclipseAPIException