FilterRule Class

 Spotfire 15.0 API Reference
Represents a rule that uses a boolean condition to determine the visibility of visualization items.
Inheritance Hierarchy
SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsFilterRule

Namespace:  Spotfire.Dxp.Application.Visuals
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 71.0.22122.5390 (71.0.22122.5390)
Syntax
C#
Copy
[SerializableAttribute]
[PersistenceVersionAttribute(12, 0)]
public sealed class FilterRule : DocumentNode

The FilterRule type exposes the following members.

Properties
  NameDescription
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyDisplayName
Gets the displayname that is used for this Rule. It will either be equal to ManualDisplayName or (when that is null) it will be an auto-generated string. This display name is suitable for use in the property pages, but not in the legend (since it shows the definition, rather than the value)
Public propertyEnabled
Gets or sets a value indicating whether this FilterRule is enabled.
Public propertyEvaluatePerTrellis
Gets or sets a value indicating whether this FilterRule should be evaluated per trellis or not.
Public propertyExpression
Gets or sets the expression this rule is evaluated on.
Public propertyHideMatchedItems
Gets or sets a value indicating whether this rule shows or hides matched items.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyManualDisplayName
Gets or sets the display name. If set to null, the Rule will be represented with an auto-generated name.
Public propertyRuleCondition
Gets the rule condition.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Top
Methods
  NameDescription
Public methodForEachNodeInSubTreeTNode
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
(Inherited from DocumentNode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodINodeContextGetAncestorT
Implements GetAncestorT.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT
Implements GetServiceT.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
Version Information


See Also

Reference

Spotfire.Dxp.Application.Visuals Namespace