XText Interface Reference

extends a XSimpleText by the capability of inserting XTextContents. More...

import"XText.idl";

Inheritance diagram for XText:

Public Member Functions
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...
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...

Detailed Description

extends a XSimpleText by the capability of inserting XTextContents.

Developers Guide

Text Documents - Editing Text - Text Contents Other Than Strings
Text Documents - Editing Text

Member Function Documentation

insertTextContent()

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.

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.

Parameters

xRange	specifies the position of insertion.
xContent	the text content to be inserted.
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] com::sun::star::text::XTextContent	xContent	)
raises	(	com::sun::star::container::NoSuchElementException
	)

removes the specified content from the text object.

Parameters

xContent

the content that is to be removed.

---

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

• com/sun/star/text/XText.idl