Class SubGrid

Module for interacting with D365 Subgrids

Hierarchy

SubGrid

Index

Constructors

constructor

Methods

Constructors

constructor

new SubGrid(xrmUiTest: XrmUiTest): SubGrid

- Defined in src/xrm/SubGrid.ts:10
Parameters
- xrmUiTest: XrmUiTest
Returns SubGrid

Methods

createNewRecord

createNewRecord(subgridName: string): Promise<void>

- Defined in src/xrm/SubGrid.ts:79
Opens the create record form by using this subgrid "Add New" button

Parameters
- subgridName: string
  
  The control name of the subgrid to use
Returns Promise<void>

getRecordCount

getRecordCount(subgridName: string): Promise<number>

- Defined in src/xrm/SubGrid.ts:23
Gets the record count of the specified subgrid

Parameters
- subgridName: string
  
  The control name of the subgrid to use
Returns Promise<number>

Promise which fulfills with the total record count

openNthRecord

openNthRecord(subgridName: string, recordNumber: number): Promise<void>

- Defined in src/xrm/SubGrid.ts:50
Opens the record in the subgrid at the n-th index

Parameters
- subgridName: string
  
  The control name of the subgrid to use
- recordNumber: number
  
  Index of the record to open, zero based
Returns Promise<void>

Promise which fulfills when record is opened

refresh

refresh(subgridName: string): Promise<void>

- Defined in src/xrm/SubGrid.ts:141
Refreshes the specified subgrid

Parameters
- subgridName: string
  
  The control name of the subgrid to refresh
Returns Promise<void>

Promise which fulfills once refreshing is done

Generated using TypeDoc