Click or drag to resize
QueryColumnList Class
Represents a list of query columns
Inheritance Hierarchy

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0
Syntax
C#
public class QueryColumnList : QueryColumnListBase

The QueryColumnList type exposes the following members.

Constructors
  NameDescription
Public methodQueryColumnList(String)
Creates an empty column list built from the given columns
Public methodQueryColumnList(IQueryObject)
Constructor
Top
Properties
  NameDescription
Public propertyAnyColumnsDefined
Returns true if any columns are defined within this column list
(Inherited from QueryColumnListBase.)
Public propertyColumns

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 propertyContainsAllColumnsSelector
Indicates whether list contains all columns selector
(Inherited from QueryColumnListBase.)
Public propertyCount
Returns the number of defined columns
(Inherited from QueryColumnListBase.)
Public propertyIsSingleColumn
Returns true if the columns represent a single column
(Inherited from QueryColumnListBase.)
Public propertyItem
Returns column on specific index
(Inherited from QueryColumnListBase.)
Public propertyNoColumns
Indicates whether list represents an empty list with no columns, no matter already existing columns or columns added after
(Inherited from QueryColumnListBase.)
Public propertyParent
Parent query for the column list
(Inherited from QueryColumnListBase.)
Protected propertyPresentColumns
Gets the hash set of present columns for duplicity detection
(Inherited from QueryColumnListBase.)
Public propertyReturnsAllColumns
Returns true if the columns contain all columns specification or columns do not contain definition of any columns
(Inherited from QueryColumnListBase.)
Top
Methods
  NameDescription
Public methodCode exampleAdd(String)
Adds one QueryColumn into list, regardless of existing columns. QueryColumn added to the list is created via FromExpression(String).
Public methodAdd(IQueryColumn)
Adds column into list, regardless of existing columns.
Protected methodAddInternal
Adds the given column to the column list
(Inherited from QueryColumnListBase.)
Public methodAddRange
Adds columns into list, regardless of existing columns.
Public methodAddRangeUnique(IEnumerableString, Boolean)
Adds columns that are not present in the list.
Public methodAddRangeUnique(IEnumerableIQueryColumn, Boolean)
Adds the given enumerable of query columns, if not already present in the list.
Public methodAddRangeUnique(QueryColumnList, Boolean)
Adds the given list of query columns, if not already present in the list.
Public methodAddUnique
Adds the given column to the column list, if column is not already present.
Protected methodAddUniqueInternal
Adds the given column to the column list, only if not already present
(Inherited from QueryColumnListBase.)
Public methodAsAliases
Returns the column list transformed to the aliases of the columns.
Protected methodChanged
Marks the list as changed and flushes all necessary caches
(Inherited from QueryColumnListBase.)
Public methodClear
Clears the list of columns
(Inherited from QueryColumnListBase.)
Public methodClone
Clones the column list
(Inherited from QueryColumnListBase.)
Public methodEnsureAllColumns
Ensures all columns flag if the list is empty
(Inherited from QueryColumnListBase.)
Public methodEnsureOrderByColumns
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 methodEquals
Returns true if the object equals to another
(Inherited from QueryColumnListBase.)
Public methodGetColumns
Gets list of columns represented as string
(Inherited from QueryColumnListBase.)
Public methodGetEnumerator
Gets the enumerator for the columns
(Inherited from QueryColumnListBase.)
Public methodGetHashCode
Gets the object hash code
(Inherited from QueryColumnListBase.)
Public methodLoad(String)
Loads the given columns to the list.
Public methodCode exampleLoad(String)
Loads the given list of columns to the list.
Public methodCode exampleLoad(IEnumerableIQueryColumn)
Loads the given list of columns to the list.
Public methodRemove
Removes one explicitly defined column by Name from the columns collection
(Inherited from QueryColumnListBase.)
Public methodRemoveAll
Removes explicitly defined columns by Name from the columns collection
(Inherited from QueryColumnListBase.)
Public methodReplaceColumn
Replaces the column with a given name with the new column definition
(Inherited from QueryColumnListBase.)
Public methodToString
Gets a string representation of the column list
(Inherited from QueryColumnListBase.)
Top
See Also