SettingsMacroContainer Class

Macro container for all settings.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.Internal.SettingsMacroContainer

Namespace: CMS.DataEngine.Internal
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 11.0.0

Syntax

public class SettingsMacroContainer : IDataContainer, 
	ISimpleDataContainer, IMacroSecurityCheckPermissions

The SettingsMacroContainer type exposes the following members.

Constructors

	Name	Description
Public method	SettingsMacroContainer	Creates new instance of SettingsMacroContainer.

Properties

	Name	Description
Public property	ColumnNames	Gets collection of all available setting keys.
Public property	Item	Gets the setting key value based on settings key name.

Methods

	Name	Description
Public method	ContainsColumn	Returns true when setting key is available by specified name.
Public method	GetObjectToCheck	Gets an object for which to perform the permissions check.
Public method	GetValue	Gets the setting key value.
Public method	SetValue	Not implemented method. Throws exception in all cases.
Public method	TryGetValue	Gets setting key value for specified setting key name.

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

Remarks

This API supports the framework infrastructure and is not intended to be used directly from your code.