The DocumentQuery type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
DocumentQuery |
Constructor
| |
DocumentQuery(String) |
Constructor
| |
DocumentQuery(TreeNode) |
Constructor
|
Methods
Name | Description | |
---|---|---|
AddColumn(String) |
Adds the additional column to the query
(Inherited from DataQuerySettingsBase TQuery .) | |
AddColumn(IQueryColumn) |
Adds the additional column to the query
(Inherited from DataQuerySettingsBase TQuery .) | |
AddColumns(IEnumerable String ) |
Adds the additional columns to the query
(Inherited from DataQuerySettingsBase TQuery .) | |
AddColumns( IQueryColumn ) |
Adds the additional columns to the query
(Inherited from DataQuerySettingsBase TQuery .) | |
AddHavingInternal |
Adds the given having condition
(Inherited from DataQuerySettingsBase TQuery .) | |
AddWhereCondition |
Adds the given where condition to the final where condition
(Inherited from WhereConditionBase TParent .) | |
AddWhereConditionInternal |
Adds the given where condition
(Inherited from WhereConditionBase TParent .) | |
All |
Ensures that there is no restriction applied for the result.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
AllCultures |
Ensures that all culture versions of the documents are retrieved.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
And |
Changes the where operator to AND for subsequent where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBase TParent .) | |
And(IWhereCondition) |
Adds the given where condition with the AND operator
(Inherited from WhereConditionBase TParent .) | |
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 .) | |
ApplyParametersTo |
Applies this query parameters to the target object
(Inherited from DataQueryBase TQuery .) | |
ApplySettings(AbstractQueryObject) |
Applies the given settings to the query
(Inherited from DataQueryBase TQuery .) | |
ApplySettings(Action DataQuerySettings ) |
Applies the given settings to the query
(Inherited from DataQueryBase TQuery .) | |
AsColumn |
Converts the query to the query column using this query as nested
(Inherited from DataQueryBase TQuery .) | |
AsIDQuery |
Creates an ID query from the given query
(Inherited from DataQueryBase TQuery .) | |
AsNested |
Creates a nested query from the given query
(Inherited from ObjectQueryBase TQuery, TObject .) | |
AsSingleColumn |
Creates a single column query from the given query
(Inherited from DataQueryBase TQuery .) | |
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 .) | |
BinaryData |
Sets whether the binary data should be included to the result
(Inherited from DataQueryBase TQuery .) | |
CallOnDispose |
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from DisposableObject.) | |
Clone |
Creates the clone of the object.
(Inherited from QueryParametersBase TParent .) | |
CloneObject |
Creates the clone of the object.
(Inherited from QueryParametersBase TParent .) | |
Column(String) |
Sets the column to select
(Inherited from DataQuerySettingsBase TQuery .) | |
Column(IQueryColumn) |
Sets the column to select
(Inherited from DataQuerySettingsBase TQuery .) | |
Columns(IEnumerable String ) |
Sets the columns to select
(Inherited from DataQuerySettingsBase TQuery .) | |
Columns( String ) |
Sets the columns to select
(Inherited from DataQuerySettingsBase TQuery .) | |
CombineWithDefaultCulture |
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 DocumentQueryBase TQuery, TObject .) | |
CopyPropertiesTo |
Copies the properties to the target query.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
CreateChild |
Creates the child collection based on the given provider
(Inherited from ObjectQueryBase TQuery, TObject .) | |
Culture |
Filters the data to include only documents translated to given culture(s).
(Inherited from DocumentQueryBase TQuery, TObject .) | |
Default |
Ensures default restrictions for the result.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
Dispose |
Make sure the objects get disposed
(Inherited from DisposableObject.) | |
Distinct |
Sets the query to use distinct selection over the given columns
(Inherited from DataQuerySettingsBase TQuery .) | |
EnsureParameters |
Ensures data parameters for the given query
(Inherited from QueryParametersBase TParent .) | |
Equals | (Inherited from Object.) | |
ExceptGlobal |
Filters the data to include only site objects, but not global objects
(Inherited from ObjectQueryBase TQuery, TObject .) | |
ExcludePath( String ) |
Filters the data to exclude documents on given path(s).
(Inherited from DocumentQueryBase TQuery, TObject .) | |
ExcludePath(String, PathTypeEnum) |
Filters the data to exclude documents on given path.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
Execute |
Executes the current query and returns it's results as a DataSet
(Inherited from DataQueryBase TQuery .) | |
ExecuteReader |
Executes the current query and returns it's results as a data reader
(Inherited from DataQueryBase TQuery .) | |
Expand |
Expands the expression by replacing parameters with their values
(Inherited from QueryParametersBase TParent .) | |
ExpandColumns |
Expands the columns within this query
(Inherited from DataQueryBase TQuery .) | |
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 .) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
FirstResult |
Sets the query as a single object query
(Inherited from DataQuerySettingsBase TQuery .) | |
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 .) | |
ForEachPage |
Executes the given action for each page (DataSet) in the results. If the query is not set up as a paged query, executes the action once with the current results.
(Inherited from DataQueryBase TQuery .) | |
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 .) | |
From |
Defines the source of the data (table, view or a nested query)
(Inherited from DataQueryBase TQuery .) | |
GenerateQueryText |
Generates query text from the executing query
(Inherited from ObjectQueryBase TQuery, TObject .) | |
GetAvailableColumns |
Gets the list of all available columns for this query
(Inherited from DocumentQueryBase TQuery, TObject .) | |
GetBinaryColumns |
Gets the binary columns for this query
(Inherited from DataQueryBase TQuery .) | |
GetClassName |
Gets the class name for current query
(Inherited from ObjectQueryBase TQuery, TObject .) | |
GetClassStructureInfo |
Gets the class structure info for this query
(Inherited from ObjectQueryBase TQuery, TObject .) | |
GetCompleteSettings |
Gets the complete parameters for the query execution
(Inherited from DocumentQueryBase TQuery, TObject .) | |
GetData |
Executes the query
(Inherited from DataQueryBase TQuery .) | |
GetDataFromDataSource |
Executes the current over data source and returns it's results as a DataSet
(Inherited from DataQueryBase TQuery .) | |
GetDataFromDB |
Executes the query using data retrieval through the given info object
(Inherited from ObjectQueryBase TQuery, TObject .) | |
GetDataSourceName |
Gets the unique query source ID
(Inherited from ObjectQueryBase TQuery, TObject .) | |
GetDefaultOrderBy |
Gets the default order by columns
(Inherited from ObjectQueryBase TQuery, TObject .) | |
GetDefaultSingleColumn |
Gets the default single column for the query
(Inherited from DataQueryBase TQuery .) | |
GetDefaultSource |
Gets the default source for this query
(Inherited from DataQueryBase TQuery .) | |
GetEnumerator |
Gets the typed enumerator
(Inherited from ObjectQueryBase TQuery, TObject .) | |
GetExecutingQuery |
Gets the query to execute against database
(Inherited from ObjectQueryBase TQuery, TObject .) | |
GetExpressions |
Gets the query expressions
(Inherited from DataQuerySettingsBase TQuery .) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetIDColumn |
Gets the ID column for this query
(Inherited from ObjectQueryBase TQuery, TObject .) | |
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 .) | |
GetReaderFromDB |
Executes the query
(Inherited from ObjectQueryBase TQuery, TObject .) | |
GetResults |
Gets query results
(Inherited from DocumentQueryBase TQuery, TObject .) | |
GetScalarResult T |
Gets the scalar
(Inherited from DataQueryBase TQuery .) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetTypedResult |
Gets typed result
(Inherited from DocumentQueryBase TQuery, TObject .) | |
GetWhere |
Gets the where condition for the given column
(Inherited from WhereConditionBase TParent .) | |
GroupBy |
Specifies the columns to group by
(Inherited from DataQuerySettingsBase TQuery .) | |
HasCompatibleSource |
Returns true if the given query is an external source
(Inherited from DataQueryBase TQuery .) | |
HasResults |
Returns true, if the query returns any results
(Inherited from DataQueryBase TQuery .) | |
Having( IWhereCondition ) |
Adds the given having conditions to the query.
(Inherited from DataQuerySettingsBase TQuery .) | |
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 .) | |
Having(String, Boolean) |
Specifies the group by having condition
(Inherited from DataQuerySettingsBase TQuery .) | |
Changed |
Marks the object as changed
(Inherited from DataQueryBase TQuery .) | |
CheckPermissions |
Ensures that the result will be filtered based on user Read permission.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
Immutable |
Makes this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBase TParent .) | |
InCategory |
Ensures that only documents assigned to specified category are retrieved (including all categories on path).
(Inherited from DocumentQueryBase TQuery, TObject .) | |
IncludeDataParameters |
Adds the data parameters to the current query parameters
(Inherited from QueryParametersBase TParent .) | |
InitFromType T |
Initializes the query from the given type
(Inherited from ObjectQueryBase TQuery, TObject .) | |
InitIDQuery |
Initializes the ID query
(Inherited from ObjectQueryBase TQuery, TObject .) | |
InRelationWith |
Ensures that only documents in relationship with a specified document are retrieved.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
LatestVersion |
Ensures that latest version of the documents is retrieved.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
Lock |
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from DisposableObject.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
NestingLevel |
Ensures that only documents within specified nesting level are retrieved.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
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 .) | |
NewHaving |
Clears the current having condition
(Inherited from DataQuerySettingsBase TQuery .) | |
NewResult |
Returns properly typed this
(Inherited from QueryParametersBase TParent .) | |
NewWhere |
Clears the current where condition
(Inherited from WhereConditionBase TParent .) | |
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 .) | |
NoColumns |
Sets the query to return no columns at all
(Inherited from DataQuerySettingsBase TQuery .) | |
NoResults |
Sets the where condition to exclude all data from result
(Inherited from WhereConditionBase TParent .) | |
NotPaged |
Sets up the query to become not paged query and output all results at once.
(Inherited from DataQuerySettingsBase TQuery .) | |
OnCurrentSite |
Filters the data to include only records on the current site.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
OnlyGlobal |
Filters the data to include only global objects.
(Inherited from ObjectQueryBase TQuery, TObject .) | |
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 .) | |
Or |
Changes the where operator to OR for next where conditions. Use in combination of methods Where...
(Inherited from WhereConditionBase TParent .) | |
Or(IWhereCondition) |
Adds the given where condition with the OR operator
(Inherited from WhereConditionBase TParent .) | |
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 .) | |
OrderBy( String ) |
Adds the columns to the order by query
(Inherited from DataQuerySettingsBase TQuery .) | |
OrderBy(OrderDirection, String ) |
Adds the columns to the order by query
(Inherited from DataQuerySettingsBase TQuery .) | |
OrderByAscending |
Adds the columns to the order by query to order by the given columns in ascending order
(Inherited from DataQuerySettingsBase TQuery .) | |
OrderByDefault |
Sets the default order by for the query
(Inherited from DataQueryBase TQuery .) | |
OrderByDescending |
Adds the columns to the order by query to order by the given columns in descending order
(Inherited from DataQuerySettingsBase TQuery .) | |
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 .) | |
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 .) | |
Path( String ) |
Filters the data to include only documents on given path(s).
(Inherited from DocumentQueryBase TQuery, TObject .) | |
Path(String, PathTypeEnum) |
Filters the data to include only documents on given path.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
Published |
Ensures that only documents published on a live site are retrieved.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
PublishedVersion |
Ensures that latest version of the documents is retrieved.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
ReplaceColumn |
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase TQuery .) | |
ReplaceOrderByColumn |
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase TQuery .) | |
ReplaceSelectedColumn |
Replaces the selected column with a new name
(Inherited from DataQuerySettingsBase TQuery .) | |
ResetWhereOperator |
Resets the where operator to the default value
(Inherited from WhereConditionBase TParent .) | |
ResolveColumns(String, Boolean) |
Resolves the columns within this query
(Inherited from DataQueryBase TQuery .) | |
ResolveColumns(String, List String ) |
Resolves the columns within this query
(Inherited from DataQueryBase TQuery .) | |
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 .) | |
Select T |
Transforms the current result
(Inherited from DataQueryBase TQuery .) | |
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 .) | |
Source |
Defines the source of the data (table, view or a nested query)
(Inherited from DataQueryBase TQuery .) | |
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 .) | |
Then |
Identity method to make the query expression more readable. Use before the OrderBy method. Doesn't provide any functionality.
(Inherited from DataQuerySettingsBase TQuery .) | |
TopN |
Selects only first top N number of records
(Inherited from DataQuerySettingsBase TQuery .) | |
ToString |
Returns the string representation of the expression
(Inherited from QueryParametersBase TParent .) | |
ToString(Boolean) |
Returns the string representation of the expression, with possibility of expanding parameters
(Inherited from ObjectQueryBase TQuery, TObject .) | |
TypeUpdated |
Updates the query class name based on the current status
(Inherited from DocumentQueryBase TQuery, TObject .) | |
Using |
Adds the given object to the list of the allocated objects to dispose
(Inherited from DisposableObject.) | |
Where( IWhereCondition ) |
Adds the given where conditions to the query
(Inherited from WhereConditionBase TParent .) | |
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 .) | |
Where(String, QueryDataParameters) |
Adds the given where condition to the query
(Inherited from WhereConditionBase TParent .) | |
Where(String, QueryUnaryOperator) |
Adds the given where condition to the query. Matches the column value with an unary operator.
(Inherited from WhereConditionBase TParent .) | |
Where(String, QueryOperator, Object) |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBase TParent .) | |
WhereAnyColumn |
Matches the given condition on any column with the same type as the given value type.
(Inherited from DataQueryBase TQuery .) | |
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 .) | |
WhereContains |
Adds the condition for a string column to contain some substring
(Inherited from WhereConditionBase TParent .) | |
WhereEmpty |
Adds the where condition for a null or empty column value
(Inherited from WhereConditionBase TParent .) | |
WhereEquals |
Adds the given where condition to the query. Matches the column to a given value.
(Inherited from WhereConditionBase TParent .) | |
WhereEqualsOrNull |
Adds the given where condition to the query. Matches the column to a given value or null value.
(Inherited from WhereConditionBase TParent .) | |
WhereExists(IDataQuery) |
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereExists(IDataQuery, Boolean) |
Adds where condition with EXISTS and the nested query "EXISTS (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereFalse |
Adds the where condition for a false column value (boolean column equals false).
(Inherited from WhereConditionBase TParent .) | |
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 .) | |
WhereIn(String, IDataQuery) |
Adds where condition to the nested query, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereIn(String, IList Int32 ) |
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereIn(String, IDataQuery, Boolean) |
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereIn(String, IList Int32 , Boolean) |
Adds where condition to the list of values, e.g. "columnName IN (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereLike |
Adds the given where condition to the query. Matches the column to a given value using LIKE operator.
(Inherited from WhereConditionBase TParent .) | |
WhereNot |
Adds the negation of the given where condition
(Inherited from WhereConditionBase TParent .) | |
WhereNotContains |
Adds the condition for a string column not to contain some substring
(Inherited from WhereConditionBase TParent .) | |
WhereNotEmpty |
Adds the where condition for a non empty column value
(Inherited from WhereConditionBase TParent .) | |
WhereNotExists |
Adds where condition with NOT EXISTS and the nested query "NOT EXISTS (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereNotIn(String, IDataQuery) |
Adds where condition to the nested query, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereNotIn(String, IList Int32 ) |
Adds where condition to the list of values, e.g. "columnName NOT IN (...)"
(Inherited from WhereConditionBase TParent .) | |
WhereNotLike |
Adds the given where condition to the query. Matches the column to a given value using NOT LIKE operator.
(Inherited from WhereConditionBase TParent .) | |
WhereNotNull |
Adds the where condition for a not null column value
(Inherited from WhereConditionBase TParent .) | |
WhereNotStartsWith |
Adds the condition for a string column not to start with some prefix
(Inherited from WhereConditionBase TParent .) | |
WhereNull |
Adds the where condition for a null column value
(Inherited from WhereConditionBase TParent .) | |
WhereStartsWith |
Adds the condition for a string column to start with some prefix
(Inherited from WhereConditionBase TParent .) | |
WhereTrue |
Adds the where condition for a true column value (boolean column equals true).
(Inherited from WhereConditionBase TParent .) | |
WithCodeName |
Sets the where condition for a specific object code name
(Inherited from ObjectQueryBase TQuery, TObject .) | |
WithComment |
Adds the comment to the given query
(Inherited from DataQuerySettingsBase TQuery .) | |
WithGuid |
Sets the where condition for a specific object code name
(Inherited from ObjectQueryBase TQuery, TObject .) | |
WithID |
Sets the where condition for a specific object ID
(Inherited from ObjectQueryBase TQuery, TObject .) | |
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 .) | |
WithSettings(AbstractQueryObject) |
Applies the given parameters to the query
(Inherited from DataQueryBase TQuery .) | |
WithSettings(Action DataQuerySettings ) |
Applies the given parameters to the query
(Inherited from DataQueryBase TQuery .) | |
WithSource(DataSet) |
Sets the given DataSet as the source of the data query
(Inherited from DataQueryBase TQuery .) | |
WithSource( TObject ) |
Sets the given DataSet as the source of the data query
(Inherited from ObjectQueryBase TQuery, TObject .) | |
WithSource(DataQuerySource) |
Sets the given source as the source of the data query
(Inherited from DataQueryBase TQuery .) |
Extension Methods
Name | Description | |
---|---|---|
GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Fields
Name | Description | |
---|---|---|
mMaxRecords |
Maximum number of records to select
(Inherited from DataQuerySettingsBase TQuery .) | |
mOffset |
Offset
(Inherited from DataQuerySettingsBase TQuery .) | |
mParameters |
Query data parameters
(Inherited from QueryParametersBase TParent .) |
Properties
Name | Description | |
---|---|---|
ClassName |
Class name
(Inherited from DataQueryBase TQuery .) | |
Count |
Number of total items in the collection
(Inherited from ObjectQueryBase TQuery, TObject .) | |
CustomQueryText |
Custom query text
(Inherited from DataQueryBase TQuery .) | |
DataSource |
Data source that provides the query data. If not set, the query queries the database directly
(Inherited from DataQueryBase TQuery .) | |
DataSourceName |
Gets the unique query source ID
(Inherited from DataQueryBase TQuery .) | |
DefaultOrderByColumns |
Default order by columns used in case if needed, and order by is not specified
(Inherited from DataQueryBase TQuery .) | |
DefaultSourceExpression |
Default source of the query in case source is not defined
(Inherited from DataQuerySettingsBase TQuery .) | |
DisposeUsedObjects |
Disposes the objects that were used as parameters for this query
(Inherited from WhereConditionBase TParent .) | |
Document |
Document instance of the specified type.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
ElementType |
Returns the element type.
(Inherited from ObjectQueryBase TQuery, TObject .) | |
Expression |
Query expression
(Inherited from ObjectQueryBase TQuery, TObject .) | |
FirstObject |
DataSet with the result
(Inherited from ObjectQueryBase TQuery, TObject .) | |
ForceOrderBy |
If true, the order by should be forced in the process of execution
(Inherited from DataQuerySettingsBase TQuery .) | |
FullQueryName |
Represents a full query name of the query
(Inherited from DocumentQueryBase TQuery, TObject .) | |
GroupByColumns |
List of columns to group by, by default doesn't group, e.g. "NodeLevel, NodeOwner"
(Inherited from DataQuerySettingsBase TQuery .) | |
HasDataSource |
Returns true if the query has specific data source
(Inherited from DataQueryBase TQuery .) | |
HasGroupBy |
Returns true if the given query has group by set
(Inherited from DataQuerySettingsBase TQuery .) | |
HavingCondition |
Where condition for the group by on the data, e.g. "DocumentName = 'ABC'"
(Inherited from DataQuerySettingsBase TQuery .) | |
HavingIsComplex |
Returns true if the given having condition is a complex condition
(Inherited from DataQuerySettingsBase TQuery .) | |
HavingIsEmpty |
Returns true if the having condition is empty
(Inherited from DataQuerySettingsBase TQuery .) | |
IncludeBinaryData |
If true, the query includes the object binary data. Default is true
(Inherited from DataQueryBase TQuery .) | |
IsImmutable |
If true, this object instance is immutable, and next subsequent modification starts with a clone of the object.
(Inherited from QueryParametersBase TParent .) | |
IsNested |
Indicates that this query is part of multi query
(Inherited from AbstractQueryObject.) | |
IsOffline |
Returns true if the given collection is offline (disconnected from the database)
(Inherited from ObjectQueryBase TQuery, TObject .) | |
IsPagedQuery |
Returns true if the query has the paging enabled
(Inherited from DataQuerySettingsBase TQuery .) | |
IsSubQuery |
If true, the query is a sub-query used in another query
(Inherited from DataQueryBase TQuery .) | |
MaxRecords |
Maximum number of results to return (use for paging together with Offset)
(Inherited from DataQuerySettingsBase TQuery .) | |
Name |
Object name, empty by default
(Inherited from AbstractQueryObject.) | |
NextPageAvailable |
Returns true if the next page is available.
(Inherited from DataQueryBase TQuery .) | |
Object |
Object instance of the specified type.
(Inherited from ObjectQueryBase TQuery, TObject .) | |
ObjectType |
Returns the object type of the objects stored within the collection.
(Inherited from ObjectQueryBase TQuery, TObject .) | |
Offset |
Index of the first record to return (use for paging together with MaxRecords)
(Inherited from DataQuerySettingsBase TQuery .) | |
OrderByColumns |
List of columns by which the result should be sorted, e.g. "NodeLevel, DocumentName DESC"
(Inherited from DataQuerySettingsBase TQuery .) | |
Parameters |
Query data parameters
(Inherited from QueryParametersBase TParent .) | |
Properties |
Document query properties.
(Inherited from DocumentQueryBase TQuery, TObject .) | |
Provider |
Query provider
(Inherited from ObjectQueryBase TQuery, TObject .) | |
QueryName |
Query name
(Inherited from DataQueryBase TQuery .) | |
QueryText |
Query text
(Inherited from DataQueryBase TQuery .) | |
Result |
DataSet with the result
(Inherited from DataQueryBase TQuery .) | |
ReturnsNoResults |
Returns true if query doesn't return any results
(Inherited from WhereConditionBase TParent .) | |
ReturnsSingleColumn |
Returns true if the query returns single column
(Inherited from DataQueryBase TQuery .) | |
SelectColumns |
List of columns to return, by default returns all columns, e.g. "DocumentName, DocumentID"
(Inherited from DataQuerySettingsBase TQuery .) | |
SelectDistinct |
If set to true, returns only distinct (different) values.
(Inherited from DataQuerySettingsBase TQuery .) | |
SourceExpression |
Source of the query
(Inherited from DataQuerySettingsBase TQuery .) | |
SupportsReader |
Returns true if the query supports data reader
(Inherited from DataQueryBase TQuery .) | |
Tables |
Collection of the result tables
(Inherited from DataQueryBase TQuery .) | |
TopNRecords |
If set, selects only first top N number of records
(Inherited from DataQuerySettingsBase TQuery .) | |
TotalRecords |
Gets the number of total records when paging is used. Gets updated once the query executes
(Inherited from DataQueryBase TQuery .) | |
TypedResult |
Typed result
(Inherited from ObjectQueryBase TQuery, TObject .) | |
TypeInfo |
Type info of the specified type
(Inherited from ObjectQueryBase TQuery, TObject .) | |
UseObjectQuery |
If true, the object query is used as default, otherwise, standard DataQuery is used
(Inherited from ObjectQueryBase TQuery, TObject .) | |
UseObjectTypeCondition |
If true, the query uses the object type condition.
(Inherited from ObjectQueryBase TQuery, TObject .) | |
WhereBuilder |
Where condition builder
(Inherited from WhereConditionBase TParent .) | |
WhereCondition |
Where condition on the data, e.g. "DocumentName = 'ABC'"
(Inherited from WhereConditionBase TParent .) | |
WhereIsComplex |
Returns true if the given where condition is a complex where condition
(Inherited from WhereConditionBase TParent .) | |
WhereIsEmpty |
Returns true if the where condition is empty
(Inherited from WhereConditionBase TParent .) | |
WhereOperator |
Operator used for adding where condition. Default is AND
(Inherited from WhereConditionBase TParent .) |
See Also