QueryColumnList Class

Represents a list of query columns

Inheritance Hierarchy

System.Object
  CMS.DataEngine.QueryColumnList

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

Syntax

public class QueryColumnList : IEnumerable<IQueryColumn>, 
	IEnumerable

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

Methods

	Name	Description
Public method	Add(IEnumerable<String>, Boolean)	Adds the given list of columns to the list
Public method	Add(String, Boolean)	Adds the given list of columns
Public method	Add(IQueryColumn, Boolean)	Adds the given list of query columns
Public method	Add(IEnumerable<IQueryColumn>, Boolean)	Adds the given list of query columns
Public method	Add(QueryColumnList, Boolean)	Adds the given list of query columns
Public method	AsAliases	Returns the column list transformed to the aliases of the columns
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	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 (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	Load(String[])	Loads the given list of columns to the list
Public method	Load(IEnumerable<IQueryColumn>)	Loads the given list of columns to the list
Public method	ReplaceColumn	Replaces the column with a given name with the new column definition
Public method	ResolveColumns	Resolves all columns into the given class columns
Public method	ToString	Gets a string representation of the column list (Overrides Object.ToString().)
Public method	Transform	Transforms the column list to a new list of columns using the given column transformation

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	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	Batch<IQueryColumn>	Returns input in batches of batchSize size. (Defined by BaseExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToHashSet<IQueryColumn>	Converts the list of objects to a hash set of distinct values (Defined by DataExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IEnumerable. (Defined by DataExtensions.)
Public Extension Method	ToList<IQueryColumn, TTo>	Converts the given collection to a list of values (Defined by BaseExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToXML	Returns XML representation of current instance of IEnumerable. (Defined by DataExtensions.)

Properties

	Name	Description
Public property	AnyColumnsDefined	Returns true if any columns are defined within this column list
Public property	Columns	List of columns represented as string
Public property	Count	Returns the number of defined columns
Protected property	IncludeAllColumns	If true, all columns are included
Public property	IsSingleColumn	Returns true if the columns represent a single column
Protected property	NoColumns	If true, the list represents an empty list with no columns
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