Table of Contents

Class RetrieveParametersBase<T>

Namespace
Kentico.Content.Web.Mvc
Assembly
Kentico.Content.Web.Mvc.dll

Base class for parameters used during retrieval. IContentRetriever

public abstract class RetrieveParametersBase<T> where T : RetrieveParametersBase<T>, new()

Type Parameters

T
Inheritance
object
RetrieveParametersBase<T>
Derived
Extension Methods

Constructors

RetrieveParametersBase() 

protected RetrieveParametersBase()

Properties

Default

Initializes default instance of T.

public static T Default { get; }

Property Value

T

IncludeContentTypeFields

Indicates whether content type-specific fields are included in the retrieved items. Default is true. When set to false, content type-specific (class) fields are omitted from the result, which can improve performance when only common fields are needed. Reusable schema fields and web page data are still retrieved regardless of this setting.

public bool IncludeContentTypeFields { get; init; }

Property Value

bool

IncludeSecuredItems

Indicates whether the secured items should be included.

public bool IncludeSecuredItems { get; init; }

Property Value

bool

IncludeUrlPath

Indicates if the URL path should be included in the retrieved data.

public bool IncludeUrlPath { get; init; }

Property Value

bool

IsForPreview

Indicates whether the result is for preview. If not specified, the website context value is used.

public bool? IsForPreview { get; set; }

Property Value

bool?

LanguageName

Content language code name of the language in which items will be retrieved. If not specified, the preferred language is used. UseLanguageFallbacks

public string LanguageName { get; init; }

Property Value

string

LinkedItemsMaxLevel

Indicates the maximum level of linked items to include.

public int LinkedItemsMaxLevel { get; init; }

Property Value

int

UseLanguageFallbacks

Indicates if fallback languages are used when querying data. LanguageName

public bool UseLanguageFallbacks { get; init; }

Property Value

bool