FilteringScheme Class TIBCO Spotfire 7.6 API Reference
A FilteringScheme contains Spotfire.Dxp.Application.Filters separated in FilterCollections for each DataTable in the Document.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.DocumentModelNode
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Framework.DocumentModelDocumentNodeListBaseFilterCollection
        Spotfire.Dxp.Framework.DocumentModelDocumentNodeListFilterCollection
          Spotfire.Dxp.Application.FiltersFilteringScheme

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(2, 0)]
[FriendVisibleAttribute(true)]
public sealed class FilteringScheme : DocumentNodeList<FilterCollection>

The FilteringScheme type exposes the following members.

Methods

  NameDescription
Public methodAdd
Adds an item to this collection.
(Inherited from DocumentNodeListT.)
Public methodAddRange
Adds the elements of the specified collection to the end of this collection.
(Inherited from DocumentNodeListT.)
Public methodAutoConfigure
Public methodClear
Removes all items from this collection.
(Inherited from DocumentNodeListT.)
Public methodContains
Determines whether the specified value is in this collection.
(Inherited from DocumentNodeListBaseT.)
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.)
Public methodGetEnumerator
Returns an enumerator that iterates through this collection.
(Inherited from DocumentNodeListBaseT.)
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.)
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 methodIndexOf
Searches for the specified value and returns the zero-based index of the first occurrence within this collection.
(Inherited from DocumentNodeListBaseT.)
Public methodInsert
Inserts an element into this collection at the specified index.
(Inherited from DocumentNodeListT.)
Public methodInsertRange
Inserts the elements of the specified collection at the specified index in this collection.
(Inherited from DocumentNodeListT.)
Protected methodInternalAdd
Adds an item to this collection.
(Inherited from DocumentNodeListBaseT.)
Protected methodInternalClear
Removes all items from this collection.
(Inherited from DocumentNodeListBaseT.)
Protected methodInternalCopyTo
Copies the elements to the array starting at the specified arrayIndex.
(Inherited from DocumentNodeListBaseT.)
Protected methodInternalInsert
Inserts an element into this collection at the specified index.
(Inherited from DocumentNodeListBaseT.)
Protected methodInternalInsertRange
InsertRange.
(Inherited from DocumentNodeListBaseT.)
Protected methodInternalMove
Moves the item at the specified index to a new location in the collection.
(Inherited from DocumentNodeListBaseT.)
Protected methodInternalRemove
Removes the first occurrence of a specific object from this collection.
(Inherited from DocumentNodeListBaseT.)
Protected methodInternalRemoveAt
Removes the element at the specified index.
(Inherited from DocumentNodeListBaseT.)
Protected methodInternalRemoveRange
RemoveRange.
(Inherited from DocumentNodeListBaseT.)
Protected methodInternalReplaceAll
Replaces the contents of the list with the elements in the specified collection.
(Inherited from DocumentNodeListBaseT.)
Protected methodInternalSet
Sets the item at the specified index.
(Inherited from DocumentNodeListBaseT.)
Protected methodInternalSort
Sorts the elements in the collection using the specified ComparisonT delegate.
(Inherited from DocumentNodeListBaseT.)
Protected methodInternalTransaction
Starts an internal transaction on the document model by executing the specified executor delegate.
(Inherited from DocumentNode.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMove
Moves the item at the specified index to a new location in the collection.
(Inherited from DocumentNodeListT.)
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 methodRemove
Removes the first occurrence of a specific object from this collection.
(Inherited from DocumentNodeListT.)
Public methodRemoveAt
Removes the element at the specified index.
(Inherited from DocumentNodeListT.)
Public methodRemoveRange
Removes a range of count elements starting at the specified index.
(Inherited from DocumentNodeListT.)
Public methodReplaceAll
Replaces the contents of the list with the elements in the specified collection.
(Inherited from DocumentNodeListT.)
Public methodResetAllFilters
Resets all filters in all FilterCollections of this FilteringScheme.
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 methodToArray
Copies the elements of the collection to a new array.
(Inherited from DocumentNodeListBaseT.)
Protected methodValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
Top
Properties

  NameDescription
Public propertyAutoConfigureFilterCollections
Gets or sets a value indicating whether to auto configure filter collections.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyCount
Gets the number of elements contained in this instance.
(Inherited from DocumentNodeListBaseT.)
Public propertyDefaultFilterCollection
Gets the default filter collection.
Public propertyFilteringSelectionReference
Gets the filtering selection.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyItemInt32
Gets or sets the element at the specified index.
(Inherited from DocumentNodeListT.)
Public propertyItemDataTable
Gets the FilterCollection for the specified data table.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodICollectionTContains
Determines whether the ICollectionT contains a specific value.
(Inherited from DocumentNodeListT.)
Explicit interface implementationPrivate methodICollectionTCopyTo
Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
(Inherited from DocumentNodeListT.)
Explicit interface implementationPrivate propertyICollectionTCount
Gets the number of elements contained in the ICollectionT.
(Inherited from DocumentNodeListT.)
Explicit interface implementationPrivate methodIEnumerableGetEnumerator
Returns an enumerator that iterates through a collection.
(Inherited from DocumentNodeListBaseT.)
Explicit interface implementationPrivate methodIServiceProviderGetService
Implements IServiceProvider.
(Inherited from Node.)
Explicit interface implementationPrivate methodIListTIndexOf
Determines the index of a specific item in the IListT.
(Inherited from DocumentNodeListT.)
Explicit interface implementationPrivate propertyICollectionTIsReadOnly
Gets a value indicating whether the ICollectionT is read-only.
(Inherited from DocumentNodeListT.)
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
Remarks

A FilterPanel references one FilteringScheme at a time. But several FilteringSchemes can exist in the Document
Version Information

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

Reference