Click or drag to resize
UIHelper Class
UI helper methods.
Inheritance Hierarchy
SystemObject
  CMS.HelpersUIHelper

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 8.2.23
Syntax
C#
public class UIHelper

The UIHelper type exposes the following members.

Constructors
  NameDescription
Public methodUIHelper
Top
Methods
  NameDescription
Public methodStatic memberEnsureTooltip
Ensures tooltip for given control.
Public methodStatic memberGetAccessDeniedUrl(String)
Gets URL for the info page which displays specified access denied message.
Public methodStatic memberGetAccessDeniedUrl(String, String, String, String, String)
Gets the URL to Access denied page
Public methodStatic memberGetAccessibleIconTag
Gets accessible-friendly font icon and screen reader representation.
Public methodStatic memberGetAccessibleImageMarkup
Returns accessible-friendly image markup based on image URL or font icon class.
Public methodStatic memberGetAccessibleImageTag
Gets accessible-friendly image tag.
Public methodStatic memberGetAdministrationPath
Gets administration path - custom, or default (if custom not set).
Public methodStatic memberGetAdministrationUrl
Get administration Url (starts with ~/) - custom, or default (if custom not set)
Public methodStatic memberGetCustomAdministrationPath
Gets custom administration path, or empty string if not set.
Public methodStatic memberGetDocumentTypeIcon
Returns HTML markup representing document type icon.
Public methodStatic memberGetDocumentTypeIconPath
Returns path to the icon image for the specified document type.
Public methodStatic memberGetDocumentTypeIconUrl(Page, String, Boolean)
Returns resolved path to the icon image for the specified document type.
Public methodStatic memberGetDocumentTypeIconUrl(Page, String, String, Boolean, Boolean)
Returns resolved path to the icon image for the specified document type.
Public methodStatic memberGetFileIcon
Returns HTML markup representing document type icon.
Public methodStatic memberGetFileIconClass
Returns font icon class for specified file extension
Public methodStatic memberGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
Public methodStatic memberGetImagePath
Gets UI image path.
Public methodStatic memberGetImageUrl
Gets UI image path.
Public methodStatic memberGetInformationUrl
Gets URL for the info page which displays specified message.
Public methodStatic memberGetShortImageUrl
Gets the
Public methodStatic memberGetTooltip
Gets tooltip body HTML.
Public methodStatic memberGetTooltipAttributes
Gets tooltip onmouseover and onmouseout attributes.
Public methodStatic memberIsFriendsModuleEnabled
Indicates if friends functionality is enabled.
Public methodStatic memberIsUIPersonalizationEnabled
Determines whether UI personalization is enabled for the specified site.
Public methodStatic memberIsUnavailableUIHidden
Determines whether the user interface, which is unavailable due to the licence, should be hidden from all sites.
Public methodStatic memberMapZippedImages
Maps the zipped images folder
Public methodStatic memberResolveImageUrl
Resolves the path to an image
Public methodStatic memberSetBreadcrumbsSuffix
Sets breadcrumbs suffix
Public methodStatic memberShortImageRedirect
Redirects the file to the images folder.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Public fieldStatic memberACCESSDENIED_PAGE
General access denied page
Public fieldStatic memberADMIN_ACCESSDENIED_PAGE
Access denied page for administration
Public fieldStatic memberDEFAULT_ADMINISTRATION_PATH
Administration UI path
Public fieldStatic memberFLAG_ICONS
Small flag icons
Public fieldStatic memberFLAG_ICONS_48
Flag icons for size 48x48
Public fieldStatic memberTREE_ICONS
Tree icons
Public fieldStatic memberTREE_ICONS_RTL
Tree icons for RTL layout
Public fieldStatic memberUNIGRID_ICONS
UniGrid icons
Top
Properties
  NameDescription
Public propertyStatic memberAllowUpdateProgress
If true, progress script is allowed on page.
Public propertyStatic memberClassicDialogs
Indicates whether classic or new (iframe) dialogs should be used throughout UI.
Top
See Also