QueryColumnList Class

Represents a list of query columns

Inheritance Hierarchy

System.Object
  CMS.DataEngine.QueryColumnListBase
    CMS.DataEngine.QueryColumnList

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

Syntax

public class QueryColumnList : QueryColumnListBase

The QueryColumnList type exposes the following members.

Constructors

	Name	Description
Public method	QueryColumnList(String)	Creates an empty column list built from the given columns
Public method	QueryColumnList(IQueryObject)	Constructor

Properties

	Name	Description
Public property	AnyColumnsDefined	Returns true if any columns are defined within this column list (Inherited from QueryColumnListBase.)
Public property	Columns	There are three possible outputs. Firstly NO_COLUMNS, there will be no column in query. Secondly list of columns represented as string, without occurrence of NO_COLUMNS. Finally Empty, that resolves to * in query. (Inherited from QueryColumnListBase.)
Protected property	ContainsAllColumnsSelector	Indicates whether list contains all columns selector (Inherited from QueryColumnListBase.)
Public property	Count	Returns the number of defined columns (Inherited from QueryColumnListBase.)
Public property	IsSingleColumn	Returns true if the columns represent a single column (Inherited from QueryColumnListBase.)
Public property	Item	Returns column on specific index (Inherited from QueryColumnListBase.)
Public property	NoColumns	Indicates whether list represents an empty list with no columns, no matter already existing columns or columns added after (Inherited from QueryColumnListBase.)
Public property	Parent	Parent query for the column list (Inherited from QueryColumnListBase.)
Protected property	PresentColumns	Gets the hash set of present columns for duplicity detection (Inherited from QueryColumnListBase.)
Public property	ReturnsAllColumns	Returns true if the columns contain all columns specification or columns do not contain definition of any columns (Inherited from QueryColumnListBase.)

Methods

	Name	Description
Public method Code example	Add(String)	Adds one QueryColumn into list, regardless of existing columns. QueryColumn added to the list is created via FromExpression(String).
Public method	Add(IQueryColumn)	Adds column into list, regardless of existing columns.
Protected method	AddInternal	Adds the given column to the column list (Inherited from QueryColumnListBase.)
Public method	AddRange	Adds columns into list, regardless of existing columns.
Public method	AddRangeUnique(IEnumerable<String>, Boolean)	Adds columns that are not present in the list.
Public method	AddRangeUnique(IEnumerable<IQueryColumn>, Boolean)	Adds the given enumerable of query columns, if not already present in the list.
Public method	AddRangeUnique(QueryColumnList, Boolean)	Adds the given list of query columns, if not already present in the list.
Public method	AddUnique	Adds the given column to the column list, if column is not already present.
Protected method	AddUniqueInternal	Adds the given column to the column list, only if not already present (Inherited from QueryColumnListBase.)
Public method	AsAliases	Returns the column list transformed to the aliases of the columns.
Protected method	Changed	Marks the list as changed and flushes all necessary caches (Inherited from QueryColumnListBase.)
Public method	Clear	Clears the list of columns (Inherited from QueryColumnListBase.)
Public method	Clone	Clones the column list (Inherited from QueryColumnListBase.)
Public method	EnsureAllColumns	Ensures all columns flag if the list is empty (Inherited from QueryColumnListBase.)
Public method	EnsureOrderByColumns	Ensures that the order by columns are provided within the list of columns as aliases, modifies the order by expression to the aliases of those columns.
Public method	Equals	Returns true if the object equals to another (Inherited from QueryColumnListBase.)
Public method	GetColumns	Gets list of columns represented as string (Inherited from QueryColumnListBase.)
Public method	GetEnumerator	Gets the enumerator for the columns (Inherited from QueryColumnListBase.)
Public method	GetHashCode	Gets the object hash code (Inherited from QueryColumnListBase.)
Public method	Load(String)	Loads the given columns to the list.
Public method Code example	Load(String[])	Loads the given list of columns to the list.
Public method Code example	Load(IEnumerable<IQueryColumn>)	Loads the given list of columns to the list.
Public method	Remove	Removes one explicitly defined column by Name from the columns collection (Inherited from QueryColumnListBase.)
Public method	RemoveAll	Removes explicitly defined columns by Name from the columns collection (Inherited from QueryColumnListBase.)
Public method	ReplaceColumn	Replaces the column with a given name with the new column definition (Inherited from QueryColumnListBase.)
Public method	ToString	Gets a string representation of the column list (Inherited from QueryColumnListBase.)