QueryParameters Class

Query parameters container.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.QueryParameters

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

Syntax

public class QueryParameters

The QueryParameters type exposes the following members.

Constructors

	Name	Description
Public method	QueryParameters(QueryInfo, QueryDataParameters, QueryMacros)	Constructor.
Public method	QueryParameters(String, QueryDataParameters, QueryTypeEnum, Boolean)	Constructor.
Public method	QueryParameters(String, String, QueryDataParameters, QueryTypeEnum, Boolean, QueryMacros, String)	Constructor.

Methods

	Name	Description
Public method	ResolveMacros	Resolves the query macros.

Extension Methods

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

Fields

	Name	Description
Public field	ConnectionStringName	Connection string name to use
Public field	ExecutionType	Execution type.
Protected field	mAllowCache	If true, caching of the query is allowed.
Public field	MaxRecords	Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used)
Public field	Name	Query name.
Public field	Offset	Index of first record to get
Public field	Params	Query parameters.
Public field	RequiresTransaction	Requires transaction.
Public field	Text	Query text.
Public field	Type	Query type.
Public field	UseNewConnection	If true, a new connection instance is created for this query execution

Properties

	Name	Description
Public property	AllowCache	If true, caching of the query is allowed.
Public property	Columns	Obsolete. Columns to get.
Public property	Macros	Query expressions
Public property	OrderBy	Obsolete. Order by.
Public property	TopN	Obsolete. Top N items.
Public property	Where	Obsolete. Where condition.