Class Form

Module for interacting with D365 Forms

Hierarchy

Form

Index

Constructors

constructor

Methods

Constructors

constructor

new Form(xrmUiTest: XrmUiTest): Form

- Defined in src/xrm/Form.ts:40
Parameters
- xrmUiTest: XrmUiTest
Returns Form

Methods

getAvailableFormSelectorItems

getAvailableFormSelectorItems(): Promise<Array<FormSelectorItem>>

- Defined in src/xrm/Form.ts:96
Gets a list of all forms that are currently available in the form selector

Returns Promise<Array<FormSelectorItem>>

Array of objects with id and label

getCurrentFormSelectorItem

getCurrentFormSelectorItem(): Promise<FormSelectorItem>

- Defined in src/xrm/Form.ts:77
Gets data about the currently selected form

Returns Promise<FormSelectorItem>

Object containing id and label of current form

noSubmit

noSubmit(): Promise<void>

- Defined in src/xrm/Form.ts:62
Sets all attributes to submit mode none. This is useful if you don't want to save and just change the page. No prompt for unsaved data will open.

Returns Promise<void>

Promise which resolves once all attribute submit modes are set.

reset

reset(): Promise<void>

- Defined in src/xrm/Form.ts:53
Sets all attributes to submit mode none. This is useful if you don't want to save and just change the page. No prompt for unsaved data will open.

deprecated

Please use noSubmit

Returns Promise<void>

Promise which resolves once all attribute submit modes are set

switch

switch(identifier: FormIdentifier): Promise<[void, void]>

- Defined in src/xrm/Form.ts:112
Switches to the specified form

Parameters
- identifier: FormIdentifier
  
  Defines which form to switch to
Returns Promise<[void, void]>

Promise which resolves once the selected form is loaded

Generated using TypeDoc