Click or drag to resize
DocumentQueryProperties Class
Document specific properties for document queries
Inheritance Hierarchy
SystemObject
  CMS.DocumentEngineDocumentQueryProperties

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 8.2.23
Syntax
C#
public class DocumentQueryProperties

The DocumentQueryProperties type exposes the following members.

Constructors
  NameDescription
Public methodDocumentQueryProperties
Constructor
Top
Methods
  NameDescription
Protected methodAddColumns
Adds required columns to the columns list based on query properties
Public methodAddCulturePriorityColumn
Adds culture priority column to data query settings to get the most relevant document culture version
Public methodAddDuplicatesPriorityColumn
Adds duplicates priority column to data query settings to get only original documents
Public methodAll
Ensures that there is no restriction applied for the result.
Public methodApplyProperties
Applies properties to given instance.
Public methodApplyToSettings
Applies these properties to the given data query settings
Public methodApplyVersionData
Applies versioned data
Public methodClone
Clones object
Public methodCulture
Filters the data to include only documents translated to given culture(s).
Public methodDefault
Ensures default state of settings for the result.
Public methodEnsureColumns
Ensures required columns based on query properties
Public methodEnsureWhereCondition
Ensures where condition based on query properties
Public methodExcludePath(String)
Filters the data to exclude documents on given path(s).
Public methodExcludePath(String, PathTypeEnum)
Filters the data to exclude documents on given path.
Public methodGetAllowedPathWhereCondition
Gets where condition based on allowed paths
Protected methodGetCategoryInternal
Gets category based on settings
Public methodGetClassesWhereCondition
Gets where condition based on multi-query settings and list of document types
Protected methodGetCombineWithDefaultCultureInternal
Gets default value for combine with default culture
Public methodGetCultureWhereCondition
Gets where condition based on list of requested cultures
Protected methodGetDefaultCultureCodeInternal
Gets default value for default culture
Public methodGetExcludedPathWhereCondition
Gets where condition based on excluded paths
Public methodGetFilterDuplicatesWhereCondition 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 methodGetMultiQuery
Gets modified multi query to execute
Public methodGetNestingLevelWhereCondition
Gets where condition to retrieve only documents in specified nesting level (The first specified path is taken as the referring one.)
Public methodGetNodeDataWhereCondition
Gets where condition for all restrictions based on tree node data
Protected methodGetPreferredCultureInternal
Gets default value for preferred culture
Public methodGetPublishedWhereCondition
Gets where condition to retrieve only published documents based on settings
Public methodGetRelationshipWhereCondition
Gets where condition to retrieve only documents in relationship defined by the properties.
Public methodGetResults
Gets query modified results. Returns null if there is no modification needed.
Public methodGetSingleQuery
Gets modified single query to execute
Public methodCheckReturnsNoResults
Checks if query should return no results
Public methodOnSite
Filters the data to include documents only on the given site(s).
Public methodPath(String)
Filters the data to include only documents on given path(s).
Public methodPath(String, PathTypeEnum)
Filters the data to include only documents on given path.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Properties
  NameDescription
Public propertyAllCultures
Indicates if all culture versions of the documents should be returned in the result.
Protected propertyCategory
Instance of category if specified.
Public propertyCategoryIsGlobal
Indicates if only documents assigned to enabled categories (default is true) should be included in the results.
Public propertyCategoryName
Defines name of the category to filter the result. Documents assigned to any category within the category path are included in the results.
Public propertyCategoryOnlyEnabled
Indicates if only documents assigned to enabled categories (default is true) should be included in the results.
Public propertyCombineWithAnyCulture
Indicates if the documents should be combined with any language version if the specific one doesn't exist.
Public propertyCombineWithDefaultCulture
Indicates if the documents should be combined with the default language version if the specific one doesn't exist.
Protected propertyCultureList
List of cultures to use in query
Public propertyCultures
List of document cultures which should be included in the result.
Public propertyDefaultCultureCode
Provides default culture code for the current query
Public propertyEnsureExtraColumns
If true, automatic extra columns are ensured for the query (NodeXML for version data, security check required columns etc.).
Public propertyExcludedPaths
List of document paths which should be excluded from the result.
Public propertyFilterDuplicates
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 propertyCheckPermissions
Indicates if the documents should be filtered based on current user permissions.
Public propertyIsLastVersion
If true, the last version of the documents is retrieved.
Public propertyIsMultiQuery
Indicates if properties are used for a multi-query.
Public propertyNestingLevel
Limits documents to a specified nesting level. (Applies only when one node alias path for multiple documents is provided.)
Public propertyPaths
List of document paths which should be included in the result.
Public propertyPreferredCultureCode
Preferred culture code to use when none set.
Public propertyRelationshipName
Defines name of the relationship. If not provided documents from all relationships will be retrieved.
Public propertyRelationshipNodeGUID
Defines node GUID of the related document. Only document in relation with this document will be included in the results.
Public propertyRelationshipSide
Defines side of the related document within the relation. Both sides are used by default.
Public propertySelectOnlyPublished
If true, only published documents are retrieved.
Public propertySiteIDs
List of site IDs on which should be the documents searched.
Public propertySiteName
Provides site name for the current query (If there is only single site specified.)
Public propertyTreeProvider
Instance of tree provider to use to parameterize documents retrieving.
Top
See Also