DocumentQueryProperties Class

Document specific properties for document queries

Inheritance Hierarchy

System.Object
  CMS.DocumentEngine.DocumentQueryProperties

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 8.2.23

Syntax

public class DocumentQueryProperties

The DocumentQueryProperties type exposes the following members.

Constructors

	Name	Description
Public method	DocumentQueryProperties	Constructor

Methods

	Name	Description
Protected method	AddColumns	Adds required columns to the columns list based on query properties
Public method	AddCulturePriorityColumn	Adds culture priority column to data query settings to get the most relevant document culture version
Public method	AddDuplicatesPriorityColumn	Adds duplicates priority column to data query settings to get only original documents
Public method	All	Ensures that there is no restriction applied for the result.
Public method	ApplyProperties	Applies properties to given instance.
Public method	ApplyToSettings	Applies these properties to the given data query settings
Public method	ApplyVersionData	Applies versioned data
Public method	Clone	Clones object
Public method	Culture	Filters the data to include only documents translated to given culture(s).
Public method	Default	Ensures default state of settings for the result.
Public method	EnsureColumns	Ensures required columns based on query properties
Public method	EnsureWhereCondition	Ensures where condition based on query properties
Public method	ExcludePath(String[])	Filters the data to exclude documents on given path(s).
Public method	ExcludePath(String, PathTypeEnum)	Filters the data to exclude documents on given path.
Public method	GetAllowedPathWhereCondition	Gets where condition based on allowed paths
Protected method	GetCategoryInternal	Gets category based on settings
Public method	GetClassesWhereCondition	Gets where condition based on multi-query settings and list of document types
Protected method	GetCombineWithDefaultCultureInternal	Gets default value for combine with default culture
Public method	GetCultureWhereCondition	Gets where condition based on list of requested cultures
Protected method	GetDefaultCultureCodeInternal	Gets default value for default culture
Public method	GetExcludedPathWhereCondition	Gets where condition based on excluded paths
Public method	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.
Public method	GetMultiQuery	Gets modified multi query to execute
Public method	GetNestingLevelWhereCondition	Gets where condition to retrieve only documents in specified nesting level (The first specified path is taken as the referring one.)
Public method	GetNodeDataWhereCondition	Gets where condition for all restrictions based on tree node data
Protected method	GetPreferredCultureInternal	Gets default value for preferred culture
Public method	GetPublishedWhereCondition	Gets where condition to retrieve only published documents based on settings
Public method	GetRelationshipWhereCondition	Gets where condition to retrieve only documents in relationship defined by the properties.
Public method	GetResults	Gets query modified results. Returns null if there is no modification needed.
Public method	GetSingleQuery	Gets modified single query to execute
Public method	CheckReturnsNoResults	Checks if query should return no results
Public method	OnSite	Filters the data to include documents only on the given site(s).
Public method	Path(String[])	Filters the data to include only documents on given path(s).
Public method	Path(String, PathTypeEnum)	Filters the data to include only documents on given path.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	AllCultures	Indicates if all culture versions of the documents should be returned in the result.
Protected property	Category	Instance of category if specified.
Public property	CategoryIsGlobal	Indicates if only documents assigned to enabled categories (default is true) should be included in the results.
Public property	CategoryName	Defines name of the category to filter the result. Documents assigned to any category within the category path are included in the results.
Public property	CategoryOnlyEnabled	Indicates if only documents assigned to enabled categories (default is true) should be included in the results.
Public property	CombineWithAnyCulture	Indicates if the documents should be combined with any language version if the specific one doesn't exist.
Public property	CombineWithDefaultCulture	Indicates if the documents should be combined with the default language version if the specific one doesn't exist.
Protected property	CultureList	List of cultures to use in query
Public property	Cultures	List of document cultures which should be included in the result.
Public property	DefaultCultureCode	Provides default culture code for the current query
Public property	EnsureExtraColumns	If true, automatic extra columns are ensured for the query (NodeXML for version data, security check required columns etc.).
Public property	ExcludedPaths	List of document paths which should be excluded from the result.
Public property	FilterDuplicates	Indicates if duplicate document are filtered from the result. This means that linked documents are not retrieved, if there is the original document already included in the results.
Public property	CheckPermissions	Indicates if the documents should be filtered based on current user permissions.
Public property	IsLastVersion	If true, the last version of the documents is retrieved.
Public property	IsMultiQuery	Indicates if properties are used for a multi-query.
Public property	NestingLevel	Limits documents to a specified nesting level. (Applies only when one node alias path for multiple documents is provided.)
Public property	Paths	List of document paths which should be included in the result.
Public property	PreferredCultureCode	Preferred culture code to use when none set.
Public property	RelationshipName	Defines name of the relationship. If not provided documents from all relationships will be retrieved.
Public property	RelationshipNodeGUID	Defines node GUID of the related document. Only document in relation with this document will be included in the results.
Public property	RelationshipSide	Defines side of the related document within the relation. Both sides are used by default.
Public property	SelectOnlyPublished	If true, only published documents are retrieved.
Public property	SiteIDs	List of site IDs on which should be the documents searched.
Public property	SiteName	Provides site name for the current query (If there is only single site specified.)
Public property	TreeProvider	Instance of tree provider to use to parameterize documents retrieving.