Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

interface XSimpleText
Base Interfaces
XSimpleText
┗ XTextRange
XTextRange
(referenced interface's summary:)
describes the object's position in a text.
Description
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.
See also
XText
Developers Guide
Text - Editing Text - Strings
Methods' Summary
createTextCursor  
createTextCursorByRange  
insertString inserts a string of characters into the text.  
insertControlCharacter inserts a control character (like a paragraph break or a hard space) into the text. 
Methods' Details
createTextCursor
XTextCursor
createTextCursor();
Returns
a new instance of a TextCursor service which can be used to travel in the given text context.
See also
TextCursor
createTextCursorByRange
XTextCursor
createTextCursorByRange( [in] XTextRange  aTextPosition );
Returns
a new instance of a TextCursor which is located at the specified TextRange to travel in the given text context.

The initial position is set to aTextPosition.

Parameter aTextPosition
specifies the start position for the new TextCursor.
See also
TextCursor
insertString
[oneway] void
insertString( [in] XTextRange  xRange,
[in] string  aString,
[in] boolean  bAbsorb );
Description
inserts a string of characters into the text.

The string may contain the following white spaces:

  • blank
  • tab
  • cr (which will insert a paragraph break)
  • lf (which will insert a line break)
Parameter xRange
specifies the position of insertion. For example, XSimpleText::createTextCursor can be used to get an XTextRange for this argument.

If the parameter bAbsorb was true the text range will contain the new inserted string, otherwise the range (and it's text) will remain unchanged.

Parameter aString
specifies the string to insert.
Parameter bAbsorb
specifies whether the text spanned by xRange will be replaced. If true then the content of xRange will be replaced by aString, otherwise aString will be inserted at the beginning of xRange.
Example
 xText.insertString( xTextCursor, "Hello " + aName$ + ",", false )
 
 xText.insertControlCharacter( xTextCursor,
 ControlCharacter_PARAGRAPH_BREAK, false );
 
 xText.insertString( xTextCursor, "more text ...", false )
insertControlCharacter
void
insertControlCharacter( [in] XTextRange  xRange,
[in] short  nControlCharacter,
[in] boolean  bAbsorb )
raises( ::com::sun::star::lang::IllegalArgumentException );
Description
inserts a control character (like a paragraph break or a hard space) into the text.
See also
ControlCharacter
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

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

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