XmlData Class

XML data container.

Inheritance Hierarchy

System.Object
  CMS.Base.XmlData
    CMS.Base.ExtendedXmlData
    CMS.Helpers.CustomData
    CMS.Helpers.ObjectParameters
    CMS.Helpers.UserDataInfo
    CMS.PortalEngine.UIContextData

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

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.

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	GetData(XmlDocument)	Returns the XML code of the data and constructed XML document.
Public method	GetObjectData	Gets object data.
Public method	GetValue	Returns value of column.
Public method	LoadData(String)	Loads the XML to the content table.
Public method	LoadData(String, XmlDocument)	Loads the XML to the content table.
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	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.)

Fields

	Name	Description
Protected field	mData	Collection of the data contents.
Protected field	mValue	Custom data value.

Properties

	Name	Description
Public property	AllowMacros	Indicates if macro values are allowed
Public property	ColumnNames	Column names.
Public property	ExcludedColumns	List of excluded columns (delimited by ';') which wont be loaded to collection. Test contains startwith.
Public property	Item	Gets or sets the value of the column.
Public property	MacroTable	Macro table
Public property	Value	Value of the custom data, if set, overrides the data collection.
Public property	XmlRootName	Gets name of xml root element.