The DocumentQueryProperties type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
DocumentQueryProperties |
Constructor
|
Methods
Name | Description | |
---|---|---|
AddColumns |
Gets list of required columns based on query properties separated by comma
| |
AddCulturePriorityColumn |
Adds culture priority column to data query settings to get the most relevant document culture version
| |
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
| |
Equals | (Inherited from Object.) | |
ExcludePath( String ) |
Filters the data to exclude documents on given path(s).
| |
ExcludePath(String, PathTypeEnum) |
Filters the data to exclude documents on given path.
| |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
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 |
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.
| |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
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
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
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.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods
Name | Description | |
---|---|---|
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.) |
Properties
Name | Description | |
---|---|---|
AllCultures |
Indicates if all culture versions of the documents should be returned in the result.
| |
Category |
Instance of category if specified.
| |
CategoryIsGlobal |
Indicates if only documents assigned to enabled categories (default is true) should be included in the results.
| |
CategoryName |
Defines name of the category to filter the result. Documents assigned to any category within the category path are included in the results.
| |
CategoryOnlyEnabled |
Indicates if only documents assigned to enabled categories (default is true) should be included in the results.
| |
CombineWithDefaultCulture |
Indicates if the documents should be combined with the default language version if the specific one doesn't exist.
| |
CultureList |
List of cultures to use in query
| |
Cultures |
List of document cultures which should be included in the result.
| |
DefaultCultureCode |
Provides default culture code for the current query
| |
EnsureExtraColumns |
If true, automatic extra columns are ensured for the query (NodeXML for version data, security check required columns etc.).
| |
ExcludedPaths |
List of document paths which should be excluded from the result.
| |
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.
| |
CheckPermissions |
Indicates if the documents should be filtered based on current user permissions.
| |
IsLastVersion |
If true, the last version of the documents is retrieved.
| |
IsMultiQuery |
Indicates if properties are used for a multi-query.
| |
NestingLevel |
Limits documents to a specified nesting level. (Applies only when one node alias path for multiple documents is provided.)
| |
Paths |
List of document paths which should be included in the result.
| |
PreferredCultureCode |
Preferred culture code to use when none set.
| |
RelationshipName |
Defines name of the relationship. If not provided documents from all relationships will be retrieved.
| |
RelationshipNodeGUID |
Defines node GUID of the related document. Only document in relation with this document will be included in the results.
| |
RelationshipSide |
Defines side of the related document within the relation. Both sides are used by default.
| |
SelectOnlyPublished |
If true, only published documents are retrieved.
| |
SiteIDs |
List of site IDs on which should be the documents searched.
| |
SiteName |
Provides site name for the current query (If there is only single site specified.)
| |
TreeProvider |
Instance of tree provider to use to parameterize documents retrieving.
|
See Also