DocumentQuery Properties |
The DocumentQuery 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 |
Gets the unique query source ID
(Inherited from DataQueryBaseTQuery.) | |
DefaultOrderByColumns |
Default order by columns used in case if needed, and order by is not specified
(Inherited from DataQueryBaseTQuery.) | |
DefaultSourceExpression |
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.) | |
Document |
Document instance of the specified type.
(Inherited from DocumentQueryBaseTQuery, TObject.) | |
ElementType |
Returns the element type.
(Inherited from ObjectQueryBaseTQuery, TObject.) | |
Expression |
Query expression
(Inherited from ObjectQueryBaseTQuery, TObject.) | |
FilterColumns |
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
(Inherited from DataQuerySettingsBaseTQuery.) | |
FirstObject |
DataSet with the result
(Inherited from ObjectQueryBaseTQuery, 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 DocumentQueryBaseTQuery, TObject.) | |
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 part of multi query
(Inherited from DataQuerySettingsBaseTQuery.) | |
IsOffline |
Returns true if the given collection is offline (disconnected from the database)
(Inherited from ObjectQueryBaseTQuery, 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
(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 ObjectQueryBaseTQuery, TObject.) | |
NextPageAvailable |
Returns true if the next page is available.
(Inherited from DataQueryBaseTQuery.) | |
Object |
Object instance of the specified type.
(Inherited from ObjectQueryBaseTQuery, TObject.) | |
ObjectType |
Returns the object type of the objects stored within the collection.
(Inherited from ObjectQueryBaseTQuery, 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.) | |
Parameters |
Query data parameters
(Inherited from QueryParametersBaseTParent.) | |
Properties |
Document query properties.
(Inherited from DocumentQueryBaseTQuery, TObject.) | |
Provider |
Query provider
(Inherited from ObjectQueryBaseTQuery, TObject.) | |
QueryName |
Query name
(Inherited from DataQueryBaseTQuery.) | |
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 DataQueryBaseTQuery.) | |
SelectColumns | Obsolete.
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from DataQuerySettingsBaseTQuery.) | |
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.) | |
SourceExpression |
Source of the query
(Inherited from DataQuerySettingsBaseTQuery.) | |
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.) | |
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 ObjectQueryBaseTQuery, TObject.) | |
TypeInfo |
Type info of the specified type
(Inherited from ObjectQueryBaseTQuery, TObject.) | |
UseObjectQuery |
If true, the object query is used as default, otherwise, standard DataQuery is used
(Inherited from ObjectQueryBaseTQuery, TObject.) | |
UseObjectTypeCondition |
If true, the query uses the object type condition.
(Inherited from ObjectQueryBaseTQuery, TObject.) | |
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.) |