Table of Contents

Class ContentTypeQueryParametersExtensions

Namespace
CMS.Websites
Assembly
CMS.Websites.dll

Content type query parameters extension methods related to web pages.

public static class ContentTypeQueryParametersExtensions
Inheritance
object
ContentTypeQueryParametersExtensions

Methods

ForWebsite(ContentTypeQueryParameters, string, PathMatch, bool)

Adds the website data to the result query.

public static ContentTypeQueryParameters ForWebsite(this ContentTypeQueryParameters parameters, string websiteChannelName, PathMatch pathMatch = null, bool includeUrlPath = true)

Parameters

parameters ContentTypeQueryParameters

Content type query parameters.

websiteChannelName string

Name of the website channel.

pathMatch PathMatch

Web page tree path for which the query should be limited.

includeUrlPath bool

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

Returns

ContentTypeQueryParameters

ForWebsite(ContentTypeQueryParameters, string, PathMatch[], bool)

Adds the website data to the result query.

public static ContentTypeQueryParameters ForWebsite(this ContentTypeQueryParameters parameters, string websiteChannelName, PathMatch[] pathMatches, bool includeUrlPath = true)

Parameters

parameters ContentTypeQueryParameters

Content type query parameters.

websiteChannelName string

Name of the website channel.

pathMatches PathMatch[]

Web page tree paths for which the query should be limited.

includeUrlPath bool

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

Returns

ContentTypeQueryParameters

SetUrlLanguageBehavior(ContentTypeQueryParameters, UrlLanguageBehavior)

Defines the behavior for URL paths of web pages in fallback languages when content query is configured with InLanguage(string, bool).

public static ContentTypeQueryParameters SetUrlLanguageBehavior(this ContentTypeQueryParameters parameters, UrlLanguageBehavior urlLanguageBehavior)

Parameters

parameters ContentTypeQueryParameters

Content type query parameters.

urlLanguageBehavior UrlLanguageBehavior

URL language behavior.

Returns

ContentTypeQueryParameters

Remarks

This behavior applies to web pages retrieved using 'ForWebsite' and 'WithLinkedItems' methods.

When limiting retrieved columns via the 'Columns' query parameterization, call UrlPathColumns(ContentTypeQueryParameters) to ensure all data necessary for URL resolution.