com.mindoo.remote.api.symphony.document
Interface IRemoteTextParagraphs

public interface IRemoteTextParagraphs

This class represents a collection of all the paragraphs in the document.

To get all the paragraphs of a document, use the Paragraphs property in the Document class.

Method Summary

int	getCount() This property represents the number of paragraphs of a document.
IRemoteTextParagraph	item(int index) This method returns a paragraph of a document according to an index.

Method Detail

getCount

int getCount()
             throws RemoteEclipseAPIException

This property represents the number of paragraphs of a document.

When a document contains complex objects or the document has a big size, the number of paragraphs returned by this property maybe is not correct.

Returns:

count

Throws:

RemoteEclipseAPIException

item

IRemoteTextParagraph item(int index)
                          throws RemoteEclipseAPIException

This method returns a paragraph of a document according to an index.

Parameters:

index - Specifies the index of the paragraph in the collection, starting at 1.

Returns:

A TextParagraph object that represents a paragraph.

Throws:

RemoteEclipseAPIException