The NavigationCommandFormatter type exposes the following members.
Constructors
Name | Description | |
---|---|---|
NavigationCommandFormatter | 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 | Overloaded. | |
FormatCommand |
Formats the NavigationCommand contained within the CommandInfoCollection.
This method returns a string representing the current selected dimension values in the
NavigationCommand using the IDimensionValuePathFormatters
DimensionValuePathFormatters.
(Overrides AbstractCommandFormatter..::.FormatCommand(CommandInfoCollection, ResultResolver).) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
SelectFormatter |
Selects an IDimensionValuePathFormatter for the DimensionValuePath.
Returns null if no applicable formatter is found.
| |
ToString | (Inherited from Object.) |
Properties
Name | Description | |
---|---|---|
DimensionValuePathFormatters |
Gets the mapping of keys to IDimensionValuePathFormatters. These are
the formatters that will be applied to indvidual DimensionValuePaths
when Format(CommandInfoCollection, ResultResolver, IDimensionValueCollectionCanonicalizer) is called. The key should be either
root Dimension name, or root Dimension id, depending on whether
the UseDimensionNameAsKey property has been set. This formatter would apply
to all selected dimension values within the specified dimension.
| |
NavCommandId |
The command identifier for the NavigationCommand.
If specified as null, then the first NavigationCommand contained within the
CommandInfoCollection will be formatted.
| |
Separator |
Gets or sets the separator to use between formatted DimensionValuePaths.
For example if there are registered IDimensionValuePathFormatters for the
Wine dimension and the Vintage dimension: [Wine-Red-Merlot][Separator][1992]
The default separator is '/'
| |
UseDimensionNameAsKey |
Specifies that dimension name (that is, the root dimension name) should be used as the key
when looking up IDimensionValuePathFormatters, instead of root
dimension value id. Set to "false" by default.
|