Represents a list box filter. A list box filter allows multiple selection and searching
while preserving space. This filter can handle a large amount of categorical values.
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.Application.FiltersFilterBase
Spotfire.Dxp.Application.FiltersColumnFilter
Spotfire.Dxp.Application.FiltersListBoxFilter
Namespace: Spotfire.Dxp.Application.Filters
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 30.0.10915.3380 (30.0.10915.3380)
Syntax
C#
[SerializableAttribute] [ToolContextAttribute] [PersistenceVersionAttribute(24, 0)] public sealed class ListBoxFilter : ColumnFilter, IDocumentNodeState, IListBoxFilter, IColumnFilter, IFilterBase, IPersistentDataProvider
The ListBoxFilter type exposes the following members.
Methods
Name | Description | |
---|---|---|
GetPropertyValue | Gets the value of a specified property. (Inherited from ColumnFilter.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
HasPropertyValue |
Checks if there is a valid value for a specified property.
(Inherited from ColumnFilter.) | |
IsSelected | Check if a value is selected or not.
| |
Reset |
Resets the filter. After calling this method, the filter does not
filter out any rows.
(Inherited from FilterBase.) | |
SetSelection(IEnumerableObject) | Select the given values, this will remove
all previously selected values. Note that the IncludeAllValues property needs to
be set to false in order for this selection to affect the filtering.
| |
SetSelection(Object) | Select the given values, this will remove
all previously selected values. Note that the IncludeAllValues property needs to
be set to false in order for this selection to affect the filtering.
| |
ToString |
Returns a String that represents this instance.
(Overrides ObjectToString.) |
Properties
Name | Description | |
---|---|---|
CheckBoxModeEnabled |
Gets or sets a value indicating whether this instance should use check boxes to indicate filtered items.
| |
Context |
Gets the context of this node.
(Inherited from DocumentNode.) | |
DataColumnReference |
Gets the column instance associated with this filter.
(Inherited from ColumnFilter.) | |
FilteredRows |
Gets the filtered rows.
(Inherited from FilterBase.) | |
HasEmptyValues |
Gets a value indicating whether the referenced column has any invalid rows.
(Inherited from ColumnFilter.) | |
Height | Gets or sets the number of lines to show in the UI list box.
| |
IncludeAllValues | Gets or sets a value indicating whether all values should be included or not.
True if filtering should include all values, if this property is set to
to true then this overrides the SelectedValues list. If this property is set then
empty values are included regardless of the IncludeEmpty setting.
| |
IncludeEmpty | Gets or sets a value indicating whether we should include empty values or not. If this is true
then the empty values in this column will not be filtered out by this filter,
otherwise the empty values will be filtered out by this filter.
| |
IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) | |
SearchExpression | Gets or sets the search expression that determines which values
are to be shown in the user interface. This property does not affect
which rows are filtered out.
| |
SearchFieldVisible | Gets or sets a value indicating whether the search field should be visible in the UI or not.
| |
SelectedValues | Gets a read-only collection of the currently selected values.
| |
Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) | |
TypeId |
Gets the type id.
(Inherited from FilterBase.) |
Explicit Interface Implementations
Name | Description | |
---|---|---|
IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) | |
INodeContextGetAncestorT |
Implements GetAncestorT.
(Inherited from DocumentNode.) | |
INodeContextGetServiceT |
Implements GetServiceT.
(Inherited from DocumentNode.) | |
INodeContextIsDescendantOf |
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.) | |
ITransactionsBeginAggregatedTransaction |
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.) | |
ITransactionsExecuteInvisibleTransaction |
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.) | |
ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.) | |
ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.) |
Version Information
See Also