Back to API Home

The Filter type exposes the following members.

Constructors

  NameDescription
Public methodFilter(Guid)
Initializes a new instance of the Filter class. Use this constructor to instantiate only filters used in manual queries.
Public methodFilter(Guid, Filter)
Initializes a new instance of the Filter class. Use this constructor only to instantiate external filters.
Public methodFilter(Guid, FilterData, Boolean)
Initializes a new instance of the Filter class. This constructor is used to instantiate a filter using its own data contract.
Public methodFilter(Guid, Guid, Boolean)
Initializes a new instance of the Filter class. This is the standard constructor for a new filters.
Public methodFilter(Guid, QueryFieldData, GeneratorFieldData, Boolean, String, String)
Initializes a new instance of the Filter class. Use this constructor only for filters used in stubbed objects.

Methods

  NameDescription
Public methodCleanup
Removes duplicates and conflicts.
Public methodClone
Clones this instance.
Public methodToDataContract
Returns the data contract.
Public methodValidateExternalFilterSettings
Validates the external filter for any changes and adjusts the current settings.

Properties

  NameDescription
Public propertyAttributeAxis
Gets the symbol for the field usage.
Public propertyAttributeEmptyPoints
Gets the symbol restrictions.
Public propertyAttributePublic
Gets the symbol public.
Public propertyAttributeRestrictions
Gets the symbol restrictions.
Public propertyAttributeSelection
Gets the symbol usage.
Public propertyBottomDimensionLevel
Gets or sets the bottom selectable level in the dimension.
Public propertyContainerId
Gets the container id.
Public propertyDescription
Gets or sets the description.
Public propertyDisplayDataType
Gets the filter data type for display.
Public propertyDisplayValue
Gets the filter default value for display.
Public propertyDisplayValueFontStyle
Gets a value indicating whether the display value is a token, including multiple values.
Public propertyDisplayValueGrain
Gets the selected hierarchy grain for display.
Public propertyDynamicFilterColumns
Gets or sets the dynamic filter columns.
Public propertyEffectiveLinkedStructure
Gets the "effective" linked structure. It may be "inherited" from the parent filter or defined for this filter.
Public propertyEmptyDataPointsRule
Gets or sets the empty data points rule, if any.
Public propertyExternalFilter
Gets or sets the external filter.
Public propertyExternalValidationRules
Gets the external filter restrictions.
Public propertyField
Gets or sets the field parent alias.
Public propertyFilterType
Gets or sets the type of the filter.
Public propertyFilterValues
Gets the filter values.
Public propertyGrainLevel
Gets or sets the default level used to select the dimension grains.
Public propertyGrainValues
Gets the dimension selected grain values.
Public propertyHasAllToken
Gets a value indicating whether this filter's values include one with the All token.
Public propertyHasConflictingValues
Gets a value indicating whether this filter has conflicting values.
Public propertyHasDefaultToken
Gets a value indicating whether this filter's values include one with the Default token.
Public propertyHasDuplicateValues
Gets a value indicating whether this filter has duplicate values (including duplicate tokens).
Public propertyHasRestrictions
Gets a value indicating whether the current filter has any restrictions set.
Public propertyHasValues
Gets a value indicating whether this filter's values include any with values, rather than tokens.
Public propertyHierarchy
Gets or sets the dimension hierarchy.
Public propertyHierarchyId
Gets the dimension hierarchy id.
Public propertyId
Gets the Id.
Public propertyIsAllMemberAllowed
Gets or sets a value indicating whether the dimension All Member is allowed for selection.
Public propertyIsBasedOnExternalFilters
Gets or sets a value indicating whether this dimension is based on external filters.
Public propertyIsChildExistenceCheckRequired
Gets or sets a value indicating whether this instance required child existence check.
Public propertyIsCustomExternalFilter
Gets a value indicating whether this instance is a customized external filter.
Public propertyIsDefaultSelectionAllowed
Gets or sets a value indicating whether the default named token use is allowed for selection.
Public propertyIsDemoteEnabled
Gets or sets a value indicating whether this Filter can be demoted to an instant dimension.
Public propertyIsDimensionAncestryRequired
Gets or sets a value indicating whether the ancestry fields are required for rendering.
Public propertyIsEditable
Gets or sets a value indicating whether this instance can be modified.
Public propertyIsEnabled
Gets or sets a value indicating whether this Filter is enabled.
Public propertyIsEqualToExternalFilter
Gets a value indicating whether this instance is equal to external filter.
Public propertyIsExternalFilter
Gets a value indicating whether this instance is an external filter.
Public propertyIsExternalFilterValueScriptEditable
Gets a value indicating whether the external filter value script is editable.
Public propertyIsHierarchyGrainPublic
Gets or sets a value indicating whether the hierarchy grain is user selectable.
Public propertyIsManualFilter
Gets a value indicating whether this instance is manual filter.
Public propertyIsManualFilterRemovable
Gets a value indicating whether this instance is a removable manual filter.
Public propertyIsMultipleSelectionAllowed
Gets or sets a value indicating whether this instance allows multiple selection.
Public propertyIsNotNullSelectionAllowed
Gets or sets a value indicating whether not null is allowed for selection for this instance.
Public propertyIsNotReadOnly
Gets or sets a value indicating whether this instance is not read only.
Public propertyIsNullSelectionAllowed
Gets or sets a value indicating whether this instance allows null for selection.
Public propertyIsOlapBased
Gets or sets a value indicating whether this instance is olap based.
Public propertyIsOlapQueryFilter
Gets or sets a value indicating whether this instance is an olap query filter.
Public propertyIsOnAggregation
Gets or sets a value indicating whether this filter is applied on aggregation.
Public propertyIsPromoteEnabled
Gets or sets a value indicating whether this Filter can be promoted to a full dimension enabled.
Public propertyIsPublic
Gets or sets a value indicating whether this Filter is public.
Public propertyIsRangeSelectionAllowed
Gets or sets a value indicating whether this instance allows ranges for values.
Public propertyIsRelationalBased
Gets a value indicating whether this instance is based on relational sources.
Public propertyIsRemovable
Gets a value indicating whether the filter can be removed (only for instant dimensions).
Public propertyIsSelected
Gets or sets a value indicating whether this instance is selected.
Public propertyIsSingleSelectionAllowed
Gets or sets a value indicating whether this instance allows single selection for values.
Public propertyIsStandard
Gets or sets a value indicating whether instance is standard (not user-based) filter.
Public propertyIsStoredProcFilterRemovable
Gets a value indicating whether this instance is a removable stored proc filter.
Public propertyIsSubquery
Gets or sets a value indicating whether the filter translates into OLAP subqueries.
Public propertyIsTimeDimension
Gets or sets a value indicating whether the attached dimension is a time dimension.
Public propertyIsTimeIgnored
Gets or sets a value indicating whether this instance is time ignored.
Public propertyIsUnknownMemberAllowed
Gets or sets a value indicating whether the dimension Unknown Members are included in the resultset.
Public propertyIsUserBased
Gets or sets a value indicating whether this instance is user-based filter.
Public propertyIsValid
Gets a value indicating whether the filter is valid.
Public propertyIsValueSelectionInverted
Gets or sets a value indicating whether the value selection is inverted.
Public propertyJoinDimensionLevel
Gets or sets the level used by the data object for joining to the dimension.
Public propertyLinkedStructure
Gets or sets the linked structure used to provide values for the filter.
Public propertyOlapHierarchy
Gets or sets the dimension hierarchy.
Public propertyOlapProperties
Gets or sets the OLAP properties class for a given filter.
Public propertyRollingValue
Gets or sets the rolling value used in empty data points calculations.
Public propertySetExternalFilterValueScript
Gets or sets the script used to set external filter value.
Public propertySingleValue
Gets or sets the value of a single-value filter.
Public propertyText
Gets or sets the filter dashboard caption.
Public propertyTopDimensionAncestryLevel
Gets or sets the top ancestry level to be rendered.
Public propertyTopDimensionLevel
Gets or sets the top selectable level in the dimension.
Public propertyUseInheritedLinkedStructure
Gets or sets a value indicating whether to use inherited linked structure.

See Also