Filter Class

Spotfire 14.3 API Reference

The Filter class contains a specific filter implementation. The type of filter is controlled by the property TypeId.

Inheritance Hierarchy

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

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 Filter : DocumentNode

The Filter type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	FilteredRows	Gets the filtered rows.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Modified	Flag indicating whether the filter is modified.
	Name	Gets or sets the name of this filter. The filter name is the same as the name of the referenced data column.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	TypeId	Gets or sets the type identifier for the filter. By setting this property, the filter is converted to the specified type.

Top

Methods

	Name	Description
	AsT	Returns the filter implementation as specified type.
	GetPropertyValue	Gets the value of a specified property.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasPropertyValue	Checks if there is a valid value for a specified property.
	Reset	Resets the filter. After calling this method, the filter does not filter out any rows.
	ToString	Returns a String that represents the current Object. (Overrides ObjectToString.)

Top

Explicit Interface Implementations

	Name	Description
	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.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