UIContextData Class

Class used for storing context data for UI.

Inheritance Hierarchy

System.Object
  CMS.Base.XmlData
    CMS.PortalEngine.UIContextData

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

Syntax

public class UIContextData : XmlData

The UIContextData type exposes the following members.

Constructors

	Name	Description
Public method	UIContextData	Constructor. Sets exluded columns property.

Methods

	Name	Description
Public method	Clear	Clears the custom data. (Inherited from XmlData.)
Public method	Clone	Clones current object
Public method	ContainsColumn	Returns true if the object contains specified column. (Inherited from XmlData.)
Public method	ConvertToHashtable	Converts XML data to Hashtable. (Inherited from XmlData.)
Public method	GetData()	Returns the XML code of the data. (Inherited from XmlData.)
Public method	GetData(XmlDocument)	Returns the XML code of the data and constructed XML document. (Inherited from XmlData.)
Public method	GetKeyValue	Returns value assigned to given key
Public method	GetObjectData	Gets object data. (Inherited from XmlData.)
Public method	GetValue	Returns value of column. (Inherited from XmlData.)
Public method	LoadData(String)	Loads the XML to the content table. (Inherited from XmlData.)
Public method	LoadData(String, XmlDocument)	Loads the XML to the content table. (Inherited from XmlData.)
Public method	Remove	Removes element with specified key from collection (Inherited from XmlData.)
Public method	SetValue	Sets value of column. (Inherited from XmlData.)
Public method	ToString	Returns xml as a string. (Inherited from XmlData.)
Public method	TryGetValue	Loads value of the column. Returns true if the operation was successful (the value was present) (Overrides XmlData.TryGetValue(String, Object).)

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	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	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	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Public field Static member	CATEGORYNAMEPREFIX	Name prefix for categories change
Protected field	mData	Collection of the data contents. (Inherited from XmlData.)
Protected field	mValue	Custom data value. (Inherited from XmlData.)

Properties

	Name	Description
Public property	AllowMacros	Indicates if macro values are allowed (Inherited from XmlData.)
Public property	ColumnNames	Column names. (Inherited from XmlData.)
Public property	ContextResolver	Data context resolver.
Public property	ExcludedColumns	List of excluded columns (delimited by ';') which wont be loaded to collection. Test contains startwith. (Inherited from XmlData.)
Public property	Item	Override indexer, add fallback to querystring (Overrides XmlData.Item[String].)
Public property	MacroTable	Macro table (Inherited from XmlData.)
Public property	ResolveMacros	Indicates whether property should be resolved with contexts resolver.
Public property	Value	Value of the custom data, if set, overrides the data collection. (Inherited from XmlData.)
Public property	XmlRootName	Gets name of xml root element. (Inherited from XmlData.)

Events

	Name	Description
Public event	OnGetValue	Event fired when the UI context dynamic data is requested