<html> <head> <title>Service SheetFilterDescriptor</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="SheetFilterDescriptor-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Filtering" 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"><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">sheet</a> :: </p> </td> </tr> <tr> <td class="title">service SheetFilterDescriptor</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>represents a description of how a cell range is to be filtered. </dd> <dd><p>The descriptor contains properties and a collection of filter conditions (filter fields) which control the behaviour of a filter operation.</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/Spreadsheets/Filtering">Spreadsheets - Filtering</a></dd> </dl> </td> </tr> </table> <hr> <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"><a href="XSheetFilterDescriptor.html">XSheetFilterDescriptor</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>provides access to the collection of filter fields. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>provides access to the properties. </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="#IsCaseSensitive">IsCaseSensitive</a></td> <td class="imsum_right">specifies if the case of letters is important when comparing entries. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#SkipDuplicates">SkipDuplicates</a></td> <td class="imsum_right">specifies if duplicate entries are left out of the result. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#UseRegularExpressions">UseRegularExpressions</a></td> <td class="imsum_right">specifies if the <a href="TableFilterField.html">TableFilterField</a>::<a href="TableFilterField.html#StringValue">StringValue</a> strings are interpreted as regular expressions. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#SaveOutputPosition">SaveOutputPosition</a></td> <td class="imsum_right">specifies if the <a href="SheetFilterDescriptor.html">SheetFilterDescriptor</a>::<a href="SheetFilterDescriptor.html#OutputPosition">OutputPosition</a> position is saved for future calls. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/TableOrientation.html">TableOrientation</a><br> <a href="#Orientation">Orientation</a></td> <td class="imsum_right">specifies if columns or rows are filtered. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#ContainsHeader">ContainsHeader</a></td> <td class="imsum_right">specifies if the first row (or column) contains headers which should not be filtered. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#CopyOutputData">CopyOutputData</a></td> <td class="imsum_right">specifies if the filtered 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 filtered data are to be copied. </td> </tr> <tr> <td class="imsum_left">[ readonly ] long<br> <a href="#MaxFieldCount">MaxFieldCount</a></td> <td class="imsum_right">returns the maximum number of filter fields in the descriptor. </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="IsCaseSensitive" class="membertitle">IsCaseSensitive</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsCaseSensitive</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if the case of letters is important when comparing entries. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SkipDuplicates" class="membertitle">SkipDuplicates</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SkipDuplicates</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if duplicate entries are left out of the result. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UseRegularExpressions" class="membertitle">UseRegularExpressions</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>UseRegularExpressions</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if the <a href="TableFilterField.html">TableFilterField</a>::<a href="TableFilterField.html#StringValue">StringValue</a> strings are interpreted as regular expressions. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SaveOutputPosition" class="membertitle">SaveOutputPosition</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>SaveOutputPosition</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if the <a href="SheetFilterDescriptor.html">SheetFilterDescriptor</a>::<a href="SheetFilterDescriptor.html#OutputPosition">OutputPosition</a> position is saved for future calls. </dd> <dd><p>This is only used if <a href="SheetFilterDescriptor.html">SheetFilterDescriptor</a>::<a href="SheetFilterDescriptor.html#CopyOutputData">CopyOutputData</a> is <b>true</b>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Orientation" class="membertitle">Orientation</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/TableOrientation.html">TableOrientation</a> <b>Orientation</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if columns or rows are filtered. </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 if the first row (or column) contains headers which should not be filtered. </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 filtered 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 filtered data are to be copied. </dd> <dd><p>This is only used if <a href="SheetFilterDescriptor.html">SheetFilterDescriptor</a>::<a href="SheetFilterDescriptor.html#CopyOutputData">CopyOutputData</a> is <b>true</b>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MaxFieldCount" class="membertitle">MaxFieldCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>MaxFieldCount</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>returns the maximum number of filter fields in the descriptor. </dd> <dd><p>This read-only property indicates the maximum count of fields the current implementation supports.</p> </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
>
5708
