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: 13.0.131

Syntax

public class DocumentHierarchyHelper : HierarchyHelper

The DocumentHierarchyHelper type exposes the following members.

Constructors

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

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

Methods

	Name	Description
Protected method	CallEndCollection(TraverseObjectSettings, String)	Calls given delegate with required parameters if delegate is not null. (Inherited from HierarchyHelper.)
Protected method	CallEndCollection(TraverseObjectSettings, String, Boolean)	Calls given delegate with required parameters if delegate is not null. (Inherited from HierarchyHelper.)
Protected method	CallItemCallback	Calls item callback if exists. (Inherited from HierarchyHelper.)
Protected method	CallObjectCallback	Calls object callback if exists. (Inherited from HierarchyHelper.)
Protected method	CallStartCollection(TraverseObjectSettings, String)	Calls given delegate with required parameters if delegate is not null. (Inherited from HierarchyHelper.)
Protected method	CallStartCollection(TraverseObjectSettings, String, Boolean)	Calls given delegate with required parameters if delegate is not null. (Inherited from HierarchyHelper.)
Protected method	DataAvailable	Returns true if the data can be exported (Overrides HierarchyHelper.DataAvailable().)
Protected method	ExportCategoryObjects	Exports categories data to given StringBuilder object. (Inherited from HierarchyHelper.)
Public method	ExportObject()	Returns XML representation of given instance of info object. (Inherited from HierarchyHelper.)
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 JSON 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	TraverseNodeStructure(TraverseObjectSettings, TreeNode)	Traverses hierarchical structure of tree node and processes ID callbacks.
Protected method	TraverseNodeStructure(TraverseObjectSettings, TreeNode, Int32)	Traverses hierarchical structure of tree node and processes ID callbacks.
Protected method	TraverseObjectCollection	Exports given child collection. (Inherited from HierarchyHelper.)
Protected method	TraverseObjectStructure(TraverseObjectSettings, GeneralizedInfo, Int32)	Goes through the object structure and calls given delegates. (Inherited from HierarchyHelper.)