QueryDataParameters Class

Container that holds a list of query parameters.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.QueryDataParameters

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

Syntax

public class QueryDataParameters : IEnumerable<DataParameter>, 
	IEnumerable

The QueryDataParameters type exposes the following members.

Constructors

	Name	Description
Public method	QueryDataParameters	Constructor

Properties

	Name	Description
Public property	Count	Number of the registered parameters
Protected property	ExistingLocalParameters	Table of existing parameters [name -> DataParameter]
Protected property	ExtraLocalMacros	Extra query macros
Public property	FillDataSet	DataSet to be filled by the query. If not given, new DataSet is created
Public property	Item[Int32]	Returns the parameter on specified index.
Public property	Item[String]	Returns the parameter of the specified name.
Protected property	LocalParameters	List of parameters defined locally in this instance
Public property	MacroCount	Number of macros in the data parameters
Protected property	ParentParameters	Parent query parameters
Public property	QueryAfter	Text included after the query
Public property	QueryBefore	Text included before the query
Public property	Source	Source of the data

Methods

	Name	Description
Public method	Add(DataParameter)	Adds the parameter into the list.
Protected method	Add(DataParameter, Boolean)	Adds the parameter into the list.
Public method	Add(String, Object, Boolean)	Adds the parameter into the list.
Public method	Add(String, Object, Type)	Adds the parameter into the list.
Public method	AddDateTime	Adds the date time parameter into the list (if the date time is DateTime.MinValue, adds DBNull.Value).
Public method	AddGuid	Adds the guid parameter into the list (if the guid id Guid.Empty, adds DBNull.Value).
Public method	AddId	Adds the ID parameter into the list (if the ID is not larger than 0, adds DBNull.Value).
Public method	AddMacro	Adds the macro to the query data parameters
Public method	AddUnique(DataParameter, Boolean)	Adds the parameter into the list, if the parameter already exists, defines a unique name for it.
Public method	AddUnique(String, Object, Boolean)	Adds the parameter into the list, if the parameter already exists, defines a unique name for it.
Public method	Equals	Returns true if the object equals another object (Overrides Object.Equals(Object).)
Public method	Expand	Expands the expression by replacing parameters with their values
Public method	GetCompleteQueryText	Gets the complete query text updated with the parameters
Public method	GetEnumerator	Gets the enumerator.
Public method	GetHashCode	Provides a hashcode for the object (Overrides Object.GetHashCode().)
Protected method	GetMacros	Gets the enumerator.
Public method	IncludeDataParameters	Adds the data parameters to the current query parameters
Public method	ResolveMacros	Resolves macros within the given query text
Public method	ToArray	Obsolete. Converts the data parameters to an array of parameters [[name, value, type], ...].
Public method	ToString	Converts the data parameter to string (Overrides Object.ToString().)

Extension Methods

	Name	Description
Public Extension Method	Batch<DataParameter>	Returns input in batches of batchSize size. (Defined by BaseExtensions.)
Public Extension Method	ToHashSet<DataParameter>	Converts the list of objects to a hash set of distinct values (Defined by DataExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IEnumerable. (Defined by DataExtensions.)
Public Extension Method	ToXML	Returns XML representation of current instance of IEnumerable. (Defined by DataExtensions.)