Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 6721

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XText</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="XText-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="#devmanual" 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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</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 XText</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XText</strong>
&#x2517 <a href="XSimpleText.html">XSimpleText</a>
   &#x2517 <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="XSimpleText.html">XSimpleText</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</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>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>extends a <a href="XSimpleText.html">XSimpleText</a> by the capability of inserting 
 <a href="XTextContent.html">XTextContent</a>s.
 </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#Text_Contents_Other_Than_Strings">Text - Editing Text - Text Contents Other Than Strings</a></dd>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Editing_Text">Text - Editing Text</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="#insertTextContent">insertTextContent</a></td>
<td class="imsum_right">inserts a content, such as a text table, text frame or text
 field.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#removeTextContent">removeTextContent</a></td>
<td class="imsum_right">removes the specified content from the text object.
 
 &nbsp;</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="insertTextContent" class="membertitle">insertTextContent</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>insertTextContent</b>(</td>
<td valign="top">[in] <a href="XTextRange.html">XTextRange</a></td>
<td valign="bottom">&nbsp;xRange,</td>
</tr>
<tr>
<td/><td valign="top">[in] <a href="XTextContent.html">XTextContent</a></td>
<td valign="bottom">&nbsp;xContent,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;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 content, such as a text table, text frame or text
 field.
 
 </dd>
<dd><p>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.
 </p>

 </dd>
<dt><b>Parameter xRange</b></dt>
<dd>specifies the position of insertion.

 </dd>
<dt><b>Parameter xContent</b></dt>
<dd>the text content to be inserted.

 </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>xContent</var>, otherwise <var>xContent</var>
 will be inserted at the end of <var>xRange</var>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="removeTextContent" class="membertitle">removeTextContent</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>removeTextContent</b>(</td>
<td valign="top">[in] <a href="XTextContent.html">XTextContent</a></td>
<td valign="bottom">&nbsp;xContent )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>removes the specified content from the text object.
 
 </dd>
<dt><b>Example</b></dt>
<dd>xDoc.removeTextContent( xDoc.TextTables.MyOwnTableName )
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>