FilteringSchemeCollection Class

TIBCO Spotfire 6.0 API Reference

Collection of all FilteringSchemes in this Document.

Inheritance Hierarchy

System Object
  Spotfire.Dxp.Framework.DocumentModel Node
    Spotfire.Dxp.Framework.DocumentModel DocumentNode
      Spotfire.Dxp.Framework.DocumentModel DocumentNodeListBase FilteringScheme
        Spotfire.Dxp.Application.Filters FilteringSchemeCollection

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

Syntax

C++

Copy to Clipboard Print

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

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

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.

C++

Copy to Clipboard Print

// 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;

// 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;