FilterSubGroup Class

Spotfire 14.5 API Reference

A specialization of the FilterGroup, representing the subgroups within a FilterPanel which can be added to a FilterGroup in TableGroups. New subgroups are created using the AddNewSubGroup(String) method.

Inheritance Hierarchy

System.Object
  Node
    Spotfire.Dxp.Framework.DocumentModel.DocumentNode
      Spotfire.Dxp.Application.Filters.FilterGroupItem
        Spotfire.Dxp.Application.Filters.FilterGroup
          Spotfire.Dxp.Application.Filters.FilterSubGroup

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(2, 0)]
public sealed class FilterSubGroup : FilterGroup

The FilterSubGroup type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Expanded	Gets or sets a value indicating whether this group is expanded or collapsed. This property defaults to true.
	FilterHandles	Gets the filter handles in this group. (Inherited from FilterGroup.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	IsEmpty	Gets a value indicating whether or not this group is empty. (Inherited from FilterGroup.)
	Items	Gets the items. (Inherited from FilterGroup.)
	Name	Gets the group display name, that is, its caption. (Overrides FilterGroup.Name.)
	Panel	Gets the FilterPanel to which this FilterGroup belongs. (Inherited from FilterGroup.)
	ParentGroup	Gets the parent group. (Inherited from FilterGroupItem.)
	Selected	Gets a value indicating whether this FilterGroupItem is selected. (Inherited from FilterGroupItem.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	Visible	Gets or sets a value indicating whether this group is visible or hidden. This property defaults to true.

Top

Methods

	Name	Description
	Add	Adds the specified Filter to this group, a FilterHandle is created and returned. (Inherited from FilterGroup.)
	ClearFilters	Removes all existing FilterHandle from this group. (Inherited from FilterGroup.)
	ForEachNodeInSubTree<TNode>	Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node. (Inherited from DocumentNode.)
	GetFilter	Finds a filter in this group, given its Name. (Inherited from FilterGroup.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Remove	Removes the FilterHandle for the specified Filter from this group. If the filter is not a member of this group, calling this method will not have any effect. (Inherited from FilterGroup.)
	SetName	Sets the name.
	SortMembersAscending	Sorts the members of this group alphabetically ascending, based on the names of the members. (Inherited from FilterGroup.)
	SortMembersDescending	Sorts the members of this group alphabetically descending, based on the names of the members. (Inherited from FilterGroup.)
	ToString	Returns a String that represents the current Object. (Inherited from FilterGroup.)

Top

Explicit Interface Implementations

	Name	Description
	INodeContext.GetAncestor<T>	Implements GetAncestor<T>(). (Inherited from DocumentNode.)
	INodeContext.GetService<T>	Implements GetService<T>(). (Inherited from DocumentNode.)
	INodeContext.IsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactions.BeginAggregatedTransaction	Implements BeginAggregatedTransaction(). (Inherited from DocumentNode.)
	ITransactions.ExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactions.ExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactions.ExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Version Information

Supported in: 14.5, 14.4, 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