Class QueryColumnBase<TColumn>

Namespace

CMS.DataEngine

Assembly

CMS.DataEngine.dll

Query column

public abstract class QueryColumnBase<TColumn> : QueryParametersBase<TColumn>, IQueryParameters<TColumn>, IQueryColumn, IQueryExpression, IQueryParameters, IQueryObjectWithValue, IQueryObject where TColumn : QueryColumnBase<TColumn>, new()

Type Parameters

TColumn

Inheritance

object

AbstractQueryObject

QueryParametersBase<TColumn>

QueryColumnBase<TColumn>

Implements

IQueryParameters<TColumn>

IQueryColumn

IQueryExpression

IQueryParameters

IQueryObjectWithValue

IQueryObject

Derived

OrderByColumn

SelectQueryColumnBase<TColumn>

Inherited Members

QueryParametersBase<TColumn>.mParameters

QueryParametersBase<TColumn>.IsImmutable

QueryParametersBase<TColumn>.Parameters

QueryParametersBase<TColumn>.ApplyParametersTo(IQueryObject)

QueryParametersBase<TColumn>.CopyPropertiesTo(IQueryObject)

QueryParametersBase<TColumn>.CloneObject()

QueryParametersBase<TColumn>.Clone()

QueryParametersBase<TColumn>.EnsureParameters()

QueryParametersBase<TColumn>.IncludeDataParameters(QueryDataParameters, string)

QueryParametersBase<TColumn>.Immutable()

QueryParametersBase<TColumn>.GetTypedQuery()

QueryParametersBase<TColumn>.Expand(string)

QueryParametersBase<TColumn>.ToString()

AbstractQueryObject.Changed()

AbstractQueryObject.Reset()

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

QueryColumnBase(string)

Constructor

protected QueryColumnBase(string expression)

Parameters

expression string

Expression (column name)

Properties

Expression

Expression (column name)

public string Expression { get; set; }

Property Value

string

IsSingleColumn

Returns true if this column represents a single column

public abstract bool IsSingleColumn { get; }

Property Value

bool

Name

Gets the column name

public override string Name { get; }

Property Value

string

TypedThis

Returns specifically typed current instance

protected TColumn TypedThis { get; }

Property Value

TColumn

Methods

AsAlias()

Returns the new column created from this column alias

public IQueryColumn AsAlias()

Returns

IQueryColumn

AsValue()

Gets a query expression representing this object as a value

public virtual IQueryExpression AsValue()

Returns

IQueryExpression

GetExpression()

Gets the expression for the column data

public virtual string GetExpression()

Returns

string

ToString(bool)

Returns the string representation of the expression, with possibility of expanding parameters

public override string ToString(bool expand)

Parameters

expand bool

If true, the result is expanded with parameters so it can act as standalone value.

Returns

string

WithExpression(string)

Sets the expression

[Obsolete("Method was not intended for public use and will be removed in the next version.")]
[ObsoleteSince(27, 0)]
public TColumn WithExpression(string expression)

Parameters

expression string

New column expression

Returns

TColumn

Operators

explicit operator string(QueryColumnBase<TColumn>)

Implicit operator for conversion from QueryColumn class to string

public static explicit operator string(QueryColumnBase<TColumn> col)

Parameters

col QueryColumnBase<TColumn>

Column object

Returns

string