ItemFilter Class TIBCO Spotfire 7.9 API Reference
Representation of an ItemFilter. The item filter has the ability to filter on a single value in the column that is applies on. The value that is being filtered on is given by Value.

In addition to the distinct values in the DataColumnReference, the Item Filter can filter on the special values given by the ItemFiltering enumeration. The All value is the default value of an Item Filter. The None value is the last value in an Item Filter. The Empty value is only used when the filter column contains empty values.

Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.DocumentModelNode
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.FiltersFilterBase
        Spotfire.Dxp.Application.FiltersColumnFilter
          Spotfire.Dxp.Application.FiltersSingleValueColumnFilter
            Spotfire.Dxp.Application.FiltersItemFilter

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

C#
[SerializableAttribute]
[ToolContextAttribute]
[PersistenceVersionAttribute(0, 1)]
public sealed class ItemFilter : SingleValueColumnFilter, 
	IItemFilter, ISingleValueColumnFilter, IColumnFilter, IFilterBase

The ItemFilter type exposes the following members.

Methods

  NameDescription
Public methodGetPropertyValue
Gets the value of a specified property.
(Inherited from ColumnFilter.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasPropertyValue
Checks if there is a valid value for a specified property.
(Inherited from ColumnFilter.)
Public methodReset
Resets the filter to include all values.
(Inherited from SingleValueColumnFilter.)
Public methodToString
Gets a text representation of this filter.
(Overrides SingleValueColumnFilterToString.)
Top
Properties

  NameDescription
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyDataColumnReference
Gets the column instance associated with this filter.
(Inherited from ColumnFilter.)
Public propertyFilteredRows
Gets the filtered rows.
(Inherited from FilterBase.)
Public propertyHasEmptyValues
Gets a value indicating whether the referenced column has any invalid rows.
(Inherited from ColumnFilter.)
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyTypeId
Gets the type id.
(Overrides FilterBaseTypeId.)
Public propertyValue
Gets or sets the filtered value.
(Inherited from SingleValueColumnFilter.)
Public propertyValues
Gets a list of allowed values.
(Inherited from SingleValueColumnFilter.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodIServiceProviderGetService
Implements IServiceProvider.
(Inherited from Node.)
Explicit interface implementationPrivate methodINodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Top
Version Information

Supported in: 7.9, 7.8, 7.7, 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference