| TreePathUtils Methods |
The TreePathUtils type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | AllowPermanentPreviewLink |
Returns true if document workflow cycle GUID shouldn't be changed when moving from publish/archive step to edit step.
|
| AutomaticallyUpdateDocumentAlias |
Returns true if the document alias should be automatically updated upon document name change.
|
| EnsureChildPath |
Ensures path to be for all child pages.
|
| EnsureMaxFileNameLength |
Ensures maximal length of the file name. Reflects the class node name source field size.
|
| EnsureMaxNodeAliasLength |
Ensures maximal allowed node alias length.
|
| EnsureMaxNodeNameLength |
Ensures maximal length of the node document name. Reflects the class node name source field size.
|
| EnsureSingleNodePath |
Ensures node alias path to be only for single document.
|
| EnsureSinglePath |
Ensures path to be only for a single page.
|
| GetAlias |
Returns the alias from the given alias path.
|
| GetAliasPathByNodeId |
Returns the AliasPath equivalent for the given node ID.
|
| GetAliasPathCondition |
Returns the where condition for node alias path expression.
|
| GetClassNameByAliasPath |
Returns the node class name corresponding to the given aliasPath.
|
| GetClassNameByDocumentID |
Returns the node class name corresponding to the given document ID.
|
| GetDocumentIdByDocumentGUID |
Returns the Document ID equivalent for the given document GUID.
|
| GetDocumentSite |
Returns the site info of the specified original document ID.
|
| GetDocumentUrl |
Returns document URL.
|
| GetFilesUrlExtension |
Returns files URL extension used for friendly URLs for specified site.
|
| GetFirstChildUrl |
Gets first child document URL
|
| GetMaxNameLength |
Gets maximal length of the node document name. Reflects the class node name source field size.
|
| GetMenuCaption |
Returns the menu caption.
|
| GetNodeByAliasPath |
Gets the base node record (CMS_Tree) by the alias path and site name.
|
| GetNodeGUIDByNodeId |
Returns the Node GUID equivalent for the given node ID.
|
| GetNodeIdByAliasPath |
Returns the node ID corresponding to the given aliasPath.
|
| GetNodeIdByNodeGUID |
Returns the Node ID equivalent for the given node GUID.
|
| GetNodeParentId |
Returns the parent node ID.
|
| GetNodeSite |
Returns the site info of the specified node.
|
| GetParentPath(String) |
Returns the parent path for the specified path (any kind of path with "/" as a separator)
|
| GetParentPath(String, Int32) |
Returns the parent path for the specified path, with distance of parentLevel from the given path.
|
| GetParentPathRestricted |
Returns the parent path for the specified path (any kind of path with "/" as a separator) with restriction on depth of the path
|
| GetPathLevel |
Returns the specified path level created from the given path.
|
| GetRedirectionUrl(PageInfo, MacroResolver) |
Gets relative redirection URL based on given settings
|
| GetRedirectionUrl(String, String, String, String, Boolean, MacroResolver) |
Gets relative redirection URL based on given settings
|
| GetSafeDocumentName |
Replaces back slash in document name.
|
| GetSafeNodeAlias |
Returns node alias without forbidden characters.
|
| GetSafeNodeAliasPath |
Returns node alias path without forbidden characters.
|
| GetSafeUrlPath |
Returns the URL path without forbidden characters and trimmed to the maximal allowed length.
|
| GetUniqueNodeAlias |
Returns the unique node alias for the given node, node alias and parent node.
|
| GetUniqueNodeName |
Returns the unique node name for the given node, node name and parent node.
|
| GetUniqueUrlPath |
Gets the safe unique URL path for the specified document. Safe URL path means that the forbidden characters are removed from the path parts,
the path is trimmed to the maximal allowed length and the parts correspond with level of nesting.
|
| GetUrlExtension |
Returns URL extension used for friendly URLs for specified site.
|
| GetUrlPathDisplayName |
Gets the URL path display name
|
| GetUrlPathFromNamePath |
Returns the safe URL path for given document. Safe URL path means that the forbidden characters are removed from the path parts,
the path is trimmed to the maximal allowed length and the parts correspond with level of nesting.
|
| IsMenuItemType |
Returns true, if the class name is considered to be menu item type document.
|
| KeepChangedDocumentsAccessible |
Returns true if the documents should be accessible after change (if the alias should be automatically generated for them).
|
| NewDocumentOrder |
Returns the new document order settings for the given site.
|
| ParseUrlPath |
Parses the prefix and default values out of the URL path
|
| PathContainsWildcardChars |
Returns true if path contains wildcard characters(% or _)
|
| UseNamePathForUrlPath |
Returns true if the new documents should automatically use the name path for their URL path.
|
See Also