ListBoxFilter Class TIBCO Spotfire 7.6 API Reference
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

SystemObject
  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

  NameDescription
Protected methodCreateEventRelay(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.)
Protected methodCreateEventRelay(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.)
Protected methodCreatePropertyT(PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected methodCreatePropertyT(PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected methodCreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) (Inherited from DocumentNode.)
Protected methodCreatePropertyT(PropertyName, UndoablePropertyT, T) (Inherited from DocumentNode.)
Protected methodCreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected methodCreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodCreateReadOnlyPropertyT
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.)
Protected methodCreateRuntimeConstantT
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.)
Protected methodCreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) Obsolete. (Inherited from DocumentNode.)
Protected methodCreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) (Inherited from DocumentNode.)
Protected methodDeclareInternalEventHandlers
Override this method to declare handlers of internal events.
(Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected methodDeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodDeserializeReadOnlyPropertyT
Deserializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodDuplicateSubtreeT
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.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetPersistedTypeName
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.)
Protected methodGetPersistedVersion
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.)
Public methodGetPropertyValue
Gets the value of a specified property.
(Inherited from ColumnFilter.)
Protected methodGetService
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.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasPropertyValue
Checks if there is a valid value for a specified property.
(Inherited from ColumnFilter.)
Protected methodInternalTransaction
Starts an internal transaction on the document model by executing the specified executor delegate.
(Inherited from DocumentNode.)
Public methodIsSelected
Check if a value is selected or not.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnConfigure
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnConfigured
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigure
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigured
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Public methodReset
Resets the filter. After calling this method, the filter does not filter out any rows.
(Inherited from FilterBase.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT)
Serializes an Undoable*Property with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableListT)
Serializes an UndoableList with values of type T storing it in info with key list.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT)
Serializes an UndoableProperty with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT)
Serializes an UndoableSet storing it in info with key given by the property name of the set.
(Inherited from DocumentNode.)
Protected methodSerializePropertyTKey, 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.)
Protected methodSerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodSerializeReadOnlyPropertyT
Serializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Public methodSetSelection(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.
Public methodSetSelection(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.
Public methodToString
Returns a String that represents this instance.
(Overrides ObjectToString.)
Protected methodValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
Top
Properties

  NameDescription
Public propertyCheckBoxModeEnabled
Gets or sets a value indicating whether this instance should use check boxes to indicate filtered items.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyDataColumnReference
Gets the column instance associated with this filter.
(Inherited from ColumnFilter.)
Public propertyFilteredRows
Gets the filtered rows.
(Inherited from FilterBase.)
Public propertyHasEmptyValues
Gets a value indicating whether the referenced column has any invalid rows.
(Inherited from ColumnFilter.)
Public propertyHeight
Gets or sets the number of lines to show in the UI list box.
Public propertyIncludeAllValues
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.
Public propertyIncludeEmpty
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.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertySearchExpression
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.
Public propertySearchFieldVisible
Gets or sets a value indicating whether the search field should be visible in the UI or not.
Public propertySelectedValues
Gets a read-only collection of the currently selected values.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyTypeId
Gets the type id.
(Inherited from FilterBase.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodIServiceProviderGetService
Implements IServiceProvider.
(Inherited from Node.)
Explicit interface implementationPrivate methodINodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Top
Version Information

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference