<html> <head> <title>Service TextPortion</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="TextPortion-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="#ServicesSummary" class="navisub">Services' Summary</a></td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#ServicesDetails" class="navisub">Services' Details</a></td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></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">service TextPortion</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>A TextPortion is a piece of text within a paragraph that does not contain changes of its attributes inside. </dd> <dd><p> It is created by an enumeration implemented in a paragraph service. It may be used to export the content of the paragraph to an external document format. </p> </dd> <dt><b>See also</b></dt> <dd><a href="TextPortionEnumeration.html">TextPortionEnumeration</a>, com::sun::star::text::XTextPortionEnumeration</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/Iterating_over_Text">Text - Iterating over Text</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Formatting">Text - Formatting</a></dd> </dl> </td> </tr> </table> <hr> <a name="ServicesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Summary</td> </tr> <tr> <td class="imsum_left"><a href="TextRange.html">TextRange</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>points to a sequence of characters within a <a href="Text.html">Text</a>. </dd> </dl> </td> </tr> </table> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XContentEnumerationAccess.html">XContentEnumerationAccess</a></td> <td class="imsum_right"><p>contains text frames, graphic objects, embedded objects or shapes that are anchored at or as character. (<a href="#XContentEnumerationAccess">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XTolerantMultiPropertySet.html">XTolerantMultiPropertySet</a></td> <td class="imsum_right"><p>gives access to a sequence of properties. (<a href="#XTolerantMultiPropertySet">details</a>)</p> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">[ readonly ] string<br> <a href="#TextPortionType">TextPortionType</a></td> <td class="imsum_right">contains the type of the text portion. </td> </tr> <tr> <td class="imsum_left">[ readonly ] short<br> <a href="#ControlCharacter">ControlCharacter</a></td> <td class="imsum_right"><b>[ DEPRECATED ]<br> </b>contains the control character of a text portion of type ControlCharacter. </td> </tr> <tr> <td class="imsum_left">[ readonly ] <a href="XTextContent.html">XTextContent</a><br> <a href="#Bookmark">Bookmark</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the bookmark of a text portion of type Bookmark. </td> </tr> <tr> <td class="imsum_left">[ readonly ] <a href="XTextContent.html">XTextContent</a><br> <a href="#DocumentIndexMark">DocumentIndexMark</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the document index mark of a text portion of type DocumentIndexMark. </td> </tr> <tr> <td class="imsum_left">[ readonly ] <a href="XTextContent.html">XTextContent</a><br> <a href="#ReferenceMark">ReferenceMark</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the bookmark of a text portion of type ReferenceMark. </td> </tr> <tr> <td class="imsum_left">[ readonly ] <a href="XFootnote.html">XFootnote</a><br> <a href="#Footnote">Footnote</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the footnote of a text portion of type Footnote. </td> </tr> <tr> <td class="imsum_left">[ readonly ] <a href="XTextField.html">XTextField</a><br> <a href="#TextField">TextField</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the text field of a text portion of type TextField. </td> </tr> <tr> <td class="imsum_left">[ readonly ] <a href="XTextContent.html">XTextContent</a><br> <a href="#InContentMetadata">InContentMetadata</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the text range of a text portion of type InContentMetadata. </td> </tr> <tr> <td class="imsum_left">[ readonly ] boolean<br> <a href="#IsCollapsed">IsCollapsed</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains whether the portion is a point only. </td> </tr> <tr> <td class="imsum_left">[ readonly ] boolean<br> <a href="#IsStart">IsStart</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains whether the portion is the start of the portion. </td> </tr> </table> <a name="ServicesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="TextRange" class="membertitle"><a href="TextRange.html">TextRange</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt>(referenced entity's summary:)</dt> <dd>points to a sequence of characters within a <a href="Text.html">Text</a>. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XContentEnumerationAccess" class="membertitle">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XContentEnumerationAccess.html">XContentEnumerationAccess</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains text frames, graphic objects, embedded objects or shapes that are anchored at or as character. </dd> <dt><b>See also</b></dt> <dd><a href="TextPortion.html#com.sun.star.text.TextFrame">com.sun.star.text.TextFrame</a>, <a href="TextPortion.html#com.sun.star.text.TextGraphicObject">com.sun.star.text.TextGraphicObject</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XTolerantMultiPropertySet" class="membertitle">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XTolerantMultiPropertySet.html">XTolerantMultiPropertySet</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>gives access to a sequence of properties. </dd> <dt><b>Since </b></dt> <dd>OOo 2.0 </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="TextPortionType" class="membertitle">TextPortionType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] string <b>TextPortionType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the type of the text portion. </dd> <dd><p> Valid content type names are:</p> <dl> <dt>Text</dt><dd>string content</dd> <dt>TextField</dt><dd>a text field</dd> <dt>TextContent</dt><dd>text content - supplied via the interface ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XContentEnumerationAccess.html">XContentEnumerationAccess</a></dd> <dt>ControlCharacter</dt><dd>a control character</dd> <dt>Footnote</dt><dd>a footnote or an endnote</dd> <dt>ReferenceMark</dt><dd>a reference mark</dd> <dt>DocumentIndexMark</dt><dd>a document index mark</dd> <dt>Bookmark</dt><dd>a bookmark</dd> <dt>Redline</dt><dd>a redline portion which is a result of the change tracking feature</dd> <dt>Ruby</dt><dd>a ruby attribute which is used in Asian text</dd> <dt>Frame</dt><dd>a frame</dd> <dt>SoftPageBreak</dt><dd>a soft page break</dd> <dt>InContentMetadata</dt><dd>a text range with attached metadata</dd> </dl> <p>For Reference marks, document index marks, etc., 2 text portions will be generated, one for the start position and one for the end position.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ControlCharacter" class="membertitle">ControlCharacter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] short <b>ControlCharacter</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dt><b>Deprecation Info</b></dt> <dd>type ControlCharacter no longer implemented </dd> <dt><b>Description</b></dt> <dd>contains the control character of a text portion of type ControlCharacter. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Bookmark" class="membertitle">Bookmark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] <a href="XTextContent.html">XTextContent</a> <b>Bookmark</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the bookmark of a text portion of type Bookmark. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DocumentIndexMark" class="membertitle">DocumentIndexMark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] <a href="XTextContent.html">XTextContent</a> <b>DocumentIndexMark</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the document index mark of a text portion of type DocumentIndexMark. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ReferenceMark" class="membertitle">ReferenceMark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] <a href="XTextContent.html">XTextContent</a> <b>ReferenceMark</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the bookmark of a text portion of type ReferenceMark. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Footnote" class="membertitle">Footnote</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] <a href="XFootnote.html">XFootnote</a> <b>Footnote</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the footnote of a text portion of type Footnote. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TextField" class="membertitle">TextField</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] <a href="XTextField.html">XTextField</a> <b>TextField</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the text field of a text portion of type TextField. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="InContentMetadata" class="membertitle">InContentMetadata</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] <a href="XTextContent.html">XTextContent</a> <b>InContentMetadata</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the text range of a text portion of type InContentMetadata. </dd> <dt><b>Since </b></dt> <dd>OOo 3.2 </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsCollapsed" class="membertitle">IsCollapsed</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] boolean <b>IsCollapsed</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains whether the portion is a point only. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsStart" class="membertitle">IsStart</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] boolean <b>IsStart</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains whether the portion is the start of the portion. </dd> <dd><p>This is used for portions which are represented by 2 TextPortion objects (e.g., DocmentIndexMark).</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <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>
