FilteringSchemeCollection Class

Spotfire 14.3 API Reference

Collection of all FilteringSchemes in this Document.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Framework.DocumentModelDocumentNodeListBaseFilteringScheme
        Spotfire.Dxp.Application.FiltersFilteringSchemeCollection

Namespace: Spotfire.Dxp.Application.Filters
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(2, 0)]
public sealed class FilteringSchemeCollection : DocumentNodeListBase<FilteringScheme>

The FilteringSchemeCollection type exposes the following members.

Properties

	Name	Description
	AutoConfigureFilteringSchemes	Gets or sets a value indicating whether to auto configure filtering schemes after they are created.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Count	Gets the number of elements contained in this instance. (Inherited from DocumentNodeListBaseT.)
	DefaultFilteringSchemeReference	Gets the default filtering scheme.
	FilteringSchemeMenuVisible	Gets or sets a property determining if the filtering scheme menu is visible or not in the UI.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	ItemInt32	Gets the element at the specified index. (Inherited from DocumentNodeListBaseT.)
	ItemDataSelection	Gets the FilteringScheme for the specified DataSelection.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	AutoConfigure	Sets AutoConfigureFilteringSchemes to true and runs AutoConfigure on all FilteringSchemes.
	Contains	Determines whether the specified value is in this collection. (Inherited from DocumentNodeListBaseT.)
	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.)
	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

Remarks

The contents of this collection is kept in sync with the data filtering selection collection owned by the data manager. Filtering schemes cannot be explicitly added to or removed from this collection but they can be implicitly added or removed by adding or removing filtering selections.

Examples

The following code snippet shows how to add a filtering scheme.

Copy

// Add a new data filtering selection.
DataFilteringSelection dataFilteringSelection = document.Data.Filterings.Add("My Filtering");

// A filtering scheme has now been implicitly added for the new data filtering selection.
FilteringScheme myFilteringScheme = document.FilteringSchemes[dataFilteringSelection];

// Let the active page use the new filtering scheme.
document.ActivePageReference.FilterPanel.FilteringSchemeReference = myFilteringScheme;

// Make sure that the filter panel shows the filtering scheme menu.
document.FilteringSchemes.FilteringSchemeMenuVisible = true;

Version Information

Supported in: 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

FilteringSchemeCollection.DataManager

Spotfire.Dxp.DataDataFilteringSelectionCollection