DocumentHierarchyHelper Class

Object hierarchy manipulation methods.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.HierarchyHelper
    CMS.DocumentEngine.DocumentHierarchyHelper

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

Syntax

public class DocumentHierarchyHelper : HierarchyHelper

The DocumentHierarchyHelper type exposes the following members.

Constructors

	Name	Description
Protected method	DocumentHierarchyHelper	Creates new instance of CMSHierarchyHelper which can be used to serialize given object.

Methods

	Name	Description
Protected method	DataAvailable	Returns true if the data can be exported (Overrides HierarchyHelper.DataAvailable().)
Public method	ExportObject()	Returns XML representation of given instance of info object. (Inherited from HierarchyHelper.)
Public method Static member	ExportObject(ExportObjectSettings, TreeNode)	Returns XML representation of given instance of info object.
Protected method	ExportObjectData	Exports the object data (Overrides HierarchyHelper.ExportObjectData().)
Protected method	GetMetadataSource	Gets the metadata source object (Overrides HierarchyHelper.GetMetadataSource().)
Public method Static member	GetNodeClassName(String, ExportFormatEnum)	Parses NodeClassName from node data.
Public method Static member	GetNodeClassName(String, ExportFormatEnum, Boolean)	Parses NodeClassName from node data.
Protected method	GetSyndicationItem	Gets the syndication item created from current object (Overrides HierarchyHelper.GetSyndicationItem(SyndicationContent).)
Public method Static member	LoadObjectFromDataSet(TreeNode, DataSet, Boolean, List<String>, List<String>)	Loads object data including collection from a given data set.
Protected method Static member	LoadObjectFromDataSet(TreeNode, DataSet, Boolean, Int32, List<String>, List<String>)	Loads TreeNode data including collection from a given data set.
Public method Static member	LoadObjectFromJSON	Loads objects data including collection from a given XML representation.
Public method Static member	LoadObjectFromXML	Loads objects data including collection from a given XML representation.
Protected method	ProcessArraySeparatorMethod	Handles array separator of the collection export. (Inherited from HierarchyHelper.)
Protected method	ProcessEndCollectionMethod	Handles end of the collection export. (Inherited from HierarchyHelper.)
Protected method	ProcessIDMethod	Handles FK ID (can be used to fill translation helper for example). (Inherited from HierarchyHelper.)
Protected method	ProcessItemMethod	Handles FK ID (can be used to fill translation helper for example). (Inherited from HierarchyHelper.)
Protected method	ProcessObjectMethod	Handles export to required format. (Overrides HierarchyHelper.ProcessObjectMethod(TraverseObjectSettings, ICMSObject, Int32).)
Protected method	ProcessStartCollectionMethod	Handles start of the collection export. (Inherited from HierarchyHelper.)
Public method Static member	TraverseObjectStructure	Returns XML representation of given instance of tree node.

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.)

Properties

	Name	Description
Public property Static member	NodeClassJSONRegex	Regex to parse node class id from JSON data.
Public property Static member	NodeClassXMLRegex	Regex to parse node class id from xml data.
Protected property	ResultBuilder	Result builder (Inherited from HierarchyHelper.)
Protected property	Settings	Settings (Inherited from HierarchyHelper.)