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

public interface IRemoteDataPilotFields

This class represents a collection of all the DataPilot fields in a DataPilot table report.

Access

• To get the row fields of a DataPilot table, use the RowFields property in the DataPilotTable class.
• To get the column fields of a DataPilot table, use the ColumnFields property in theDataPilotTable class.
• To get the data fields of a DataPilot table, use the DataFields property in the DataPilotTable class.
• To get the hidden fields of a DataPilot table, use the HiddenFields property in theDataPilotTable class.
• To get the page fields of a DataPilot table, use the PageFields property in the DataPilotTable class.

Method Summary

IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getCount() This property returns the number of the DataPilot fields.
IRemoteDataPilotField	item(int index) This method returns a DataPilotField object that represents a row, column, data, page, or hidden field.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

getCount

int getCount()
             throws RemoteEclipseAPIException

This property returns the number of the DataPilot fields.

Returns:

count

Throws:

RemoteEclipseAPIException

item

IRemoteDataPilotField item(int index)
                           throws RemoteEclipseAPIException

This method returns a DataPilotField object that represents a row, column, data, page, or hidden field.

Parameters:

index - Specifies the index of the field to get, starting at 1.

Returns:

A DataPilotField object represents a row, column, data, page, or hidden field.

Throws:

RemoteEclipseAPIException