CheckBoxFilter Class

Spotfire 14.3 API Reference

Representation of the Check Box Filter. The check box filter allows for one or more values to be selected through a check box control.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.FiltersFilterBase
        Spotfire.Dxp.Application.FiltersColumnFilter
          Spotfire.Dxp.Application.FiltersCheckBoxFilter

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(8, 0)]
[ToolContextAttribute]
public sealed class CheckBoxFilter : ColumnFilter

The CheckBoxFilter type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	DataColumnReference	Gets the column instance associated with this filter. (Inherited from ColumnFilter.)
	HasEmptyValues	Gets a value indicating whether the referenced column has any invalid rows. (Inherited from ColumnFilter.)
	IncludeEmpty	Gets or sets a value indicating whether or not the filter should include empty value rows.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	TypeId	Gets the type id. (Overrides FilterBaseTypeId.)
	Values	Gets a collection of the check box values.

Top

Methods

	Name	Description
	Check	Checks the checkbox for value.
	GetPropertyValue	Gets the value of a specified property. (Inherited from ColumnFilter.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasPropertyValue	Checks if there is a valid value for a specified property. (Inherited from ColumnFilter.)
	IsChecked	Determines whether the specified value is checked.
	Reset	Resets the filter, so that it no longer filters out any rows. Resetting this filter causes IncludeEmpty to be set to true. (Overrides FilterBaseReset.)
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)
	Uncheck	Unchecks the checkbox for value.
	UncheckAll	Unchecks the checkboxes for all values in this instance.

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