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: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(24, 0)] [ToolContextAttribute] public sealed class ListBoxFilter : ColumnFilter, IDocumentNodeState, IListBoxFilter, IColumnFilter, IFilterBase, IPersistentDataProvider
The ListBoxFilter type exposes the following members.
Methods
Name | Description | |
---|---|---|
CreateEventRelay(PropertyName, StatelessDependencyDeclarer) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) | |
CreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) | |
CreatePropertyT(PropertyName, UndoableListT) |
Creates an UndoableListT and assigns it to the specified field.
The UndoableListT will have the specified propertyName.
(Inherited from DocumentNode.) | |
CreatePropertyT(PropertyName, UndoableSetT) |
Creates an UndoableSetT and assigns it to the specified field.
The UndoableSetT will have the specified propertyName.
(Inherited from DocumentNode.) | |
CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) |
Creates an UndoableCrossReferencePropertyT and assigns it to the specified field.
The UndoableCrossReferencePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) | |
CreatePropertyT(PropertyName, UndoablePropertyT, T) |
Creates an UndoablePropertyT and assigns it to the specified field.
The UndoablePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) | |
CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) |
Creates an UndoableDictionaryTKey, TValue and assigns it to the specified field.
The UndoableDictionaryTKey, TValue will have the specified propertyName.
(Inherited from DocumentNode.) | |
CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) |
Creates an UndoableKeyedCollectionTKey, TNode and assigns it to the specified field.
The UndoableKeyedCollectionTKey, TNode will have the specified propertyName.
(Inherited from DocumentNode.) | |
CreateReadOnlyPropertyT |
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.) | |
CreateRuntimeConstantT |
Creates a runtime constant. A runtime constant is a property in the document model
whose value is computed once when first accessed. The value is then disposed
along with the DocumentNode.
(Inherited from DocumentNode.) | |
CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) | Obsolete.
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) | |
CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) |
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) | |
DeclareInternalEventHandlers | Override this method to declare handlers of internal events.
(Inherited from DocumentNode.) | |
DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) |
Deserializes an UndoableCrossReferencePropertyT with value of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) | |
DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) | (Inherited from DocumentNode.) | |
DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) | (Inherited from DocumentNode.) | |
DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) | (Inherited from DocumentNode.) | |
DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) | (Inherited from DocumentNode.) | |
DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) | (Inherited from DocumentNode.) | |
DeserializeReadOnlyPropertyT |
Deserializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) | |
DuplicateSubtreeT | Returns a copy of the sub tree spanned from this node that
has the same outwards non-owning references. The returned copy will
be in state New and is intended to be attached to the document
immediately. (Inherited from DocumentNode.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetPersistedTypeName | Can be used in the deserialization constructor to get the type name that the class
corresponding to this class had when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) | |
GetPersistedVersion | Can be used in the deserialization constructor to get the persistence version that this class
was marked with when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) | |
GetPropertyValue | Gets the value of a specified property. (Inherited from ColumnFilter.) | |
GetService | Override this method to provide services accessible
from this node and its descendants.
If you can not provide the requested service, you should call
base.GetService which relays the request to the owner
or to the AnalysisApplication if no owner is set.
(Inherited from Node.) | |
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.) | |
InternalTransaction |
Starts an internal transaction on the document model by
executing the specified executor delegate.
(Inherited from DocumentNode.) | |
IsSelected | Check if a value is selected or not.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnConfigure |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) | |
OnConfigured |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) | |
OnReconfigure |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) | |
OnReconfigured |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) | |
Reset |
Resets the filter. After calling this method, the filter does not
filter out any rows.
(Inherited from FilterBase.) | |
SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT) | Serializes an Undoable*Property with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) | |
SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT) | Serializes an UndoableList with values of type T
storing it in info with key list.Name.
(Inherited from DocumentNode.) | |
SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT) | Serializes an UndoableProperty with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) | |
SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT) | Serializes an UndoableSet storing it in info
with key given by the property name of the set.
(Inherited from DocumentNode.) | |
SerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue) | Serializes an UndoableDictionary storing it in info
with key given by the property name of the dictionary.
(Inherited from DocumentNode.) | |
SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) |
Serializes an UndoableKeyedCollectionTKey, TNode storing it in info
with key given by the property name of the keyedCollection.
(Inherited from DocumentNode.) | |
SerializeReadOnlyPropertyT |
Serializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) | |
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.) | |
ValidateAttached | Validates that the node is attached.
(Inherited from DocumentNode.) |
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