The DimensionValuePathFormatter type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | DimensionValuePathFormatter | Overloaded. |
Methods
| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| Format |
Formats the elements of a DimensionValuePath by applying RootFormatter
to DimensionValuePath.First, PathFormatter to
DimensionValuePath.Intermediates and DimensionValuePath.Last.
Root, intermediates or selected dimension value can be set to be included or excluded in the formatted string by setting the AppendRoot, AppendAncestors and AppendDimensionValue properties. |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| JoinFormattedValues |
Joins the string output of the applied IStringFormatters on portions of the
DimensionValuePath using the Separator |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | AppendAncestors |
Specifies whether or not to append ancestor dimension values to the URL.
If "true" for "Wine Type" dimension, the following URL would be ouput, for
example:
If false, "White" would be omitted:
|
| AppendDimensionValue |
Specifies whether or not to append the selected dimension value to the URL.
If "true" for "Wine Type" dimension, the following URL would be ouput, for
example:
If false, "Sauvignon-Blanc" would be omitted:
|
| AppendRoot |
Specifies whether or not to append root dimension values to the URL.
If "true" for "Wine Type" dimension, the following URL would be ouput, for
example:
If "false", the root "Wine Type" would be omitted from the URL string:
|
| PathFormatter |
Gets or sets the IStringFormatter to be applied to each dimension value in
DimensionValuePath.Intermediates and the DimensionValuePath.Last.
If the value is null this portion of the DimensionValuePath will not be present
in the output string.
|
| RootFormatter |
Gets or sets the IStringFormatter to be applied to DimensionValuePath.First.
If the value is null, this portion of the DimensionValuePath will not be present in the output string.
|
| Separator |
Gets or sets the character that will be used to join the output of the RootFormatter
and PathFormatter, as well as individual values output by the PathFormatter.
For example if all formatters are set and a dimension is a hierarchy the output might be
[Wine Type]Separator[Red]Separator[Merlot]. The default value is '-'.
|
Copy