Interface Ui

controls

footerSection

formSelector

headerSection

navigation

process

quickForms

tabs

addOnLoad

• addOnLoad(handler): void

• Adds a function to be called on the form OnLoad event. The function will be added to the bottom of the event handler pipeline.

  Parameters

  • handler: Xrm.Events.LoadEventHandler | LoadEventHandlerAsync

  Returns void

  See

  External Link: ui.addOnLoad (Client API reference)

clearFormNotification

• clearFormNotification(uniqueId): boolean

• Clears the form notification described by uniqueId.

  Parameters

  • uniqueId: string

    Unique identifier.

  Returns boolean

  True if it succeeds, otherwise false.

close

• close(): void

• Closes the form.

  Returns void

getFormType

• getFormType(): FormType

• Gets form type.

  Returns FormType

  The form type.

  Remarks

  Values returned are:

  • 0 Undefined
  • 1 Create
  • 2 Update
  • 3 Read Only
  • 4 Disabled
  • 6 Bulk Edit
  • Deprecated values are 5 (Quick Create), and 11 (Read Optimized)

getViewPortHeight

• getViewPortHeight(): number

• Gets view port height.

  Returns number

  The view port height, in pixels.

  Remarks

  This method does not work with Microsoft Dynamics CRM for tablets.

getViewPortWidth

• getViewPortWidth(): number

• Gets view port width.

  Returns number

  The view port width, in pixels.

  Remarks

  This method does not work with Microsoft Dynamics CRM for tablets.

refreshRibbon

• refreshRibbon(refreshAll?): void

• Re-evaluates the ribbon's configured EnableRules.

  Parameters

  • Optional refreshAll: boolean

    Indicates whether all the ribbon command bars on the current page are refreshed. If you specify false only the page-level ribbon command bar is refreshed. If you do not specifiy this parameter, by default false is passed.

  Returns void

  Remarks

  This method does not work with Microsoft Dynamics CRM for tablets.

removeOnLoad

• removeOnLoad(handler): void

• Removes a function from the form OnLoad event.

  Parameters

  • handler: Xrm.Events.LoadEventHandler | LoadEventHandlerAsync

  Returns void

  See

  External Link: ui.removeOnLoad (Client API reference)

setFormEntityName

• setFormEntityName(name): void

• Sets the name of the table to be displayed on the form.

  Parameters

  • name: string

    Name of the table to be displayed on the form.

  Returns void

  See

  External Link: setFormEntityName (Client API reference)

setFormNotification

• setFormNotification(message, level, uniqueId): boolean

• Displays a form level notification. Any number of notifications can be displayed and will remain until removed using clearFormNotification. The height of the notification area is limited so each new message will be added to the top.

  Parameters

  • message: string

    The text of the notification message.

  • level: Xrm.FormNotificationLevel

    The level of the notification which defines how the message will be displayed, such as the icon. ERROR: Notification will use the system error icon. WARNING: Notification will use the system warning icon. INFO: Notification will use the system info icon.

  • uniqueId: string

    Unique identifier for the notification which is used with clearFormNotification to remove the notification.

  Returns boolean

  true if it succeeds, otherwise false.