Click or drag to resize
UIContextData Class
Class used for storing context data for UI.
Inheritance Hierarchy

Namespace: CMS.PortalEngine
Assembly: CMS.PortalEngine (in CMS.PortalEngine.dll) Version: 9.0.0
Syntax
C#
public class UIContextData : XmlData

The UIContextData type exposes the following members.

Constructors
  NameDescription
Public methodUIContextData
Constructor. Sets excluded columns property.
Top
Fields
  NameDescription
Public fieldStatic memberCATEGORYNAMEPREFIX
Name prefix for categories change
Protected fieldmData
Collection of the data contents.
(Inherited from XmlData.)
Top
Properties
  NameDescription
Public propertyAllowMacros
Indicates if macro values are allowed
(Inherited from XmlData.)
Public propertyColumnNames
Column names.
(Inherited from XmlData.)
Public propertyContextResolver
Data context resolver.
Public propertyExcludedColumns
List of excluded column name prefixes (delimited by ';'). Columns starting with these won't be loaded to collection.
(Inherited from XmlData.)
Public propertyItem
Override indexer, add fallback to querystring
(Overrides XmlDataItemString.)
Public propertyMacroTable
Macro table
(Inherited from XmlData.)
Public propertyResolveMacros
Indicates whether property should be resolved with contexts resolver.
Public propertyValue Obsolete.
Single value of the custom data. If set, overrides the data collection.
(Inherited from XmlData.)
Public propertyXmlRootName
Gets name of xml root element.
(Inherited from XmlData.)
Top
Methods
  NameDescription
Public methodClear
Clears the custom data.
(Inherited from XmlData.)
Public methodClone
Clones current object
Public methodContainsColumn
Returns true if the object contains specified column.
(Inherited from XmlData.)
Public methodConvertToHashtable
Converts XML data to Hashtable.
(Inherited from XmlData.)
Public methodGetData
Returns the XML code of the data.
(Inherited from XmlData.)
Public methodGetKeyValue
Returns value assigned to given key
Public methodGetObjectData
Gets object data.
(Inherited from XmlData.)
Public methodGetValue
Returns value of column.
(Inherited from XmlData.)
Public methodGetXmlElement
Gets the XML element for the data
(Inherited from XmlData.)
Public methodLoadData
Loads the XML to the content table.
(Inherited from XmlData.)
Public methodLoadFromXmlElement
Loads the data from the given XML element
(Inherited from XmlData.)
Public methodRemove
Removes element with specified key from collection
(Inherited from XmlData.)
Public methodSetValue
Sets value of column.
(Inherited from XmlData.)
Public methodToString
Returns xml as a string.
(Inherited from XmlData.)
Public methodTryGetValue
Loads value of the column. Returns true if the operation was successful (the value was present)
(Overrides XmlDataTryGetValue(String, Object).)
Top
Events
  NameDescription
Public eventOnGetValue
Event fired when the UI context dynamic data is requested
Top
See Also