Class DataParameter

Namespace

CMS.DataEngine

Assembly

CMS.DataEngine.dll

Container for a single query parameter.

public class DataParameter

Inheritance

object

DataParameter

Derived

DynamicDataParameter

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

DataParameter()

Constructor.

public DataParameter()

DataParameter(string, object)

Constructor.

public DataParameter(string name, object value)

Parameters

name string

Name

value object

Value

Properties

Direction

Gets or sets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter. The default is System.Data.ParameterDirection.Input.

public ParameterDirection Direction { get; set; }

Property Value

ParameterDirection

Name

Parameter name.

public string Name { get; }

Property Value

string

ParamRegEx

Regular expression to located the parameter within text

public Regex ParamRegEx { get; }

Property Value

Regex

Type

Parameter type.

public Type Type { get; set; }

Property Value

Type

Value

Parameter value.

public object Value { get; }

Property Value

object

Methods

Clone()

Clones the parameter

public virtual DataParameter Clone()

Returns

DataParameter

Equals(object)

Returns true if the parameter equals to another parameter object. Both name and value must match in order to consider two parameters equal.

public override bool Equals(object obj)

Parameters

obj object

Object to compare to

Returns

bool

Expand(string)

Expands the given expression

public string Expand(string expression)

Parameters

expression string

Expression to expand

Returns

string

GetCurrentValue()

Gets the current value for query execution

protected virtual object GetCurrentValue()

Returns

object

GetHashCode()

Gets the hash code of the object

public override int GetHashCode()

Returns

int

GetValueToCompare()

Gets the value for the parameter comparison

protected virtual object GetValueToCompare()

Returns

object

ToString()

Converts the data parameter to string

public override string ToString()

Returns

string