Xrm.Page.ui.formSelector item (client-side reference)

  • Article

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Form Items are available from the Xrm.Page.ui.formSelector.getCurrentItem or the Xrm.Page.ui.formSelector.items collection. A form item represents a form that is available to a user because it is associated with a security role that the user is also associated to. Often there will be only one form. When more than one form is available, these methods can be used to change the form the user is viewing.

Note

The Xrm.Page.ui.formSelector.items collection used to access these items is not available for Dynamics 365 mobile clients (phones and tablets) and the interactive service hub.

Form Item Methods

  • getId
    Returns the GUID ID of the form.

  • getLabel
    Returns the label of the form.

  • navigate
    Opens the specified form.

getId

Returns the GUID ID of the form.

itemObj.getId()
  • Return Value
    Type: String

getLabel

Returns the label of the form.

itemObj.getLabel()
  • Return Value
    Type: String

Opens the specified form.

Note

When you use the navigate method while unsaved changes exist, the user is prompted to save changes before the new form can be displayed. The Onload event occurs when the new form loads.

itemObj.navigate()

See Also

Client-side programming reference
Form scripting quick reference
Write code for Microsoft Dynamics 365 forms
Use the Xrm.Page object model
formSelector.getCurrentItem
formSelector.items

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright