Introduction:
With CRM 2015 SP1, the Client API was extended to allow attaching events to sub-grid to manage the sub-grid data/operations.
The OnLoad event however executes on all of the following operations
- Load of parent form.
- Save of parent form.
- Add a new record in sub-grid
- Remove a record from sub-grid
- Navigating to prev/next page in sub-grid.
When we register a method on the OnLoad event, it does not indicate in any way which of the above actually fired the onload event.
Workaround to Identifying the operation
We cannot register an event when the record is added/removed from the sub-grid. The only event available is onload, so one way to identify if it was one of the add/remove operations that caused the grid to call the onload event, we can keep a check on the count of records in the grid.
We can register the onload event using the following code
//This function is executed onload event of form
function onLoad() {
var funtionName = "onLoad";
try {
//setting timeout beacuse subgid take some time to load after the form is loaded
setTimeout(function () {
//validating to check if the sub grid is present on the form
if (Xrm.Page != null && Xrm.Page != undefined && Xrm.Page.getControl("contact_subgrid") != null && Xrm.Page.getControl("contact_subgrid") != undefined) {
//stores the row count of subgrid on load event of CRM Form
_rowCount = Xrm.Page.getControl("contact_subgrid").getGrid().getTotalRecordCount();
//registering refreshform function onload event of subgrid
Xrm.Page.getControl("contact_subgrid").addOnLoad(onGridLoad);
}
}, 5000);
} catch (e) {
Xrm.Utility.alertDialog(functionName + "Error: " + (e.message || e.description));
}
}
The rowCount is defined as global variable and is updated here to store the count of records in the grid when the form is loaded initially.//This function calls the intended function on load of subgrid
function onGridLoad() {
var functionName = " onGridLoad ";
var currentRowCount = null;
try {
//setting timeout beacuse subgrid take some time to load after the form is loaded
setTimeout(function () {
//validating to check if the sub grid is present on the form
if (Xrm.Page != null && Xrm.Page != undefined && Xrm.Page.getControl("contact_subgrid") != null && Xrm.Page.getControl("contact_subgrid") != undefined) {
//stores the row count of subgrid on load event of CRM Form
currentRowCount = Xrm.Page.getControl("contact_subgrid").getGrid().getTotalRecordCount();
if (currentRowCount > _rowCount) {
//call the intended function which we want to call only when records are added to the grid
dosomething();
//set current row count to the global row count
_rowCount = currentRowCount;
}
else if (currentRowCount < _rowCount) {
//call the intended function which we want to call only when records are removed from the grid
dosomethingelse();
//set current row count to the global row count
_rowCount = currentRowCount;
}
}
}, 2000);
} catch (e) {
Xrm.Utility.alertDialog(functionName + "Error: " + (e.message || e.description));
}
}
Conclusion :
In this way we can identify if a record is added or removed from sub grid in Dynamics CRM 2015 SP1.
Before you move on to the next post, check this Inogic Dynamics CRM Solutions – Change the Pace of your Business Decisions.
There's much more, for more Dynamics CRM Tips and Tricks head on to Inogic Blog. If you have any questions on Dynamics CRM or need any help in implementation, customization, upgradation of Dynamics CRM or are looking to get more out of your CRM, feel free to reach us at crm@inogic.com today!
The post Identify the trigger for an On-load event for Sub-grid in Dynamics CRM appeared first on Inogic Blog.