Xrm.Page.ui（客户端引用）

项目
07/06/2017

发布日期： 2016年11月

适用于： Dynamics CRM 2015

Xrm.Page.ui 包含用于检索用户界面相关信息的属性和方法，并包含窗体的数个子组件的集合。

Xrm.Page.ui 属性和方法

关闭
关闭窗体的方法。
控件
页面上所有控件的集合。
窗体选择器
使用 formSelector.getCurrentItem 方法检索正在使用中的窗体的信息和 formSelector.items 集合包含的用户可用的所有窗体的信息。
getCurrentControl
获得控件对象的方法目前在窗体上有焦点。

备注

这种方法不宜用在 Microsoft Dynamics CRM 2013 更新汇总 2 上。
getFormType
获得记录窗体上下文的方法。
navigation.items
页面上所有导航项目的集合。
窗体通知
使用 setFormNotification 显示窗体级别通知并使用 clearFormNotification 删除通知。
refreshRibbon
影响功能区重新评估控制数据显示内容的数据的方法。
选项卡
页面上所有选项卡的集合。
视区方法
ViewPort 是包含窗体数据页面的区域。它对应于窗体的主体，不包括页面区域上的导航、标题、页脚或窗体助理。使用 getViewPortHeight 和 getViewPortWidth 方法获取 ViewPort 的当前大小。

关闭

关闭窗体的方法。

Xrm.Page.ui.close()

备注：

HTML Window.close 方法已取消。若要关闭窗体必须使用此方法。如果在窗体上有任何未保存的更改，窗口关闭前会提示用户是否要保存他们的更改。

通过适用于平板电脑的 Microsoft Dynamics CRM，此方法模拟返回导航按钮的行为。

控件

页面上所有控件的集合。

有关集合方法的信息，请参阅集合（客户端引用），有关集合中控件对象的信息，请参阅 Xrm.Page.ui 控制方法（客户端引用）。

窗体选择器

使用 formSelector.getCurrentItem 方法检索正在使用中的窗体的信息和 formSelector.items 集合包含的用户可用的所有窗体的信息。

备注

formSelectoritems 集合不存在，且 formSelector.getCurrentItem 方法不能与适用于平板电脑的 Microsoft Dynamics CRM 一起使用。

formSelector.getCurrentItem

当前显示的是返回窗体引用的方法。

备注

当仅有一个窗体可用时，此方法将返回 null。

返回值
类型:对象

formSelector.items

当前用户可以访问所有窗体项的集合。

备注

在此集合中，只有与用户安全角色之一关联的窗体可用。

有关集合方法的信息，请参阅集合（客户端引用），有关集合中项的信息，请参阅 Xrm.Page.ui.formSelector 项（客户端引用）。

getCurrentControl

获得控件对象的方法目前在窗体上有焦点。该方法不能将 Web 资源和 IFRAME 控件返回。

备注

这种方法不宜用在 Microsoft Dynamics CRM 2013 更新汇总 2 上。

当最后由用户编辑的字段是一个作为单选按钮或者复选框控件的布尔属性时，此方法不会向当前控件返回引用。使用 Xrm.Page.ui 控件 setFocus 方法后，此方法也无法立刻返回引用。

Xrm.Page.ui.getCurrentControl()

返回值
类型:对象

getFormType

获得记录窗体上下文的方法。

Xrm.Page.ui.getFormType()

返回值
类型:号码

下表列出对应返回值的窗体类型。

值

窗体类型

0

尚未定义

1

创建

2

更新

3

只读

4

已禁用

5

快速创建（已弃用）

6

批量编辑

11

读取优化（已弃用）

备注

“快速创建”窗体返回 1。值 5 用于已移除的较早类型快速创建窗体。

值	窗体类型
0	尚未定义
1	创建
2	更新
3	只读
4	已禁用
5	快速创建（已弃用）
6	批量编辑
11	读取优化（已弃用）

navigation.items

页面上所有导航项目的集合。

备注

此集合与适用于平板电脑的 Microsoft Dynamics CRM 不共存。

有关集合方法的信息，请参阅集合（客户端引用），有关集合中项的信息，请参阅 Xrm.Page.ui.navigation 项（客户端引用）。

窗体通知

使用 setFormNotification 显示窗体级别通知并使用 clearFormNotification 删除通知。

clearFormNotification

使用此方法删除窗体级别通知。

Xrm.Page.ui.clearFormNotification(uniqueId)

参数
- uniqueId
  类型：字符串。与 setFormNotification 一起使用的消息的唯一标示符，可用于设置该通知。
返回值
类型：布尔值。如果方法成功，则 True；否则 false。
备注
本方法仅用于更新的实体。

setFormNotification

使用此方法显示窗体级别通知。您可以查看任何数量的通知并会一直显示，直到使用 clearFormNotification 删除他们。通知区域的高度有限制，因此每个新的邮消息将被添加到顶部。用户可以向下滚动查看未删除的旧消息。

Xrm.Page.ui.setFormNotification(message, level, uniqueId);

参数
- message
  类型：字符串。消息的文本。
- level
  类型：字符串。消息的级别。
  
  级别定义消息的显示方式。
  - ERROR：通知将使用系统错误图标。
  - WARNING：通知将使用系统警告图标。
  - INFO：通知将使用系统信息图标。
- uniqueId
  类型：字符串。与 clearFormNotification 一起使用的消息的唯一标示符，可用于删除该通知。
返回值
类型：布尔值。如果方法成功，则 True；否则 false。
备注
本方法仅用于更新的实体。

refreshRibbon

影响功能区重新评估控制数据显示内容的数据的方法。

Xrm.Page.ui.refreshRibbon()

返回值
类型： 无

注意： 当功能区 <EnableRule> (RibbonDiffXml) 取决于窗体中的值时，通常使用这个函数。在您的代码更改规则使用的值后，可使用该方法强制功能区重新评估窗体中的数据，以便可以应用这些规则。

选项卡

页面上所有选项卡的集合。

有关集合方法的信息，请参阅集合（客户端引用），有关集合中项的信息，请参阅 Xrm.Page.ui 选项卡（客户端引用）。

视区方法

ViewPort 是包含窗体数据页面的区域。它对应于窗体的主体，不包括页面区域上的导航、标题、页脚或窗体助理。使用 getViewPortHeight 和 getViewPortWidth 方法获取 ViewPort 的当前大小。

备注

这些方法不适用于适用于平板电脑的 Microsoft Dynamics CRM。

getViewPortHeight

获取视区高度（以像素为单位）的方法。

Xrm.Page.ui.getViewPortHeight()

返回值
类型:号码

getViewPortWidth

获取视区宽度（以像素为单位）的方法。

Xrm.Page.ui.getViewPortWidth()

返回值
类型:号码

另请参阅

客户端编程引用
 脚本即时引用的表单
 为 Microsoft Dynamics CRM 2015 窗体编写代码
 使用 Xrm.Page 对象模型
 Xrm.Page.data.entity（客户端引用）

通过