Click or drag to resize
DocumentHierarchyHelper Class
Object hierarchy manipulation methods.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineHierarchyHelper
    CMS.DocumentEngineDocumentHierarchyHelper

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 8.2.23
Syntax
C#
public class DocumentHierarchyHelper : HierarchyHelper

The DocumentHierarchyHelper type exposes the following members.

Constructors
  NameDescription
Protected methodDocumentHierarchyHelper
Creates new instance of CMSHierarchyHelper which can be used to serialize given object.
Top
Methods
  NameDescription
Protected methodDataAvailable
Returns true if the data can be exported
(Overrides HierarchyHelperDataAvailable.)
Public methodExportObject
Returns XML representation of given instance of info object.
(Inherited from HierarchyHelper.)
Public methodStatic memberExportObject(ExportObjectSettings, TreeNode)
Returns XML representation of given instance of info object.
Protected methodExportObjectData
Exports the object data
(Overrides HierarchyHelperExportObjectData.)
Protected methodGetMetadataSource
Gets the metadata source object
(Overrides HierarchyHelperGetMetadataSource.)
Public methodStatic memberGetNodeClassName(String, ExportFormatEnum)
Parses NodeClassName from node data.
Public methodStatic memberGetNodeClassName(String, ExportFormatEnum, Boolean)
Parses NodeClassName from node data.
Protected methodGetSyndicationItem
Gets the syndication item created from current object
(Overrides HierarchyHelperGetSyndicationItem(SyndicationContent).)
Public methodStatic memberLoadObjectFromDataSet(TreeNode, DataSet, Boolean, ListString, ListString)
Loads object data including collection from a given data set.
Protected methodStatic memberLoadObjectFromDataSet(TreeNode, DataSet, Boolean, Int32, ListString, ListString)
Loads TreeNode data including collection from a given data set.
Public methodStatic memberLoadObjectFromJSON
Loads objects data including collection from a given XML representation.
Public methodStatic memberLoadObjectFromXML
Loads objects data including collection from a given XML representation.
Protected methodProcessArraySeparatorMethod
Handles array separator of the collection export.
(Inherited from HierarchyHelper.)
Protected methodProcessEndCollectionMethod
Handles end of the collection export.
(Inherited from HierarchyHelper.)
Protected methodProcessIDMethod
Handles FK ID (can be used to fill translation helper for example).
(Inherited from HierarchyHelper.)
Protected methodProcessItemMethod
Handles FK ID (can be used to fill translation helper for example).
(Inherited from HierarchyHelper.)
Protected methodProcessObjectMethod
Handles export to required format.
(Overrides HierarchyHelperProcessObjectMethod(TraverseObjectSettings, ICMSObject, Int32).)
Protected methodProcessStartCollectionMethod
Handles start of the collection export.
(Inherited from HierarchyHelper.)
Public methodStatic memberTraverseObjectStructure
Returns XML representation of given instance of tree node.
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
Properties
  NameDescription
Public propertyStatic memberNodeClassJSONRegex
Regex to parse node class id from JSON data.
Public propertyStatic memberNodeClassXMLRegex
Regex to parse node class id from xml data.
Protected propertyResultBuilder
Result builder
(Inherited from HierarchyHelper.)
Protected propertySettings
Settings
(Inherited from HierarchyHelper.)
Top
See Also