<html> <head> <title>Service DocumentIndexMark</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="DocumentIndexMark-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</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">Exported Interfaces</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 DocumentIndexMark</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>is a <a href="TextRange.html">TextRange</a> which is explicitly marked as an index entry for a <a href="DocumentIndex.html">DocumentIndex</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="TextContent.html">TextContent</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>is an object which can be anchored in a text, like instances of <a href="TextFrame.html">TextFrame</a> or <a href="TextFields.html">TextFields</a>. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="BaseIndexMark.html">BaseIndexMark</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>is a <a href="TextRange.html">TextRange</a> which is explicitly marked as an index entry. This is the base service of index marks for <a href="DocumentIndex.html">DocumentIndex</a>, <a href="ContentIndex.html">ContentIndex</a>, and <a href="UserIndex.html">UserIndex</a>. </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">string<br> <a href="#PrimaryKey">PrimaryKey</a></td> <td class="imsum_right">contains the primary key of the index entry. It is used to build a hierarchical document index. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#SecondaryKey">SecondaryKey</a></td> <td class="imsum_right">contains the secondary key of the index entry. It is used to build a hierarchical document index. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsMainEntry">IsMainEntry</a></td> <td class="imsum_right">determins if this entry is a main entry. In a document index this entry will be emphasized by assigning a character style to it. </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="PrimaryKey" class="membertitle">PrimaryKey</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>PrimaryKey</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the primary key of the index entry. It is used to build a hierarchical document index. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SecondaryKey" class="membertitle">SecondaryKey</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>SecondaryKey</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the secondary key of the index entry. It is used to build a hierarchical document index. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsMainEntry" class="membertitle">IsMainEntry</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsMainEntry</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determins if this entry is a main entry. In a document index this entry will be emphasized by assigning a character style to it. </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>