SettingsCategoryContainer Class

Note: This API is now obsolete.

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

Syntax

[ObsoleteAttribute("This class should not be used directly and will be removed from public API.")]
public class SettingsCategoryContainer : IDataContainer, 
	ISimpleDataContainer, IMacroSecurityCheckPermissions

The SettingsCategoryContainer type exposes the following members.

Constructors

	Name	Description
Public method	SettingsCategoryContainer	Creates new instance of SettingsCategoryContainer.

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.

Methods

	Name	Description
Public method	ContainsColumn	Returns true if the object contains specified column.
Public method	GetObjectToCheck	Gets an object for which to perform the permissions check.
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	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.)