Endeca Presentation API
RefinementConfig Class
NamespacesEndeca.NavigationRefinementConfig
Class representing a dynamic refinement config for a dimension value. This will determine how refinements are computed under this dimension value. Use of a dynamic refinement config will suppress generation of a "More..." child dimension value. You can determine whether there are more refinements than the ones shown by looking at the "DGraph.More" property on the refinements' parent dimension value. Any of the settings in this class can be set explicitly or defaulted to use the corresponding dimension's settings in developer studio.
Declaration Syntax
C#Visual BasicVisual C++
public class RefinementConfig
Public Class RefinementConfig
public ref class RefinementConfig
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
RefinementConfigRefinementConfigNew(Int64)
Default constructor where the
CopyC#
dimValId
sets the dimension value this dynamic refinement config is associated with.

DimensionValueId
Accessor which gets the Dimension value ID associated with this refinement config.

DynamicRanking
Accessor which gets and sets whether the dimension value has Dynamic Ranking enabled, disabled or defaults to the settings in Developer Studio.

DynamicRankOrder
Accessor which gets and sets whether the dimension value is sorted statically (ordered by refinement sort order), dynamically (ordered by refinement count). If set to use default then the dimension value will be sorted statically or dynamically depending on the dimension's setting in Developer Studio. This is only used if the dimension value has Dynamic Ranking enabled.

DynamicRefinementCount
Accessor which gets and sets the maximum number of dimension values (refinements) to return to the user. This is only used if the dimension value has Dynamic Ranking enabled.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Exposed
Accessor that gets and sets whether to expose the dimension value.

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 the string representation of the dynamic refinement config.

Inheritance Hierarchy
Object
RefinementConfig

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