TableGroup Class

Spotfire 14.3 API Reference

A specialization of the FilterGroup, representing one root group that exists within a FilterPanel and that can be accessed through the TableGroups property. In addition to the functionality of standard groups, the root group can contain one or more subgroups. Subgroups are added using the AddNewSubGroup(String) method. Additionally, the root filter group is special in the sense that is cannot be renamed.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.FiltersFilterGroupItem
        Spotfire.Dxp.Application.FiltersFilterGroup
          Spotfire.Dxp.Application.FiltersTableGroup

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, 10)]
public sealed class TableGroup : FilterGroup

The TableGroup type exposes the following members.

Properties

	Name	Description
	AutoSynchronizeFilters	Gets or sets a value indicating whether to auto synchronize filters handles when the FilterCollection changes.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Expanded	Gets a value indicating whether this group is expanded or collapsed. This property defaults to true. (Inherited from FilterGroup.)
	FilterCollectionReference	Gets the FilterCollection for this TableGroup.
	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 FilterGroupName.)
	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.)
	SubGroups	Gets the subgroups of this root group.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	Visible	Gets or sets a value indicating whether this FilterGroupItem is visible in its FilterGroup. (Inherited from FilterGroupItem.)

Top

Methods

	Name	Description
	Add	Adds the specified Filter to this group, a FilterHandle is created and returned. (Inherited from FilterGroup.)
	AddNewSubGroup	Adds a new filter group with the given name as a subgroup of this group. The new group is added to the end of the list of members of this group.
	ClearFilters	Removes all existing FilterHandle from this group. (Inherited from FilterGroup.)
	ClearSubGroups	Removes all subgroups from this group.
	GetFilter	Finds a filter in this group, given its Name. (Inherited from FilterGroup.)
	GetSubGroup	Finds a subgroup in this group, given its Name.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InsertNewSubGroup	Creates a new filter group with the given name and inserts it as a subgroup of this group at the given position.
	Remove(Filter)	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.)
	Remove(FilterSubGroup)	Removes the specified subgroup from this group. If the filter is not a member of this group, it will not be removed.
	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
	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