UIContextHelper Class

Class helper for context's methods.

Inheritance Hierarchy

System.Object
  CMS.PortalEngine.UIContextHelper

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

Syntax

public class UIContextHelper

The UIContextHelper type exposes the following members.

Constructors

	Name	Description
Public method	UIContextHelper

Methods

	Name	Description
Public method Static member	AppendDialogHash(String)	Appends hash to URL. Used in selectors (no need for dialog mode).
Public method Static member	AppendDialogHash(UIContext, String)	Appends hash to URL if context contains dialog parameter
Public method Static member	CorrectChildParentRelations	Appends URL suffix to element's url. Replace objectID for parentobjectID if object types are different (parent-child)
Public method Static member	ElementIsLayout	Indicates if UI element contains template with IsLayout checked.
Public method Static member	EnsureBootstrapBodyClass	Ensures the bootstrap css class for specified body css class string if it is allowed for view mode.
Public method Static member	EnsureBootstrapJavaScript	Ensures the bootstrap JavaScript files for specified page if it is allowed for view mode.
Public method Static member	FindElementFeature	Returns element feature. If feature is empty, tries to find it from parents.
Public method Static member	GetApplicationDescriptionLink	Returns link to Application description for given element. If provided element doesn't have an application, empty string is returned.
Public method Static member	GetApplicationHash(UIElementInfo)	Gets the application hash (starting with #)
Public method Static member	GetApplicationHash(String, String)	Gets the application hash (starting with #)
Public method Static member	GetApplicationUrl(UIElementInfo, String)	Returns application URL for application specified by UI element object
Public method Static member	GetApplicationUrl(String, String, String)	Returns application URL for application specified by module name and element name
Public method Static member	GetClassAlternativeFormsLink	Returns the link icon to the management of the module UI elements
Public method Static member	GetClassFieldsLink	Returns the link icon to the management of the module UI elements
Public method Static member	GetDocumentationRootUrl	Obsolete. Gets URL for product documentation root.
Public method Static member	GetDocumentationSearchUrlPattern	Obsolete. Gets URL pattern for product documentation search. Pass searched text as 0th substitution.
Public method Static member	GetDocumentationTopicUrl	Obsolete. Gets URL for product documentation topic. Topic is either a topic ID, or an absolute URL.
Public method Static member	GetEditLink	Returns the link icon to the management of the module UI elements
Public method Static member	GetElementBreadcrumbsSuffix	Gets UI element breadcrumbs suffix.
Public method Static member	GetElementDialogUrl(UIElementInfo, Int32, String)	Returns dialog UI element URL, appends automatically Dialog and Hash parameters.
Public method Static member	GetElementDialogUrl(String, String, Int32, String)	Returns dialog UI element URL, appends automatically Dialog and Hash parameters.
Public method Static member	GetElementUrl()	Returns basic UIPage with no parameters. Use only in special cases, in most cases use GetElementUrl with parameters.
Public method Static member	GetElementUrl(UIElementInfo, UIContext)	Returns element's url based on elements type
Public method Static member	GetElementUrl(String, String, UIContext)	Returns element's url based on element's type
Public method Static member	GetElementUrl(UIElementInfo, Boolean, Int32, String)	Returns element's URL
Public method Static member	GetElementUrl(String, String, Boolean, Int32, String)	Returns element's URL
Public method Static member	GetObjectBreadcrumbsText	Returns object's breadcrumbs text.
Public method Static member	GetObjectType	Gets object type of (created)edited object (if any)
Public method Static member	GetResourceName	Returns resource name for given resource ID.
Public method Static member	GetResourceUIElementLink	Returns the link icon to the management of the module UI element
Public method Static member	GetResourceUIElementsLink	Returns the link icon to the management of the module UI elements
Public method Static member	GetTitleText	Gets title text based on 'titletext' property. If this property is not found, use element's caption (not localized).
Public method Static member	GetUIContext	Returns control's UI context. If no parent control contains own UI context, use main page's (stored in request stock helper).
Public method Static member	CheckElementAccess	Checks permission and access condition condition for single UI element. If element's ElementCheckModuleReadPermission property and automaticReadCheck are set, read permission for element's module is also checked.
Public method Static member	CheckElementAvailabilityInUI	Checks the UI element availability. This check includes evaluation of the element's macro condition, license check of the element's feature and check if the element's resource (module) is available.
Public method Static member	CheckElementVisibilityCondition	Checks visibility condition for the given UI element
Public method Static member	CheckFeatureAvailableInUI	Checks for element's feature availability for UI.
Public method Static member	CheckSelectedElement	Checks if given element is parent of selected element (based by ID path)
Public method Static member	CheckUIElementAccessHierarchical	Checks the permissions of all UI elements hierarchically starting with specified UI element (with optional custom root element).
Public method Static member	IsInGlobalApplicationScope	Indicates whether current element is in Global application scope (current or parent)
Public method Static member	RegisterAdminRedirectScript	Registers reload script for administration interface with possibility to specify target URL
Public method Static member	RegisterApplicationStorageScript	Register application storage script. The current application is stored in browser storage for later use.

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	AFTERPROPERTIESDEFINITION	Definition of 'after' properties for every UI element.
Public field Static member	BEFOREPROPERTIESDEFINITION	Definition of 'before' properties for every UI element.
Public field Static member	GRIDDIRECTORY	Default directory for uni grids definitions