DocumentQueryProperties Properties |
The DocumentQueryProperties type exposes the following members.
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.
| |
CombineWithAnyCulture |
Indicates if the documents should be combined with any language version if the specific one doesn't exist.
| |
CombineWithDefaultCulture |
Indicates if the documents should be combined with the default language version if the specific one doesn't exist.
| |
CultureList |
Ordered and filtered list of cultures to use in query
| |
Cultures |
Prioritized 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 (column for version data application, security check required columns etc.).
| |
ExcludedPaths |
List of document paths which should be excluded from the result.
| |
ExcludedVersionedColumns |
List of versioned columns which should not be applied
| |
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.)
| |
ParentQuery |
Parent document query
| |
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 parametrize documents retrieving.
|