TreePathUtils Class

Provides static helper methods for converting and validating paths, aliases and names.

Inheritance Hierarchy

System.Object
  CMS.DocumentEngine.TreePathUtils

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 13.0.131

Syntax

public static class TreePathUtils

The TreePathUtils type exposes the following members.

Fields

	Name	Description
Public field Static member	MAX_NAME_LENGTH	Maximal length of the node document name.

Properties

	Name	Description
Public property Static member	MaxAliasLength	Maximal length of the node alias name.
Public property Static member	MaxNameLength	Maximal length of the node document name.
Public property Static member	RemoveDiacriticForSafeURLPath	Indicates if diacritics should be removed from the URL path.

Methods

	Name	Description
Public method Static member	AllowPermanentPreviewLink	Returns true if document workflow cycle GUID shouldn't be changed when moving from publish/archive step to edit step.
Public method Static member	AutomaticallyUpdateDocumentAlias	Returns true if the document alias should be automatically updated upon document name change.
Public method Static member	EnsureChildPath	Ensures path to be for all child pages.
Public method Static member	EnsureMaxFileNameLength	Ensures maximal length of the file name. Reflects the class node name source field size.
Public method Static member	EnsureMaxNodeAliasLength	Ensures maximal allowed node alias length.
Public method Static member	EnsureMaxNodeNameLength	Ensures maximal length of the node document name. Reflects the class node name source field size.
Public method Static member	EnsureSingleNodePath	Ensures node alias path to be only for single document.
Public method Static member	EnsureSinglePath	Ensures path to be only for a single page.
Public method Static member	ExistsLinkedPageInSubTree	Return true if the specified subtree contains any linked page.
Public method Static member	GetAlias	Returns the alias from the given alias path.
Public method Static member	GetAliasPathByNodeId	Returns the AliasPath equivalent for the given node ID.
Public method Static member	GetAliasPathCondition	Returns the where condition for node alias path expression.
Public method Static member	GetClassNameByDocumentID	Returns the node class name corresponding to the given document ID.
Public method Static member	GetDocumentIdByDocumentGUID	Returns the Document ID equivalent for the given document GUID.
Public method Static member	GetDocumentSite	Returns the site info of the specified original document ID.
Public method Static member	GetMaxNameLength	Gets maximal length of the node document name. Reflects the class node name source field size.
Public method Static member	GetNodeAliasPathsOnPath	Gets list of node alias paths for all documents on given path.
Public method Static member	GetNodeByAliasPath	Gets the base node record (CMS_Tree) by the alias path and site name.
Public method Static member	GetNodeGUIDByNodeId	Returns the Node GUID equivalent for the given node ID.
Public method Static member	GetNodeIdByAliasPath	Returns the node ID corresponding to the given aliasPath.
Public method Static member	GetNodeIdByNodeGUID	Returns the Node ID equivalent for the given node GUID.
Public method Static member	GetNodeInheritedValue	Gets the inherited value for a single document column.
Public method Static member	GetNodeParentId	Returns the parent node ID.
Public method Static member	GetNodeSite	Returns the site info of the specified node.
Public method Static member	GetNodesOnPathWhereCondition	Returns where condition for all nodes on the path to the given alias path.
Public method Static member	GetParentPath(String)	Returns the parent path for the specified path (any kind of path with "/" as a separator)
Public method Static member	GetParentPath(String, Int32)	Returns the parent path for the specified path, with distance of parentLevel from the given path.
Public method Static member	GetPathLevel	Returns the specified path level created from the given path.
Public method Static member	GetSafeDocumentName	Replaces back slash in document name.
Public method Static member	GetSafeNodeAlias	Returns node alias without forbidden characters.
Public method Static member	GetUniqueNodeAlias	Returns the unique node alias for the given node, node alias and parent node.
Public method Static member	GetUniqueNodeName	Returns the unique node name for the given node, node name and parent node.
Public method Static member	IsMenuItemType	Returns true, if the class name is considered to be menu item type document.
Public method Static member	NewDocumentOrder	Returns the new document order settings for the given site.