LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | Public Attributes | List of all members
SheetFilterDescriptor Service Referencepublished

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

import"SheetFilterDescriptor.idl";

Inheritance diagram for SheetFilterDescriptor:
XSheetFilterDescriptor XSheetFilterDescriptor2 XPropertySet XInterface XInterface XInterface

Exported Interfaces

interface XSheetFilterDescriptor
 provides access to the collection of filter fields. More...
 
interface XSheetFilterDescriptor2
 provides access to the collection of filter fields. More...
 
interface com::sun::star::beans::XPropertySet
 published service PropertySet More...
 

Public Attributes

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

Additional Inherited Members

- Public Member Functions inherited from XSheetFilterDescriptor
sequence< TableFilterFieldgetFilterFields ()
 returns the collection of filter fields. More...
 
void setFilterFields ([in] sequence< TableFilterField > aFilterFields)
 sets a new collection of filter fields. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Protected Member Functions inherited from XSheetFilterDescriptor2
sequence< TableFilterField2getFilterFields2 ()
 returns the collection of filter fields. More...
 
void setFilterFields2 ([in] sequence< TableFilterField2 > aFilterFields)
 sets a new collection of filter fields. More...
 
- Protected Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 

Detailed 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 behavior of a filter operation.

Developers Guide
Spreadsheets - Filtering

Exported Interfaces

published service PropertySet

provides access to the properties.

provides access to the collection of filter fields.

interface XSheetFilterDescriptor2
optional

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

Member Data Documentation

boolean ContainsHeader
property

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

boolean CopyOutputData
property

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

boolean IsCaseSensitive
property

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

long MaxFieldCount
propertyreadonly

returns the maximum number of filter fields in the descriptor.

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

specifies if columns or rows are filtered.

com::sun::star::table::CellAddress OutputPosition
property

specifies the position where filtered data are to be copied.

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

boolean SaveOutputPosition
property

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

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

boolean SkipDuplicates
property

specifies if duplicate entries are left out of the result.

boolean UseRegularExpressions
property

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


The documentation for this service was generated from the following file: