:: com :: sun :: star :: sheet ::

service SheetFilterDescriptor
Description
represents a description of how a cell range is to be filtered.

The descriptor contains properties and a collection of filter conditions (filter fields) which control the behaviour of a filter operation.

Developers Guide
8.3.5 Spreadsheet Documents - Working with Spreadsheet Documents - Database Operations - Filtering

Exported Interfaces
XSheetFilterDescriptor
Description
provides access to the collection of filter fields.
::com::sun::star::beans::XPropertySet
Description
provides access to the properties.
Properties' Summary
IsCaseSensitive specifies if the case of letters is important when comparing entries.
SkipDuplicates specifies if duplicate entries are left out of the result.
UseRegularExpressions specifies if the TableFilterField::StringValue strings are interpreted as regular expressions.
SaveOutputPosition specifies if the SheetFilterDescriptor::OutputPosition position is saved for future calls.
Orientation specifies if columns or rows are filtered.
ContainsHeader specifies if the first row (or column) contains headers which should not be filtered.
CopyOutputData specifies if the filtered data should be copied to another position in the document.
OutputPosition specifies the position where filtered data are to be copied.
MaxFieldCount returns the maximum number of filter fields in the descriptor.
Properties' Details
IsCaseSensitive
boolean IsCaseSensitive;
Description
specifies if the case of letters is important when comparing entries.
SkipDuplicates
boolean SkipDuplicates;
Description
specifies if duplicate entries are left out of the result.
UseRegularExpressions
boolean UseRegularExpressions;
Description
specifies if the TableFilterField::StringValue strings are interpreted as regular expressions.
SaveOutputPosition
boolean SaveOutputPosition;
Description
specifies if the SheetFilterDescriptor::OutputPosition position is saved for future calls.

This is only used if SheetFilterDescriptor::CopyOutputData is true .

Orientation
::com::sun::star::table::TableOrientation Orientation;
Description
specifies if columns or rows are filtered.
ContainsHeader
boolean ContainsHeader;
Description
specifies if the first row (or column) contains headers which should not be filtered.
CopyOutputData
boolean CopyOutputData;
Description
specifies if the filtered data should be copied to another position in the document.
OutputPosition
::com::sun::star::table::CellAddress OutputPosition;
Description
specifies the position where filtered data are to be copied.

This is only used if SheetFilterDescriptor::CopyOutputData is true .

MaxFieldCount
[ readonly ] long MaxFieldCount;
Description
returns the maximum number of filter fields in the descriptor.

This read-only property indicates the maximum count of fields the current implementation supports.


 
Top of Page