service SheetFilterDescriptor in module com::sun::star::sheet::

(Global Index)

Syntax

service SheetFilterDescriptor;

Description

a description of how a cell range is to be filtered.

Exported Interfaces

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

Description

represents a description of how to filter cells.


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

Description

provides information about and access to the properties from an implementation.


Property 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.

Property Details



IsCaseSensitive

Syntax

boolean IsCaseSensitive;

Description

specifies if the case of letters is important when comparing entries.


SkipDuplicates

Syntax

boolean SkipDuplicates;

Description

specifies if duplicate entries are left out of the result.


UseRegularExpressions

Syntax

boolean UseRegularExpressions;

Description

specifies if the TableFilterField::StringValue strings are interpreted as regular expressions.


SaveOutputPosition

Syntax

boolean SaveOutputPosition;

Description

specifies if the SheetFilterDescriptor::OutputPosition position is saved for future calls.

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


Orientation

Syntax

com::sun::star::table::TableOrientation Orientation;

Description

specifies if columns or rows are filtered.


ContainsHeader

Syntax

boolean ContainsHeader;

Description

specifies if the first row (or column) contains headers which should not be filtered.


CopyOutputData

Syntax

boolean CopyOutputData;

Description

specifies if the filtered data should be copied to another position in the document.


OutputPosition

Syntax

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

Syntax

[readonly] long MaxFieldCount;

Description

returns the maximum number of filter fields in the descriptor.

Top of Page