RadioButtonFilter Class

Spotfire 14.3 API Reference

Representation of the Radio Button Filter. Similar to the ItemFilter, this filter can filter on single values in the column that the filter is being applied on. Graphically, the values in the column are represented as radio buttons.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.FiltersFilterBase
        Spotfire.Dxp.Application.FiltersColumnFilter
          Spotfire.Dxp.Application.FiltersSingleValueColumnFilter
            Spotfire.Dxp.Application.FiltersRadioButtonFilter

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)]
[ToolContextAttribute]
public sealed class RadioButtonFilter : SingleValueColumnFilter

The RadioButtonFilter type exposes the following members.

Properties

	Name	Description
	AllowAll	Get or set a value indicating whether All is allowed in this filter. If the filter value is All when AllowAll is set to false, the filter value will be set to None. If AllowAll is false, Reset or setting the value to All will have no effect. (Inherited from SingleValueColumnFilter.)
	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.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	ShowNone	Get or set a value indicating whether None is shown in the filter. Even if None is hidden, it may still be set in the filter. (Inherited from SingleValueColumnFilter.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	TypeId	Gets the type id. (Overrides FilterBaseTypeId.)
	Value	Gets or sets the filtered value. (Inherited from SingleValueColumnFilter.)
	Values	Gets a list of allowed values. (Inherited from SingleValueColumnFilter.)

Top

Methods

	Name	Description
	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.)
	Reset	Resets the filter to include all values. (Inherited from SingleValueColumnFilter.)
	ToString	Gets a text representation of this filter. (Overrides SingleValueColumnFilterToString.)

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