Removes the specified DimensionValue from the set of selected DimensionValues in the NavigationCommand.

Namespace:  Endeca.Data
Assembly:  Endeca.Data (in Endeca.Data.dll) Version: 2.1.3.0 (2.1.3.622)

Syntax

C#
public void RemoveDimensionValue(
	DimensionValue dimensionValue
)
Visual Basic (Declaration)
Public Sub RemoveDimensionValue ( _
	dimensionValue As DimensionValue _
)
Visual C++
public:
void RemoveDimensionValue(
	DimensionValue^ dimensionValue
)

Parameters

dimensionValue
Type: Endeca.Data..::.DimensionValue
The DimensionValue to be removed

Remarks

RemoveDimensionValue will remove the entire path that this dimension value is contained in. Note that you may be looking for SelectParentDimensionValue(DimensionValue) if you are in a hierarchical dimension and expect to move back only one step in the dimension tree.

Note also that if you pass in a dimension value that is not currently selected, but one of its descendants is selected, then the entire path to that descendant will be removed.

See Also