SettingsCategoryContainer Class

Object encapsulating all settings objects to be accessible via macro engine.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.SettingsCategoryContainer

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

Syntax

public class SettingsCategoryContainer : IDataContainer, 
	ISimpleDataContainer

The SettingsCategoryContainer type exposes the following members.

Constructors

	Name	Description
Public method	SettingsCategoryContainer	Creates new instance of SettingsCategoryContainer.

Methods

	Name	Description
Public method	ContainsColumn	Returns true if the object contains specified column.
Public method	GetValue	Gets or sets the value of the column.
Public method	SetValue	Not implemented.
Public method	TryGetValue	Returns value of column.

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.)

Properties

	Name	Description
Public property	ColumnNames	Column names.
Public property	Item	Gets the value of the column, setter is not implemented.
Public property	KeysAsObjects	Indicates whether settings keys are treated as normal children (InfoObjects) or simple values.
Public property	SettingsCategoryInfo	Gets the encapsulated settings category info.
Public property	SiteID	Gets the site ID.