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

Syntax

public class DocumentUIHelper

The DocumentUIHelper type exposes the following members.

Constructors

	Name	Description
Public method	DocumentUIHelper

Fields

	Name	Description
Public field Static member	PAGE_ELEMENT_NAME	Name of the Page element.

Methods

	Name	Description
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	EnsureDocumentBreadcrumbs	Ensures current document breadcrumbs (non-clickable)
Public method Static member	GetAbsolutePageUrl	Gets absolute URL of given page in the given culture for administration.
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	GetDocumentEditUrl	Gets link to edit document in Administration.
Public method Static member	GetDocumentMarkImage	Gets document mark image tag.
Public method Static member	GetDocumentMarks	Gets document mark image tag.
Public method Static member	GetDocumentPageUrl(UIPageURLSettings)	Gets page URL for the user interface.
Public method Static member	GetDocumentPageUrl(UIPageURLSettings, Func<UIPageURLSettings, String>)	Gets page URL for the user interface.
Public method Static member	GetHomePageUrl	Gets absolute URL of home page for specified parameters.
Public method Static member	GetNewCultureVersionPageUrl	Gets URL for new document language version page.
Public method Static member	GetPageHandlerLivePath	Returns a relative URL path to PresentationUrlRedirect handler with parameters based on which the page live site URL can be generated when needed.
Public method Static member	GetPageHandlerPreviewPath	Returns a relative URL path to PresentationUrlRedirect handler with parameters based on which the page preview URL can be generated when needed.
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	GetPageNotAvailableUrl	Gets page not available url with proper reason why the page cannot be displayed.
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	IconsUsed	Returns true if any of the icon is used
Public method Static member	IsElementHiddenForNode	Returns true if element should be hidden when editing specific tree node.
Public method Static member	IsIconUsed	Returns true if icon type is enabled
Public method Static member	TransformToCompareUrl	Transforms given URL to its compare variant using UIContext.SplitModeCultureCode.