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.

Namespace:  Endeca.Web.Url.Seo.Formatting
Assembly:  Endeca.Web.Url.Seo (in Endeca.Web.Url.Seo.dll) Version: 2.1.1.0 (2.1.1.0)

Syntax

C#
public string Format(
	DimensionValuePath dimensionValuePath
)
Visual Basic (Declaration)
Public Function Format ( _
	dimensionValuePath As DimensionValuePath _
) As String
Visual C++
public:
virtual String^ Format(
	DimensionValuePath^ dimensionValuePath
) sealed

Parameters

dimensionValuePath
Type: DimensionValuePath
The DimensionValue elements to format

Return Value

The formatted DimensionValuePath string.

Implements

IDimensionValuePathFormatter..::.Format(DimensionValuePath)

Exceptions

ExceptionCondition
System..::.ArgumentException If the DimensionValuePath is null

See Also