LibreOffice
LibreOffice 6.0 SDK API Reference
Exported Interfaces | Public Attributes | List of all members
Text Service Referencepublished

is an independent piece of text which consists of a series of one or more paragraphs. More...

import"Text.idl";

Inheritance diagram for Text:
XEnumerationAccess XText XTextRangeCompare XTextRangeMover XRelativeTextContentInsert XElementAccess XSimpleText XInterface XInterface XInterface XInterface XTextRange XInterface SheetCell

Exported Interfaces

interface com::sun::star::container::XEnumerationAccess
 This is the factory for an enumeration of the paragraphs in this text. More...
 
interface XText
 provides a cursor factory and the possibility to insert and remove contents. More...
 
interface XTextRangeCompare
 optional interface to compare positions of TextRange instances within this text. More...
 
interface XTextRangeMover
 makes it possible to change the position of paragraphs. More...
 
interface XRelativeTextContentInsert
 makes it possible to insert a new text content, before or after existing text contents. More...
 

Public Attributes

::com::sun::star::beans::PropertyValues StartRedline
 contains the properties of a redline at the start of the document. More...
 
::com::sun::star::beans::PropertyValues EndRedline
 contains the properties of a redline at the start of the document. More...
 

Additional Inherited Members

- Public Member Functions inherited from XEnumerationAccess
com::sun::star::container::XEnumeration createEnumeration ()
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XText
void insertTextContent ([in] com::sun::star::text::XTextRange xRange, [in] com::sun::star::text::XTextContent xContent, [in] boolean bAbsorb) raises ( com::sun::star::lang::IllegalArgumentException )
 inserts a content, such as a text table, text frame or text field. More...
 
void removeTextContent ([in] com::sun::star::text::XTextContent xContent) raises ( com::sun::star::container::NoSuchElementException )
 removes the specified content from the text object. More...
 
- Public Member Functions inherited from XSimpleText
com::sun::star::text::XTextCursor createTextCursor ()
 
com::sun::star::text::XTextCursor createTextCursorByRange ([in] com::sun::star::text::XTextRange aTextPosition)
 
void insertString ([in] com::sun::star::text::XTextRange xRange, [in] string aString, [in] boolean bAbsorb)
 inserts a string of characters into the text. More...
 
void insertControlCharacter ([in] com::sun::star::text::XTextRange xRange, [in] short nControlCharacter, [in] boolean bAbsorb) raises ( com::sun::star::lang::IllegalArgumentException )
 inserts a control character (like a paragraph break or a hard space) into the text. More...
 
- Public Member Functions inherited from XTextRange
XText getText ()
 
XTextRange getStart ()
 
XTextRange getEnd ()
 
string getString ()
 
void setString ([in] string aString)
 the whole string of characters of this piece of text is replaced. More...
 
- Protected Member Functions inherited from XTextRangeCompare
short compareRegionStarts ([in] XTextRange xR1, [in] XTextRange xR2) raises ( com::sun::star::lang::IllegalArgumentException )
 
short compareRegionEnds ([in] XTextRange xR1, [in] XTextRange xR2) raises ( com::sun::star::lang::IllegalArgumentException )
 
- Protected Member Functions inherited from XTextRangeMover
void moveTextRange ([in] com::sun::star::text::XTextRange xRange, [in] short nParagraphs)
 moves the contents to which xRange refers forward or backward. More...
 
- Protected Member Functions inherited from XRelativeTextContentInsert
void insertTextContentBefore ([in] XTextContent xNewContent, [in] XTextContent xSuccessor) raises ( com::sun::star::lang::IllegalArgumentException )
 inserts text the new text content before of the successor argument. More...
 
void insertTextContentAfter ([in] XTextContent xNewContent, [in] XTextContent xPredecessor) raises ( com::sun::star::lang::IllegalArgumentException )
 inserts text the new text content after the predecessor argument. More...
 

Detailed 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
com::sun::star::text::TextDocument
com::sun::star::text::TextFrame
com::sun::star::table::Cell
Developers Guide
Text - Working with Text Documents - Word Processing

Exported Interfaces

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.

interface XRelativeTextContentInsert
optional

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

Deprecated:
hack
interface XText

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

interface XTextRangeCompare
optional

optional interface to compare positions of TextRange instances within this text.

interface XTextRangeMover
optional

makes it possible to change the position of paragraphs.

Member Data Documentation

::com::sun::star::beans::PropertyValues EndRedline
optionalpropertymaybevoid

contains the properties of a redline at the start of the document.

The sequence contains the following properties

See also
StartRedline
::com::sun::star::beans::PropertyValues StartRedline
optionalproperty

contains the properties of a redline at the start of the document.


The sequence contains the following properties

See also
EndRedline

The documentation for this service was generated from the following file: