Endeca Presentation API
DimGroup Class
NamespacesEndeca.NavigationDimGroup
Class encapsulating a group of dimensions.
Declaration Syntax
C#Visual BasicVisual C++
public class DimGroup : IList, ICollection, 
	IEnumerable
Public Class DimGroup _
	Implements IList, ICollection, IEnumerable
public ref class DimGroup : IList, 
	ICollection, IEnumerable
Members
All MembersMethodsProperties



IconMemberDescription
Add(Object)
This operation is not supported.

Clear()()
This operation is not supported.

Contains(Object)
Determines whether an element is in the DimGroup.

CopyTo(Array, Int32)
Copies the entire DimGroup to a compatible one-dimensional Array, starting at the specified index of the target array.

Count
Gets the number of elements actually contained in the DimGroup.

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.)
GetDimension(Int64)
Gets the Dimension with the ID dimensionId from this list.

GetDimension(String)
Gets the Dimension with the name dimensionName from this list.

GetEnumerator()()
Returns an enumerator for the entire DimGroup.

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.)
Id
Gets the ID of the dimension group.

IndexOf(Object)
Returns the zero-based index of the first occurrence of a value in the DimGroup or in a portion of it.

Insert(Int32, Object)
This operation is not supported.

IsExplicit()()
Determines if the dimension group is an explicit or implicit dimension group.

IsFixedSize
Gets a value indicating whether the DimGroup has a fixed size.

IsReadOnly
Gets a value indicating whether the DimGroup is read-only.

IsSynchronized
Gets a value indicating whether access to the DimGroup is synchronized (thread-safe).

Item[([Int32])]
Gets the Dimension at the specified index. The set operation is not supported.

MemberwiseClone()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Name
Gets the name of the dimension group.

Remove(Object)
This operation is not supported.

RemoveAt(Int32)
This operation is not supported.

SyncRoot
This operation is not supported.

ToString()()
Returns a String that represents the current Object.
(Inherited from Object.)
Remarks
Dimension groups provide a way to impose relationships on dimensions (Dimension objects). By creating a dimension group, dimensions can be organized for presentation purposes. Each explicit dimension group must be given a name; a unique ID is generated when the data is indexed.

If a dimension is not assigned to an explicit dimension group, it is placed in an implicit dimension group of its own. These implicit groups have no name and an ID of zero.

Inheritance Hierarchy
Object
DimGroup

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