QueryColumnListBase Class

Provides basic query column list functionality

Inheritance Hierarchy

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

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

Syntax

public abstract class QueryColumnListBase : IEnumerable<IQueryColumn>, 
	IEnumerable

The QueryColumnListBase type exposes the following members.

Constructors

	Name	Description
Protected method	QueryColumnListBase	Constructor

Properties

	Name	Description
Public property	AnyColumnsDefined	Returns true if any columns are defined within this column list
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.
Protected property	ContainsAllColumnsSelector	Indicates whether list contains all columns selector
Public property	Count	Returns the number of defined columns
Public property	IsSingleColumn	Returns true if the columns represent a single column
Public property	Item	Returns column on specific index
Public property	NoColumns	Indicates whether list represents an empty list with no columns, no matter already existing columns or columns added after
Public property	Parent	Parent query for the column list
Protected property	PresentColumns	Gets the hash set of present columns for duplicity detection
Public property	ReturnsAllColumns	Returns true if the columns contain all columns specification or columns do not contain definition of any columns

Methods

	Name	Description
Protected method	AddInternal	Adds the given column to the column list
Protected method	AddUniqueInternal	Adds the given column to the column list, only if not already present
Protected method	Changed	Marks the list as changed and flushes all necessary caches
Public method	Clear	Clears the list of columns
Public method	Clone	Clones the column list
Public method	EnsureAllColumns	Ensures all columns flag if the list is empty
Public method	Equals	Returns true if the object equals to another (Overrides Object.Equals(Object).)
Public method	GetColumns	Gets list of columns represented as string
Public method	GetEnumerator	Gets the enumerator for the columns
Public method	GetHashCode	Gets the object hash code (Overrides Object.GetHashCode().)
Public method	Remove	Removes one explicitly defined column by Name from the columns collection
Public method	RemoveAll	Removes explicitly defined columns by Name from the columns collection
Public method	ReplaceColumn	Replaces the column with a given name with the new column definition
Public method	ToString	Gets a string representation of the column list (Overrides Object.ToString().)

Operators

	Name	Description
Public operator Static member	Equality	Compares two column lists
Public operator Static member	Inequality	Compares two column lists

Extension Methods

	Name	Description
Public Extension Method	Batch<IQueryColumn>	Returns input in batches of batchSize size. (Defined by BaseExtensions.)
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.)