EnumDataContainer Class

Provides wrapper for any Enum object for usage in the macro engine. Uses reflection to extract fields of the enum.

Inheritance Hierarchy

System.Object
  CMS.Base.EnumDataContainer

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

Syntax

public class EnumDataContainer : IDataContainer, 
	ISimpleDataContainer

The EnumDataContainer type exposes the following members.

Constructors

	Name	Description
Public method	EnumDataContainer	Creates new instance of enum container.

Methods

	Name	Description
Public method	ContainsColumn	Returns true if given name is within the enumeration items.
Public method	GetValue	Returns the value of given enumeration item.
Public method	SetValue	Not implemented, throws an exception.
Public method	TryGetValue	Returns the value of given enumeration item.

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	CopyTo	Copies the data of specified columns of the source object to the target object. (Defined by DataExtensions.)
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	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
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	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 IDataContainer. (Defined by DataExtensions.)
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 IDataContainer. (Defined by DataExtensions.)

Fields

	Name	Description
Protected field	mColumnNames	Column names (enum items).
Protected field	mEnumType	Type of the enum.

Properties

	Name	Description
Public property	ColumnNames	Returns list of enumeration items.
Public property	EnumType	Element type.
Public property	Item	Returns the value of given enumeration item.