DocumentUIHelper Class

Helper methods for document management UI

Inheritance Hierarchy

System.Object
  CMS.UIControls.DocumentUIHelper

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23

Syntax

public class DocumentUIHelper

The DocumentUIHelper type exposes the following members.

Constructors

	Name	Description
Public method	DocumentUIHelper

Methods

	Name	Description
Public method Static member	EnsureDocumentBreadcrumbs	Ensures current document breadcrumbs (non-clickable)
Public method Static member	GetDocumentActionPageUrl	Gets UI page page URL for document action.
Public method Static member	GetDocumentDialogConfig	Creates DialogConfiguration object for specified document action.
Public method Static member	GetDocumentPageUrl(UIPageURLSettings)	Gets UI page page URL.
Public method Static member	GetDocumentPageUrl(UIPageURLSettings, Func<UIPageURLSettings, String>)	Gets UI page page URL.
Public method Static member	GetNewCultureVersionPageUrl	Gets URL for new document language version page.
Public method Static member	GetPageNotAvailable(String, String)	Gets URL for new document language version page.
Public method Static member	GetPageNotAvailable(String, Boolean, String)	Gets URL for new document language version page.
Public method Static member	GetSplitViewUrl	Gets URL for the split view mode.
Public method Static member	GetViewPageUrl	Gets the view page URL
Public method Static member	GetViewValidateUrl	Gets URL for the view validate page.
Public method Static member	CheckDocumentPermissions(ICMSDocumentManager)	Checks document permissions regarding the document manager mode and optionally redirects to access denied page
Public method Static member	CheckDocumentPermissions(PermissionsEnum, TreeNode)	Checks currently edited document permissions and optionally redirects to access denied page
Public method Static member	CheckDocumentPermissions(TreeNode, PermissionsEnum)	Checks document permissions
Public method Static member	TransformToCompareUrl	Transforms given URL to its compare variant using UIContext.SplitModeCultureCode.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)