FilterRuleCollection Class

Spotfire 14.2 API Reference
Represents a list of rules in a Visualization that are used to filter visualization items.
Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsFilterRuleCollection

Namespace:  Spotfire.Dxp.Application.Visuals
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
[SerializableAttribute]
[PersistenceVersionAttribute(12, 0)]
public sealed class FilterRuleCollection : DocumentNode, 
	IEnumerable, IEnumerable<FilterRule>

The FilterRuleCollection type exposes the following members.

Properties

  NameDescription
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyCount
Gets the count.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyItem
Gets the FilterRule at the specified index. Includes all filter rules even disabled filter rules.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Top
Methods

  NameDescription
Public methodAddBottomNRule(String, ConditionValue, Boolean)
Adds a bottom N rule to the end of the collection.
Public methodAddBottomNRule(String, Int32, Boolean)
Adds a bottom N rule to the end of the collection.
Public methodAddExpressionRule
Adds a new expression rule to the end of the collection.
Public methodAddRangeRule
Adds a range rule to the end of the collection.
Public methodAddStringRule
Adds a string rule to the end of the collection.
Public methodAddThresholdRule
Adds a threshold rule to the end of the collection.
Public methodAddTopNRule(String, ConditionValue, Boolean)
Adds a top N rule to the end of the collection.
Public methodAddTopNRule(String, Int32, Boolean)
Adds a top N rule to the end of the collection.
Public methodClear
Clears this collection, removing all filter rules.
Public methodContains
Determines whether the collection contains a specified rule.
Public methodGetEnumerator
Returns an enumerator that iterates through a collection.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf
Determines the index of a specific rule in the collection.
Public methodMove
Moves a rule at the specified index to another location in the collection.
Public methodRemove
Removes the specified rule from the collection.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodIEnumerableFilterRuleGetEnumerator
Gets an enumerator that iterates through this FilterRuleCollection.
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 methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference