IMultiDocumentQuery TQuery, TInnerQuery, TObject  MembersKentico 8.0 API Reference
The IMultiDocumentQuery TQuery, TInnerQuery, TObject  type exposes the following members.
Methods

  NameDescription
Public methodAddColumn(String)
Adds the additional column to the query
(Inherited from IDataQuerySettings TQuery .)
Public methodAddColumn(IQueryColumn)
Adds the additional column to the query
(Inherited from IDataQuerySettings TQuery .)
Public methodAddColumns(IEnumerable String )
Adds the additional columns to the query
(Inherited from IDataQuerySettings TQuery .)
Public methodAddColumns( IQueryColumn )
Adds the additional columns to the query
(Inherited from IDataQuerySettings TQuery .)
Public methodAddResultColumn(String)
Adds the additional column to the query
(Inherited from IMultiQuery TQuery, TInnerQuery .)
Public methodAddResultColumn(IQueryColumn)
Adds the additional column to the query
(Inherited from IMultiQuery TQuery, TInnerQuery .)
Public methodAddResultColumns(IEnumerable String )
Adds the additional columns to the query
(Inherited from IMultiQuery TQuery, TInnerQuery .)
Public methodAddResultColumns( IQueryColumn )
Adds the additional columns to the query
(Inherited from IMultiQuery TQuery, TInnerQuery .)
Public methodAll
Ensures that there is no restriction applied for the result.
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodAllCultures
Ensures that all culture versions of the documents are retrieved.
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodAnd 
Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
(Inherited from IWhereCondition TParent .)
Public methodAnd(IWhereCondition)
Adds the given where condition with the AND operator
(Inherited from IWhereCondition 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 IWhereCondition TParent .)
Public methodApplyParametersTo
Applies this where condition to the target object
(Inherited from IQueryParameters.)
Public methodApplySettings(AbstractQueryObject)
Applies the given settings to the query
(Inherited from IDataQuery.)
Public methodApplySettings(Action DataQuerySettings )
Applies the given settings to the query
(Inherited from IDataQuery.)
Public methodAsIDQuery
Creates an ID query from the given query
(Inherited from IDataQuery.)
Public methodAsNested 
Creates a nested query from the given query
(Inherited from IObjectQuery TQuery, TObject .)
Public methodAsNested TResult  
Creates a nested query from the given query
(Inherited from IDataQuery.)
Public methodAsSingleColumn
Creates a single column query from the given query
(Inherited from IDataQuery.)
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 IDataQuery.)
Public methodBinaryData
Sets whether the binary data should be included to the result
(Inherited from IDataQuery TQuery .)
Public methodCloneObject
Creates the clone of the object.
(Inherited from IQueryObject.)
Public methodColumn(String)
Sets the column to select
(Inherited from IDataQuerySettings TQuery .)
Public methodColumn(IQueryColumn)
Sets the column to select
(Inherited from IDataQuerySettings TQuery .)
Public methodColumns(IEnumerable String )
Sets the columns to select
(Inherited from IDataQuerySettings TQuery .)
Public methodColumns( String )
Sets the columns to select
(Inherited from IDataQuerySettings TQuery .)
Public methodCombineWithDefaultCulture
The data will be combined with documents in site default culture if not translated to the requested one. This behavior can be used only when a single culture of documents is requested.
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodCulture
Filters the data to include only documents translated to given culture(s).
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodDefault
Ensures default restrictions for the result.
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodOnlineDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from OnlineIDisposable.)
Public methodDistinct
Sets the query to use distinct selection over the given columns
(Inherited from IDataQuerySettings TQuery .)
Public methodEnsureParameters
Ensures data parameters for the given query
(Inherited from IQueryParameters.)
Public methodExceptGlobal
Filters the data to include only site objects, but not global objects
(Inherited from IObjectQuery TQuery, TObject .)
Public methodExcludePath( String )
Filters the data to exclude documents on given path(s).
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodExcludePath(String, PathTypeEnum)
Filters the data to exclude documents on given path.
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodExecute
Executes the current query and returns it's results as a DataSet
(Inherited from IDataQuery.)
Public methodExecuteReader
Executes the current query and returns it's results as a data reader
(Inherited from IDataQuery.)
Public methodExpand
Expands the expression by replacing parameters with their values
(Inherited from IQueryParameters.)
Public methodExpandColumns
Expands the columns within this query
(Inherited from IDataQuery 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.
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodFirstResult
Sets the query as a single object query
(Inherited from IDataQuerySettings 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 IDataQuery.)
Public methodFrom
Defines the source of the data (table, view or a nested query)
(Inherited from IDataQuery TQuery .)
Public methodGetCompleteSettings
Gets the complete parameters for the query execution
(Inherited from IDataQuery.)
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 IDataQuery.)
Public methodGetScalarResult T 
Gets the scalar
(Inherited from IDataQuery.)
Public methodGroupBy
Specifies the columns to group by
(Inherited from IDataQuerySettings TQuery .)
Public methodHaving( IWhereCondition )
Adds the given having conditions to the query.
(Inherited from IDataQuerySettings 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 IDataQuerySettings TQuery .)
Public methodHaving(String, Boolean)
Specifies the group by having condition
(Inherited from IDataQuerySettings TQuery .)
Public methodCheckPermissions
Ensures that the result will be filtered based on user Read permission.
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodInCategory
Ensures that only documents assigned to specified category are retrieved (including all categories on path).
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodIncludeDataParameters
Adds the data parameters to the current query parameters
(Inherited from IQueryParameters.)
Public methodInRelationWith
Ensures that only documents in relationship with a specified document are retrieved.
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodLatestVersion
Ensures that latest version of the documents is retrieved.
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodNestingLevel
Ensures that only documents within specified nesting level are retrieved.
(Inherited from IDocumentQuery TQuery, TObject .)
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 IDataQuerySettings TQuery .)
Public methodNewHaving
Clears the current having condition
(Inherited from IDataQuerySettings TQuery .)
Public methodNewWhere
Clears the current where condition
(Inherited from IWhereCondition 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 IDataQuerySettings TQuery .)
Public methodNoDefaultColumns
Sets the query to return no columns at all
(Inherited from IMultiQuery TQuery, TInnerQuery .)
Public methodNoResults
Sets the where condition to exclude all data from result
(Inherited from IWhereCondition TParent .)
Public methodNotPaged
Sets up the query to become not paged query and output all results at once.
(Inherited from IDataQuerySettings TQuery .)
Public methodOnCurrentSite
Filters the data to include only records on the current site.
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodOnlyGlobal
Filters the data to include only global objects.
(Inherited from IObjectQuery TQuery, TObject .)
Public methodOnSite
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 IObjectQuery TQuery, TObject .)
Public methodOr 
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
(Inherited from IWhereCondition TParent .)
Public methodOr(IWhereCondition)
Adds the given where condition with the OR operator
(Inherited from IWhereCondition 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 IWhereCondition TParent .)
Public methodOrderBy( String )
Adds the columns to the order by query
(Inherited from IDataQuerySettings TQuery .)
Public methodOrderBy(OrderDirection,  String )
Adds the columns to the order by query
(Inherited from IDataQuerySettings TQuery .)
Public methodOrderByAscending
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from IDataQuerySettings TQuery .)
Public methodOrderByDefault
Sets the default order by for the query
(Inherited from IDataQuery TQuery .)
Public methodOrderByDescending
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from IDataQuerySettings 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 IDataQuerySettings 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 IDataQuerySettings TQuery .)
Public methodPath( String )
Filters the data to include only documents on given path(s).
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodPath(String, PathTypeEnum)
Filters the data to include only documents on given path.
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodPublished
Ensures that only documents published on a live site are retrieved.
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodPublishedVersion
Ensures that latest version of the documents is retrieved.
(Inherited from IDocumentQuery TQuery, TObject .)
Public methodReplaceColumn
Replaces the selected column with a new name
(Inherited from IDataQuerySettings TQuery .)
Public methodResultColumn(String)
Sets the column to select
(Inherited from IMultiQuery TQuery, TInnerQuery .)
Public methodResultColumn(IQueryColumn)
Sets the column to select
(Inherited from IMultiQuery TQuery, TInnerQuery .)
Public methodResultColumns(IEnumerable String )
Sets the columns to select
(Inherited from IMultiQuery TQuery, TInnerQuery .)
Public methodResultColumns( String )
Sets the columns to select
(Inherited from IMultiQuery TQuery, TInnerQuery .)
Public methodResultOrderBy( String )
Adds the columns to the order by query
(Inherited from IMultiQuery TQuery, TInnerQuery .)
Public methodResultOrderBy(OrderDirection,  String )
Adds the columns to the order by query
(Inherited from IMultiQuery TQuery, TInnerQuery .)
Public methodResultOrderByAscending
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from IMultiQuery TQuery, TInnerQuery .)
Public methodResultOrderByDescending
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from IMultiQuery 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 IWhereCondition.)
Public methodSelect T 
Transforms the current result
(Inherited from IDataQuery.)
Public methodSource
Defines the source of the data (table, view or a nested query)
(Inherited from IDataQuery 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 IDataQuerySettings TQuery .)
Public methodThen
Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
(Inherited from IDataQuerySettings TQuery .)
Public methodTopN
Selects only first top N number of records
(Inherited from IDataQuerySettings TQuery .)
Public methodToString
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from IQueryParameters.)
Public methodType
Includes given type with optional parameters
(Inherited from IMultiQuery TQuery, TInnerQuery .)
Public methodTypes
Includes the given types to the resulting query
(Inherited from IMultiQuery TQuery, TInnerQuery .)
Public methodWhere( IWhereCondition )
Adds the given where conditions to the query
(Inherited from IWhereCondition 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 IWhereCondition TParent .)
Public methodWhere(String, QueryDataParameters)
Adds the given where condition to the query
(Inherited from IWhereCondition TParent .)
Public methodWhere(String, QueryUnaryOperator)
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from IWhereCondition TParent .)
Public methodWhere(String, QueryOperator, Object)
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from IWhereCondition TParent .)
Public methodWhereAnyColumn
Matches the given condition on any column with the same type as the given value type.
(Inherited from IDataQuery 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 IDataQuery TQuery .)
Public methodWhereContains
Adds the condition for a string column to contain some substring
(Inherited from IWhereCondition TParent .)
Public methodWhereEmpty
Adds the where condition for a null or empty column value
(Inherited from IWhereCondition TParent .)
Public methodWhereEquals
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from IWhereCondition TParent .)
Public methodWhereEqualsOrNull
Adds the given where condition to the query. Matches the column to a given value or null value.
(Inherited from IWhereCondition TParent .)
Public methodWhereExists
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from IWhereCondition TParent .)
Public methodWhereFalse
Adds the where condition for a false column value (boolean column equals false).
(Inherited from IWhereCondition 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 IWhereCondition TParent .)
Public methodWhereIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName IN (...)"
(Inherited from IWhereCondition TParent .)
Public methodWhereIn(String, IList Int32 )
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from IWhereCondition TParent .)
Public methodWhereLike
Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
(Inherited from IWhereCondition TParent .)
Public methodWhereNot
Adds the negation of the given where condition
(Inherited from IWhereCondition TParent .)
Public methodWhereNotContains
Adds the condition for a string column not to contain some substring
(Inherited from IWhereCondition TParent .)
Public methodWhereNotEmpty
Adds the where condition for a non empty column value
(Inherited from IWhereCondition TParent .)
Public methodWhereNotExists
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
(Inherited from IWhereCondition TParent .)
Public methodWhereNotIn(String, IDataQuery)
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
(Inherited from IWhereCondition TParent .)
Public methodWhereNotIn(String, IList Int32 )
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
(Inherited from IWhereCondition TParent .)
Public methodWhereNotLike
Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator.
(Inherited from IWhereCondition TParent .)
Public methodWhereNotNull
Adds the where condition for a not null column value
(Inherited from IWhereCondition TParent .)
Public methodWhereNotStartsWith
Adds the condition for a string column not to start with some prefix
(Inherited from IWhereCondition TParent .)
Public methodWhereNull
Adds the where condition for a null column value
(Inherited from IWhereCondition TParent .)
Public methodWhereStartsWith
Adds the condition for a string column to start with some prefix
(Inherited from IWhereCondition TParent .)
Public methodWhereTrue
Adds the where condition for a true column value (boolean column equals true).
(Inherited from IWhereCondition TParent .)
Public methodWithCodeName
Sets the where condition for a specific object code name
(Inherited from IObjectQuery TQuery, TObject .)
Public methodWithComment
Adds the comment to the given query
(Inherited from IDataQuerySettings TQuery .)
Public methodWithGuid
Sets the where condition for a specific object code name
(Inherited from IObjectQuery TQuery, TObject .)
Public methodWithID
Sets the where condition for a specific object ID
(Inherited from IObjectQuery TQuery, 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 IObjectQuery TQuery, TObject .)
Public methodWithSettings(AbstractQueryObject)
Applies the given parameters to the query
(Inherited from IDataQuery TQuery .)
Public methodWithSettings(Action DataQuerySettings )
Applies the given parameters to the query
(Inherited from IDataQuery TQuery .)
Public methodWithSource(DataSet)
Sets the given DataSet as the source of the data query
(Inherited from IDataQuery TQuery .)
Public methodWithSource(DataQuerySource)
Sets the given source as the source of the data query
(Inherited from IDataQuery TQuery .)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodFakeExecution
Fakes the execution of a query
(Defined by UnitTestExtensions.)
Back to Top
Properties

  NameDescription
Public propertyClassName
Class name
(Inherited from IDataQuery.)
Public propertyCustomQueryText
Custom query text
(Inherited from IDataQuery.)
Public propertyDataSource
Data source that provides the query data. If not set, the query queries the database directly
(Inherited from IDataQuery.)
Public propertyDataSourceName
Gets the unique query source ID
(Inherited from IDataQuery.)
Public propertyDefaultOrderByColumns
Default order by columns used in case if needed, and order by is not specified
(Inherited from IDataQuery.)
Public propertyDefaultSourceExpression
Default source of the query in case source is not defined
(Inherited from IDataQuerySettings.)
Public propertyGroupByColumns
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
(Inherited from IDataQuerySettings.)
Public propertyHasDataSource
Returns true if the query has specific data source
(Inherited from IDataQuery.)
Public propertyHavingCondition
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
(Inherited from IDataQuerySettings.)
Public propertyIncludeBinaryData
If true, the query includes the object binary data. Default is false
(Inherited from IDataQuery.)
Public propertyIsNested
Indicates that this query is part of multi query
(Inherited from IQueryObject.)
Public propertyIsSubQuery
If true, the query is a sub-query used in another query
(Inherited from IDataQuery.)
Public propertyMaxRecords
Maximum number of results to return (use for paging together with Offset)
(Inherited from IDataQuerySettings.)
Public propertyName
Object name, empty by default
(Inherited from IQueryObject.)
Public propertyObjectType
Returns the object type of the objects stored within the collection.
(Inherited from IObjectQuery.)
Public propertyOffset
Index of the first record to return (use for paging together with MaxRecords)
(Inherited from IDataQuerySettings.)
Public propertyOrderByColumns
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
(Inherited from IDataQuerySettings.)
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 IMultiQuery.)
Public propertyParameters
Query data parameters
(Inherited from IQueryParameters.)
Public propertyProperties
Document query parameters.
(Inherited from IDocumentQuery.)
Public propertyQueryName
Query name
(Inherited from IDataQuery.)
Public propertyQueryText
Query text
(Inherited from IDataQuery.)
Public propertyResult
DataSet with the result
(Inherited from IDataQuery.)
Public propertySelectColumns
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from IDataQuerySettings.)
Public propertySelectDistinct
If set to true, returns only distinct (different) values.
(Inherited from IDataQuerySettings.)
Public propertySelectResultColumns
List of columns to use for results, by default returns all columns defined in the inner queries. Example: "DocumentName, DocumentID"
(Inherited from IMultiQuery.)
Public propertySourceExpression
Source of the query
(Inherited from IDataQuerySettings.)
Public propertySupportsReader
Returns true if the query supports data reader
(Inherited from IDataQuery.)
Public propertyTables
Collection of the result tables
(Inherited from IDataQuery.)
Public propertyTopNRecords
If set, selects only first top N number of records
(Inherited from IDataQuerySettings.)
Public propertyTotalRecords
Gets the number of total records when paging is used. Gets updated once the query executes
(Inherited from IDataQuery.)
Public propertyUseTypeColumns
If true (default), the query uses type columns for the output, otherwise it uses only global columns
(Inherited from IMultiQuery.)
Public propertyWhereCondition
Where condition on the data, e.g. "DocumentName = 'ABC'"
(Inherited from IWhereCondition.)
Public propertyWhereIsComplex
Returns true if the given where condition is a complex where condition
(Inherited from IWhereCondition.)
Back to Top
See Also