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: 12.0.0

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.

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.

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	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, Boolean)	Overloaded. Writes XML representation of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)
Public Extension Method	ToXML(String, Boolean)	Overloaded. Returns XML representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, List<String>, Boolean)	Overloaded. Writes XML representation of selected columns of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)