<html> <head> <title>Service SheetSortDescriptor2</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="SheetSortDescriptor2-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Sorting#Table_Sort_Descriptor" 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">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">sheet</a> :: </p> </td> </tr> <tr> <td class="title">service SheetSortDescriptor2</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>a description of how a cell range is to be sorted. </dd> <dd><p>This service extends the ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/TableSortDescriptor2.html">TableSortDescriptor2</a> service with spreadsheet specific properties.</p> </dd> <dt><b/></dt> <dd/></dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Sorting#Table_Sort_Descriptor">Spreadsheets - Sorting - Table Sort Descriptor</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">::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/TableSortDescriptor2.html">TableSortDescriptor2</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>provides common sorting properties. The fields in the SortFields property are not fully supported at the moment. IsCaseSensitive, CollatorLocale and CollatorAlgorithm are only supported once and if every field contains different of this it gives undefined results. </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">boolean<br> <a href="#BindFormatsToContent">BindFormatsToContent</a></td> <td class="imsum_right">specifies if cell formats are moved with the contents they belong to. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsUserListEnabled">IsUserListEnabled</a></td> <td class="imsum_right">specifies if a user defined sorting list is used. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#UserListIndex">UserListIndex</a></td> <td class="imsum_right">specifies which user defined sorting list is used. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CopyOutputData">CopyOutputData</a></td> <td class="imsum_right">specifies if the sorted data should be copied to another position in the document. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellAddress.html">CellAddress</a><br> <a href="#OutputPosition">OutputPosition</a></td> <td class="imsum_right">specifies the position where sorted data are to be copied. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#ContainsHeader">ContainsHeader</a></td> <td class="imsum_right">specifies whether the first row or column (depending on ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/TableSortDescriptor.html">TableSortDescriptor</a>::<a href="../table/TableSortDescriptor.html#Orientation">Orientation</a>) is a header which should not be sorted. </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="BindFormatsToContent" class="membertitle">BindFormatsToContent</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>BindFormatsToContent</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if cell formats are moved with the contents they belong to. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsUserListEnabled" class="membertitle">IsUserListEnabled</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsUserListEnabled</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if a user defined sorting list is used. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UserListIndex" class="membertitle">UserListIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>UserListIndex</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies which user defined sorting list is used. </dd> <dd><p>This property is only used, if <a href="SheetSortDescriptor.html">SheetSortDescriptor</a>::<a href="SheetSortDescriptor.html#IsUserListEnabled">IsUserListEnabled</a> is <b>true</b>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CopyOutputData" class="membertitle">CopyOutputData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>CopyOutputData</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if the sorted data should be copied to another position in the document. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="OutputPosition" class="membertitle">OutputPosition</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="../table/module-ix.html">table</a>::<a href="../table/CellAddress.html">CellAddress</a> <b>OutputPosition</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the position where sorted data are to be copied. </dd> <dd><p>This property is only used, if <a href="SheetSortDescriptor.html">SheetSortDescriptor</a>::<a href="SheetSortDescriptor.html#CopyOutputData">CopyOutputData</a> is <b>true</b>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ContainsHeader" class="membertitle">ContainsHeader</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>ContainsHeader</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies whether the first row or column (depending on ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/TableSortDescriptor.html">TableSortDescriptor</a>::<a href="../table/TableSortDescriptor.html#Orientation">Orientation</a>) is a header which should not be sorted. </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
>
5722
