Sophie

Sophie

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

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

<html>
<head>
<title>Service NumberingLevel</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="NumberingLevel-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">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 NumberingLevel</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>provides access to a numbering level as part of the Numbering Rules.
 </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">short<br>
<a href="#Adjust">Adjust</a></td>
<td class="imsum_right">adjusts the numbering (HoriOrientation_LEFT/RIGHT/CENTER)

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#ParentNumbering">ParentNumbering</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>number of upper levels that are included in the current numbering symbol.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#Prefix">Prefix</a></td>
<td class="imsum_right">the prefix of the numbering symbol.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#Suffix">Suffix</a></td>
<td class="imsum_right">the suffix of the numbering symbol.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#CharStyleName">CharStyleName</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>Name of the character style that is used for the numbering symbol.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#BulletId">BulletId</a></td>
<td class="imsum_right"><b>[ DEPRECATED ]<br>
</b><b>[ OPTIONAL ]<br>
</b>the ID of the symbol in the given font. This is only valid if the
 numbering type is <b>NumberingType::CHAR_SPECIAL</b>.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#BulletChar">BulletChar</a></td>
<td class="imsum_right">contains the symbol in the given font. This is only valid if the
 numbering type is <b>NumberingType::CHAR_SPECIAL</b>.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#BulletFontName">BulletFontName</a></td>
<td class="imsum_right">the name of the font for the symbol. This is only valid if the
 numbering type is <b>NumberingType::CHAR_SPECIAL</b>.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/FontDescriptor.html">FontDescriptor</a><br>
<a href="#BulletFont">BulletFont</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>the font used to paint the bullet.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#GraphicURL">GraphicURL</a></td>
<td class="imsum_right">the URL of the graphic file that is used as the numbering symbol.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XBitmap.html">XBitmap</a><br>
<a href="#GraphicBitmap">GraphicBitmap</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>the bitmap containing the bullet.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Size.html">Size</a><br>
<a href="#GraphicSize">GraphicSize</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>size of the graphic that is used as bullet.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#VertOrient">VertOrient</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>contains the vertical orientation of a graphic.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#StartWith">StartWith</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>specifies the start value for the numbering.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#LeftMargin">LeftMargin</a></td>
<td class="imsum_right">specifies the left margin of the numbering
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#SymbolTextDistance">SymbolTextDistance</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>specifies the distance between the numbering symbol and the text of
 the paragraph.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#FirstLineOffset">FirstLineOffset</a></td>
<td class="imsum_right">specifies the offset between the beginning of the first line and
 the beginning of the following lines of the paragraph.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#NumberingType">NumberingType</a></td>
<td class="imsum_right">specifies the type of numbering.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">string<br>
<a href="#HeadingStyleName">HeadingStyleName</a></td>
<td class="imsum_right">contains the name of the paragraph style that is interpreted as the
 header of this level. It is only contained in the levels of
 chapter numbering rules.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a><br>
<a href="#BulletColor">BulletColor</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>contains the color for the symbol. This is only valid if the
 numbering type is <b>NumberingType::CHAR_SPECIAL</b>.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">short<br>
<a href="#BulletRelSize">BulletRelSize</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>contains the size of the symbol relative to the high of the paragraph. This is only valid if the
 numbering type is <b>NumberingType::CHAR_SPECIAL</b>.
 &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="Adjust" class="membertitle">Adjust</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>Adjust</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>adjusts the numbering (HoriOrientation_LEFT/RIGHT/CENTER)

 </dd>
<dd><p>
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="ParentNumbering" class="membertitle">ParentNumbering</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>ParentNumbering</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>number of upper levels that are included in the current numbering symbol.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Prefix" class="membertitle">Prefix</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>Prefix</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>the prefix of the numbering symbol.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Suffix" class="membertitle">Suffix</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>Suffix</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>the suffix of the numbering symbol.
 </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>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>Name of the character style that is used for the numbering symbol.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="BulletId" class="membertitle">BulletId</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>BulletId</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>deprecated</i></dd>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>the ID of the symbol in the given font. This is only valid if the
 numbering type is <b>NumberingType::CHAR_SPECIAL</b>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="BulletChar" class="membertitle">BulletChar</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>BulletChar</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>contains the symbol in the given font. This is only valid if the
 numbering type is <b>NumberingType::CHAR_SPECIAL</b>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="BulletFontName" class="membertitle">BulletFontName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>BulletFontName</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>the name of the font for the symbol. This is only valid if the
 numbering type is <b>NumberingType::CHAR_SPECIAL</b>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="BulletFont" class="membertitle">BulletFont</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/FontDescriptor.html">FontDescriptor</a> <b>BulletFont</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>the font used to paint the bullet.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="GraphicURL" class="membertitle">GraphicURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>GraphicURL</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>the URL of the graphic file that is used as the numbering symbol.

 </dd>
<dd><p> This is only valid if the numbering type is
 <b>NumberingType::BITMAP</b>.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="GraphicBitmap" class="membertitle">GraphicBitmap</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XBitmap.html">XBitmap</a> <b>GraphicBitmap</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>the bitmap containing the bullet.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="GraphicSize" class="membertitle">GraphicSize</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Size.html">Size</a> <b>GraphicSize</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>size of the graphic that is used as bullet.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="VertOrient" class="membertitle">VertOrient</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>VertOrient</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>contains the vertical orientation of a graphic.

 </dd>
<dd><p> It is set using com::sun::star::text::VertOrientation.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="StartWith" class="membertitle">StartWith</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>StartWith</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>specifies the start value for the numbering.

 </dd>
<dd><p>This property is only valid if the numbering type is not
 <b>NumberingType::BITMAP</b> or
 <b>NumberingType::CHAR_SPECIAL</b>.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="LeftMargin" class="membertitle">LeftMargin</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>LeftMargin</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>specifies the left margin of the numbering
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="SymbolTextDistance" class="membertitle">SymbolTextDistance</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>SymbolTextDistance</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>specifies the distance between the numbering symbol and the text of
 the paragraph.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="FirstLineOffset" class="membertitle">FirstLineOffset</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>FirstLineOffset</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>specifies the offset between the beginning of the first line and
 the beginning of the following lines of the paragraph.
 </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 numbering.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="HeadingStyleName" class="membertitle">HeadingStyleName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>string <b>HeadingStyleName</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>contains the name of the paragraph style that is interpreted as the
 header of this level. It is only contained in the levels of
 chapter numbering rules.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="BulletColor" class="membertitle">BulletColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>BulletColor</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>contains the color for the symbol. This is only valid if the
 numbering type is <b>NumberingType::CHAR_SPECIAL</b>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="BulletRelSize" class="membertitle">BulletRelSize</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>BulletRelSize</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>contains the size of the symbol relative to the high of the paragraph. This is only valid if the
 numbering type is <b>NumberingType::CHAR_SPECIAL</b>.
 </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>