Click or drag to resize
DocumentQuery<TDocument> Properties

The DocumentQuery< TDocument> generic type exposes the following members.

Properties
  NameDescription
Public propertyAllowMaterialization
If true, the query allows materialization
(Inherited from DataQueryBase<TQuery>.)
Public propertyClassName
Class name
(Inherited from DataQueryBase<TQuery>.)
Protected propertyConnectionStringForced
If true, the connection string was set explicitly
(Inherited from DataQueryBase<TQuery>.)
Public propertyConnectionStringName
Connection string name
(Inherited from DataQueryBase<TQuery>.)
Public propertyCount
Number of total items in the collection
(Inherited from DataQueryBase<TQuery>.)
Public propertyCustomQueryText
Custom query text
(Inherited from DataQueryBase<TQuery>.)
Public propertyDataSource
Data source that provides the query data. If not set, the query queries the database directly
(Inherited from DataQueryBase<TQuery>.)
Public propertyDataSourceName
Data source identifier that represents the location from which the data are obtained.
(Inherited from WhereConditionBase<TParent>.)
Public propertyDefaultOrderByColumns
Default order by columns used in case if needed, and order by is not specified
(Inherited from DataQueryBase<TQuery>.)
Public propertyDefaultQuerySource
Default source of the query in case source is not defined
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyDisposeUsedObjects
Disposes the objects that were used as parameters for this query
(Inherited from WhereConditionBase<TParent>.)
Protected propertyDocument
Document instance of the specified type.
(Inherited from DocumentQueryBase<TQuery, TObject>.)
Public propertyElementType
Returns the element type.
(Inherited from ObjectQueryBase<TQuery, TObject>.)
Public propertyExpression
Query expression
(Inherited from ObjectQueryBase<TQuery, TObject>.)
Public propertyFilterColumns
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyFirstObject
Returns first object from the query result DataSet. The property does not limit the actual number of fetched rows.
(Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected propertyForceOrderBy
If true, the order by should be forced in the process of execution
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyFullQueryName
Represents a full query name of the query
(Inherited from DocumentQueryBase<TQuery, TObject>.)
Public propertyGroupByColumns
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyHasDataSource
Returns true if the query has specific data source
(Inherited from DataQueryBase<TQuery>.)
Public propertyHasGroupBy
Returns true if the given query has group by set
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyHavingCondition
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyHavingIsComplex
Returns true if the given having condition is a complex condition
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyHavingIsEmpty
Returns true if the having condition is empty
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyIncludeBinaryData
If true, the query includes the object binary data. Default is true
(Inherited from DataQueryBase<TQuery>.)
Public propertyIsCombinedQuery
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 DataQueryBase<TQuery>.)
Protected propertyIsImmutable
If true, this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBase<TParent>.)
Public propertyIsNested
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 DataQuerySettingsBase<TQuery>.)
Public propertyIsOffline
Returns true if the given collection is offline (disconnected from the database)
(Inherited from ObjectQueryBase<TQuery, TObject>.)
Public propertyIsPagedQuery
Returns true if the query has the paging enabled
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyIsSubQuery
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 DataQuerySettingsBase<TQuery>.)
Public propertyMaxRecords
Maximum number of results to return (use for paging together with Offset)
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyName
Object name, empty by default
(Inherited from ObjectQueryBase<TQuery, TObject>.)
Public propertyNextPageAvailable
Returns true if the next page is available.
(Inherited from DataQueryBase<TQuery>.)
Protected propertyObject
Object instance of the specified type.
(Inherited from ObjectQueryBase<TQuery, TObject>.)
Public propertyObjectType
Returns the object type of the objects stored within the collection.
(Inherited from ObjectQueryBase<TQuery, TObject>.)
Public propertyOffset
Index of the first record to return (use for paging together with MaxRecords)
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyOrderByColumns
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyParameters
Query data parameters
(Inherited from QueryParametersBase<TParent>.)
Public propertyProperties
Document query properties.
(Inherited from DocumentQueryBase<TQuery, TObject>.)
Public propertyProvider
Query provider
(Inherited from ObjectQueryBase<TQuery, TObject>.)
Public propertyQueryName
Query name
(Inherited from DataQueryBase<TQuery>.)
Public propertyQuerySource
Query source object
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyQueryText
Query text
(Inherited from DataQueryBase<TQuery>.)
Public propertyResult
DataSet with the result
(Inherited from DataQueryBase<TQuery>.)
Public propertyReturnsNoResults
Returns true if query doesn't return any results
(Inherited from WhereConditionBase<TParent>.)
Public propertyReturnsSingleColumn
Returns true if the query returns single column
(Inherited from DataQueryBase<TQuery>.)
Public propertySelectColumnsList
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertySelectDistinct
If set to true, returns only distinct (different) values.
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertySupportsReader
Returns true if the query supports data reader
(Inherited from DataQueryBase<TQuery>.)
Public propertyTables
Collection of the result tables
(Inherited from DataQueryBase<TQuery>.)
Public propertyTopNRecords
If set, selects only first top N number of records
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyTotalExpression
Total items expression. When defined, used instead default total items for a paged query.
(Inherited from DataQuerySettingsBase<TQuery>.)
Public propertyTotalRecords
Gets the number of total records when paging is used. Gets updated once the query executes
(Inherited from DataQueryBase<TQuery>.)
Public propertyTypedResult
Typed result
(Inherited from ObjectQueryBase<TQuery, TObject>.)
Public propertyTypeInfo
Type info of the specified type
(Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected propertyUseObjectQuery
If true, the object query is used as default, otherwise, standard DataQuery is used
(Inherited from ObjectQueryBase<TQuery, TObject>.)
Public propertyUseObjectTypeCondition
If true, the query uses the object type condition.
(Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected propertyWhereBuilder
Where condition builder
(Inherited from WhereConditionBase<TParent>.)
Public propertyWhereCondition
Where condition on the data, e.g. "DocumentName = 'ABC'"
(Inherited from WhereConditionBase<TParent>.)
Public propertyWhereIsComplex
Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5"
(Inherited from WhereConditionBase<TParent>.)
Public propertyWhereIsEmpty
Returns true if the where condition is empty
(Inherited from WhereConditionBase<TParent>.)
Protected propertyWhereOperator
Operator used for adding where condition. Default is AND
(Inherited from WhereConditionBase<TParent>.)
Top
See Also