Client API grid context
Grids present data in a tabular format. Grids can span the entire form or can be one of the items on a form; the latter are called subgrids.
The Client API grid context object provides reference to a subgrid on a form against which the current code is executed.
Note
Getting the context of a grid (spanning the entire form) is only supported in ribbon commands. More information: Form and grid context in ribbon actions
Use the formContext object to get an instance of the form where the code is executed, and then retrieve the subgrid control on the form. For example, when you know the name of a subgrid control (say Contacts subgrid in the default account form), you can access it using the following code:
function doSomething(executionContext) {
var formContext = executionContext.getFormContext(); // get the form Context
var gridContext = formContext.getControl("Contacts"); // get the grid context
// Perform operations on the subgrid
}
Note
When using gridContext
, calls to getControl()
are not supported.
Related articles
Client API form context
Client API execution context
Understand the Client API object model
Grids and subgrids
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應