MultiDocumentQueryBase TQuery, TInnerQuery, TObject  MembersKentico 8.1 API Reference
The MultiDocumentQueryBase TQuery, TInnerQuery, TObject  type exposes the following members.
Constructors

  NameDescription
Public methodMultiDocumentQueryBase TQuery, TInnerQuery, TObject 
Default constructor
Back to Top
Methods

  NameDescription
Public methodAddColumn(String)
Adds the additional column to the query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodAddColumn(IQueryColumn)
Adds the additional column to the query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodAddColumns(IEnumerable String )
Adds the additional columns to the query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodAddColumns( IQueryColumn )
Adds the additional columns to the query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodAddFilterColumn
Adds the additional filter column to the query
(Inherited from DataQuerySettingsBase TQuery .)
Protected methodAddHavingInternal
Adds the given having condition
(Inherited from DataQuerySettingsBase TQuery .)
Public methodAddResultColumn(String)
Adds the additional column to the query
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodAddResultColumn(IQueryColumn)
Adds the additional column to the query
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodAddResultColumns(IEnumerable String )
Adds the additional columns to the query
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodAddResultColumns( IQueryColumn )
Adds the additional columns to the query
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Protected methodAddWhereCondition
Adds the given where condition to the final where condition
(Inherited from WhereConditionBase TParent .)
Protected methodAddWhereConditionInternal
Adds the given where condition
(Inherited from WhereConditionBase TParent .)
Public methodAll
Ensures that there is no restriction applied for the result.
Public methodAllCultures
Ensures that all culture versions of the documents are retrieved.
Public methodAnd 
Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBase TParent .)
Public methodAnd(IWhereCondition)
Adds the given where condition with the AND operator
(Inherited from WhereConditionBase TParent .)
Public methodAnd(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 methodAnySettingsDefined
Returns true if the object has any settings defined that influence the resulting query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodApplyParametersTo
Applies this query parameters to the target object
(Inherited from DataQueryBase TQuery .)
Protected methodApplyProperties
Applies main query properties to the given query to ensure synchronized state before execution
(Overrides MultiObjectQueryBase TQuery, TInnerQuery, TObject  ApplyProperties(TInnerQuery).)
Public methodApplySettings(AbstractQueryObject)
Applies the given settings to the query
(Inherited from DataQueryBase TQuery .)
Public methodApplySettings(Action DataQuerySettings )
Applies the given settings to the query
(Inherited from DataQueryBase TQuery .)
Public methodAs TNewType 
Changes the type of the query to another type
(Inherited from DataQueryBase TQuery .)
Public methodAsColumn
Converts the query to the query column using this query as nested
(Inherited from DataQueryBase TQuery .)
Public methodAsIDQuery
Creates an ID query from the given query
(Inherited from DataQueryBase TQuery .)
Public methodAsMaterializedList
Makes a materialized list from the given query
(Inherited from DataQueryBase TQuery .)
Public methodAsNested
Creates a nested query from the given query
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Public methodAsSingleColumn
Creates a single column query from the given query
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodAsSubQuery
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 MultiQueryBase TQuery, TInnerQuery .)
Public methodAsValue
Gets a query expression representing this object as a value
(Inherited from DataQueryBase TQuery .)
Public methodBinaryData
Sets whether the binary data should be included to the result
(Inherited from DataQueryBase TQuery .)
Public methodCallOnDispose
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from DisposableObject.)
Public methodClone
Creates the clone of the object.
(Inherited from QueryParametersBase TParent .)
Public methodCloneObject
Creates the clone of the object.
(Inherited from QueryParametersBase TParent .)
Public methodColumn(String)
Sets the column to select
(Inherited from DataQuerySettingsBase TQuery .)
Public methodColumn(IQueryColumn)
Sets the column to select
(Inherited from DataQuerySettingsBase TQuery .)
Public methodColumns(IEnumerable String )
Sets the columns to select
(Inherited from DataQuerySettingsBase TQuery .)
Public methodColumns( String )
Sets the columns to select
(Inherited from DataQuerySettingsBase TQuery .)
Public methodCombineWithAnyCulture
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.
Public methodCombineWithDefaultCulture
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.
Public methodCopyPropertiesTo
Copies the properties to the target query.
(Overrides MultiQueryBase TQuery, TInnerQuery  CopyPropertiesTo(IQueryObject).)
Public methodCreateChild
Creates the child collection based on the given provider
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Protected methodCreateQuery
Creates query for the given type
(Overrides MultiObjectQueryBase TQuery, TInnerQuery, TObject  CreateQuery(String).)
Public methodCulture
Filters the data to include only documents translated to given culture(s).
Protected methodDataSourceChanged
Marks the object as changed when data source changes
(Inherited from DataQueryBase TQuery .)
Public methodDefault
Ensures default restrictions for the result.
Public methodDispose
Make sure the objects get disposed
(Inherited from DisposableObject.)
Public methodDistinct
Sets the query to use distinct selection over the given columns
(Inherited from DataQuerySettingsBase TQuery .)
Public methodEnsureParameters
Ensures data parameters for the given query
(Inherited from QueryParametersBase TParent .)
Protected methodEnsureQueries(IEnumerable String )
Ensures the queries for the given types
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Protected methodEnsureQueries( String )
Ensures the queries for the given types
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Protected methodEnsureQuery
Ensures the query with the given type
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Public methodExcept
Gets the intersection of this data query with another query
(Inherited from DataQueryBase TQuery .)
Public methodExceptGlobal
Filters the data to include only site objects, but not global objects
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Public methodExcludePath( String )
Filters the data to exclude documents on given path(s).
Public methodExcludePath(String, PathTypeEnum)
Filters the data to exclude documents on given path.
Public methodExecute
Executes the current query and returns it's results as a DataSet
(Inherited from DataQueryBase TQuery .)
Public methodExecuteReader
Executes the current query and returns it's results as a data reader
(Inherited from DataQueryBase TQuery .)
Public methodExpand
Expands the expression by replacing parameters with their values
(Inherited from QueryParametersBase TParent .)
Public methodExpandColumns
Expands the columns within this query
(Inherited from DataQueryBase TQuery .)
Public methodFilterDuplicates
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.
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodFirstResult
Sets the query as a single object query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodForEachPage
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 methodForEachRow
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 methodFrom
Defines the source of the data (table, view or a nested query)
(Inherited from DataQueryBase TQuery .)
Protected methodGenerateQueryText
Generates the query text
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Protected methodGetAvailableColumns
Gets the list of all available columns for this query
(Overrides MultiQueryBase TQuery, TInnerQuery  GetAvailableColumns .)
Protected methodGetBinaryColumns
Gets the binary columns for this query
(Inherited from DataQueryBase TQuery .)
Protected methodGetClassName
Gets the class name for current query
(Inherited from DataQueryBase TQuery .)
Protected methodGetClassStructureInfo
Gets the class structure info for this query
(Inherited from DataQueryBase TQuery .)
Public methodGetCompleteSettings
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 DataQueryBase TQuery .)
Protected methodGetData
Executes the query
(Inherited from DataQueryBase TQuery .)
Protected methodGetDataFromDataSource
Executes the current over data source and returns it's results as a DataSet
(Inherited from DataQueryBase TQuery .)
Protected methodGetDataFromDB
Executes the query
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Protected methodGetDataSourceName
Gets the unique query source ID
(Inherited from DataQueryBase TQuery .)
Protected methodGetDefaultOrderBy
Gets the default order by columns
(Inherited from DataQueryBase TQuery .)
Protected methodGetDefaultSingleColumn
Gets the default single column for the query
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Protected methodGetDefaultSource
Gets the default source for this query
(Inherited from DataQueryBase TQuery .)
Public methodGetEnumerator
Gets the typed enumerator
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Protected methodGetExecutingQuery
Gets the executing query
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodGetExpression
Gets a query expression representing this object as a value
(Inherited from DataQueryBase TQuery .)
Public methodGetExpressions
Gets the query expressions
(Inherited from DataQuerySettingsBase TQuery .)
Public methodGetFullQueryText
Gets the full query text including resolved parameters
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Protected methodGetIDColumn
Gets the ID column for this query
(Overrides DataQueryBase TQuery  GetIDColumn .)
Public methodGetListResult 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 methodGetMultiQuery
Attempts to get a single query for the whole result based on the current state of the query object
(Overrides MultiQueryBase TQuery, TInnerQuery  GetMultiQuery .)
Protected methodGetReaderFromDB
Executes the query
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Protected methodGetResults
Gets query results
(Overrides MultiQueryBase TQuery, TInnerQuery  GetResults(IDataQuery, Int32 ).)
Public methodGetScalarResult T 
Gets the scalar
(Inherited from DataQueryBase TQuery .)
Protected methodGetSingleInnerQuery
Attempts to get a single query if multi-query is defined only by a single query
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Protected methodGetSingleQuery
Attempts to get a single query for the whole result based on the current state of the query object
(Overrides MultiQueryBase TQuery, TInnerQuery  GetSingleQuery .)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodGetTypedResult
Gets typed result
(Overrides MultiObjectQueryBase TQuery, TInnerQuery, TObject  GetTypedResult .)
Protected methodGetTypesWhereCondition
Returns the where condition which filters the default query data for specific types
(Overrides MultiQueryBase TQuery, TInnerQuery  GetTypesWhereCondition(IEnumerable String ).)
Protected methodGetWhere(String, QueryOperator, Object)
Gets the where condition for the given column
(Inherited from WhereConditionBase TParent .)
Protected methodGetWhere(IQueryObjectWithValue, QueryOperator, Object)
Gets the where condition for the given column
(Inherited from WhereConditionBase TParent .)
Public methodGroupBy
Specifies the columns to group by
(Inherited from DataQuerySettingsBase TQuery .)
Public methodHasCompatibleSource
Returns true if the given query is an external source
(Inherited from DataQueryBase TQuery .)
Public methodHasResults
Returns true, if the query returns any results
(Inherited from DataQueryBase TQuery .)
Public methodHaving( IWhereCondition )
Adds the given having conditions to the query.
(Inherited from DataQuerySettingsBase TQuery .)
Public methodHaving(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 methodHaving(String, Boolean)
Specifies the group by having condition
(Inherited from DataQuerySettingsBase TQuery .)
Public methodChanged
Marks the object as changed
(Inherited from DataQueryBase TQuery .)
Public methodCheckPermissions
Ensures that the result will be filtered based on user Read permission.
Protected methodCheckReturnsNoResults
Checks if where condition results in no data
(Overrides WhereConditionBase TParent  CheckReturnsNoResults .)
Public methodImmutable
Makes this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBase TParent .)
Public methodInCategory
Ensures that only documents assigned to specified category are retrieved (including all categories on path).
Public methodIncludeDataParameters
Adds the data parameters to the current query parameters
(Inherited from QueryParametersBase TParent .)
Public methodInRelationWith
Ensures that only documents in relationship with a specified document are retrieved.
Public methodIntersect
Gets the intersection of this data query with another query
(Inherited from DataQueryBase TQuery .)
Public methodLatestVersion
Ensures that latest version of the documents is retrieved.
Public methodLock
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from DisposableObject.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodModifyAllInnerQueries
Modifies all inner queries with the given parameters
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Protected methodModifySingleInnerQuery
Modifies single inner query with the given parameters. Operation is not supported if multi query doesn't represent a single query source
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Public methodNestingLevel
Ensures that only documents within specified nesting level are retrieved.
Protected methodNewDataSet
Creates a new DataSet for the query results
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Protected methodNewEmptyQuery
Creates a new empty query
(Inherited from DataQueryBase TQuery .)
Public methodNewGroupBy
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 methodNewHaving
Clears the current having condition
(Inherited from DataQuerySettingsBase TQuery .)
Protected methodNewResult
Returns properly typed this
(Inherited from QueryParametersBase TParent .)
Public methodNewWhere
Clears the current where condition
(Inherited from WhereConditionBase TParent .)
Public methodNextPage
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 methodNoColumns
Sets the query to return no columns at all
(Inherited from DataQuerySettingsBase TQuery .)
Public methodNoDefaultColumns
Sets the query to return no columns at all
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodNoResults
Sets the where condition to exclude all data from result
(Inherited from WhereConditionBase TParent .)
Public methodNotPaged
Sets up the query to become not paged query and output all results at once.
(Inherited from DataQuerySettingsBase TQuery .)
Public methodOnCurrentSite
Filters the data to include only records on the current site.
Public methodOnlyCoupledColumns
Ensures that only coupled columns will be included in the results.
Public methodOnlyGlobal
Filters the data to include only global objects.
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Public methodOnSite
Filters the documents to include only records on the given site.
(Overrides MultiObjectQueryBase TQuery, TInnerQuery, TObject  OnSite(SiteInfoIdentifier, Boolean).)
Public methodOr 
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBase TParent .)
Public methodOr(IWhereCondition)
Adds the given where condition with the OR operator
(Inherited from WhereConditionBase TParent .)
Public methodOr(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 methodOrderBy( String )
Adds the columns to the order by query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodOrderBy(OrderDirection,  String )
Adds the columns to the order by query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodOrderByAscending
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from DataQuerySettingsBase TQuery .)
Public methodOrderByDefault
Sets the default order by for the query
(Inherited from DataQueryBase TQuery .)
Public methodOrderByDescending
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from DataQuerySettingsBase TQuery .)
Public methodPage
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 methodPagedBy
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 methodPath( String )
Filters the data to include only documents on given path(s).
Public methodPath(String, PathTypeEnum)
Filters the data to include only documents on given path.
Public methodPublished
Ensures that only documents published on a live site are retrieved.
Public methodPublishedVersion
Ensures that latest version of the documents is retrieved.
Public methodReplaceColumn
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase TQuery .)
Protected methodReplaceOrderByColumn
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase TQuery .)
Protected methodReplaceSelectedColumn
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase TQuery .)
Protected methodResetWhereOperator
Resets the where operator to the default value
(Inherited from WhereConditionBase TParent .)
Protected methodResolveColumns
Resolves the columns in the given list
(Inherited from DataQueryBase TQuery .)
Protected methodResolveType
Resolves the given type into corresponding types
(Overrides MultiQueryBase TQuery, TInnerQuery  ResolveType(String).)
Public methodResultColumn(String)
Sets the column to select
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodResultColumn(IQueryColumn)
Sets the column to select
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodResultColumns(IEnumerable String )
Sets the columns to select
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodResultColumns( String )
Sets the columns to select
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodResultOrderBy( String )
Adds the columns to the order by query
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodResultOrderBy(OrderDirection,  String )
Adds the columns to the order by query
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodResultOrderByAscending
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodResultOrderByDescending
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodReturnNoResults
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 methodSelect T 
Transforms the current result
(Inherited from DataQueryBase TQuery .)
Protected methodSetClassName
Sets class name for current query
(Overrides MultiQueryBase TQuery, TInnerQuery  SetClassName(String).)
Public methodSnapshot
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 methodSource
Defines the source of the data (table, view or a nested query)
(Inherited from DataQueryBase TQuery .)
Public methodTake
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 methodThen
Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
(Inherited from DataQuerySettingsBase TQuery .)
Public methodTopN
Selects only first top N number of records
(Inherited from DataQuerySettingsBase TQuery .)
Public methodToString 
Returns the string representation of the expression
(Inherited from QueryParametersBase TParent .)
Public methodToString(Boolean)
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodType
Includes given type with optional parameters
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodTypes
Includes the given types to the resulting query
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public methodUnion
Gets the union of this data query with another query
(Inherited from DataQueryBase TQuery .)
Public methodUnionAll
Gets the union of this data query with another query without eliminating the duplicities
(Inherited from DataQueryBase TQuery .)
Public methodUsing
Adds the given object to the list of the allocated objects to dispose
(Inherited from DisposableObject.)
Public methodWhere( IWhereCondition )
Adds the given where conditions to the query
(Inherited from WhereConditionBase TParent .)
Public methodWhere(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 methodWhere(String, QueryDataParameters)
Adds the given where condition to the query
(Inherited from WhereConditionBase TParent .)
Public methodWhere(String, QueryUnaryOperator)
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBase TParent .)
Public methodWhere(IQueryObjectWithValue, QueryUnaryOperator)
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBase TParent .)
Public methodWhere(String, QueryOperator, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBase TParent .)
Public methodWhere(IQueryObjectWithValue, QueryOperator, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBase TParent .)
Public methodWhereAnyColumn
Matches the given condition on any column with the same type as the given value type.
(Inherited from DataQueryBase TQuery .)
Public methodWhereAnyColumnContains
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 methodWhereContains(String, String)
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBase TParent .)
Public methodWhereContains(IQueryObjectWithValue, String)
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBase TParent .)
Public methodWhereEmpty
Adds the where condition for a null or empty column value
(Inherited from WhereConditionBase TParent .)
Public methodWhereEndsWith(String, String)
Adds the condition for a string column to end with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereEndsWith(IQueryObjectWithValue, String)
Adds the condition for a string expression to end with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereEquals(String, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBase TParent .)
Public methodWhereEquals(IQueryObjectWithValue, Object)
Adds the given where condition to the query. Matches the left side to the given right side.
(Inherited from WhereConditionBase TParent .)
Public methodWhereEqualsOrNull
Adds the given where condition to the query. Matches the column to a given value or null value.
(Inherited from WhereConditionBase TParent .)
Public methodWhereExists(IDataQuery)
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBase TParent .)
Protected methodWhereExists(IDataQuery, Boolean)
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBase TParent .)
Public methodWhereFalse(String)
Adds the where condition for a false column value (boolean column equals false).
(Inherited from WhereConditionBase TParent .)
Public methodWhereFalse(IQueryObjectWithValue)
Adds the where condition for a false expression value (boolean expression equals false).
(Inherited from WhereConditionBase TParent .)
Public methodWhereGreaterOrEquals(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 methodWhereGreaterOrEquals(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 methodWhereGreaterThan(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 methodWhereGreaterThan(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 methodWhereID
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 methodWhereIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .)
Public methodWhereIn(String, IList Int32 )
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .)
Protected methodWhereIn(String, IDataQuery, Boolean)
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .)
Protected methodWhereIn(String, IList Int32 , Boolean)
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .)
Public methodWhereLessOrEquals(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 methodWhereLessOrEquals(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 methodWhereLessThan(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 methodWhereLessThan(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 methodWhereLike(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 methodWhereLike(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 methodWhereNot
Adds the negation of the given where condition
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotContains(String, String)
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotContains(IQueryObjectWithValue, String)
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotEmpty
Adds the where condition for a non empty column value
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotEndsWith(String, String)
Adds the condition for a string column not to end with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotEndsWith(IQueryObjectWithValue, String)
Adds the condition for a string column not to end with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotEquals(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 methodWhereNotEquals(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 methodWhereNotExists
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotIn(String, IList Int32 )
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotLike(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 methodWhereNotLike(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 methodWhereNotNull(String)
Adds the where condition for a not null column value
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotNull(IQueryObjectWithValue)
Adds the where condition for a not null expression value
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotStartsWith(String, String)
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereNotStartsWith(IQueryObjectWithValue, String)
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereNull(String)
Adds the where condition for a null column value
(Inherited from WhereConditionBase TParent .)
Public methodWhereNull(IQueryObjectWithValue)
Adds the where condition for a null expression value
(Inherited from WhereConditionBase TParent .)
Public methodWhereStartsWith(String, String)
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereStartsWith(IQueryObjectWithValue, String)
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBase TParent .)
Public methodWhereTrue(String)
Adds the where condition for a true column value (boolean column equals true).
(Inherited from WhereConditionBase TParent .)
Public methodWhereTrue(IQueryObjectWithValue)
Adds the where condition for a true expression value (boolean expression equals true).
(Inherited from WhereConditionBase TParent .)
Public methodWithCodeName
Sets the where condition for a specific object code name
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Public methodWithComment
Adds the comment to the given query
(Inherited from DataQuerySettingsBase TQuery .)
Public methodWithCoupledColumns
Ensures that coupled columns will be included in the results.
Public methodWithGuid
Sets the where condition for a specific object GUID
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Public methodWithID
Sets the where condition for a specific object ID
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Public methodWithObjectType
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 MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Public methodWithSettings(AbstractQueryObject)
Applies the given parameters to the query
(Inherited from DataQueryBase TQuery .)
Public methodWithSettings(Action DataQuerySettings )
Applies the given parameters to the query
(Inherited from DataQueryBase TQuery .)
Public methodWithSource(DataSet)
Sets the given DataSet as the source of the data query
(Inherited from DataQueryBase TQuery .)
Public methodWithSource(DataQuerySource)
Sets the given source as the source of the data query
(Inherited from DataQueryBase TQuery .)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodFakeExecution
Fakes the execution of a query
(Defined by UnitTestExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetObjectRelationships
Gets the query for all relationships of the objects that the query represents
(Defined by RelationshipsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Back to Top
Fields

  NameDescription
Protected fieldmMaxRecords
Maximum number of records to select
(Inherited from DataQuerySettingsBase TQuery .)
Protected fieldmOffset
Offset
(Inherited from DataQuerySettingsBase TQuery .)
Protected fieldmParameters
Query data parameters
(Inherited from QueryParametersBase TParent .)
Back to Top
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 MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
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
Gets the unique query source ID
(Inherited from DataQueryBase TQuery .)
Public propertyDefaultOrderByColumns
Default order by columns used in case if needed, and order by is not specified
(Inherited from DataQueryBase TQuery .)
Protected propertyDefaultQuery
Default query used by the process when type queries are not used
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public propertyDefaultSourceExpression
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
Generic document instance.
Public propertyElementType
Returns the element type.
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Public propertyExpression
Query expression
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Public propertyFilterColumns
List of columns used for extra filtering within the query, e.g. "CMS_C, CMS_RN"
(Inherited from DataQuerySettingsBase TQuery .)
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 DataQueryBase TQuery .)
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 part of multi query
(Inherited from AbstractQueryObject.)
Public propertyIsOffline
Returns true if the given collection is offline (disconnected from the database)
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, 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
(Inherited from DataQueryBase 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 DataQueryBase TQuery .)
Public propertyNextPageAvailable
Returns true if the next page is available.
(Inherited from DataQueryBase TQuery .)
Public propertyObjectType
Returns the object type of the objects stored within the collection.
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, 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 propertyOrderByResultColumns
List of columns for the result order by. If not specified, the result is ordered by sources and global order by.
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public propertyParameters
Query data parameters
(Inherited from QueryParametersBase TParent .)
Public propertyProperties
Document query properties.
Public propertyProvider
Query provider
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Public propertyQueries
Inner queries
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public propertyQueriesList
Inner queries list
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public propertyQueryName
Query name
(Inherited from DataQueryBase 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 MultiQueryBase TQuery, TInnerQuery .)
Public propertySelectColumnsObsolete.
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from DataQuerySettingsBase 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 propertySelectResultColumnsObsolete.
List of columns to use for results, by default returns all columns defined in the inner queries. Example: "DocumentName, DocumentID"
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public propertySelectResultColumnsList
List of columns to use for results, by default returns all columns defined in the inner queries. Example: "DocumentName, DocumentID"
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public propertySourceExpression
Source of the query
(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 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 MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Protected propertyUseDefaultQuery
Flag indicating if the default query should be forcibly used. Default false. This flag is automatically reverted to false in case initializer of particular type query is used through Type("sometype", q => q.Where(...)).
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
Public propertyUseObjectTypeCondition
If true, the query uses the object type condition.
(Inherited from MultiObjectQueryBase TQuery, TInnerQuery, TObject .)
Public propertyUseTypeColumns
If true (default), the query uses type columns for the output, otherwise it uses only global columns
(Inherited from MultiQueryBase TQuery, TInnerQuery .)
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 is a complex where condition
(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 .)
Back to Top
See Also