Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.3 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: text ::

service Text
Description
is an independent piece of text which consists of a series of one or more paragraphs.

This service is used, for example, for the text of a TextDocument or the text in a cell or TextFrame.

See also
TextDocument, TextFrame, ::com::sun::star::table::Cell
Developers Guide
Text - Working with Text Documents - Word Processing

Exported Interfaces - Summary
::com::sun::star::container::XEnumerationAccess

This is the factory for an enumeration of the paragraphs in this text. (details)

XText

provides a cursor factory and the possibility to insert and remove contents.

XTextRangeCompare

optional interface to compare postions of TextRange instances within this text. (details)

XTextRangeMover

makes it possible to change the position of paragraphs. (details)

XRelativeTextContentInsert

makes it possible to insert a new text content, before or after existing text contents. (details)

Properties' Summary
::com::sun::star::beans::PropertyValues
StartRedline
[ OPTIONAL ]
contains the properties of a redline at the start of the document.
The sequence contains the following properties  
[ maybevoid ] ::com::sun::star::beans::PropertyValues
EndRedline
[ OPTIONAL ]
contains the properties of a redline at the start of the document. The sequence contains the following properties  
Exported Interfaces - Details
::com::sun::star::container::XEnumerationAccess
Description
This is the factory for an enumeration of the paragraphs in this text.

This interface is mainly useful for exporting the text to a data format.

XText
Description
provides a cursor factory and the possibility to insert and remove contents.
XTextRangeCompare
Usage Restrictions
optional
Description
optional interface to compare postions of TextRange instances within this text.
XTextRangeMover
Usage Restrictions
optional
Description
makes it possible to change the position of paragraphs.
XRelativeTextContentInsert
Usage Restrictions
deprecated
optional
Deprecation Info
hack
Description
makes it possible to insert a new text content, before or after existing text contents.
Properties' Details
StartRedline
::com::sun::star::beans::PropertyValues StartRedline;
Usage Restrictions
optional
Description
contains the properties of a redline at the start of the document.
The sequence contains the following properties
  • string RedlineAuthor

  • com::sun::star::util::DateTime RedlineDate_Time

  • string RedlineComment

  • string RedlineType

  • string RedlineIdentifier

  • boolean IsCollapsed

  • boolean IsStart

  • boolean MergeLastPara

  • [maybevoid] com::sun::star::text::XText RedlineText (maybevoid)

  • com::sun::star::beans::PropertyValues RedlineSuccessorData (contains the same properties except for the RedlineSuccessorData

See also
EndRedline
EndRedline
[ maybevoid ] ::com::sun::star::beans::PropertyValues EndRedline;
Usage Restrictions
optional
Description
contains the properties of a redline at the start of the document. The sequence contains the following properties
  • string RedlineAuthor

  • com::sun::star::util::DateTime RedlineDate_Time

  • string RedlineComment

  • string RedlineType

  • string RedlineIdentifier

  • boolean IsCollapsed

  • boolean IsStart

  • boolean MergeLastPara

  • [maybevoid] com::sun::star::text::XText RedlineText (maybevoid)

  • com::sun::star::beans::PropertyValues RedlineSuccessorData (contains the same properties except for the RedlineSuccessorData

See also
StartRedline

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.