MultiDocumentQuery Properties |
The MultiDocumentQuery type exposes the following members.
Name | Description | |
---|---|---|
AllowMaterialization |
If true, the query allows materialization
(Inherited from DataQueryBaseTQuery.) | |
ClassName |
Class name
(Inherited from DataQueryBaseTQuery.) | |
ConnectionStringForced |
If true, the connection string was set explicitly
(Inherited from DataQueryBaseTQuery.) | |
ConnectionStringName |
Connection string name
(Inherited from DataQueryBaseTQuery.) | |
Count |
Number of total items in the collection
(Inherited from DataQueryBaseTQuery.) | |
CustomQueryText |
Custom query text
(Inherited from DataQueryBaseTQuery.) | |
DataSource |
Data source that provides the query data. If not set, the query queries the database directly
(Inherited from DataQueryBaseTQuery.) | |
DataSourceName |
Data source identifier that represents the location from which the data are obtained.
(Inherited from WhereConditionBaseTParent.) | |
DefaultOrderByColumns |
Default order by columns used in case if needed, and order by is not specified
(Inherited from DataQueryBaseTQuery.) | |
DefaultOrderByType |
If true, the result is ordered by source type by default, then by source order. If false (default), the result is ordered by the source order, and items from different types may interleave.
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
DefaultQuery |
Default query used by the process when type queries are not used.
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
DefaultQuerySource |
Default source of the query in case source is not defined
(Inherited from DataQuerySettingsBaseTQuery.) | |
DisposeUsedObjects |
Disposes the objects that were used as parameters for this query
(Inherited from WhereConditionBaseTParent.) | |
ElementType |
Returns the element type.
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
Expression |
Query expression
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
FilterColumns |
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
(Inherited from DataQuerySettingsBaseTQuery.) | |
FirstObject |
Returns first object from the query result DataSet. The property does not limit the actual number of fetched rows.
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
ForceOrderBy |
If true, the order by should be forced in the process of execution
(Inherited from DataQuerySettingsBaseTQuery.) | |
FullQueryName |
Represents a full query name of the query
(Inherited from DataQueryBaseTQuery.) | |
GroupByColumns |
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
(Inherited from DataQuerySettingsBaseTQuery.) | |
HasDataSource |
Returns true if the query has specific data source
(Inherited from DataQueryBaseTQuery.) | |
HasGroupBy |
Returns true if the given query has group by set
(Inherited from DataQuerySettingsBaseTQuery.) | |
HavingCondition |
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
(Inherited from DataQuerySettingsBaseTQuery.) | |
HavingIsComplex |
Returns true if the given having condition is a complex condition
(Inherited from DataQuerySettingsBaseTQuery.) | |
HavingIsEmpty |
Returns true if the having condition is empty
(Inherited from DataQuerySettingsBaseTQuery.) | |
IncludeBinaryData |
If true, the query includes the object binary data. Default is true
(Inherited from DataQueryBaseTQuery.) | |
IsCombinedQuery |
If true, this query is combined from several queries. When additional parameters are applied to it, it will be wrapped into a nested query.
(Inherited from DataQueryBaseTQuery.) | |
IsImmutable |
If true, this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBaseTParent.) | |
IsNested |
Indicates that this query is nested within another query as its source.
This brings certain constraints such as that is cannot use CTE.
(Inherited from DataQuerySettingsBaseTQuery.) | |
IsOffline |
Returns true if the given collection is offline (disconnected from the database)
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
IsPagedQuery |
Returns true if the query has the paging enabled
(Inherited from DataQuerySettingsBaseTQuery.) | |
IsSubQuery |
If true, the query is a sub-query used in another query.
This brings certain constraints such as that it cannot use order by or CTE.
(Inherited from DataQuerySettingsBaseTQuery.) | |
MaxRecords |
Maximum number of results to return (use for paging together with Offset)
(Inherited from DataQuerySettingsBaseTQuery.) | |
Name |
Object name, empty by default
(Inherited from DataQueryBaseTQuery.) | |
NextPageAvailable |
Returns true if the next page is available.
(Inherited from DataQueryBaseTQuery.) | |
ObjectType |
Returns the object type of the objects stored within the collection.
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
Offset |
Index of the first record to return (use for paging together with MaxRecords)
(Inherited from DataQuerySettingsBaseTQuery.) | |
OrderByColumns |
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
(Inherited from DataQuerySettingsBaseTQuery.) | |
OrderByResultColumns |
List of columns for the result order by. If not specified, the result is ordered by sources and global order by.
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
Parameters |
Query data parameters
(Inherited from QueryParametersBaseTParent.) | |
Properties |
Document query properties.
(Inherited from MultiDocumentQueryBaseTQuery, TInnerQuery, TObject.) | |
Provider |
Query provider
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
Queries |
Inner queries. Can be used to search for specific query.
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
QueriesList |
Inner queries list. Defines order of the queries.
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
QueryName |
Query name
(Inherited from DataQueryBaseTQuery.) | |
QuerySource |
Query source object
(Inherited from DataQuerySettingsBaseTQuery.) | |
QueryText |
Query text
(Inherited from DataQueryBaseTQuery.) | |
Result |
DataSet with the result
(Inherited from DataQueryBaseTQuery.) | |
ReturnsNoResults |
Returns true if query doesn't return any results
(Inherited from WhereConditionBaseTParent.) | |
ReturnsSingleColumn |
Returns true if the query returns single column
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
SelectColumnsList |
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from DataQuerySettingsBaseTQuery.) | |
SelectDistinct |
If set to true, returns only distinct (different) values.
(Inherited from DataQuerySettingsBaseTQuery.) | |
SelectedTypes |
Returns the types of the inner queries
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
SelectResultColumnsList |
List of columns to use for results, by default returns all columns defined in the inner queries. Example: "DocumentName, DocumentID"
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
SupportsReader |
Returns true if the query supports data reader
(Inherited from DataQueryBaseTQuery.) | |
Tables |
Collection of the result tables
(Inherited from DataQueryBaseTQuery.) | |
TopNRecords |
If set, selects only first top N number of records
(Inherited from DataQuerySettingsBaseTQuery.) | |
TotalExpression |
Total items expression. When defined, used instead default total items for a paged query.
(Inherited from DataQuerySettingsBaseTQuery.) | |
TotalRecords |
Gets the number of total records when paging is used. Gets updated once the query executes
(Inherited from DataQueryBaseTQuery.) | |
TypedResult |
Typed result
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
UseDefaultQuery |
Flag indicating if the default query should be forcibly used. Default false. This flag is automatically reverted to false in case initializer of particular type query is used through Type("sometype", q => q.Where(...)).
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
UseGlobalWhereOnResult |
If true, the global where condition from the parent query is used outside the inner queries on the whole result. If false (default), the global where condition is used inside individual inner queries.
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
UseObjectTypeCondition |
If true, the query uses the object type condition.
(Inherited from MultiObjectQueryBaseTQuery, TInnerQuery, TObject.) | |
UseTypeColumns |
If true (default), the query uses type columns for the output, otherwise it uses only global columns
(Inherited from MultiQueryBaseTQuery, TInnerQuery.) | |
WhereBuilder |
Where condition builder
(Inherited from WhereConditionBaseTParent.) | |
WhereCondition |
Where condition on the data, e.g. "DocumentName = 'ABC'"
(Inherited from WhereConditionBaseTParent.) | |
WhereIsComplex |
Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5"
(Inherited from WhereConditionBaseTParent.) | |
WhereIsEmpty |
Returns true if the where condition is empty
(Inherited from WhereConditionBaseTParent.) | |
WhereOperator |
Operator used for adding where condition. Default is AND
(Inherited from WhereConditionBaseTParent.) |