Click or drag to resize
DocumentQueryTDocument Properties

The DocumentQueryTDocument generic type exposes the following members.

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