:: 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

Included Services
::com::sun::star::text::TextRange
(referenced entity's summary:)
points to a sequence of characters within a ::com::sun::star::text::Text .
Exported Interfaces
::com::sun::star::container::XContentEnumerationAccess
Usage Restrictions
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
::com::sun::star::beans::XTolerantMultiPropertySet
Usage Restrictions
optional
Description
gives access to a sequence of properties.
Since
OpenOffice 2.0.0
Properties' Summary
[ readonly ] string
TextPortionType
contains the type of the text portion.  
[ readonly ] short
ControlCharacter
returns the control character if the text portion contains a ControlCharacter  
::com::sun::star::text::XTextContent
Bookmark
[ OPTIONAL ]
contains the bookmark if the portion is of the type  
boolean
IsCollapsed
[ OPTIONAL ]
determines whether the portion is a point only.  
boolean
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
::com::sun::star::text::XTextContent Bookmark;
Usage Restrictions
optional
Description
contains the bookmark if the portion is of the type
IsCollapsed
boolean IsCollapsed;
Usage Restrictions
optional
Description
determines whether the portion is a point only.
IsStart
boolean IsStart;
Usage Restrictions
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