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: 9.0.0

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.
Public field Static member	MAXURLPATHLENGTH	Maximal length of the node URLPath.
Public field Static member	URL_PREFIX_MVC	URL prefix for the MVC
Public field Static member	URL_PREFIX_ROUTE	URL prefix for the Routing

Properties

	Name	Description
Public property Static member	AllowedURLPathValues	Returns string containing allowed characters that cant be used in URL path.
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	MaxURLPathLength	Maximal length of the URL path.
Public property Static member	RemoveDiacriticForSafeURLPath	Indicates if diacritics should be removed from the URL path.
Public property Static member	UseLimitURLReplacements	Gets the value that indicates whether whether multiple, starting and trailing replacements should be limited.

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	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	GetClassNameByAliasPath	Returns the node class name corresponding to the given aliasPath.
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	GetDocumentUrl	Returns document URL.
Public method Static member	GetFilesUrlExtension	Returns files URL extension used for friendly URLs for specified site.
Public method Static member	GetFirstChildUrl	Gets first child document URL
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	GetMenuCaption	Returns the menu caption.
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	GetNodeParentId	Returns the parent node ID.
Public method Static member	GetNodeSite	Returns the site info of the specified node.
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	GetParentPathRestricted	Returns the parent path for the specified path (any kind of path with "/" as a separator) with restriction on depth of the path
Public method Static member	GetPathLevel	Returns the specified path level created from the given path.
Public method Static member	GetRedirectionUrl(PageInfo, MacroResolver)	Gets relative redirection URL based on given settings
Public method Static member	GetRedirectionUrl(String, String, String, String, Boolean, MacroResolver)	Gets relative redirection URL based on given settings
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	GetSafeNodeAliasPath	Returns node alias path without forbidden characters.
Public method Static member	GetSafeUrlPath	Returns the URL path without forbidden characters and trimmed to the maximal allowed length.
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	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.
Public method Static member	GetUrlExtension	Returns URL extension used for friendly URLs for specified site.
Public method Static member	GetUrlPathDisplayName	Gets the URL path display name
Public method Static member	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.
Public method Static member	IsMenuItemType	Returns true, if the class name is considered to be menu item type document.
Public method Static member	KeepChangedDocumentsAccessible	Returns true if the documents should be accessible after change (if the alias should be automatically generated for them).
Public method Static member	NewDocumentOrder	Returns the new document order settings for the given site.
Public method Static member	ParseUrlPath	Parses the prefix and default values out of the URL path
Public method Static member	PathContainsWildcardChars	Returns true if path contains wildcard characters(% or _)
Public method Static member	UseNamePathForUrlPath	Returns true if the new documents should automatically use the name path for their URL path.