Class CreationParameters

Namespace

Dynamicweb.QueryPublisher

Assembly

Dynamicweb.QueryPublisher.dll

Represents a container for all objects and primitive parameters required to build or render a Query Publisher view (templates, lists, facets, paging, sorting, etc).

public class CreationParameters

Inheritance

object

CreationParameters

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This type is a simple immutable+mutable hybrid aggregate:

• The dictionaries passed into the primary constructor are captured once (read-only fields).
• Other members are mutable so the pipeline can enrich the instance progressively. All collections default to empty to minimize null checks in consumers.

Constructors

CreationParameters(Dictionary<string, object>, Dictionary<string, FacetGroupResult>)

Represents a container for all objects and primitive parameters required to build or render a Query Publisher view (templates, lists, facets, paging, sorting, etc).

public CreationParameters(Dictionary<string, object> parameters, Dictionary<string, FacetGroupResult> facets)

Parameters

parameters Dictionary<string, object>

Arbitrary contextual values (typically coming from request, paragraph settings, or custom logic) exposed to templates / rendering logic. Never null (internally normalized to an empty dictionary).

facets Dictionary<string, FacetGroupResult>

Raw facet group result map keyed by facet group system name. Never null (internally normalized to an empty dictionary).

Remarks

This type is a simple immutable+mutable hybrid aggregate:

• The dictionaries passed into the primary constructor are captured once (read-only fields).
• Other members are mutable so the pipeline can enrich the instance progressively. All collections default to empty to minimize null checks in consumers.

Properties

FacetGroups

Gets or sets the facet group definitions (configuration) used to build UI prior to or after binding facet counts (Facets). Defaults to an empty sequence.

public IEnumerable<IFacetGroup> FacetGroups { get; set; }

Property Value

IEnumerable<IFacetGroup>

Facets

Gets the executed facet group results keyed by facet group name. Never null.

public Dictionary<string, FacetGroupResult> Facets { get; }

Property Value

Dictionary<string, FacetGroupResult>

PagingHandler

Gets or sets the paging handler controlling paging activation, current page and ranges. Must be provided by the caller before paging is evaluated in the pipeline.

public required PagingHandler PagingHandler { get; set; }

Property Value

PagingHandler

Parameters

Gets the arbitrary parameter bag made available to templates or downstream processing components. Never null.

public Dictionary<string, object> Parameters { get; }

Property Value

Dictionary<string, object>

Query

Gets or sets the query definition that produced QueryResult Must be supplied so that consumers can inspect parameters, meta or sorting.

public required IQuery Query { get; set; }

Property Value

IQuery

QueryResult

Gets or sets the concrete query execution result (documents and facet groups) produced by the indexing/query subsystem.

public required IQueryResult QueryResult { get; set; }

Property Value

IQueryResult

ShowFacetOptionsWithNoResults

Gets or sets a value indicating whether facet options with zero result count should still be rendered (useful for keeping UI stable / visibility of all filters).

public bool ShowFacetOptionsWithNoResults { get; set; }

Property Value

bool

SortOrder

Gets or sets the effective sort order applied to the query (may be user selected). Defaults to an empty sequence.

public IEnumerable<SortInfo> SortOrder { get; set; }

Property Value

IEnumerable<SortInfo>