Class Button

Module for interacting with D365 Buttons

Hierarchy

Button

Index

Constructors

constructor

Methods

Constructors

constructor

new Button(xrmUiTest: XrmUiTest): Button

- Defined in src/xrm/Button.ts:35
Parameters
- xrmUiTest: XrmUiTest
Returns Button

Methods

click

click(buttonIdentifier: ButtonIdentifier, openMoreCommands?: boolean): Promise<void>

- Defined in src/xrm/Button.ts:79
Clicks a ribbon button

Parameters
- buttonIdentifier: ButtonIdentifier
  
  Identifier for finding button, either by label or by data-id
- Default value openMoreCommands: boolean = true
  
  Whether more commands has to be clicked for finding the button. Will be used automatically if button is not found on first try
Returns Promise<void>

Promise which resolves once button was clicked

expandMoreCommands

expandMoreCommands(): Promise<boolean>

- Defined in src/xrm/Button.ts:47
Expands the more commands ribbon menu

Returns Promise<boolean>

Promise which resolves once more commands was clicked

isVisible

isVisible(buttonIdentifier: ButtonIdentifier, openMoreCommands?: boolean): Promise<boolean>

- Defined in src/xrm/Button.ts:102
Checks if a button is visible

Parameters
- buttonIdentifier: ButtonIdentifier
  
  Identifier for finding button, either by label or by data-id
- Default value openMoreCommands: boolean = true
  
  Whether more commands has to be clicked for finding the button. Will be used automatically if button is not found on first try
Returns Promise<boolean>

Promise which resolves with a boolean value indicating if the button was visible

Generated using TypeDoc