UIContextHelper Class

Class helper for context's methods.

Inheritance Hierarchy

System.Object
  CMS.FormEngine.Web.UI.UIContextHelper

Namespace: CMS.FormEngine.Web.UI
Assembly: CMS.FormEngine.Web.UI (in CMS.FormEngine.Web.UI.dll) Version: 11.0.0

Syntax

public class UIContextHelper

The UIContextHelper type exposes the following members.

Constructors

	Name	Description
Public method	UIContextHelper

Fields

	Name	Description
Public field Static member	GRIDDIRECTORY	Default directory for uni grids definitions
Public field Static member	QUERY_STRING_KEY	Represents key for storing query string

Methods

	Name	Description
Public method Static member	AppendDialogHash	Appends hash to URL if context contains dialog parameter
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	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	FindElementFeature	Returns element feature. If feature is empty, tries to find it from parents.
Public method Static member	GetApplicationDescriptionUrl	Returns URL to Application description for given element. If provided element doesn't have an application, empty string is returned.
Public method Static member	GetElementBreadcrumbsSuffix	Gets UI element breadcrumbs suffix.
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	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).