LibreOffice
LibreOffice 5.0 SDK API Reference
|
represents a description of how a cell range is to be filtered. More...
import "SheetFilterDescriptor.idl";
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 | |
![]() | |
sequence< TableFilterField > | getFilterFields () |
returns the collection of filter fields. More... | |
void | setFilterFields ([in] sequence< TableFilterField > aFilterFields) |
sets a new collection of filter fields. More... | |
![]() | |
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... | |
![]() | |
sequence< TableFilterField2 > | getFilterFields2 () |
returns the collection of filter fields. More... | |
void | setFilterFields2 ([in] sequence< TableFilterField2 > aFilterFields) |
sets a new collection of filter fields. More... | |
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.
interface com::sun::star::beans::XPropertySet |
published service PropertySet
provides access to the properties.
interface XSheetFilterDescriptor |
provides access to the collection of filter fields.
|
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.
|
property |
specifies if the first row (or column) contains headers which should not be filtered.
|
property |
specifies if the filtered data should be copied to another position in the document.
|
property |
specifies if the case of letters is important when comparing entries.
|
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.
|
property |
specifies if columns or rows are filtered.
|
property |
specifies the position where filtered data are to be copied.
This is only used if SheetFilterDescriptor::CopyOutputData is TRUE
.
|
property |
specifies if the SheetFilterDescriptor::OutputPosition position is saved for future calls.
This is only used if SheetFilterDescriptor::CopyOutputData is TRUE
.
|
property |
specifies if duplicate entries are left out of the result.
|
property |
specifies if the TableFilterField::StringValue strings are interpreted as regular expressions.