English:

The Free and Open Productivity Suite
New: Apache OpenOffice 4.1.1 released!

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XTextContent
Base Interfaces
XTextContent
┗ ::com::sun::star::lang::XComponent

::com::sun::star::lang::XComponent
(referenced interface's summary:)
allows to exclicitly free resources and break cyclic references.
Description
enables objects to be inserted into a text and to provide their location in a text once they are inserted into it.
Developers Guide
Text - Navigating - Locating Text Contents

Methods' Summary
attach is called when this object gets embedded in a text.  
getAnchor  
Methods' Details
attach
void
attach( [in] XTextRange  xTextRange )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
is called when this object gets embedded in a text.

This acts like a multi-phase construction, thus the object may be invalid until it is attached to a text position. In general, this method is called from within .

Both text objects and text content objects may only be connected to each other if they are created by the same component. When implementing new components, this behaviour is deprecated.

getAnchor
XTextRange
getAnchor();

Returns
the text range to which the content is attached.

Note: The anchor of the actual implementation for text tables does not have a position in the text. Thus that anchor can not be used for some operation like attach for example or insertTextContent or other function that require the object to have a position in the text.

The reason why a text table still needs an anchor is that for example tables should be insertable via insertTextContent and that interface uses a parameter of that type.

Top of Page

Logo ApacheCon Europe 2014

Apache Feather

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

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. 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.