Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XText
Base Interfaces
XTextXSimpleTextXTextRange

XSimpleText
(referenced interface's summary:)
is the main interface for a distinct text unit, i.e. the main text of a document, the text for headers and footers or for single cells of a table.
Description
extends a XSimpleText by the capability of inserting XTextContents.
Developers Guide
Text - Editing Text - Text Contents Other Than Strings
Text - Editing Text

Methods' Summary
insertTextContent inserts a content, such as a text table, text frame or text field.  
removeTextContent removes the specified content from the text object.  
Methods' Details
insertTextContent
void
insertTextContent( [in] XTextRange  xRange,
[in] XTextContent  xContent,
[in] boolean  bAbsorb )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
inserts a content, such as a text table, text frame or text field.

Which contents are accepted is implementation-specific. Some implementations may only accept contents which were created by the factory that supplied the same text or the document which contains the text.

Parameter xRange
specifies the position of insertion.
Parameter xContent
the text content to be inserted.
Parameter bAbsorb
specifies whether the text spanned by xRange will be replaced. If true then the content of xRange will be replaced by xContent, otherwise xContent will be inserted at the end of xRange.
removeTextContent
void
removeTextContent( [in] XTextContent  xContent )
raises( ::com::sun::star::container::NoSuchElementException );

Description
removes the specified content from the text object.
Example
xDoc.removeTextContent( xDoc.TextTables.MyOwnTableName )
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.