DocumentHierarchyHelper MembersKentico 8.0 API Reference
The DocumentHierarchyHelper type exposes the following members.
Constructors

  NameDescription
Protected methodDocumentHierarchyHelper
Creates new instance of CMSHierarchyHelper which can be used to serialize given object.
Back to Top
Methods

  NameDescription
Protected methodDataAvailable
Returns true if the data can be exported
(Overrides HierarchyHelper DataAvailable .)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
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 HierarchyHelper ExportObjectData .)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Protected methodGetMetadataSource
Gets the metadata source object
(Overrides HierarchyHelper GetMetadataSource .)
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 HierarchyHelper GetSyndicationItem(SyndicationContent).)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodStatic memberLoadObjectFromDataSet(TreeNode, DataSet, Boolean, List String , List String )
Loads object data including collection from a given data set.
Protected methodStatic memberLoadObjectFromDataSet(TreeNode, DataSet, Boolean, Int32, List String , List String )
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 methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
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 HierarchyHelper ProcessObjectMethod(TraverseObjectSettings, ICMSObject, Int32).)
Protected methodProcessStartCollectionMethod
Handles start of the collection export.
(Inherited from HierarchyHelper.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Public methodStatic memberTraverseObjectStructure
Returns XML representation of given instance of tree node.
Back to Top
Extension Methods

  NameDescription
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.)
Back to 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.)
Back to Top
See Also