FilterCollection Class

Spotfire 14.7 API Reference

The FilterCollection contains the Filters for a specific DataTable in a FilteringScheme.

Inheritance Hierarchy

SystemObject
  Node
    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: 69.0.21424.2902 (69.0.21424.2902)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(33, 0)]
public sealed class FilterCollection : DocumentNodeListBase<Filter>

The FilterCollection type exposes the following members.

Properties

	Name	Description
	AutoCreateFilters	Gets or sets a value indicating whether to automatically create filters for new columns.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Count	Gets the number of elements contained in this instance. (Inherited from DocumentNodeListBaseT.)
	DataTableReference	Gets the data table.
	FilteredRows	Gets the filtered rows.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	ItemString	Gets the Filter with the specified name.
	ItemInt32	Gets the element at the specified index. (Inherited from DocumentNodeListBaseT.)
	ItemDataColumn	Gets the Filter with the specified DataColumn.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	AddNewFilter(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.
	AddNewFilter(TypeIdentifier, DataColumn)	Creates a filter and adds it to this FilterCollection. The filter type corresponds to the supplied filter identifier.
	AutoConfigure	If this collection is empty, then the flag AutoCreateFilters is set to true and filters are created for each column in the DataTableReference.
	Clear	Removes all items from this collection.
	Contains(String)	Determines whether a named element is in this collection.
	Contains(T)	Determines whether the specified value is in this collection. (Inherited from DocumentNodeListBaseT.)
	Contains(DataColumn)	Determines whether a DataColumn has a filter representation in this collection.
	ForEachNodeInSubTreeTNode	Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node. (Inherited from DocumentNode.)
	GetEnumerator	Returns an enumerator that iterates through this collection. (Inherited from DocumentNodeListBaseT.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Searches for the specified value and returns the zero-based index of the first occurrence within this collection. (Inherited from DocumentNodeListBaseT.)
	Remove	Removes the specified item.
	ResetAllFilters	Resets all filters.
	ToArray	Copies the elements of the collection to a new array. (Inherited from DocumentNodeListBaseT.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a collection. (Inherited from DocumentNodeListBaseT.)
	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.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Version Information

Supported in: 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Application.Filters Namespace