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: 8.2.23
Syntax
C#
public class UIContextData : XmlData

The UIContextData type exposes the following members.

Constructors
  NameDescription
Public methodUIContextData
Constructor. Sets exluded columns property.
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 methodGetData(XmlDocument)
Returns the XML code of the data and constructed XML document.
(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 methodLoadData(String)
Loads the XML to the content table.
(Inherited from XmlData.)
Public methodLoadData(String, XmlDocument)
Loads the XML to the content table.
(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
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Public fieldStatic memberCATEGORYNAMEPREFIX
Name prefix for categories change
Protected fieldmData
Collection of the data contents.
(Inherited from XmlData.)
Protected fieldmValue
Custom data value.
(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 columns (delimited by ';') which wont be loaded to collection. Test contains startwith.
(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
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
Events
  NameDescription
Public eventOnGetValue
Event fired when the UI context dynamic data is requested
Top
See Also