FilterCollection Class TIBCO Spotfire 7.9 API Reference
The FilterCollection contains the Filters for a specific DataTable in a FilteringScheme.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.DocumentModelNode
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Framework.DocumentModelDocumentNodeListBaseFilter
        Spotfire.Dxp.Application.FiltersFilterCollection

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]
[PersistenceVersionAttribute(2, 0)]
public sealed class FilterCollection : DocumentNodeListBase<Filter>, 
	IUniqueNameGenerator

The FilterCollection type exposes the following members.

Methods

  NameDescription
Public methodAddNewFilter(DataColumn)
Creates a filter and adds it to this FilterCollection. This method will make an effort to create a suitable filter for the column based on number of unique values and the column data type.
Public methodAddNewFilter(TypeIdentifier, DataColumn)
Creates a filter and adds it to this FilterCollection. The filter type corresponds to the supplied filter identifier.
Public methodAutoConfigure
If this collection is empty, then the flag AutoCreateFilters is set to true and filters are created for each column in the DataTableReference.
Public methodClear
Removes all items from this collection.
Public methodContains(String)
Determines whether a named element is in this collection.
Public methodContains(T)
Determines whether the specified value is in this collection.
(Inherited from DocumentNodeListBaseT.)
Public methodContains(DataColumn)
Determines whether a DataColumn has a filter representation in this collection.
Public methodGetEnumerator
Returns an enumerator that iterates through this collection.
(Inherited from DocumentNodeListBaseT.)
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 methodRemove
Removes the specified item.
Public methodResetAllFilters
Resets all filters.
Public methodToArray
Copies the elements of the collection to a new array.
(Inherited from DocumentNodeListBaseT.)
Top
Properties

  NameDescription
Public propertyAutoCreateFilters
Gets or sets a value indicating whether to automatically create filters for new columns.
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 propertyDataTableReference
Gets the data table.
Public propertyFilteredRows
Gets the filtered rows.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyItemString
Gets the Filter with the specified name.
Public propertyItemInt32
Gets the element at the specified index.
(Inherited from DocumentNodeListBaseT.)
Public propertyItemDataColumn
Gets the Filter with the specified DataColumn.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Top
Explicit Interface Implementations

  NameDescription
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 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.9, 7.8, 7.7, 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference