The DocumentHierarchyHelper type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
 | DocumentHierarchyHelper |
Creates new instance of CMSHierarchyHelper which can be used to serialize given object.
|
Methods
| Name | Description | |
|---|---|---|
| DataAvailable |
Returns true if the data can be exported
(Overrides HierarchyHelper DataAvailable .) |
 |  Equals | (Inherited from Object.) |
| ExportObject |
Returns XML representation of given instance of info object.
(Inherited from HierarchyHelper.) |
 | ExportObject(ExportObjectSettings, TreeNode) |
Returns XML representation of given instance of info object.
|
| ExportObjectData |
Exports the object data
(Overrides HierarchyHelper ExportObjectData .) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetMetadataSource |
Gets the metadata source object
(Overrides HierarchyHelper GetMetadataSource .) |
| GetNodeClassName(String, ExportFormatEnum) |
Parses NodeClassName from node data.
|
| GetNodeClassName(String, ExportFormatEnum, Boolean) |
Parses NodeClassName from node data.
|
| GetSyndicationItem |
Gets the syndication item created from current object
(Overrides HierarchyHelper GetSyndicationItem(SyndicationContent).) |
| GetType | Gets the (Inherited from Type of the current instance.Object.) |
| LoadObjectFromDataSet(TreeNode, DataSet, Boolean, List String , List String ) |
Loads object data including collection from a given data set.
|
| LoadObjectFromDataSet(TreeNode, DataSet, Boolean, Int32, List String , List String ) |
Loads TreeNode data including collection from a given data set.
|
| LoadObjectFromJSON |
Loads objects data including collection from a given XML representation.
|
| LoadObjectFromXML |
Loads objects data including collection from a given XML representation.
|
| MemberwiseClone | Creates a shallow copy of the current (Inherited from Object.Object.) |
| ProcessArraySeparatorMethod |
Handles array separator of the collection export.
(Inherited from HierarchyHelper.) |
| ProcessEndCollectionMethod |
Handles end of the collection export.
(Inherited from HierarchyHelper.) |
| ProcessIDMethod |
Handles FK ID (can be used to fill translation helper for example).
(Inherited from HierarchyHelper.) |
| ProcessItemMethod |
Handles FK ID (can be used to fill translation helper for example).
(Inherited from HierarchyHelper.) |
| ProcessObjectMethod |
Handles export to required format.
(Overrides HierarchyHelper ProcessObjectMethod(TraverseObjectSettings, ICMSObject, Int32).) |
| ProcessStartCollectionMethod |
Handles start of the collection export.
(Inherited from HierarchyHelper.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TraverseObjectStructure |
Returns XML representation of given instance of tree node.
|
Extension Methods
| Name | Description | |
|---|---|---|
 | AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) |
| GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Properties
| Name | Description | |
|---|---|---|
 | NodeClassJSONRegex |
Regex to parse node class id from JSON data.
|
| NodeClassXMLRegex |
Regex to parse node class id from xml data.
|
 | ResultBuilder |
Result builder
(Inherited from HierarchyHelper.) |
| Settings |
Settings
(Inherited from HierarchyHelper.) |
See Also