UIHelper Class

UI helper methods.

Inheritance Hierarchy

System.Object
  CMS.Helpers.UIHelper

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

Syntax

public class UIHelper

The UIHelper type exposes the following members.

Constructors

	Name	Description
Public method	UIHelper

Methods

	Name	Description
Public method Static member	EnsureTooltip	Ensures tooltip for given control.
Public method Static member	GetAccessDeniedUrl(String)	Gets URL for the info page which displays specified access denied message.
Public method Static member	GetAccessDeniedUrl(String, String, String, String, String)	Gets the URL to Access denied page
Public method Static member	GetAccessibleIconTag	Gets accessible-friendly font icon and screen reader representation.
Public method Static member	GetAccessibleImageMarkup	Returns accessible-friendly image markup based on image URL or font icon class.
Public method Static member	GetAccessibleImageTag	Gets accessible-friendly image tag.
Public method Static member	GetAdministrationPath	Gets administration path - custom, or default (if custom not set).
Public method Static member	GetAdministrationUrl	Get administration Url (starts with ~/) - custom, or default (if custom not set)
Public method Static member	GetCustomAdministrationPath	Gets custom administration path, or empty string if not set.
Public method Static member	GetDocumentTypeIcon	Returns HTML markup representing document type icon.
Public method Static member	GetDocumentTypeIconPath	Returns path to the icon image for the specified document type.
Public method Static member	GetDocumentTypeIconUrl(Page, String, Boolean)	Returns resolved path to the icon image for the specified document type.
Public method Static member	GetDocumentTypeIconUrl(Page, String, String, Boolean, Boolean)	Returns resolved path to the icon image for the specified document type.
Public method Static member	GetFileIcon	Returns HTML markup representing document type icon.
Public method Static member	GetFileIconClass	Returns font icon class for specified file extension
Public method Static member	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture.
Public method Static member	GetImagePath	Gets UI image path.
Public method Static member	GetImageUrl	Gets UI image path.
Public method Static member	GetInformationUrl	Gets URL for the info page which displays specified message.
Public method Static member	GetShortImageUrl	Gets the
Public method Static member	GetTooltip	Gets tooltip body HTML.
Public method Static member	GetTooltipAttributes	Gets tooltip onmouseover and onmouseout attributes.
Public method Static member	IsFriendsModuleEnabled	Indicates if friends functionality is enabled.
Public method Static member	IsUIPersonalizationEnabled	Determines whether UI personalization is enabled for the specified site.
Public method Static member	IsUnavailableUIHidden	Determines whether the user interface, which is unavailable due to the licence, should be hidden from all sites.
Public method Static member	MapZippedImages	Maps the zipped images folder
Public method Static member	ResolveImageUrl	Resolves the path to an image
Public method Static member	SetBreadcrumbsSuffix	Sets breadcrumbs suffix
Public method Static member	ShortImageRedirect	Redirects the file to the images folder.

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.)

Fields

	Name	Description
Public field Static member	ACCESSDENIED_PAGE	General access denied page
Public field Static member	ADMIN_ACCESSDENIED_PAGE	Access denied page for administration
Public field Static member	DEFAULT_ADMINISTRATION_PATH	Administration UI path
Public field Static member	FLAG_ICONS	Small flag icons
Public field Static member	FLAG_ICONS_48	Flag icons for size 48x48
Public field Static member	TREE_ICONS	Tree icons
Public field Static member	TREE_ICONS_RTL	Tree icons for RTL layout
Public field Static member	UNIGRID_ICONS	UniGrid icons

Properties

	Name	Description
Public property Static member	AllowUpdateProgress	If true, progress script is allowed on page.
Public property Static member	ClassicDialogs	Indicates whether classic or new (iframe) dialogs should be used throughout UI.