FilterPanel Class

Spotfire 14.3 API Reference

A Filter Panel represents the contents of the Spotfire control panel that can contain the data filters.

Each Filter Panel contains one or more filter groups in which the filters are placed. These groups and the filters in them are accessible through the TableGroups property.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.ApplicationPanel
        Spotfire.Dxp.Application.FiltersFilterPanel

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(15, 0)]
public sealed class FilterPanel : Panel

The FilterPanel type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	DockingPlacement	Gets or sets the docking placement of the panel. (Inherited from Panel.)
	FilteringSchemeReference	Gets or sets the FilteringScheme to use.
	FiltersMatchingSearchPattern	Gets an enumerator over the filters in this panel that match the expression given by InteractiveSearchPattern.
	InteractiveSearchPattern	Gets or sets the search pattern.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	PanelState	Gets or sets the PanelState of the panel. (Inherited from Panel.)
	Placement	Obsolete. Gets the placement of the panel. (Inherited from Panel.)
	TableGroups	Gets the top level filter groups associated with data tables.
	Title	Gets the title of the panel. (Inherited from Panel.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	TypeId	Gets the type identifier for the panel. (Inherited from Panel.)
	Visible	Gets or sets whether the panel is visible. (Inherited from Panel.)

Top

Methods

	Name	Description
	ApplyOrganizationFrom	Applies the filter organization, that is, visibility, selected state, groups and sort order from another filter panel to this instance.
	AutoConfigure	Configures this filter panel with a default FilteringScheme.
	AutoConfigure(FilterPanel)	Configures this filter panel from the specified source filter panel.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

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