Sophie

Sophie

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

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

<html>
<head>
<title>Service LineNumberingProperties</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="LineNumberingProperties-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Text/Line_Numbering_and_Outline_Numbering#Line_Numbering" 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">Included Services</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 LineNumberingProperties</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to the settings of the line numbering.
 </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/Line_Numbering_and_Outline_Numbering#Line_Numbering">Text - Line Numbering and Outline Numbering - Line Numbering</a></dd>
</dl>
</td>
</tr>
</table>
<hr>
<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">boolean<br>
<a href="#IsOn">IsOn</a></td>
<td class="imsum_right">If <b>true</b>, line numbering is used.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#CharStyleName">CharStyleName</a></td>
<td class="imsum_right">The name of the character style that is used for the line number.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#CountEmptyLines">CountEmptyLines</a></td>
<td class="imsum_right">If <b>true</b>, empty lines are counted.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#CountLinesInFrames">CountLinesInFrames</a></td>
<td class="imsum_right">If <b>true</b>, lines in frames are included in counting.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#Distance">Distance</a></td>
<td class="imsum_right">specifies the distance between the line number and the start or
 end of the text area.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#Interval">Interval</a></td>
<td class="imsum_right">Line numbers are shown on every <var>Interval</var>th line.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#SeparatorText">SeparatorText</a></td>
<td class="imsum_right">specifies the string that is used for the line separator.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#SeparatorInterval">SeparatorInterval</a></td>
<td class="imsum_right">The line separator is shown every <var>SeparatorInterval</var>th line.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#NumberPosition">NumberPosition</a></td>
<td class="imsum_right">specifies the position of the line number (constant LineNumberPositions
 left/right/inside/outside).
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#NumberingType">NumberingType</a></td>
<td class="imsum_right">specifies the type of the numbering.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#RestartAtEachPage">RestartAtEachPage</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>specifies if the line numbering should start from the
 beginning at each page.

 &nbsp;</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="IsOn" class="membertitle">IsOn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>IsOn</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If <b>true</b>, line numbering is used.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="CharStyleName" class="membertitle">CharStyleName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>CharStyleName</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The name of the character style that is used for the line number.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="CountEmptyLines" class="membertitle">CountEmptyLines</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>CountEmptyLines</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If <b>true</b>, empty lines are counted.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="CountLinesInFrames" class="membertitle">CountLinesInFrames</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>CountLinesInFrames</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>If <b>true</b>, lines in frames are included in counting.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Distance" class="membertitle">Distance</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>Distance</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>specifies the distance between the line number and the start or
 end of the text area.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Interval" class="membertitle">Interval</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>Interval</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Line numbers are shown on every <var>Interval</var>th line.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="SeparatorText" class="membertitle">SeparatorText</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>SeparatorText</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>specifies the string that is used for the line separator.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="SeparatorInterval" class="membertitle">SeparatorInterval</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>SeparatorInterval</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The line separator is shown every <var>SeparatorInterval</var>th line.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="NumberPosition" class="membertitle">NumberPosition</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>NumberPosition</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>specifies the position of the line number (constant LineNumberPositions
 left/right/inside/outside).
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="NumberingType" class="membertitle">NumberingType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>NumberingType</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>specifies the type of the numbering.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="RestartAtEachPage" class="membertitle">RestartAtEachPage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>RestartAtEachPage</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>specifies if the line numbering should start from the
 beginning at each page.

 </dd>
<dd><p>If set to <b>false</b> the line numbering will be continous.</p>

 </dd>
<dt><b/></dt>
<dd/></dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<br>&nbsp;<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>