(incubating) | The Free and Open Productivity Suite
Announcing Apache OpenOffice 3.4

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
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.

::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.
::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 © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache Feather

Copyright & License | Privacy | Contact Us

Apache and the Apache feather logos are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.