XmlData Class

XML data container.

Inheritance Hierarchy

System.Object
  CMS.Helpers.XmlData
    CMS.FormEngine.Web.UI.UIContextData
    CMS.Helpers.CustomData
    CMS.Helpers.ObjectParameters
    CMS.Helpers.UserDataInfo

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 11.0.0

Syntax

[SerializableAttribute]
public class XmlData : ISerializable, IDataContainer, 
	ISimpleDataContainer

The XmlData type exposes the following members.

Constructors

	Name	Description
Public method	XmlData()	Constructor - creates empty XmlData object.
Public method	XmlData(String)	Constructor with root element name specification.
Public method	XmlData(SerializationInfo, StreamingContext)	Constructor for deserialization.

Fields

	Name	Description
Protected field	mData	Collection of the data contents.

Properties

	Name	Description
Public property	AllowMacros	Indicates if macro values are allowed
Public property	ColumnNames	Column names.
Public property	ExcludedColumns	List of excluded column name prefixes (delimited by ';'). Columns starting with these won't be loaded to collection.
Public property	Item	Gets or sets the value of the column.
Public property	MacroTable	Macro table
Public property	XmlRootName	Gets name of xml root element.

Methods

	Name	Description
Public method	Clear	Clears the custom data.
Public method	Clone	Returns the cloned object.
Public method	ContainsColumn	Returns true if the object contains specified column.
Public method	ConvertToHashtable	Converts XML data to Hashtable.
Public method	GetData	Returns the XML code of the data.
Public method	GetObjectData	Gets object data.
Public method	GetValue	Returns value of column.
Public method	GetXmlElement	Gets the XML element for the data
Public method	LoadData	Loads the XML to the content table.
Public method	LoadFromXmlElement	Loads the data from the given XML element
Public method	Remove	Removes element with specified key from collection
Public method	SetValue	Sets value of column.
Public method	ToString	Returns xml as a string. (Overrides Object.ToString().)
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.)