Back to API Home

The DashboardParameter type exposes the following members.

Constructors

  NameDescription
Public methodDashboardParameter
Initializes a new instance of the DashboardParameter class.

Methods

  NameDescription
Public methodBack
Makes the parameter go back one value in the history.
Public methodCopyFilterValuesTo(DashboardParameter)
Copies the filter values of this parameter over target parameter. Target parameter's filter values get overwriten.
Public methodCopyFilterValuesTo(ParameterInfo)
Copies the filter values of this parameter over target parameter info object. Target parameter info's filter values get overwriten.
Public methodCopyValuesTo
Copies the parameter values to the other parameter.
Public methodForward
Makes the parameter go forward one value in the history.
Public methodGetGrainStringValue
Gets the grain string value.
Public methodInvalidateFilter()()()()
Indicates that the filter has changed and forces anything this parameter controls to update. This is required after the filter has been changed. This will updated the history.
Public methodInvalidateFilter(Boolean)
Indicates that the filter has changed and forces anything this parameter controls to update. This is required after the filter has been changed.
Public methodPushHistory
Pushes the current parameter settings on to where the next history position is based on the current HistoryPosition. All items after are cut.
Public methodSerializedConstructor
Called when de-serialization is finished as this instance is marked with data contract.
Public methodSerializingConstructor
Called when de-serialization occurs as this instance is marked with data contract.
Public methodSetDateOffsetValue(Int32, TimeDimensionElementType)
Sets the date offset value from an enum.
Public methodSetDateOffsetValue(Int32, DateTimeGrain)
Sets the date offset value from an enum.
Public methodSetDateRange(DateTime, DateTimeGrain)
Sets the date range.
Public methodSetDateRange(DateTime, DateTime, DateTimeGrain)
Sets the date range.
Public methodSetRangeToken
Sets the range token.
Public methodSetSelection
Sets the selection.
Public methodToParameterInfo
Converts this instance to a ParameterInfo object.
Public methodToString()()()()
Returns a comma-separated list of selected values.
(Overrides Object..::..ToString()()()().)
Public methodToString(Char, Char)
Returns a String that represents a list of selected values.
Public methodUpdateFromParameterInfo
Updates this instance from the supplied parameter info.

Properties

  NameDescription
Public propertyDashboard
Gets or sets the dashboard.
Public propertyDateOffset
Gets or sets the date offset.
Public propertyDateOffsetGrain
Gets or sets the date offset grain.
Public propertyDateRangeEnd
Gets the date range end.
Public propertyDateRangeStart
Gets the date range start.
Public propertyDescription
Gets or sets the description.
Public propertyExcludedTokens
Gets the excluded tokens.
Public propertyFilterDataIds
Gets or sets the filter data IDs.
Public propertyFilterlessValue
Gets the filterless value. This is a value that can be used if filters are not enabled to pass values to/from a dashboard.
Public propertyFilterValues
Gets the filter values.
Public propertyFirstDayOfTheWeek
Gets the first day of the week.
Public propertyFormulaValue
Gets or sets the formula parameter value. This is the value to set on the formula when this parameter is acting on a formula.
Public propertyGrainLevel
Gets or sets the default level to be used in rendering a full dimension attributes.
Public propertyHashCode
Gets the hash code.
Public propertyHierarchyDateRangeEnd
Gets the date range end. NOTE: THIS IS FOR INTERNAL USE FOR THE NEEDS OF THE PARAMETER CONTROLS ONLY
Public propertyHierarchyDateRangeStart
Gets the date range start. NOTE: THIS IS FOR INTERNAL USE FOR THE NEEDS OF THE PARAMETER CONTROLS ONLY
Public propertyHistoricValues
Gets the historic values. These are the previously set values of this parameter.
Public propertyHistoryPosition
Gets or sets the history position. This is the current position within HistoricValues.
Public propertyIncludedTokens
Gets the included tokens.
Public propertyIncludeNewCompatibleTokens
Gets or sets a value indicating whether new compatible tokens should be included.
Public propertyIsAxisLevelPublic
Gets or sets a value indicating whether the axis level is public.
Public propertyIsDynamicParameter
Gets or sets a value indicating whether this instance is dynamic parameter.
Public propertyIsFilterLevelPublic
Gets or sets a value indicating whether the filter level is public.
Public propertyIsLoadedDynamically
Gets or sets a value indicating whether the parameter names and values are loaded dynamically from a virtual table.
Public propertyIsOlapQueryParameter
Gets or sets a value indicating whether the this parameter is Olap Query parameter.
Public propertyIsPeriodToPeriodPublic
Gets or sets a value indicating whether the period to period is public.
Public propertyIsValueSelectionInverted
Gets or sets a value indicating whether a logical NOT is applied to the filter value selection.
Public propertyName
Gets or sets the name.
Public propertyParameterControlTypeName
Gets or sets the FullName of the parameter control type. This will be the control that this parameter renders as.
Public propertyParameterPropertyLinks
Gets the property links.
Public propertyParameterSettings
Gets the parameter settings.
Public propertySelectedKeys
Gets the keys of the selected members.
Public propertySingleValue
Gets or sets the value of a single-value filter.

Events

  NameDescription
Public eventFilterChanged
Occurs when the filter changes.

See Also