<html> <head> <title>Interface XSimpleText</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XSimpleText-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Editing_Text#Strings" class="navimain">Devguide</a></td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">text</a> :: </p> </td> </tr> <tr> <td class="title">interface XSimpleText</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XSimpleText</strong> ┗ <a href="XTextRange.html">XTextRange</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XTextRange.html">XTextRange</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>describes the object's position in a text. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>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.</dd> <dt><b>See also</b></dt> <dd><a href="XText.html">XText</a></dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Editing_Text#Strings">Text - Editing Text - Strings</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#createTextCursor">createTextCursor</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#createTextCursorByRange">createTextCursorByRange</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#insertString">insertString</a></td> <td class="imsum_right">inserts a string of characters into the text. </td> </tr> <tr> <td class="imsum_left"><a href="#insertControlCharacter">insertControlCharacter</a></td> <td class="imsum_right">inserts a control character (like a paragraph break or a hard space) into the text. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="createTextCursor" class="membertitle">createTextCursor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XTextCursor.html">XTextCursor</a></td> </tr> <tr> <td valign="top"><b>createTextCursor</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a new instance of a <a href="TextCursor.html">TextCursor</a> service which can be used to travel in the given text context. </dd> <dt><b>See also</b></dt> <dd><a href="TextCursor.html">TextCursor</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createTextCursorByRange" class="membertitle">createTextCursorByRange</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XTextCursor.html">XTextCursor</a></td> </tr> <tr> <td valign="top"><b>createTextCursorByRange</b>(</td> <td valign="top">[in] <a href="XTextRange.html">XTextRange</a></td> <td valign="bottom"> aTextPosition );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a new instance of a <a href="TextCursor.html">TextCursor</a> which is located at the specified <a href="TextRange.html">TextRange</a> to travel in the given text context. <p>The initial position is set to <var>aTextPosition</var>. </dd> <dt><b>Parameter aTextPosition</b></dt> <dd>specifies the start position for the new <a href="TextCursor.html">TextCursor</a>. </dd> <dt><b>See also</b></dt> <dd><a href="TextCursor.html">TextCursor</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="insertString" class="membertitle">insertString</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">[oneway] void</td> </tr> <tr> <td valign="top"><b>insertString</b>(</td> <td valign="top">[in] <a href="XTextRange.html">XTextRange</a></td> <td valign="bottom"> xRange,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aString,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bAbsorb );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>inserts a string of characters into the text. </dd> <dd><p>The string may contain the following white spaces: </p> <ul> <li>blank</li> <li>tab</li> <li>cr (which will insert a paragraph break)</li> <li>lf (which will insert a line break)</li> </ul> </dd> <dt><b>Parameter xRange</b></dt> <dd>specifies the position of insertion. For example, <method>XSimpleText::createTextCursor can be used to get an <a href="XTextRange.html">XTextRange</a> for this argument. <p>If the parameter <a href="#bAbsorb">bAbsorb</a> was <b>true</b> the text range will contain the new inserted string, otherwise the range (and it's text) will remain unchanged. </dd> <dt><b>Parameter aString</b></dt> <dd>specifies the string to insert. </dd> <dt><b>Parameter bAbsorb</b></dt> <dd>specifies whether the text spanned by <var>xRange</var> will be replaced. If <b>true</b> then the content of <var>xRange</var> will be replaced by <var>aString</var>, otherwise <var>aString</var> will be inserted at the beginning of <var>xRange</var>. </dd> <dt><b>Example</b></dt> <dd><pre> xText.insertString( xTextCursor, "Hello " + aName$ + ",", false ) xText.insertControlCharacter( xTextCursor, ControlCharacter_PARAGRAPH_BREAK, false ); xText.insertString( xTextCursor, "more text ...", false ) </pre> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="insertControlCharacter" class="membertitle">insertControlCharacter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>insertControlCharacter</b>(</td> <td valign="top">[in] <a href="XTextRange.html">XTextRange</a></td> <td valign="bottom"> xRange,</td> </tr> <tr> <td/><td valign="top">[in] short</td> <td valign="bottom"> nControlCharacter,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bAbsorb )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>inserts a control character (like a paragraph break or a hard space) into the text.</dd> <dt><b>See also</b></dt> <dd><a href="ControlCharacter.html">ControlCharacter</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
