| UIContextHelper Methods |
The UIContextHelper type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | AppendDialogHash(String) |
Appends hash to URL. Used in selectors (no need for dialog mode).
|
| AppendDialogHash(UIContext, String) |
Appends hash to URL if context contains dialog parameter
|
| CorrectChildParentRelations |
Appends URL suffix to element's url. Replace objectID for parentobjectID if object types are different (parent-child)
|
| ElementIsLayout |
Indicates if UI element contains template with IsLayout checked.
|
| EnsureBootstrapBodyClass |
Ensures the bootstrap css class for specified body css class string if it is allowed for view mode.
|
| EnsureBootstrapJavaScript |
Ensures the bootstrap JavaScript files for specified page if it is allowed for view mode.
|
| FindElementFeature |
Returns element feature. If feature is empty, tries to find it from parents.
|
| GetApplicationDescriptionLink |
Returns link to Application description for given element.
If provided element doesn't have an application, empty string is returned.
|
| GetApplicationHash(UIElementInfo) |
Gets the application hash (starting with #)
|
| GetApplicationHash(String, String) |
Gets the application hash (starting with #)
|
| GetApplicationUrl(UIElementInfo, String) |
Returns application URL for application specified by UI element object
|
| GetApplicationUrl(String, String, String) |
Returns application URL for application specified by module name and element name
|
| GetClassAlternativeFormsLink |
Returns the link icon to the management of the module UI elements
|
| GetClassFieldsLink |
Returns the link icon to the management of the module UI elements
|
| GetDocumentationRootUrl | Obsolete.
Gets URL for product documentation root.
|
| GetDocumentationSearchUrlPattern | Obsolete.
Gets URL pattern for product documentation search.
Pass searched text as 0th substitution.
|
| GetDocumentationTopicUrl | Obsolete.
Gets URL for product documentation topic. Topic is either a topic ID, or an absolute URL.
|
| GetEditLink |
Returns the link icon to the management of the module UI elements
|
| GetElementBreadcrumbsSuffix |
Gets UI element breadcrumbs suffix.
|
| GetElementDialogUrl(UIElementInfo, Int32, String) |
Returns dialog UI element URL, appends automatically Dialog and Hash parameters.
|
| GetElementDialogUrl(String, String, Int32, String) |
Returns dialog UI element URL, appends automatically Dialog and Hash parameters.
|
| GetElementUrl |
Returns basic UIPage with no parameters. Use only in special cases, in most cases use GetElementUrl with parameters.
|
| GetElementUrl(UIElementInfo, UIContext) |
Returns element's url based on elements type
|
| GetElementUrl(String, String, UIContext) |
Returns element's url based on element's type
|
| GetElementUrl(UIElementInfo, Boolean, Int32, String) |
Returns element's URL
|
| GetElementUrl(String, String, Boolean, Int32, String) |
Returns element's URL
|
| GetObjectBreadcrumbsText |
Returns object's breadcrumbs text.
|
| GetObjectType |
Gets object type of (created)edited object (if any)
|
| GetResourceName |
Returns resource name for given resource ID.
|
| GetResourceUIElementLink |
Returns the link icon to the management of the module UI element
|
| GetResourceUIElementsLink |
Returns the link icon to the management of the module UI elements
|
| GetTitleText |
Gets title text based on 'titletext' property. If this property is not found, use element's caption (not localized).
|
| GetUIContext |
Returns control's UI context. If no parent control contains own UI context, use main page's (stored in request stock helper).
|
| 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.
|
| 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.
|
| CheckElementVisibilityCondition |
Checks visibility condition for the given UI element
|
| CheckFeatureAvailableInUI |
Checks for element's feature availability for UI.
|
| CheckSelectedElement |
Checks if given element is parent of selected element (based by ID path)
|
| CheckUIElementAccessHierarchical |
Checks the permissions of all UI elements hierarchically starting with specified UI element (with optional custom root element).
|
| IsInGlobalApplicationScope |
Indicates whether current element is in Global application scope (current or parent)
|
| RegisterAdminRedirectScript |
Registers reload script for administration interface with possibility to specify target URL
|
| RegisterApplicationStorageScript |
Register application storage script. The current application is stored in browser storage for later use.
|
Extension Methods| Name | Description | |
|---|---|---|
 | AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) |
| GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
See Also