IMultiDocumentQuery Properties |
The IMultiDocumentQuery type exposes the following members.
Name | Description | |
---|---|---|
AllowMaterialization |
If true, the query allows materialization
(Inherited from IDataQuery.) | |
ClassName |
Class name
(Inherited from IDataQuery.) | |
ConnectionStringName |
Query connection string name
(Inherited from IDataQuery.) | |
Count |
Number of actual records retrieved from the database
(Inherited from IDataQuery.) | |
CustomQueryText |
Custom query text
(Inherited from IDataQuery.) | |
DataSource |
Data source that provides the query data. If not set, the query queries the database directly
(Inherited from IDataQuery.) | |
DataSourceName |
Data source identifier that represents the location from which the data are obtained.
(Inherited from IWhereCondition.) | |
DefaultOrderByColumns |
Default order by columns used in case if needed, and order by is not specified
(Inherited from IDataQuery.) | |
DefaultQuerySource |
Default source of the query in case source is not defined
(Inherited from IDataQuerySettings.) | |
FilterColumns |
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
(Inherited from IDataQuerySettings.) | |
GroupByColumns |
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
(Inherited from IDataQuerySettings.) | |
HasDataSource |
Returns true if the query has specific data source
(Inherited from IDataQuery.) | |
HasGroupBy |
Returns true if the given query has group by set
(Inherited from IDataQuerySettings.) | |
HavingCondition |
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
(Inherited from IDataQuerySettings.) | |
IncludeBinaryData |
If true, the query includes the object binary data
(Inherited from IDataQuery.) | |
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 IDataQuery.) | |
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 IDataQuerySettings.) | |
IsPagedQuery |
Returns true if the query has the paging enabled
(Inherited from IDataQuerySettings.) | |
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 IDataQuerySettings.) | |
MaxRecords |
Maximum number of results to return (use for paging together with Offset)
(Inherited from IDataQuerySettings.) | |
Name |
Object name, empty by default
(Inherited from IQueryObject.) | |
ObjectType |
Returns the object type of the objects stored within the collection.
(Inherited from IObjectQuery.) | |
Offset |
Index of the first record to return (use for paging together with MaxRecords)
(Inherited from IDataQuerySettings.) | |
OrderByColumns |
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
(Inherited from IDataQuerySettings.) | |
OrderByResultColumns |
List of columns for the result order by. If not specified, the result is ordered by sources and global order by.
(Inherited from IMultiQuery.) | |
Parameters |
Query data parameters
(Inherited from IQueryObject.) | |
Properties |
Document query parameters.
(Inherited from IDocumentQuery.) | |
QueryName |
Query name
(Inherited from IDataQuery.) | |
QuerySource |
Source of the query
(Inherited from IDataQuerySettings.) | |
QueryText |
Query text
(Inherited from IDataQuery.) | |
Result | DataSet with the result.
(Inherited from IDataQuery.) | |
ReturnsSingleColumn |
Returns true if the query returns single column
(Inherited from IDataQuery.) | |
SelectColumnsList |
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from IDataQuerySettings.) | |
SelectDistinct |
If set to true, returns only distinct (different) values.
(Inherited from IDataQuerySettings.) | |
SelectResultColumnsList |
List of columns to use for results, by default returns all columns defined in the inner queries. Example: "DocumentName, DocumentID"
(Inherited from IMultiQuery.) | |
SupportsReader |
Gets a value indicating whether the query supports the ExecuteReader(CommandBehavior, Boolean) method.
Otherwise the Execute method must be used.
(Inherited from IDataQuery.) | |
Tables |
Collection of the result tables
(Inherited from IDataQuery.) | |
TopNRecords |
If set, selects only first top N number of records
(Inherited from IDataQuerySettings.) | |
TotalExpression |
Total items expression. When defined, used instead default total items for a paged query.
(Inherited from IDataQuerySettings.) | |
TotalRecords |
Gets the number of total records when paging is used. Gets updated once the query executes
(Inherited from IDataQuery.) | |
UseObjectTypeCondition |
If true, the query uses the object type condition.
(Inherited from IObjectQuery.) | |
UseTypeColumns |
If true (default), the query uses type columns for the output, otherwise it uses only global columns
(Inherited from IMultiQuery.) | |
WhereCondition |
Where condition on the data, e.g. "DocumentName = 'ABC'"
(Inherited from IWhereCondition.) | |
WhereIsComplex |
Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5"
(Inherited from IWhereCondition.) | |
WhereIsEmpty |
Returns true if the where condition is empty
(Inherited from IWhereCondition.) |