Service SheetFilterDescriptor

Services' Summary

Interfaces' Summary

Properties' Summary

Services' Details

Interfaces' Details

Properties' Details

:: 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: Spreadsheets - Filtering

Exported Interfaces - Summary
XSheetFilterDescriptor	provides access to the collection of filter fields.
XSheetFilterDescriptor2	provides access to the collection of filter fields. (details)
::com::sun::star::beans::XPropertySet	provides access to the properties.

Properties' Summary
boolean IsCaseSensitive	specifies if the case of letters is important when comparing entries.
boolean SkipDuplicates	specifies if duplicate entries are left out of the result.
boolean UseRegularExpressions	specifies if the TableFilterField::StringValue strings are interpreted as regular expressions.
boolean SaveOutputPosition	specifies if the SheetFilterDescriptor::OutputPosition position is saved for future calls.
::com::sun::star::table::TableOrientation Orientation	specifies if columns or rows are filtered.
boolean ContainsHeader	specifies if the first row (or column) contains headers which should not be filtered.
boolean CopyOutputData	specifies if the filtered data should be copied to another position in the document.
::com::sun::star::table::CellAddress OutputPosition	specifies the position where filtered data are to be copied.
[ readonly ] long MaxFieldCount	returns the maximum number of filter fields in the descriptor.

Exported Interfaces - Details

XSheetFilterDescriptor

Description provides access to the collection of filter fields.

XSheetFilterDescriptor2

Usage Restrictions optional Description provides access to the collection of filter fields. This interface provides a sequence of TableFilterField2 structures supporting a wider range of comparison operators, compared to the TableFilterField structure provided by interface XSheetFilterDescriptor. Since OOo 3.2

::com::sun::star::beans::XPropertySet

Description provides access to the properties.

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

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous