Attributes' Summary |
FilterComponents |
is the number of filter components, or filter controls, which the filter controller is responsible
for.
|
DisjunctiveTerms |
is the number of disjunctive terms of the filter expression represented by the form based filter.
|
ActiveTerm |
denotes the active term of the filter controller.
|
Methods' Details |
addFilterControllerListener
- Description
- registers a listener to be notified of certain changes in the form based filter.
Registering the same listener multiple times results in multiple notifications of the same event,
and also requires multiple revocations of the listener.
|
|
removeFilterControllerListener
- Description
- revokes a listener which was previously registered to be notified of certain changes in the form based filter.
|
|
setPredicateExpression
void |
setPredicateExpression( |
[in] long |
_Component, |
| [in] long |
_Term, |
| [in] string |
_PredicateExpression ) |
raises( |
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- sets a given predicate expression
- Parameter _Component
- denotes the filter component whose expression is to be set. Must be greater than or equal to 0, and smaller than
FilterComponents.
- Parameter _Term
- denotes the disjunctive term in which the expression is to be set. Must be greater than or equal to 0,
and smaller than DisjunctiveTerms.
- Parameter _PredicateExpression
- denotes the predicate expression to set for the given filter component in the given term.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if one of the indexes is out of the allowed range
|
|
getFilterComponent
- Description
- retrieves the filter component with the given index.
The filter control has the same control model as the control which it stands in for. Consequently, you can use this method
to obtain the database column which the filter control works on, by examining the control model's BoundField
property.
- Parameter _Component
- denotes the index of the filter component whose control should be obtained. Must be greater than or equal to 0,
and smaller than FilterComponents.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if _Component is out of the allowed range.
- See also
- ::com::sun::star::form::component::DataAwareControlModel::BoundField
|
|
getPredicateExpressions
sequence< sequence< string > > |
getPredicateExpressions(); |
- Description
- retrieves the entirety of the predicate expressions represented by the filter controller.
Each element of the returned sequence is a disjunctive term, having exactly FilterComponents
elements, which denote the single predicate expressions of this term.
|
|
removeDisjunctiveTerm
- Description
- removes a given disjunctive term
- Parameter _Term
- the index of the term to remove. Must be greater than or equal to 0, and smaller than
DisjunctiveTerms.
- Throws
- ::com::sun::star::lang::IndexOutOfBoundsException
if _Term is out of the allowed range.
|
|
appendEmptyDisjunctiveTerm
void |
appendEmptyDisjunctiveTerm(); |
- Description
- appends an empty disjunctive term to the list of terms.
|
|
Attributes' Details |
FilterComponents
[ readonly ] long FilterComponents;
- Description
- is the number of filter components, or filter controls, which the filter controller is responsible
for.
This number is constant during one session of the form based filter.
|
|
DisjunctiveTerms
[ readonly ] long DisjunctiveTerms;
- Description
- is the number of disjunctive terms of the filter expression represented by the form based filter.
|
|
ActiveTerm
|
Top of Page
Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.
LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.
The Document Foundation acknowledges all community members, please find more info at our website.
Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.