Overview | Module | Use | Devguide | Index

Included Services | Exported Interfaces | Properties' Summary | Properties' Details

:: com :: sun :: star :: text ::
service TextPortion
Description A TextPortion is a piece of text within a paragraph that does not contain changes of its attributes inside. It is created by an enumaration implemented in a paragraph service. It is used to export the content of the paragraph to an external document format. Developers Guide 7.3.1 Text Documents - Working with Text Documents - Word Processing - Iterating over Text 7.3.2 Text Documents - Working with Text Documents - Formatting

Included Services
TextRange | points to a sequence of characters within a Text .

Exported Interfaces
::com::sun::star::container::XContentEnumerationAccess | [ OPTIONAL ] Description contains text frames, graphic objects, embedded objects or shapes that are anchored at or as character. See also com.sun.star.text.TextFrame See also com.sun.star.text.TextGraphicObject

Properties' Summary
TextPortionType | contains the type of the text portion.
ControlCharacter | returns the control character if the text portion contains a ControlCharacter
Bookmark | [ OPTIONAL ] contains the bookmark if the portion is of the type
IsCollapsed | [ OPTIONAL ] determines whether the portion is a point only.
IsStart | [ OPTIONAL ] determines whether the portion is a start portion if two portions are needed to include an object (i.e. DocmentIndexMark)

Properties' Details
TextPortionType
[ readonly ] string TextPortionType; Description contains the type of the text portion. Valid content type names are: Text - string content TextField - TextField content TextContent - text content - supplied via the interface XContentEnumerationAccess Footnote - a footnote or an endnote ControlCharacter - a control character ReferenceMark - a reference mark DocumentIndexMark - a document index mark Bookmark - a bookmark Redline - a redline portion which is a result of the change tracking feature. Ruby - a ruby attribute which is used in Asian text. The text portions for reference marks and document index marks are generated twice for each mark since they may include string content.
ControlCharacter
[ readonly ] short ControlCharacter; Description returns the control character if the text portion contains a ControlCharacter
Bookmark
XTextContent Bookmark; [ OPTIONAL ] Description contains the bookmark if the portion is of the type
IsCollapsed
boolean IsCollapsed; [ OPTIONAL ] Description determines whether the portion is a point only.
IsStart
boolean IsStart; [ OPTIONAL ] Description determines whether the portion is a start portion if two portions are needed to include an object (i.e. DocmentIndexMark)

Top of Page

Copyright © 2003 Sun Microsystems, Inc.