Grid (read-only) objects and methods (client-side reference)获取子表单对象的一些方法 Crm 2016
https://msdn.microsoft.com/en-us/library/dn932126.aspx#BKMK_GridControl
Updated: November 29, 2016
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
You can set event handlers to execute scripts when data is loaded in subgrids. This provides methods to change the selected view and get references to data displayed in the grid.
In this topic
- GridControl
-
Events and methods for the GridControl: OnLoad event, addOnLoad, getEntityName, getGrid, getViewSelector and removeOnLoad.
- Grid
-
Methods for the Grid returned by the GridControl.getGrid method: getRows, getSelectedRows, and getTotalRecordCount.
- GridRow
-
The getData method for the GridRow returned by the Grid.getRows and Grid.getSelectedRows methods.
- GridRowData
-
The getEntity method for the GridRowData returned by the GridRow.getData method.
- GridEntity
-
Methods for the GridEntity returned by the GridRowData.getEntity method: getEntityName, getEntityReference, getId, andgetPrimaryAttributeValue.
- ViewSelector
-
Methods for the ViewSelector returned by the GridControl.getViewSelector, getCurrentView, isVisible and setCurrentView
GridControl
Before CRM Online 2015 Update 1 the only unique method for the subgrid control was refresh. When you know the name of the subgrid control you can access it using the following code, for example, to access the CONTACTS subgrid in the default account form.
var contactsSubgrid = Xrm.Page.getControl("Contacts");
Tip |
---|
To identify the names of subgrid controls in the form without opening the form editor, see the information in Use browser developer tools. |
As an Xrm.Page.ui control, GridControl also has all the standard control methods: getControlType, Label methods, getParent, Visible methods,setFocus, and Notification methods as well as refresh. See Xrm.Page.ui control (client-side reference) for more information on these methods.
OnLoad event
Add event handlers to this event to run every time the subgrid refreshes. This includes when users sort the values by clicking the column headings. Use the GridControl.addOnLoad and GridControl.removeOnLoad methods to manage event handlers, usually in the form Onloadevent.
addOnLoad
Use this method to add event handlers to the GridControlOnLoad event.
Parameter type: Function
Example: Add the myContactsGridOnloadFunction function to the Contacts subgrid OnLoad event.
var myContactsGridOnloadFunction = function () { console.log("Contacts Subgrid OnLoad occurred") };
Xrm.Page.getControl("Contacts").addOnLoad(myContactsGridOnloadFunction);
getEntityName
Use this method to get the logical name of the entity data displayed in the grid.
Return value type: String
Example: Set the opportunitySubgrids variable to an array of subgrid controls that display opportunity records.
var opportunitySubgrids = Xrm.Page.getControl(function (ctrl, i) {
if (ctrl.getControlType() == "subgrid") {
return (ctrl.getEntityName() == "opportunity");
}
else {
return false;
}
})
getGrid
getViewSelector
Use this method to get access to the ViewSelector available for the GridControl.
Return value type:ViewSelector
Example: Set the contactsSubgridViewSelector variable to the view selector of the Contacts subgrid.
var contactsSubgridViewSelector = Xrm.Page.getControl("Contacts").getViewSelector();
removeOnLoad
Use this method to remove event handlers from the GridControlOnLoad event.
Parameter type: Function
Example: Add the myContactsGridOnloadFunction function to the Contacts subgrid OnLoad event and then remove it.
var myContactsGridOnloadFunction = function () { console.log("Contacts Subgrid OnLoad occurred") };
Xrm.Page.getControl("Contacts").addOnLoad(myContactsGridOnloadFunction);
Xrm.Page.getControl("Contacts").removeOnLoad(myContactsGridOnloadFunction);
Grid
Use Grid methods to access information about data in the grid. Grid is returned by the GridControl.getGrid method.
getRows
Returns a collection of every GridRow in the Grid.
Return value type: Collection
Example: Set the allRows variable to a collection of GridRow from the Contacts subgrid.
var allRows = Xrm.Page.getControl("Contacts").getGrid().getRows();
Remarks:
See Collections (client-side reference) for information on the methods available to access data in a collection.
getSelectedRows
Returns a collection of every selected GridRow in the Grid.
Return value type: Collection
Example: Populate the selectedEntityReferencesArray variable with entity references for selected rows from the Contacts subgrid.
//Get an array of entity references for all selected rows in the subgrid
var selectedEntityReferences = [];
var selectedRows = Xrm.Page.getControl("Contacts").getGrid().getSelectedRows();
selectedRows.forEach(function (selectedRow, i) {
selectedEntityReferences.push(selectedRow.getData().getEntity().getEntityReference());
});
Remarks:
See Collections (client-side reference) for information on the methods available to access data in a collection.
getTotalRecordCount
In the web application or the Dynamics 365 for Outlook client while connected to the server, this method returns the total number of records that match the filter criteria of the view, not limited by the number visible in a single page.
When the Dynamics 365 for Outlook client isn’t connected to the server, this number is limited to those records that the user has selected to take offline.
For Microsoft Dynamics 365 for tablets and Microsoft Dynamics 365 for phones this method will return the number of records in the subgrid.
Return value type: Number
Example: Set the filteredRecordCount variable to the total number of records that match the filter criteria of the view.
var filteredRecordCount = Xrm.Page.getControl("Contacts").getGrid().getTotalRecordCount();
GridRow
Use the GridRow.getData method to access the GridRowData. A collection of GridRow is returned by Grid.getRows and Grid.getSelectedRowsmethods.
getData
Returns the GridRowData for the GridRow.
Return value type:GridRowData
Example: Populate the allGridRowDataArray variable with GridRowData for all rows from the Contacts subgrid.
var allGridRowData = [];
var rows = Xrm.Page.getControl("Contacts").getGrid().getRows();
rows.forEach(function (row, i) {
allGridRowData.push(row.getData());
});
GridRowData
Use the GridRowData.getEntity method to access the GridEntity. GridRowData is returned by the GridRow.getData method.
getEntity
Returns the GridEntity for the GridRowData.
Return value type:GridEntity
Example: Populate the allGridEntitiesArray variable with GridEntity for all rows from the Contacts subgrid.
var allGridEntities = [];
var rows = Xrm.Page.getControl("Contacts").getGrid().getRows();
rows.forEach(function (row, i) {
allGridEntities.push(row.getData().getEntity());
});
GridEntity
Use the GridEntity methods to access data about the specific records in the rows. GridEntity is returned by the GridRowData.getEntity method.
getEntityName
Returns the logical name for the record in the row.
Return value type: String
Example: Set the firstEntityType variable to the value of the entity logical name for the first row in the Contacts subgrid.
var firstEntityType = Xrm.Page.getControl("Contacts").getGrid().getRows().get(0).getData().getEntity().getEntityName();
// firstEntityType == "contact"
getEntityReference
Return value type: Lookup
Example: Set the firstEntityType variable to an entity reference for the first row in the Contacts subgrid.
var firstEntityReference = Xrm.Page.getControl("Contacts").getGrid().getRows().get(0).getData().getEntity().getEntityReference();
// firstEntityReference.entityType == "contact"
// firstEntityReference.id == "{13CD16BD-3EC4-E411-80CF-00155DB58496}"
// firstEntityReference.name == "Rene Valdes (sample)"
Remarks:
This lookup has the following properties:
Name |
Type |
Description |
---|---|---|
entityType |
String |
The logical name for the record in the row. The same data returned by the GridEntity.getEntityNamemethod. |
id |
String |
The id for the record in the row. The same data returned by the GridEntity.getId method. |
name |
String |
The primary attribute value for the record in the row. The same data returned by theGridEntity.getPrimaryAttributeValue method. |
getId
Returns the id for the record in the row.
Return value type: String
Example: Set the firstEntityId variable to the value of id of the record from the first row in the Contacts subgrid.
var firstEntityId = Xrm.Page.getControl("Contacts").getGrid().getRows().get(0).getData().getEntity().getId();
// firstEntityId == "{13CD16BD-3EC4-E411-80CF-00155DB58496}"
getPrimaryAttributeValue
Returns the primary attribute value for the record in the row.
Return value type: String
Example: Set the currentView variable to the current view of the view selector for the Contacts subgrid.
var firstEntityPrimaryAttributeValue = Xrm.Page.getControl("Contacts").getGrid().getRows().get(0).getData().getEntity().getPrimaryAttributeValue();
// firstEntityPrimaryAttributeValue == "Rene Valdes (sample)"
ViewSelector
Use the ViewSelector methods to get or set information about the view selector of the subgrid control.
Note |
---|
If the subgrid control is not configured to display the view selector, calling the ViewSelector methods will throw an error. |
getCurrentView
Use this method to get a reference to the current view.
Return value type: Lookup object
Example: Set the currentView variable to the current view of the view selector for the Contacts subgrid.
var currentView = Xrm.Page.getControl("Contacts").getViewSelector().getCurrentView();
Remarks:
If the subgrid control is not configured to display the view selector, calling this method on the ViewSelector returned by theGridControl.getViewSelector method will throw an error.
isVisible
Use this method to determine whether the view selector is visible.
Return value type: Boolean
Example: Set the viewSelectorIsVisible variable to represent the visibility status of the view selector for the Contacts subgrid.
var viewSelectorIsVisible = Xrm.Page.getControl("Contacts").getViewSelector().isVisible();
Remarks:
If the subgrid control is not configured to display the view selector, calling this method on the ViewSelector returned by theGridControl.getViewSelector will throw an error.
setCurrentView
Use this method to set the current view.
Parameter type: Lookup object
Example: Set the ContactsIFollow variable to be the current view of the Contacts subgrid.
var ContactsIFollow = {
entityType: 1039, // SavedQuery
id:"{3A282DA1-5D90-E011-95AE-00155D9CFA02}",
name: "Contacts I Follow"
}
//Set the view using ContactsIFollow
Xrm.Page.getControl("Contacts").getViewSelector().setCurrentView(ContactsIFollow);
Remarks:
If the subgrid control isn’t configured to display the view selector, calling this method on the ViewSelector returned by theGridControl.getViewSelector will throw an error.
This Lookup has the following properties:
Name |
Type |
Description |
---|---|---|
entityType |
Number |
The object type code for the SavedQuery (1039) or UserQuery (4230) that represents the view the user can select. |
id |
String |
The ID for the view the user can select. |
name |
String |
The name of the view the user can select. |
Grid (read-only) objects and methods (client-side reference)获取子表单对象的一些方法 Crm 2016的更多相关文章
- 关于client浏览器界面文字内容溢出用省略号表示方法
在实际的项目中,因为client浏览器文字内容的长度不确定性和页面布局的固定性,难免会出现文字内容超过div(或其它标签,下同)区域的情况.此时比較好的做法就是当文字超过限定的div宽度后自己主动以省 ...
- [SharePoint]javascript client object model 获取lookup 类型的field的值,包括user类型(单人或者多人)的值。how to get the multiple user type/lookup type field value by Javascript client object model
1. how to get value var context = new SP.ClientContext.get_current(); var web = context.get_web(); v ...
- Dynamics 365中的Client API form context (formContext)
适用于Dynamics 365 for Customer Engagement apps 9.x版本. 本文是一篇翻译,原文来源是微软官方文档. 本文链接:https://www.cnblogs.co ...
- Bluetooth 4.0之Android 解说
Android平台包括了对蓝牙网络协议栈的支持,它同意一个蓝牙设备跟其它的蓝牙设备进行无线的数据交换.应用程序通过Android蓝牙API提供訪问蓝牙的功能. 这些API会把应用程序无线连接到其 ...
- Unit Testing of Spring MVC Controllers: “Normal” Controllers
Original link: http://www.petrikainulainen.net/programming/spring-framework/unit-testing-of-spring-m ...
- SpringDataRedis入门到深入
一:简介 SpringDataRedis是SpringData开源项目中的一部分,它可以在Spring项目中更灵活简便的访问和操作Redis:原先在没有SpringDataRedis时往往使用Jedi ...
- Django ORM、一对一、一对多、多对多、详解
上篇博客也提到这些知识点,可能大家还是不太清楚,这篇博客为大家详细讲解ORM中的几个知识点 1.1首先我们先看一个小案例: #_*_coding:utf-8_*_ from django.db imp ...
- Python Day20
Django 表操作 1.基本操作 # 增 # # models.Tb1.objects.create(c1='xx', c2='oo') 增加一条数据,可以接受字典类型数据 **kwargs # o ...
- Python自动化之一对多
一对多 建立一对多关系之后(也就是加了外键),会在字表里面多一个"外键字段_id"这个字段 查询 #_*_coding:utf-8_*_ from django.db import ...
随机推荐
- delphi第2节
- Mysql删除数据后磁盘空间未释放的解决办法【转】
转自 Mysql删除数据后,磁盘空间未释放的解决办法 - 今日头条(TouTiao.com)http://toutiao.com/a6303087712678412546/?tt_from=mobil ...
- JSP内置对象---总结
request: javax.servlet.http.HttpServletRequest的接口实例 1. setCharacterEncoding("GBK"):防乱码2. ...
- 【摘自网络】dll库和lib库有什么区别
简单地讲:第一:.DLL是动态链接库,而.LIB是静态链接库dll是个编译好的程序,调用时可以直接调用其中的函数,不参加工程的编译. 而lib应该说是一个程序集, 只是把一些相应的函数总结在一起, 如 ...
- IPoint Interface接口
Description A Point is a zero-dimensional object that represents a specific (X, Y) location in a the ...
- C# 经典入门15章 RichTextBox
aaarticlea/png;base64,iVBORw0KGgoAAAANSUhEUgAAAsEAAAIRCAIAAAAk7fcMAAAgAElEQVR4nOy9+SOU3/////pHuswYyz
- ZOJ3944People Counting<暴力/枚举>
题意:输入一张照片,给出人物的特征,判断有多少个人. .O. /|\ (.) 思路:按照3*3的图统计,只要有一个点符合就加1 #include<cstdio> #include<i ...
- wind10系统 Atheros AR9271 Wireless Network Adapter USBwifi无线网卡的驱动安装解决无法搜索wifi信号,连接wifi信号无法上网的问题
一.解决无法搜索wifi信号的问题 卸载掉之前的驱动,上网下载其他的驱动程序安装. http://drivers.mydrivers.com/drivers/463_185289.htm 二.安装完后 ...
- 两列布局,读《css那些事儿》
两列布局: 1.两列定宽: 要点:float.width固定. :after清除浮动. 前提:两列的盒模型宽度相加不能大于父元素的宽度,否则会出现错位现象. <!DOCTYPE html> ...
- Claris and XOR(模拟)
Claris and XOR Time Limit: 2000/1000 MS (Java/Others) Memory Limit: 65536/65536 K (Java/Others)To ...