Representation of the Check Box Hierarchy Filter.
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.Application.FiltersFilterBase
Spotfire.Dxp.Application.FiltersHierarchyFilter
Spotfire.Dxp.Application.FiltersCheckBoxHierarchyFilter
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(21, 0)] public sealed class CheckBoxHierarchyFilter : HierarchyFilter, ICheckBoxHierarchyFilter, IColumnFilter, IFilterBase
The CheckBoxHierarchyFilter type exposes the following members.
Methods
Name | Description | |
---|---|---|
![]() | Check(DistinctDataValue) |
Checks the node with path nodePath.
|
![]() | Check(ListDistinctDataValue) |
Checks the node with path nodePath.
|
![]() | CheckAllNodes |
Checks all nodes in this filter.
|
![]() | Collapse(DistinctDataValue) |
Collapses the specified node path.
|
![]() | Collapse(ListDistinctDataValue) |
Collapses the specified node path.
|
![]() | Expand(DistinctDataValue) |
Expands the specified node path.
|
![]() | Expand(ListDistinctDataValue) |
Expands the specified node path.
|
![]() | GetPropertyValue | Gets the value of a specified property. (Inherited from HierarchyFilter.) |
![]() | 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 HierarchyFilter.) |
![]() | IsChecked(DistinctDataValue) |
Determines whether the node at nodePath is checked or unchecked.
|
![]() | IsChecked(ListDistinctDataValue) |
Determines whether the node at nodePath is checked or unchecked.
|
![]() | IsExpanded(DistinctDataValue) |
Determines whether the specified node path is expanded.
|
![]() | IsExpanded(ListDistinctDataValue) |
Determines whether the specified node path is expanded.
|
![]() | Reset |
Resets the filter, so that it no longer filters out any rows.
(Overrides FilterBaseReset.) |
![]() | ToString | Returns a string that represents the current object. (Overrides ObjectToString.) |
![]() | UnCheck(DistinctDataValue) |
Unchecks the node with path nodePath.
|
![]() | UnCheck(ListDistinctDataValue) |
Unchecks the node with path nodePath.
|
![]() | UncheckAllNodes |
Unchecks all nodes in this filter. Doing so causes all data values
to be filtered out.
|
Properties
Name | Description | |
---|---|---|
![]() | Context |
Gets the context of this node.
(Inherited from DocumentNode.) |
![]() | DataColumnReference |
Gets the DataColumn instance associated with this filter.
(Inherited from HierarchyFilter.) |
![]() | FilteredRows |
Gets the filtered rows.
(Inherited from FilterBase.) |
![]() | HasFixedHeight |
Gets or sets a value indicating whether the height of the filter is fixed. If the number of items does not fit within the specified height
then a scrollbar is added.
|
![]() | Height | Gets or sets the number of lines to show in the UI list box.
This setting only has an effect if HasFixedHeight is true.
|
![]() | Hierarchy |
Gets the DataHierarchy instance associated with this filter.
(Inherited from HierarchyFilter.) |
![]() | IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) |
![]() | SearchAllLevels |
Gets or sets a value indicating whether the search should be performed in all levels in the hierarchy.
|
![]() | 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.
|
![]() | SearchLevel |
Gets or sets the level in the hierarhcy where the search is performed. This value has an affect only if
SearchAllLevels is false.
|
![]() | Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) |
![]() | TypeId |
Gets the type id.
(Overrides FilterBaseTypeId.) |
Explicit Interface Implementations
Name | Description | |
---|---|---|
![]() ![]() | IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) |
![]() ![]() | 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.) |
![]() ![]() | ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.) |
![]() ![]() | ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.) |
Version Information
See Also