SingleValueColumnFilter Class

Spotfire 14.5 API Reference
Base class for column filter that are used to filter on a single value.
Inheritance Hierarchy

System.Object
  Node
    Spotfire.Dxp.Framework.DocumentModel.DocumentNode
      Spotfire.Dxp.Application.Filters.FilterBase
        Spotfire.Dxp.Application.Filters.ColumnFilter
          Spotfire.Dxp.Application.Filters.SingleValueColumnFilter
            Spotfire.Dxp.Application.Filters.ItemFilter
            Spotfire.Dxp.Application.Filters.RadioButtonFilter

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

C#
[SerializableAttribute]
[PersistenceVersionAttribute(49, 0)]
[ToolContextAttribute]
public abstract class SingleValueColumnFilter : ColumnFilter

The SingleValueColumnFilter type exposes the following members.

Properties

  NameDescription
Public propertyAllowAll
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.
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 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 propertyShowNone
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.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyTypeId
Gets the type id.
(Inherited from FilterBase.)
Public propertyValue
Gets or sets the filtered value.
Public propertyValues
Gets a list of allowed values.
Top
Methods

  NameDescription
Protected methodCreateAction<T>
Creates a standard modfiy action that handles the documentNodeHandle.
(Inherited from FilterBase.)
Protected methodCreateEventRelay(PropertyName, StatelessDependencyDeclarer)
Creates an event relay. An event relay is a property in the document model which propagates event. An event is raised for the event relay whenever when the trigger returned by the specified dependencyDeclarer fires.
(Inherited from DocumentNode.)
Protected methodCreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode)
Creates an event relay. An event relay is a property in the document model which propagates event. An event is raised for the event relay whenever when the trigger returned by the specified dependencyDeclarer fires.
(Inherited from DocumentNode.)
Protected methodCreateProperty<T>(PropertyName, UndoableList<T>) (Inherited from DocumentNode.)
Protected methodCreateProperty<T>(PropertyName, UndoableSet<T>) (Inherited from DocumentNode.)
Protected methodCreateProperty<TNode>(PropertyName, UndoableCrossReferenceProperty<TNode>, TNode) (Inherited from DocumentNode.)
Protected methodCreateProperty<T>(PropertyName, UndoableProperty<T>, T) (Inherited from DocumentNode.)
Protected methodCreateProperty<TKey, TValue>(PropertyName, UndoableDictionary<TKey, TValue>) (Inherited from DocumentNode.)
Protected methodCreateProperty<TKey, TNode>(PropertyName, PropertyName, UndoableKeyedCollection<TKey, TNode>) (Inherited from DocumentNode.)
Protected methodCreateReadOnlyProperty<T>
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.)
Protected methodCreateRuntimeConstant<T>
Creates a runtime constant. A runtime constant is a property in the document model whose value is computed once when first accessed. The value is then disposed along with the DocumentNode.
(Inherited from DocumentNode.)
Protected methodCreateRuntimeProperty<T> (Inherited from DocumentNode.)
Protected methodDeclareInternalEventHandlers
Override this method to declare handlers of internal events.
(Inherited from ColumnFilter.)
Protected methodDeserializeProperty<T>(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferenceProperty<T>) (Inherited from DocumentNode.)
Protected methodDeserializeProperty<T>(SerializationInfo, StreamingContext, PropertyName, UndoableList<T>) (Inherited from DocumentNode.)
Protected methodDeserializeProperty<T>(SerializationInfo, StreamingContext, PropertyName, UndoableProperty<T>) (Inherited from DocumentNode.)
Protected methodDeserializeProperty<T>(SerializationInfo, StreamingContext, PropertyName, UndoableSet<T>) (Inherited from DocumentNode.)
Protected methodDeserializeProperty<TKey, TValue>(SerializationInfo, StreamingContext, PropertyName, UndoableDictionary<TKey, TValue>) (Inherited from DocumentNode.)
Protected methodDeserializeProperty<TKey, TNode>(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollection<TKey, TNode>) (Inherited from DocumentNode.)
Protected methodDeserializeReadOnlyProperty<T>
Deserializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodDuplicateSubtree<T>
Returns a copy of the sub tree spanned from this node that has the same outwards non-owning references. The returned copy will be in state New and is intended to be attached to the document immediately.
(Inherited from DocumentNode.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodForEachNodeInSubTree<TNode>
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
(Inherited from DocumentNode.)
Protected methodGetObjectData
Implements ISerializable.
(Overrides ColumnFilter.GetObjectData(SerializationInfo, StreamingContext).)
Protected methodGetPersistedTypeName
Can be used in the deserialization constructor to get the type name that the class corresponding to this class had when it was originally serialized. Will return null if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.)
Protected methodGetPersistedVersion
Can be used in the deserialization constructor to get the persistence version that this class was marked with when it was originally serialized. Will return null if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.)
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.)
Protected methodInternalTransaction
Starts an internal transaction on the document model by executing the specified executor delegate.
(Inherited from DocumentNode.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnConfigure
Allows a node to configure itself to the surrounding document.
(Overrides DocumentNode.OnConfigure().)
Protected methodOnConfigured
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigure
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigured
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Public methodReset
Resets the filter to include all values.
(Overrides FilterBase.Reset().)
Protected methodSerializeProperty<T>(SerializationInfo, StreamingContext, UndoableCrossReferenceProperty<T>)
Serializes an Undoable*Property with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializeProperty<T>(SerializationInfo, StreamingContext, UndoableList<T>)
Serializes an UndoableList with values of type T storing it in info with key list.Name.
(Inherited from DocumentNode.)
Protected methodSerializeProperty<T>(SerializationInfo, StreamingContext, UndoableProperty<T>)
Serializes an UndoableProperty with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializeProperty<T>(SerializationInfo, StreamingContext, UndoableSet<T>)
Serializes an UndoableSet storing it in info with key given by the property name of the set.
(Inherited from DocumentNode.)
Protected methodSerializeProperty<TKey, TValue>(SerializationInfo, StreamingContext, UndoableDictionary<TKey, TValue>)
Serializes an UndoableDictionary storing it in info with key given by the property name of the dictionary.
(Inherited from DocumentNode.)
Protected methodSerializeProperty<TKey, TNode>(SerializationInfo, StreamingContext, UndoableKeyedCollection<TKey, TNode>) (Inherited from DocumentNode.)
Protected methodSerializeReadOnlyProperty<T>
Serializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Public methodToString
Gets a text representation of this filter.
(Overrides Object.ToString().)
Protected methodValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodINodeContext.GetAncestor<T> (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContext.GetService<T> (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContext.IsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.BeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
Version Information

Supported in: 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference