ListBoxFilter Class

Spotfire 14.3 API Reference

Represents a list box filter. A list box filter allows multiple selection and searching while preserving space. This filter can handle a large amount of categorical values.

Inheritance Hierarchy

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

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

The ListBoxFilter type exposes the following members.

Properties

	Name	Description
	CheckBoxModeEnabled	Gets or sets a value indicating whether this instance should use check boxes to indicate filtered items.
	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.)
	Height	Gets or sets the number of lines to show in the UI list box.
	IncludeAllValues	Gets or sets a value indicating whether all values should be included or not. True if filtering should include all values, if this property is set to to true then this overrides the SelectedValues list. If this property is set then empty values are included regardless of the IncludeEmpty setting.
	IncludeEmpty	Gets or sets a value indicating whether we should include empty values or not. If this is true then the empty values in this column will not be filtered out by this filter, otherwise the empty values will be filtered out by this filter.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	SearchExpression	Gets or sets the search expression that determines which values are to be shown in the user interface. This property does not affect which rows are filtered out.
	SearchFieldVisible	Gets or sets a value indicating whether the search field should be visible in the UI or not.
	SelectedValues	Gets a read-only collection of the currently selected values.
	ShowAll	Gets or sets a value indicating whether (All) is shown in the filter or not.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

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.)
	IsSelected	Check if a value is selected or not.
	SetSelection(IEnumerableObject)	Select the given values, this will remove all previously selected values. Note that the IncludeAllValues property needs to be set to false in order for this selection to affect the filtering.
	SetSelection(Object)	Select the given values, this will remove all previously selected values. Note that the IncludeAllValues property needs to be set to false in order for this selection to affect the filtering.
	ToString	Returns a String that represents this instance. (Overrides ObjectToString.)

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