formContext.ui (Client API reference)
Provides properties and methods to retrieve information about the user interface (UI) as well as collections for several sub components of the form.
Properties
| Name | Description |
|---|---|
controls |
Collection of all the controls on the page. See Collections for information about the collections and Controls for information about the control objects in the collection. |
formSelector |
Use the formSelector.getCurrentItem method to retrieve information about the form currently in use. Use the formSelector.items collection to return information about all the forms available for the user. formSelector is not available for Microsoft Dynamics 365 for tablets. |
navigation |
An object containing a property items, which is a collection of all the navigation items on the page. See Collections for information about the collection methods and formContext.ui.navigation item for information about the items in the collection. navigation is not available for Microsoft Dynamics 365 for tablets. |
process |
Provides objects and methods to interact with the business process flow control on a form. More information: formContext.ui.process |
quickForms |
A collection of all the quick view controls on a form using the new form rendering engine (also called "turbo forms"). More information: formContext.ui quickForms |
tabs |
A collection of all the tabs on the page. See Collections for information about the collection methods and formContex.ui tab for information about the items in the collection. |
Methods
| Name | Description |
|---|---|
| addOnLoad | Adds a function to be called on the form OnLoad event. |
| clearFormNotification | Removes form level notifications. |
| close | Closes the form. |
| getFormType | Gets the form type for the record. |
| getViewPortHeight | Gets the height of the viewport in pixels. |
| getViewPortWidth | Get the width of the viewport in pixels. |
| refreshRibbon | Causes the ribbon to re-evaluate data that controls what is displayed in it. |
| removeOnLoad | Removes a function from the form OnLoad event. |
| setFormEntityName | Sets the name of the table to be displayed on the form. |
| setFormNotification | Displays form level notifications. |
formContext.ui.footerSection removed
The formContext.ui.footerSection was removed in October of 2021. More information: Form footers in model-driven apps won't be supported with the 2021 release wave 2