<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="#IncludedServices" class="navisub">Included Services</a></td> <td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</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 enumaration implemented in a paragraph service. It is used to export the content of the paragraph to an external document format.</p> </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="IncludedServices"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services</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="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces</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"><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/></dt> <dd/><dt><b/></dt> <dd/></dl> </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"><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/></dt> <dd/></dl> </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">returns the control character if the text portion contains a ControlCharacter </td> </tr> <tr> <td class="imsum_left"><a href="XTextContent.html">XTextContent</a><br> <a href="#Bookmark">Bookmark</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the bookmark if the portion is of the type </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsCollapsed">IsCollapsed</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determines whether the portion is a point only. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsStart">IsStart</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>determines whether the portion is a start portion if two portions are needed to include an object (i.e. DocmentIndexMark) </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> <UL> <LI><P>Text - string content</P> <LI><P>TextField - TextField content</P> <LI><P>TextContent - text content - supplied via the interface XContentEnumerationAccess</P> <LI><P>Footnote - a footnote or an endnote</P> <LI><P>ControlCharacter - a control character</P> <LI><P>ReferenceMark - a reference mark </P> <LI><P>DocumentIndexMark - a document index mark</P> <LI><P>Bookmark - a bookmark</P> <LI><P>Redline - a redline portion which is a result of the change tracking feature.</P> <LI><P>Ruby - a ruby attribute which is used in Asian text</P> <LI><P>Frame - a frame.</P> </UL> <p>The text portions for reference marks and document index marks are generated twice for each mark since they may include string content.</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>Description</b></dt> <dd>returns the control character if the text portion contains a 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><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 if the portion is of the type </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>boolean <b>IsCollapsed</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determines 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>boolean <b>IsStart</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>determines whether the portion is a start portion if two portions are needed to include an object (i.e. DocmentIndexMark)</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 © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
6597
