Class XmlData

Namespace

CMS.Helpers

Assembly

CMS.Helpers.dll

XML data container.

public class XmlData : IDataContainer, ISimpleDataContainer

Inheritance

object

XmlData

Implements

IDataContainer

ISimpleDataContainer

Derived

CustomData

ObjectParameters

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

XmlData()

Constructor - creates empty XmlData object.

public XmlData()

XmlData(string)

Constructor with root element name specification.

public XmlData(string rootName)

Parameters

rootName string

Root element name

Fields

mData

Collection of the data contents.

protected StringSafeDictionary<object> mData

Field Value

StringSafeDictionary<object>

Properties

AllowMacros

Indicates if macro values are allowed

public virtual bool AllowMacros { get; set; }

Property Value

bool

ColumnNames

Column names.

public virtual List<string> ColumnNames { get; }

Property Value

List<string>

ExcludedColumns

List of excluded column name prefixes (delimited by ';'). Columns starting with these won't be loaded to collection.

public string ExcludedColumns { get; set; }

Property Value

string

this[string]

Gets or sets the value of the column.

public virtual object this[string key] { get; set; }

Parameters

key string

Column name

Property Value

object

MacroTable

Macro table

public virtual Hashtable MacroTable { get; set; }

Property Value

Hashtable

XmlRootName

Gets name of xml root element.

public string XmlRootName { get; }

Property Value

string

Methods

Clear()

Clears the custom data.

public virtual void Clear()

Clone()

Returns the cloned object.

public virtual XmlData Clone()

Returns

XmlData

ContainsColumn(string)

Returns true if the object contains specified column.

public virtual bool ContainsColumn(string columnName)

Parameters

columnName string

Column name

Returns

bool

ConvertToHashtable()

Converts XML data to Hashtable.

public virtual Hashtable ConvertToHashtable()

Returns

Hashtable

GetData()

Returns the XML code of the data.

public virtual string GetData()

Returns

string

Remarks

Data are represented as a string values

GetValue(string)

Returns value of column.

public virtual object GetValue(string columnName)

Parameters

columnName string

Column name

Returns

object

GetXmlElement(XmlDocument)

Gets the XML element for the data

public virtual XmlElement GetXmlElement(XmlDocument document)

Parameters

document XmlDocument

Parent XML document

Returns

XmlElement

LoadData(string)

Loads the XML to the content table.

public virtual void LoadData(string data)

Parameters

data string

Content XML to load

LoadFromXmlElement(XmlElement)

Loads the data from the given XML element

public virtual void LoadFromXmlElement(XmlElement element)

Parameters

element XmlElement

XML element

Remove(string)

Removes element with specified key from collection

public virtual void Remove(string key)

Parameters

key string

Key to remove

SetValue(string, object)

Sets value of column.

public virtual bool SetValue(string columnName, object value)

Parameters

columnName string

Column name

value object

Column value

Returns

bool

ToString()

Returns xml as a string.

public override string ToString()

Returns

string

TryGetValue(string, out object)

Returns value of column.

public virtual bool TryGetValue(string columnName, out object value)

Parameters

columnName string

Column name

value object

Returns the value

Returns

bool

Returns true if the operation was successful (the value was present)