DocumentQuery Class

Predefined query returning given object type. Uses the .selectdocuments query internally.

Inheritance Hierarchy

System.Object
  CMS.Base.DisposableObject
    CMS.DataEngine.AbstractQueryObject
      CMS.DataEngine.QueryParametersBase<DocumentQuery>
        CMS.DataEngine.WhereConditionBase<DocumentQuery>
          CMS.DataEngine.DataQuerySettingsBase<DocumentQuery>
            CMS.DataEngine.DataQueryBase<DocumentQuery>
              CMS.DataEngine.ObjectQueryBase<DocumentQuery, TreeNode>
                CMS.DocumentEngine.DocumentQueryBase<DocumentQuery, TreeNode>
                  CMS.DocumentEngine.DocumentQuery

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 8.2.23

Syntax

public class DocumentQuery : DocumentQueryBase<DocumentQuery, TreeNode>

The DocumentQuery type exposes the following members.

Constructors

	Name	Description
Public method	DocumentQuery()	Constructor
Public method	DocumentQuery(String)	Constructor
Public method	DocumentQuery(TreeNode)	Constructor

Methods

	Name	Description
Public method	AddColumn(String)	Adds the additional column to the query (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	AddColumn(IQueryColumn)	Adds the additional column to the query (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	AddColumns(IEnumerable<String>)	Adds the additional columns to the query (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	AddColumns(String[])	Adds the additional columns to the query (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	AddColumns(IQueryColumn[])	Adds the additional columns to the query (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	AddFilterColumn	Adds the additional filter column to the query (Inherited from DataQuerySettingsBase<TQuery>.)
Protected method	AddHavingInternal	Adds the given having condition (Inherited from DataQuerySettingsBase<TQuery>.)
Protected method	AddWhereCondition	Adds the given where condition to the final where condition (Inherited from WhereConditionBase<TParent>.)
Protected method	AddWhereConditionInternal	Adds the given where condition (Inherited from WhereConditionBase<TParent>.)
Public method	All	Ensures that there is no restriction applied for the result. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	AllCultures	Ensures that all culture versions of the documents are retrieved. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	And()	Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where... (Inherited from WhereConditionBase<TParent>.)
Public method	And(IWhereCondition)	Adds the given where condition with the AND operator (Inherited from WhereConditionBase<TParent>.)
Public method	And(Action<WhereCondition>)	Adds the given where condition with the AND operator. Creates a new where condition object and runs the setup actions on it. (Inherited from WhereConditionBase<TParent>.)
Protected method	AnySettingsDefined	Returns true if the object has any settings defined that influence the resulting query (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	ApplyParametersTo	Applies this query parameters to the target object (Inherited from DataQueryBase<TQuery>.)
Public method	ApplySettings(AbstractQueryObject)	Applies the given settings to the query (Inherited from DataQueryBase<TQuery>.)
Public method	ApplySettings(Action<DataQuerySettings>)	Applies the given settings to the query (Inherited from DataQueryBase<TQuery>.)
Public method	As<TNewType>	Changes the type of the query to another type (Inherited from DataQueryBase<TQuery>.)
Public method	AsColumn	Converts the query to the query column using this query as nested (Inherited from DataQueryBase<TQuery>.)
Public method	AsIDQuery	Creates an ID query from the given query (Inherited from DataQueryBase<TQuery>.)
Public method	AsMaterializedList	Makes a materialized list from the given query (Inherited from DataQueryBase<TQuery>.)
Public method	AsNested	Creates a nested query from the given query (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	AsSingleColumn	Creates a single column query from the given query (Inherited from DataQueryBase<TQuery>.)
Public method	AsSubQuery	Modifies the query to be able to be used as a sub-query, e.g. for usage in WHERE A IN ([query]). Ensures single column result, and removes order by from the result. (Inherited from DataQueryBase<TQuery>.)
Public method	AsValue	Gets a query expression representing this object as a value (Inherited from DataQueryBase<TQuery>.)
Public method	BinaryData	Sets whether the binary data should be included to the result (Inherited from DataQueryBase<TQuery>.)
Public method	CallOnDispose	Adds the given action to the list of actions called when the handler object is disposed (Inherited from DisposableObject.)
Public method	Clone	Creates the clone of the object. (Inherited from QueryParametersBase<TParent>.)
Public method	CloneObject	Creates the clone of the object. (Inherited from QueryParametersBase<TParent>.)
Public method	Column(String)	Sets the column to select (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	Column(IQueryColumn)	Sets the column to select (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	Columns(IEnumerable<String>)	Sets the columns to select (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	Columns(String[])	Sets the columns to select (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	Columns(IQueryColumn[])	Sets the columns to select (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	CombineWithAnyCulture	The data will be combined with documents in any culture if not translated to the requested one(s). When several cultures are required, the order is taken in account as a priority for documents with several matching language versions followed by any other language version. If no culture specified, the highest priority has site preferred culture, second the default culture followed by the rest of site cultures. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	CombineWithDefaultCulture	The data will be combined with documents in site default culture if not translated to the requested one(s). When several cultures are required, the order is taken in account as a priority for documents with several matching language versions. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	CopyPropertiesTo	Copies the properties to the target query. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	CreateChild	Creates the child collection based on the given provider (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	Culture	Filters the data to include only documents translated to given culture(s). (Inherited from DocumentQueryBase<TQuery, TObject>.)
Protected method	DataSourceChanged	Marks the object as changed when data source changes (Inherited from DataQueryBase<TQuery>.)
Public method	Default	Ensures default restrictions for the result. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	Dispose	Make sure the objects get disposed (Inherited from DisposableObject.)
Public method	Distinct	Sets the query to use distinct selection over the given columns (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	EnsureParameters	Ensures data parameters for the given query (Inherited from QueryParametersBase<TParent>.)
Public method	Except	Gets the intersection of this data query with another query (Inherited from DataQueryBase<TQuery>.)
Public method	ExceptGlobal	Filters the data to include only site objects, but not global objects (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	ExcludePath(String[])	Filters the data to exclude documents on given path(s). (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	ExcludePath(String, PathTypeEnum)	Filters the data to exclude documents on given path. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	Execute	Executes the current query and returns it's results as a DataSet (Inherited from DataQueryBase<TQuery>.)
Public method	ExecuteReader	Executes the current query and returns it's results as a data reader (Inherited from DataQueryBase<TQuery>.)
Public method	Expand	Expands the expression by replacing parameters with their values (Inherited from QueryParametersBase<TParent>.)
Public method	ExpandColumns	Expands the columns within this query (Inherited from DataQueryBase<TQuery>.)
Public method	FilterDuplicates	Ensures that duplicate document are filtered from the result. This means that linked documents are not retrieved, if there is the original document already included in the results. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	FirstResult	Sets the query as a single object query (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	ForEachObject	Executes the given action for each item (TObject) in the result. Processes the items in batches of the given size. (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	ForEachPage	Executes the given action for each page (DataSet) in the results. If the query is not set up as a paged query before calling this method and pageSize is not set, executes the action once with the current results. (Inherited from DataQueryBase<TQuery>.)
Public method	ForEachRow	Executes the given action for each item (DataRow) in the result. Processes the items in batches of the given size. (Inherited from DataQueryBase<TQuery>.)
Public method	From	Defines the source of the data (table, view or a nested query) (Inherited from DataQueryBase<TQuery>.)
Protected method	GenerateQueryText	Generates query text from the executing query (Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected method	GetAvailableColumns	Gets the list of all available columns for this query (Inherited from DocumentQueryBase<TQuery, TObject>.)
Protected method	GetBinaryColumns	Gets the binary columns for this query (Inherited from DataQueryBase<TQuery>.)
Protected method	GetClassName	Gets the class name for current query (Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected method	GetClassStructureInfo	Gets the class structure info for this query (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	GetCompleteSettings	Gets the complete parameters for the query execution. The parameters are always a new instance of DataQuerySettings which can be further modified without any impact to the query itself. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Protected method	GetData	Gets data set returned by document query or custom data set. Data set can be modified by calling DocumentEvents.GetData event. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Protected method	GetDataFromDataSource	Executes the current over data source and returns it's results as a DataSet (Inherited from DataQueryBase<TQuery>.)
Protected method	GetDataFromDB	Executes the query using data retrieval through the given info object (Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected method	GetDataSourceName	Gets the unique query source ID (Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected method	GetDefaultOrderBy	Gets the default order by columns (Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected method	GetDefaultSingleColumn	Gets the default single column for the query (Inherited from DataQueryBase<TQuery>.)
Protected method	GetDefaultSource	Gets the default source for this query (Inherited from DataQueryBase<TQuery>.)
Public method	GetEnumerator	Gets the typed enumerator (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	GetExecutingQuery	Gets the query to execute against database (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	GetExpression	Gets a query expression representing this object as a value (Inherited from DataQueryBase<TQuery>.)
Public method	GetExpressions	Gets the query expressions (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	GetFullQueryText	Gets the full query text including resolved parameters (Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected method	GetIDColumn	Gets the ID column for this query (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	GetListResult<T>	Gets the result as a list of values from the first column that the query returns. Excludes null values from the result. (Inherited from DataQueryBase<TQuery>.)
Protected method	GetReaderFromDB	Executes the query (Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected method	GetResults	Gets query results (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	GetScalarResult<T>	Gets the scalar (Inherited from DataQueryBase<TQuery>.)
Protected method	GetTypedResult	Gets typed result (Inherited from DocumentQueryBase<TQuery, TObject>.)
Protected method	GetWhere(String, QueryOperator, Object)	Gets the where condition for the given column (Inherited from WhereConditionBase<TParent>.)
Protected method	GetWhere(IQueryObjectWithValue, QueryOperator, Object)	Gets the where condition for the given column (Inherited from WhereConditionBase<TParent>.)
Public method	GroupBy	Specifies the columns to group by (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	HasCompatibleSource	Returns true if the given query is an external source (Inherited from DataQueryBase<TQuery>.)
Public method	HasResults	Returns true, if the query returns any results (Inherited from DataQueryBase<TQuery>.)
Public method	Having(IWhereCondition[])	Adds the given having conditions to the query. (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	Having(Action<WhereCondition>)	Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it. (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	Having(String, Boolean)	Specifies the having condition (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	Changed	Marks the object as changed (Inherited from DataQueryBase<TQuery>.)
Public method	CheckPermissions	Ensures that the result will be filtered based on user Read permission. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Protected method	CheckReturnsNoResults	Checks if where condition results in no data (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	Immutable	Makes this object instance is immutable, and next subsequent modification starts with a clone of the object. (Inherited from QueryParametersBase<TParent>.)
Public method	InCategory	Ensures that only documents assigned to specified category are retrieved (including all categories on path). (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	IncludeDataParameters	Adds the data parameters to the current query parameters (Inherited from QueryParametersBase<TParent>.)
Protected method	InitFromType<T>	Initializes the query from the given type (Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected method	InitIDQuery	Initializes the ID query (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	InRelationWith	Ensures that only documents in relationship with a specified document are retrieved. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	Intersect	Gets the intersection of this data query with another query (Inherited from DataQueryBase<TQuery>.)
Public method	LatestVersion	Ensures that latest version of the documents is retrieved. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Protected method	LoadTotalRecordsNonPaged	Loads the number of total records for an unpaged query (Inherited from DataQueryBase<TQuery>.)
Protected method	LoadTotalRecordsPaged	Loads the number of total records for a paged query (Inherited from DataQueryBase<TQuery>.)
Public method	Lock	Locks the event on the given lock object. The context stays locked until the handler is disposed. (Inherited from DisposableObject.)
Public method	NestingLevel	Ensures that only documents within specified nesting level are retrieved. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Protected method	NewEmptyQuery	Creates a new empty query (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	NewGroupBy	Clears the current group by, reverting the source of data to the original. Note, that this method also resets the existing having condition which is closely bound to the group by. (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	NewHaving	Clears the current having condition (Inherited from DataQuerySettingsBase<TQuery>.)
Protected method	NewResult	Returns properly typed this (Inherited from QueryParametersBase<TParent>.)
Public method	NewWhere	Clears the current where condition (Inherited from WhereConditionBase<TParent>.)
Public method	NextPage	Adjusts the query to a next page, using the current page size. Use in combination with PagedBy and NextPageAvailable to iterate over the data in batches. (Inherited from DataQuerySettingsBase<TQuery>.)
Protected method	NoColumns	Sets the query to return no columns at all (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	NoResults	Sets the where condition to exclude all data from result (Inherited from WhereConditionBase<TParent>.)
Public method	NotPaged	Sets up the query to become not paged query and output all results at once. (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	OnCurrentSite	Filters the data to include only records on the current site. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	OnlyGlobal	Filters the data to include only global objects. (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	OnSite	Filters the data to include only records on the given site. If site binding is defined, filters the global objects by the site ID (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	Or()	Changes the where operator to OR for next where conditions. Use in combination of methods Where... (Inherited from WhereConditionBase<TParent>.)
Public method	Or(IWhereCondition)	Adds the given where condition with the OR operator (Inherited from WhereConditionBase<TParent>.)
Public method	Or(Action<WhereCondition>)	Adds the given where condition with the OR operator. Creates a new where condition object and runs the setup actions on it. (Inherited from WhereConditionBase<TParent>.)
Public method	OrderBy(String[])	Adds the columns to the order by query (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	OrderBy(OrderDirection, String[])	Adds the columns to the order by query (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	OrderByAscending	Adds the columns to the order by query to order by the given columns in ascending order (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	OrderByDefault	Sets the default order by for the query (Inherited from DataQueryBase<TQuery>.)
Public method	OrderByDescending	Adds the columns to the order by query to order by the given columns in descending order (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	Page	Specifies the page to select with given page index and page size. Page number is indexed from 0 (first page) (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	PagedBy	Sets up the query as a paged query with the given page size. Resets the page index to first page. Use in combination with NextPageAvailable and NextPage to iterate over the data in batches. (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	Path(String[])	Filters the data to include only documents on given path(s). (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	Path(String, PathTypeEnum)	Filters the data to include only documents on given path. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	Published	Ensures that only documents published on a live site are retrieved. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	PublishedVersion	Ensures that latest version of the documents is retrieved. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	ReplaceColumn	Replaces the selected column with a new name (Inherited from DataQuerySettingsBase<TQuery>.)
Protected method	ReplaceOrderByColumn	Replaces the selected column with a new name (Inherited from DataQuerySettingsBase<TQuery>.)
Protected method	ReplaceSelectedColumn	Replaces the selected column with a new name (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	Reset	Flushes the results but leaves the generated query text unchanged. After the reset, query can be executed again to obtain new data. (Inherited from DataQueryBase<TQuery>.)
Protected method	ResetWhereOperator	Resets the where operator to the default value (Inherited from WhereConditionBase<TParent>.)
Protected method	ResolveColumns	Resolves the columns in the given list (Inherited from DataQueryBase<TQuery>.)
Public method	ReturnNoResults	Sets the query to return no results. This action is irreversible, once the query is set to return no results it cannot be changed. This method is used by data engine to forbid access to data that are not allowed to be accessed (e.g. license limitations), without notifying the process about the fact. (Inherited from WhereConditionBase<TParent>.)
Public method	Select<T>	Transforms the current result (Inherited from DataQueryBase<TQuery>.)
Protected method	SetClassName	Gets the class name for current query (Inherited from DataQueryBase<TQuery>.)
Public method	Snapshot	Creates an immutable snapshot of the current query as a base for further evaluation. Doesn't modify the original query in any way. (Inherited from QueryParametersBase<TParent>.)
Public method	Source	Defines the source of the data (table, view or a nested query) (Inherited from DataQueryBase<TQuery>.)
Public method	Take	Identity method to make the query expression more readable. Use before the Columns or Page method. Doesn't provide any functionality. (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	Then	Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality. (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	TopN	Selects only first top N number of records (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	ToString()	Returns the string representation of the expression (Inherited from QueryParametersBase<TParent>.)
Public method	ToString(Boolean)	Returns the string representation of the expression, with possibility of expanding parameters (Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected method	TypeUpdated	Updates the query class name based on the current status (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public method	Union	Gets the union of this data query with another query (Inherited from DataQueryBase<TQuery>.)
Public method	UnionAll	Gets the union of this data query with another query without eliminating the duplicities (Inherited from DataQueryBase<TQuery>.)
Public method	Using	Adds the given object to the list of the allocated objects to dispose (Inherited from DisposableObject.)
Public method	Where(IWhereCondition[])	Adds the given where conditions to the query (Inherited from WhereConditionBase<TParent>.)
Public method	Where(Action<WhereCondition>)	Adds the given where condition to the query. Creates a new where condition object and runs the setup actions on it. (Inherited from WhereConditionBase<TParent>.)
Public method	Where(String, QueryDataParameters)	Adds the given where condition to the query (Inherited from WhereConditionBase<TParent>.)
Public method	Where(String, QueryUnaryOperator)	Adds the given where condition to the query. Matches the column value with an unary operator. (Inherited from WhereConditionBase<TParent>.)
Public method	Where(IQueryObjectWithValue, QueryUnaryOperator)	Adds the given where condition to the query. Matches the column value with an unary operator. (Inherited from WhereConditionBase<TParent>.)
Public method	Where(String, QueryOperator, Object)	Adds the given where condition to the query. Matches the column to a given value. (Inherited from WhereConditionBase<TParent>.)
Public method	Where(IQueryObjectWithValue, QueryOperator, Object)	Adds the given where condition to the query. Matches the column to a given value. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereAnyColumn	Matches the given condition on any column with the same type as the given value type. (Inherited from DataQueryBase<TQuery>.)
Public method	WhereAnyColumnContains	Adds condition to all items that contain given text in any of the string columns. Performs a SQL substring search on the data. (Inherited from DataQueryBase<TQuery>.)
Public method	WhereContains(String, String)	Adds the condition for a string column to contain some substring (Inherited from WhereConditionBase<TParent>.)
Public method	WhereContains(IQueryObjectWithValue, String)	Adds the condition for a string column to contain some substring (Inherited from WhereConditionBase<TParent>.)
Public method	WhereEmpty	Adds the where condition for a null or empty column value (Inherited from WhereConditionBase<TParent>.)
Public method	WhereEndsWith(String, String)	Adds the condition for a string column to end with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereEndsWith(IQueryObjectWithValue, String)	Adds the condition for a string expression to end with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereEquals(String, Object)	Adds the given where condition to the query. Matches the column to a given value. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereEquals(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side to the given right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereEqualsOrNull	Adds the given where condition to the query. Matches the column to a given value or null value. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereExists(IDataQuery)	Adds where condition with EXISTS and the nested query "EXISTS (...)" (Inherited from WhereConditionBase<TParent>.)
Protected method	WhereExists(IDataQuery, Boolean)	Adds where condition with EXISTS and the nested query "EXISTS (...)" (Inherited from WhereConditionBase<TParent>.)
Public method	WhereFalse(String)	Adds the where condition for a false column value (boolean column equals false). (Inherited from WhereConditionBase<TParent>.)
Public method	WhereFalse(IQueryObjectWithValue)	Adds the where condition for a false expression value (boolean expression equals false). (Inherited from WhereConditionBase<TParent>.)
Public method	WhereGreaterOrEquals(String, Object)	Adds the given where condition to the query. Matches the left side which is greater or equal than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereGreaterOrEquals(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is greater or equal than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereGreaterThan(String, Object)	Adds the given where condition to the query. Matches the left side which is greater than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereGreaterThan(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is greater than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereID	Adds the where condition to match the ID to the query. In case the column name is not provided or unknown, does not generate where condition. If given ID is invalid, adds the condition to match NULL. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereIn(String, IDataQuery)	Adds where condition to the nested query, e.g. "columnName IN (...)" (Inherited from WhereConditionBase<TParent>.)
Public method	WhereIn(String, IList<Int32>)	Adds where condition to the list of values, e.g. "columnName IN (...)" (Inherited from WhereConditionBase<TParent>.)
Protected method	WhereIn(String, IDataQuery, Boolean)	Adds where condition to the list of values, e.g. "columnName IN (...)" (Inherited from WhereConditionBase<TParent>.)
Protected method	WhereIn(String, IList<Int32>, Boolean)	Adds where condition to the list of values, e.g. "columnName IN (...)" (Inherited from WhereConditionBase<TParent>.)
Public method	WhereLessOrEquals(String, Object)	Adds the given where condition to the query. Matches the left side which is less or equal than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereLessOrEquals(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is less or equal than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereLessThan(String, Object)	Adds the given where condition to the query. Matches the left side which is less than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereLessThan(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is less than the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereLike(String, String)	Adds the given where condition to the query. Matches the column to a given value using LIKE operator. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereLike(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side and right side using LIKE operator. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNot	Adds the negation of the given where condition (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotContains(String, String)	Adds the condition for a string column not to contain some substring (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotContains(IQueryObjectWithValue, String)	Adds the condition for a string column not to contain some substring (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotEmpty	Adds the where condition for a non empty column value (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotEndsWith(String, String)	Adds the condition for a string column not to end with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotEndsWith(IQueryObjectWithValue, String)	Adds the condition for a string column not to end with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotEquals(String, Object)	Adds the given where condition to the query. Matches the column which is not equal to a given value. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotEquals(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side which is not equal to the right side. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotExists	Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)" (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotIn(String, IDataQuery)	Adds where condition to the nested query, e.g. "columnName NOT IN (...)" (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotIn(String, IList<Int32>)	Adds where condition to the list of values, e.g. "columnName NOT IN (...)" (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotLike(String, String)	Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotLike(IQueryObjectWithValue, Object)	Adds the given where condition to the query. Matches the left side and right side using NOT LIKE operator. (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotNull(String)	Adds the where condition for a not null column value (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotNull(IQueryObjectWithValue)	Adds the where condition for a not null expression value (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotStartsWith(String, String)	Adds the condition for a string column not to start with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNotStartsWith(IQueryObjectWithValue, String)	Adds the condition for a string column not to start with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNull(String)	Adds the where condition for a null column value (Inherited from WhereConditionBase<TParent>.)
Public method	WhereNull(IQueryObjectWithValue)	Adds the where condition for a null expression value (Inherited from WhereConditionBase<TParent>.)
Public method	WhereStartsWith(String, String)	Adds the condition for a string column to start with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereStartsWith(IQueryObjectWithValue, String)	Adds the condition for a string column to start with some prefix (Inherited from WhereConditionBase<TParent>.)
Public method	WhereTrue(String)	Adds the where condition for a true column value (boolean column equals true). (Inherited from WhereConditionBase<TParent>.)
Public method	WhereTrue(IQueryObjectWithValue)	Adds the where condition for a true expression value (boolean expression equals true). (Inherited from WhereConditionBase<TParent>.)
Public method	WithCodeName	Sets the where condition for a specific object code name (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	WithComment	Adds the comment to the given query (Inherited from DataQuerySettingsBase<TQuery>.)
Public method	WithGuid	Sets the where condition for a specific object GUID (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	WithID	Sets the where condition for a specific object ID (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	WithObjectType	Changes the query to use the given object type. Applies the object type condition to the query. The new object type must have the same class name as the original one. (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	WithSettings(AbstractQueryObject)	Applies the given parameters to the query (Inherited from DataQueryBase<TQuery>.)
Public method	WithSettings(Action<DataQuerySettings>)	Applies the given parameters to the query (Inherited from DataQueryBase<TQuery>.)
Public method	WithSource(DataSet)	Sets the given DataSet as the source of the data query (Inherited from DataQueryBase<TQuery>.)
Public method	WithSource(TObject[])	Sets the given DataSet as the source of the data query (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public method	WithSource(DataQuerySource)	Sets the given source as the source of the data query (Inherited from DataQueryBase<TQuery>.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mMaxRecords	Maximum number of records to select (Inherited from DataQuerySettingsBase<TQuery>.)
Protected field	mOffset	Offset (Inherited from DataQuerySettingsBase<TQuery>.)
Protected field	mOrderByColumns	Order by columns (Inherited from DataQuerySettingsBase<TQuery>.)
Protected field	mParameters	Query data parameters (Inherited from QueryParametersBase<TParent>.)
Protected field	mSelectColumnsList	Columns to select (Inherited from DataQuerySettingsBase<TQuery>.)

Properties

	Name	Description
Public property	AllowMaterialization	If true, the query allows materialization (Inherited from DataQueryBase<TQuery>.)
Public property	ClassName	Class name (Inherited from DataQueryBase<TQuery>.)
Protected property	ConnectionStringForced	If true, the connection string was set explicitly (Inherited from DataQueryBase<TQuery>.)
Public property	ConnectionStringName	Connection string name (Inherited from DataQueryBase<TQuery>.)
Public property	Count	Number of total items in the collection (Inherited from DataQueryBase<TQuery>.)
Public property	CustomQueryText	Custom query text (Inherited from DataQueryBase<TQuery>.)
Public property	DataSource	Data source that provides the query data. If not set, the query queries the database directly (Inherited from DataQueryBase<TQuery>.)
Public property	DataSourceName	Gets the unique query source ID (Inherited from DataQueryBase<TQuery>.)
Public property	DefaultOrderByColumns	Default order by columns used in case if needed, and order by is not specified (Inherited from DataQueryBase<TQuery>.)
Public property	DefaultSourceExpression	Default source of the query in case source is not defined (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	DisposeUsedObjects	Disposes the objects that were used as parameters for this query (Inherited from WhereConditionBase<TParent>.)
Protected property	Document	Document instance of the specified type. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public property	ElementType	Returns the element type. (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public property	Expression	Query expression (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public property	FilterColumns	List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN" (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	FirstObject	DataSet with the result (Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected property	ForceOrderBy	If true, the order by should be forced in the process of execution (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	FullQueryName	Represents a full query name of the query (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public property	GroupByColumns	List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner" (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	HasDataSource	Returns true if the query has specific data source (Inherited from DataQueryBase<TQuery>.)
Public property	HasGroupBy	Returns true if the given query has group by set (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	HavingCondition	Where condition for the group by on the data, e.g. "DocumentName = 'ABC'" (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	HavingIsComplex	Returns true if the given having condition is a complex condition (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	HavingIsEmpty	Returns true if the having condition is empty (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	IncludeBinaryData	If true, the query includes the object binary data. Default is true (Inherited from DataQueryBase<TQuery>.)
Public property	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 DataQueryBase<TQuery>.)
Protected property	IsImmutable	If true, this object instance is immutable, and next subsequent modification starts with a clone of the object. (Inherited from QueryParametersBase<TParent>.)
Public property	IsNested	Indicates that this query is part of multi query (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	IsOffline	Returns true if the given collection is offline (disconnected from the database) (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public property	IsPagedQuery	Returns true if the query has the paging enabled (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	IsSubQuery	If true, the query is a sub-query used in another query (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	MaxRecords	Maximum number of results to return (use for paging together with Offset) (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	Name	Object name, empty by default (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public property	NextPageAvailable	Returns true if the next page is available. (Inherited from DataQueryBase<TQuery>.)
Protected property	Object	Object instance of the specified type. (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public property	ObjectType	Returns the object type of the objects stored within the collection. (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public property	Offset	Index of the first record to return (use for paging together with MaxRecords) (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	OrderByColumns	List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC" (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	Parameters	Query data parameters (Inherited from QueryParametersBase<TParent>.)
Public property	Properties	Document query properties. (Inherited from DocumentQueryBase<TQuery, TObject>.)
Public property	Provider	Query provider (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public property	QueryName	Query name (Inherited from DataQueryBase<TQuery>.)
Public property	QueryText	Query text (Inherited from DataQueryBase<TQuery>.)
Public property	Result	DataSet with the result (Inherited from DataQueryBase<TQuery>.)
Public property	ReturnsNoResults	Returns true if query doesn't return any results (Inherited from WhereConditionBase<TParent>.)
Public property	ReturnsSingleColumn	Returns true if the query returns single column (Inherited from DataQueryBase<TQuery>.)
Public property	SelectColumns	Obsolete. List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID" (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	SelectColumnsList	List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID" (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	SelectDistinct	If set to true, returns only distinct (different) values. (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	SourceExpression	Source of the query (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	SupportsReader	Returns true if the query supports data reader (Inherited from DataQueryBase<TQuery>.)
Public property	Tables	Collection of the result tables (Inherited from DataQueryBase<TQuery>.)
Public property	TopNRecords	If set, selects only first top N number of records (Inherited from DataQuerySettingsBase<TQuery>.)
Public property	TotalRecords	Gets the number of total records when paging is used. Gets updated once the query executes (Inherited from DataQueryBase<TQuery>.)
Public property	TypedResult	Typed result (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public property	TypeInfo	Type info of the specified type (Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected property	UseObjectQuery	If true, the object query is used as default, otherwise, standard DataQuery is used (Inherited from ObjectQueryBase<TQuery, TObject>.)
Public property	UseObjectTypeCondition	If true, the query uses the object type condition. (Inherited from ObjectQueryBase<TQuery, TObject>.)
Protected property	WhereBuilder	Where condition builder (Inherited from WhereConditionBase<TParent>.)
Public property	WhereCondition	Where condition on the data, e.g. "DocumentName = 'ABC'" (Inherited from WhereConditionBase<TParent>.)
Public property	WhereIsComplex	Returns true if the given where condition contains compound conditions, e. g. "A > 1 AND B = 5" (Inherited from WhereConditionBase<TParent>.)
Public property	WhereIsEmpty	Returns true if the where condition is empty (Inherited from WhereConditionBase<TParent>.)
Protected property	WhereOperator	Operator used for adding where condition. Default is AND (Inherited from WhereConditionBase<TParent>.)