Click or drag to resize
QueryDataParameters Class
Container that holds a list of query parameters.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineQueryDataParameters

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23
Syntax
C#
public class QueryDataParameters : IEnumerable<DataParameter>, 
	IEnumerable

The QueryDataParameters type exposes the following members.

Constructors
  NameDescription
Public methodQueryDataParameters
Constructor
Top
Methods
  NameDescription
Public methodAdd(DataParameter)
Adds the parameter into the list.
Protected methodAdd(DataParameter, Boolean)
Adds the parameter into the list.
Public methodAdd(String, Object, Boolean)
Adds the parameter into the list.
Public methodAdd(String, Object, Type)
Adds the parameter into the list.
Public methodAddDateTime
Adds the date time parameter into the list (if the date time is DateTime.MinValue, adds DBNull.Value).
Public methodAddGuid
Adds the guid parameter into the list (if the guid id Guid.Empty, adds DBNull.Value).
Public methodAddId
Adds the ID parameter into the list (if the ID is not larger than 0, adds DBNull.Value).
Public methodAddMacro
Adds the macro to the query data parameters
Public methodAddUnique
Adds the parameter into the list, if the parameter already exists, defines a unique name for it.
Public methodEquals
Returns true if the object equals another object
(Overrides ObjectEquals(Object).)
Public methodExpand
Expands the expression by replacing parameters with their values
Public methodGetCompleteQueryText
Gets the complete query text updated with the parameters
Public methodGetEnumerator
Gets the enumerator.
Public methodGetHashCode
Provides a hashcode for the object
(Overrides ObjectGetHashCode.)
Protected methodGetMacroEnumerator
Gets the enumerator.
Public methodGetUpdateQueryColumns
Gets the columns representation for the update query in the form of Column1 = @Column1, Column2 = @Column2, etc.
Public methodIncludeDataParameters
Adds the data parameters to the current query parameters
Public methodResolveMacros
Resolves macros within the given query text
Public methodToArray
Converts the data parameters to an array of parameters [[name, value, type], ...].
Public methodToString
Converts the data parameter to string
(Overrides ObjectToString.)
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodBatchDataParameter
Returns input in batches of batchSize size.
(Defined by BaseExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
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 MethodToHashSetDataParameter
Converts the list of objects to a hash set of distinct values
(Defined by DataExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToJSON
Returns JSON representation of current instance of IEnumerable.
(Defined by DataExtensions.)
Public Extension MethodToListDataParameter, TTo
Converts the given collection to a list of values
(Defined by BaseExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToXML
Returns XML representation of current instance of IEnumerable.
(Defined by DataExtensions.)
Top
Properties
  NameDescription
Public propertyCount
Number of the registered parameters
Protected propertyExistingLocalParameters
Table of existing parameters [name -> DataParameter]
Protected propertyExtraLocalMacros
Extra query macros
Public propertyFillDataSet
DataSet to be filled by the query. If not given, new DataSet is created
Public propertyItemInt32
Returns the parameter on specified index.
Public propertyItemString
Returns the parameter of the specified name.
Protected propertyLocalParameters
List of parameters defined locally in this instance
Public propertyMacroCount
Number of macros in the data parameters
Protected propertyParentParameters
Parent query parameters
Public propertyQueryAfter
Text included after the query
Public propertyQueryBefore
Text included before the query
Public propertySource
Source of the data
Top
See Also