| DocumentQueryProperties Methods |
The DocumentQueryProperties type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddColumns |
Adds required columns to the columns list based on query properties
|
 | AddCulturePriorityColumn |
Adds culture priority column to data query settings to get the most relevant document culture version
|
| AddDuplicatesPriorityColumn |
Adds duplicates priority column to data query settings to get only original documents
|
| All |
Ensures that there is no restriction applied for the result.
|
| ApplyProperties |
Applies properties to given instance.
|
| ApplyToSettings |
Applies these properties to the given data query settings
|
| ApplyVersionData |
Applies versioned data
|
| Clone |
Clones object
|
| Culture |
Filters the data to include only documents translated to given culture(s).
|
| Default |
Ensures default state of settings for the result.
|
| EnsureColumns |
Ensures required columns based on query properties
|
| EnsureWhereCondition |
Ensures where condition based on query properties
|
| ExcludePath(String) |
Filters the data to exclude documents on given path(s).
|
| ExcludePath(String, PathTypeEnum) |
Filters the data to exclude documents on given path.
|
| GetAllowedPathWhereCondition |
Gets where condition based on allowed paths
|
| GetCategoryInternal |
Gets category based on settings
|
| GetClassesWhereCondition |
Gets where condition based on multi-query settings and list of document types
|
| GetCombineWithDefaultCultureInternal |
Gets default value for combine with default culture
|
| GetCultureWhereCondition |
Gets where condition based on list of requested cultures
|
| GetDefaultCultureCodeInternal |
Gets default value for default culture
|
| GetExcludedPathWhereCondition |
Gets where condition based on excluded paths
|
| GetFilterDuplicatesWhereCondition | Obsolete.
Gets where condition to retrieve documents only once.
This means that linked documents are not retrieved if there is the original document in the results.
|
| GetMultiQuery |
Gets modified multi query to execute
|
| GetNestingLevelWhereCondition |
Gets where condition to retrieve only documents in specified nesting level (The first specified path is taken as the referring one.)
|
| GetNodeDataWhereCondition |
Gets where condition for all restrictions based on tree node data
|
| GetPreferredCultureInternal |
Gets default value for preferred culture
|
| GetPublishedWhereCondition |
Gets where condition to retrieve only published documents based on settings
|
| GetRelationshipWhereCondition |
Gets where condition to retrieve only documents in relationship defined by the properties.
|
| GetResults |
Gets query modified results. Returns null if there is no modification needed.
|
| GetSingleQuery |
Gets modified single query to execute
|
| CheckReturnsNoResults |
Checks if query should return no results
|
| OnSite |
Filters the data to include documents only on the given site(s).
|
| Path(String) |
Filters the data to include only documents on given path(s).
|
| Path(String, PathTypeEnum) |
Filters the data to include only documents on given path.
|
Extension Methods| Name | Description | |
|---|---|---|
 | AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) |
| GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
See Also