Endeca Presentation API
DimLocation Class
NamespacesEndeca.NavigationDimLocation
DimLocation represents a specific location in a dimension.
Declaration Syntax
C#Visual BasicVisual C++
public class DimLocation
Public Class DimLocation
public ref class DimLocation
Members
All MembersMethodsProperties



IconMemberDescription
Ancestors
Gets the ancestors of the dimension location.

DimValue
Gets the dimension value of this dimension location.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(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.)
GetHashCode()()
Serves as a hash function for a particular type. GetHashCode()() is suitable for use in hashing algorithms and data structures like a hash table.
(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.)
ToString()()
Returns a String that represents the current Object.
(Inherited from Object.)
Remarks
The dimension location comprises one dimension value (DimVal object) and a DimValList that contains all of the dimension location’s ancestors (also DimVal objects) up to, but not including, the dimension root.

DimLocation objects are returned as part of an Endeca record, via an AssocDimLocationsList object in the ERec data structure. The dimension locations designate the record’s location within the dimension hierarchy.

Note that when returned in an AssocDimLocations object, the dimension locations are all from the same dimension. However, when returned in a DimLocationList object, the dimension locations can be from different dimensions (which is typically the result of a compound dimension search).

Inheritance Hierarchy
Object
DimLocation

Assembly: Endeca.Navigation (Module: Endeca.Navigation) Version: 0.0.0.0