The DimensionValuePathFormatter type exposes the following members.

Properties

  NameDescription
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:

CopyC#
http://wines.endeca.com/browse/New-Zealand/Wine-Type-White-Sauvignon-Blanc/Cloudy-Bay/_/N-1z141hbZ66sZ1z1413q
Here "White" is the ancestor dimension value in the "Wine Type" dimension.

If false, "White" would be omitted:

CopyC#
http://wines.endeca.com/browse/New-Zealand/Wine-Type-Sauvignon-Blanc/Cloudy-Bay/_/N-1z141hbZ66sZ1z1413q

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:

CopyC#
http://wines.endeca.com/browse/New-Zealand/Wine-Type-White-Sauvignon-Blanc/Cloudy-Bay/_/N-1z141hbZ66sZ1z1413q
Here "Sauvignon-Blanc" is the selected dimension value in the "Wine Type" dimension.

If false, "Sauvignon-Blanc" would be omitted:

CopyC#
http://wines.endeca.com/browse/New-Zealand/Wine-Type-White/Cloudy-Bay/_/N-1z141hbZ66sZ1z1413q

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:

CopyC#
http://wines.endeca.com/browse/New-Zealand/Wine-Type-White-Sauvignon-Blanc/Cloudy-Bay/_/N-1z141hbZ66sZ1z1413q
Here "Wine-Type" is the dimension value in the "Wine Type" dimension.

If "false", the root "Wine Type" would be omitted from the URL string:

CopyC#
http://wines.endeca.com/browse/New-Zealand/White-Sauvignon-Blanc/Cloudy-Bay/_/N-1z141hbZ66sZ1z1413q

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 '-'.

See Also