Click or drag to resize
QueryColumnListBase Class
Provides basic query column list functionality
Inheritance Hierarchy

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0
Syntax
C#
public abstract class QueryColumnListBase : IEnumerable<IQueryColumn>, 
	IEnumerable

The QueryColumnListBase type exposes the following members.

Constructors
  NameDescription
Protected methodQueryColumnListBase
Constructor
Top
Properties
  NameDescription
Public propertyAnyColumnsDefined
Returns true if any columns are defined within this column list
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.

Protected propertyContainsAllColumnsSelector
Indicates whether list contains all columns selector
Public propertyCount
Returns the number of defined columns
Public propertyIsSingleColumn
Returns true if the columns represent a single column
Public propertyItem
Returns column on specific index
Public propertyNoColumns
Indicates whether list represents an empty list with no columns, no matter already existing columns or columns added after
Public propertyParent
Parent query for the column list
Protected propertyPresentColumns
Gets the hash set of present columns for duplicity detection
Public propertyReturnsAllColumns
Returns true if the columns contain all columns specification or columns do not contain definition of any columns
Top
Methods
  NameDescription
Protected methodAddInternal
Adds the given column to the column list
Protected methodAddUniqueInternal
Adds the given column to the column list, only if not already present
Protected methodChanged
Marks the list as changed and flushes all necessary caches
Public methodClear
Clears the list of columns
Public methodClone
Clones the column list
Public methodEnsureAllColumns
Ensures all columns flag if the list is empty
Public methodEquals
Returns true if the object equals to another
(Overrides ObjectEquals(Object).)
Public methodGetColumns
Gets list of columns represented as string
Public methodGetEnumerator
Gets the enumerator for the columns
Public methodGetHashCode
Gets the object hash code
(Overrides ObjectGetHashCode.)
Public methodRemove
Removes one explicitly defined column by Name from the columns collection
Public methodRemoveAll
Removes explicitly defined columns by Name from the columns collection
Public methodReplaceColumn
Replaces the column with a given name with the new column definition
Public methodToString
Gets a string representation of the column list
(Overrides ObjectToString.)
Top
Operators
  NameDescription
Public operatorStatic memberEquality
Compares two column lists
Public operatorStatic memberInequality
Compares two column lists
Top
Extension Methods
  NameDescription
Public Extension MethodBatchIQueryColumn
Returns input in batches of batchSize size.
(Defined by BaseExtensions.)
Public Extension MethodToJSON
Returns JSON representation of current instance of IEnumerable.
(Defined by DataExtensions.)
Public Extension MethodToXML
Returns XML representation of current instance of IEnumerable.
(Defined by DataExtensions.)
Top
See Also