Filter.TypeId Property

Filter TypeId Property

TIBCO Spotfire 6.0 API Reference

Gets or sets the type identifier for the filter. By setting this property, the filter is converted to the specified type.

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

Syntax

C++

Copy to Clipboard Print

public TypeIdentifier TypeId { get; set; }

public TypeIdentifier TypeId { get; set; }

Property Value

Type: TypeIdentifier
The TypeIdentifier, which should be one of the FilterTypeIdentifiers.

Exceptions

Exception	Condition
System ArgumentNullException	If set to null.
System ArgumentException	If set to an invalid filter type identifier.

Examples

To change the filter into a checkbox filter, use the following:

C++

Copy to Clipboard Print

Filter filter;
filter.TypeId = FilterTypeIdentifiers.CheckBoxFilter;
CheckBoxFilter checkBoxFilter = filter.As<CheckBoxFilter>();

Filter filter;
filter.TypeId = FilterTypeIdentifiers.CheckBoxFilter;
CheckBoxFilter checkBoxFilter = filter.As<CheckBoxFilter>();