Click or drag to resize
UIContextHelper Class
Class helper for context's methods.
Inheritance Hierarchy
SystemObject
  CMS.PortalEngineUIContextHelper

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

The UIContextHelper type exposes the following members.

Constructors
  NameDescription
Public methodUIContextHelper
Top
Methods
  NameDescription
Public methodStatic memberAppendDialogHash(String)
Appends hash to URL. Used in selectors (no need for dialog mode).
Public methodStatic memberAppendDialogHash(UIContext, String)
Appends hash to URL if context contains dialog parameter
Public methodStatic memberCorrectChildParentRelations
Appends URL suffix to element's url. Replace objectID for parentobjectID if object types are different (parent-child)
Public methodStatic memberElementIsLayout
Indicates if UI element contains template with IsLayout checked.
Public methodStatic memberEnsureBootstrapBodyClass
Ensures the bootstrap css class for specified body css class string if it is allowed for view mode.
Public methodStatic memberEnsureBootstrapJavaScript
Ensures the bootstrap JavaScript files for specified page if it is allowed for view mode.
Public methodStatic memberFindElementFeature
Returns element feature. If feature is empty, tries to find it from parents.
Public methodStatic memberGetApplicationDescriptionLink
Returns link to Application description for given element. If provided element doesn't have an application, empty string is returned.
Public methodStatic memberGetApplicationHash(UIElementInfo)
Gets the application hash (starting with #)
Public methodStatic memberGetApplicationHash(String, String)
Gets the application hash (starting with #)
Public methodStatic memberGetApplicationUrl(UIElementInfo, String)
Returns application URL for application specified by UI element object
Public methodStatic memberGetApplicationUrl(String, String, String)
Returns application URL for application specified by module name and element name
Public methodStatic memberGetClassAlternativeFormsLink
Returns the link icon to the management of the module UI elements
Public methodStatic memberGetClassFieldsLink
Returns the link icon to the management of the module UI elements
Public methodStatic memberGetDocumentationRootUrl Obsolete.
Gets URL for product documentation root.
Public methodStatic memberGetDocumentationSearchUrlPattern Obsolete.
Gets URL pattern for product documentation search. Pass searched text as 0th substitution.
Public methodStatic memberGetDocumentationTopicUrl Obsolete.
Gets URL for product documentation topic. Topic is either a topic ID, or an absolute URL.
Public methodStatic memberGetEditLink
Returns the link icon to the management of the module UI elements
Public methodStatic memberGetElementBreadcrumbsSuffix
Gets UI element breadcrumbs suffix.
Public methodStatic memberGetElementDialogUrl(UIElementInfo, Int32, String)
Returns dialog UI element URL, appends automatically Dialog and Hash parameters.
Public methodStatic memberGetElementDialogUrl(String, String, Int32, String)
Returns dialog UI element URL, appends automatically Dialog and Hash parameters.
Public methodStatic memberGetElementUrl
Returns basic UIPage with no parameters. Use only in special cases, in most cases use GetElementUrl with parameters.
Public methodStatic memberGetElementUrl(UIElementInfo, UIContext)
Returns element's url based on elements type
Public methodStatic memberGetElementUrl(String, String, UIContext)
Returns element's url based on element's type
Public methodStatic memberGetElementUrl(UIElementInfo, Boolean, Int32, String)
Returns element's URL
Public methodStatic memberGetElementUrl(String, String, Boolean, Int32, String)
Returns element's URL
Public methodStatic memberGetObjectBreadcrumbsText
Returns object's breadcrumbs text.
Public methodStatic memberGetObjectType
Gets object type of (created)edited object (if any)
Public methodStatic memberGetResourceName
Returns resource name for given resource ID.
Public methodStatic memberGetResourceUIElementLink
Returns the link icon to the management of the module UI element
Public methodStatic memberGetResourceUIElementsLink
Returns the link icon to the management of the module UI elements
Public methodStatic memberGetTitleText
Gets title text based on 'titletext' property. If this property is not found, use element's caption (not localized).
Public methodStatic memberGetUIContext
Returns control's UI context. If no parent control contains own UI context, use main page's (stored in request stock helper).
Public methodStatic memberCheckElementAccess
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 methodStatic memberCheckElementAvailabilityInUI
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 methodStatic memberCheckElementVisibilityCondition
Checks visibility condition for the given UI element
Public methodStatic memberCheckFeatureAvailableInUI
Checks for element's feature availability for UI.
Public methodStatic memberCheckSelectedElement
Checks if given element is parent of selected element (based by ID path)
Public methodStatic memberCheckUIElementAccessHierarchical
Checks the permissions of all UI elements hierarchically starting with specified UI element (with optional custom root element).
Public methodStatic memberIsInGlobalApplicationScope
Indicates whether current element is in Global application scope (current or parent)
Public methodStatic memberRegisterAdminRedirectScript
Registers reload script for administration interface with possibility to specify target URL
Public methodStatic memberRegisterApplicationStorageScript
Register application storage script. The current application is stored in browser storage for later use.
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 memberAFTERPROPERTIESDEFINITION
Definition of 'after' properties for every UI element.
Public fieldStatic memberBEFOREPROPERTIESDEFINITION
Definition of 'before' properties for every UI element.
Public fieldStatic memberGRIDDIRECTORY
Default directory for uni grids definitions
Top
See Also