通过

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

  • 项目

 

发布日期： 2017年1月

适用于： Dynamics 365 (online),Dynamics 365 (on-premises),Dynamics CRM 2016,Dynamics CRM Online

Xrm.Page.ui.quickForms 集合提供方法在使用新窗体呈现引擎（也称为“涡轮窗体”）时访问 Microsoft Dynamics 365 表单上的所有快速视图控件及其关系人控件。 快速视图控件是添加到 Microsoft Dynamics 365 中主窗体的快速视图窗体，允许您查看主窗体中关于相关实体记录的信息。 快速视图控件中的关系人控件中的数据无法编辑。 有关快速视图控件与快速视图窗体的详细信息，请参阅 TechNet：创建和编辑快速视图窗体

备注

CRM Online 2016 更新 1 和 CRM 2016 Service Pack 1（本地）中引入了此功能。

只有在 Dynamics 365 中使用新窗体呈现引擎时，本主题才适用。 如果您在 Dynamics 365 中使用旧窗体呈现（也称为“刷新窗体”），可以使用标准控件对象访问快速视图控件及其关系人控件；请参阅 Xrm.Page.ui 控制方法（客户端引用）。

重要

出现 Dynamics 365 中的旧窗体弃用公告时，如果您正在使用旧窗体呈现，必须立即计划使用新窗体呈现引擎。 由于在旧窗体和新窗体呈现中访问快速视图控件的方式存在差异，您必须更新并测试以快速视图控件为目标的现有代码，以便在切换到新窗体呈现引擎时使用主题中描述的方法。 有关旧窗体呈现被弃用的详细信息，请参阅 移除旧窗体呈现选项

本主题内容

quickForms 集合方法

quickForms 对象方法

quickForms 集合方法

quickForms 集合提供对位于窗体上的所有快速视图控件的访问。quickForms 集合支持在 Dynamics 365 中的集合的所有标准方法。 请参阅集合（客户端引用）

以下示例演示如何使用通过指定快速视图控件示例的索引值（整数）或名称（字符串）作为参数的 9b85e46f-ca6e-4313-af04-4290e3c6ab8b#BKMK_get 方法检索 quickForms 集合中的快速视图控件。

quickViewControl = Xrm.Page.ui.quickForms.get(arg)

quickForms 对象方法

quickForms 对象表示快速视图控件实例。 以下方法可在窗体的快速视图控件实例受支持。

  • getControl

  • getControlType

  • getName

  • getParent

  • getVisible

  • 标签方法

  • isLoaded

  • 刷新

getControl

获取快速视图控件中的关系人控件。

quickViewControl.getControl()

可以访问关系人控件集中的单个控件，方法是将一个参数作为关系人控件的名称或索引值在快速视图控件中传递。 例如：quickViewControl.getControl("firstname") 或 quickViewControl.getControl(0)

  • 返回值
    类型： 如果使用不带任何参数的方法为对象集，如果使用带参数的方法则为对象。

  • 备注
    检索到快速视图控件中的关系人控件后，可以使用任何一种支持的方法用于不更改关系人控件数据的关系人控件上的 Dynamics 365 控件。 这是因为快速视图控件中的关系人控件是只读的。 例如，您可以使用：quickViewControl.getControl(0).getAttribute() 用于 Dynamics 365 控制所支持方法的详细信息，请参阅 Xrm.Page.ui 控制方法（客户端引用）

    重要

    51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getAttribute 或关系人控件上的任何与数据有关的方法可能在主窗体 f451f339-bcee-4260-9904-abc8c0efa153#BKMK_OnloadEvent 上无法工作，因为它绑定的快速视图控件可能在加载主窗体时没有完全加载。 您必须使用用于快速视图控件实例的 isLoaded 方法帮助您确定绑定的快速视图窗体已完全加载。 更多信息：isLoaded

    此外，您使用新窗体呈现引擎检索窗体上的快速视图控件中的关系人控件与旧窗体不同。 因此，如果您使用旧窗体并且有以快速视图控件中的关系人控件为目标的代码，当您决定使用 Dynamics 365 中的新窗体呈现引擎时，必须更新代码。

getControlType

返回对快速视图控件分类的字符串值。

quickViewControl.getControlType()

对于快速视图控件，方法会返回 quickform。

对于快速视图控件中的关系人控件，方法会返回控件的实际类别。 有关其他可能的返回值的详细信息，请参阅 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getControlType。

getName

返回已分配给快速视图控件的名称。

quickViewControl.getName()
  • 返回值
    类型： 字符串。 快速视图控件的名称。

getParent

返回对包含控件的部分对象的引用。

控件类型： 全部。

quickViewControl.getParent()

getVisible

返回一个指示快速视图控件当前是否可见的值。

备注

如果包含此控件的部分或选项卡不可见，此方法可能仍会返回 true。 确保控制实际可见；您还需要检查包含元素的可见性。

quickViewControl.getVisible()
  • 返回值
    类型： 布尔。 如果快速视图控件可见，则返回 True，否则返回 false。

标签方法

使用 getLabel 和 setLabel 方法获取或更改快速视图控件的标签。

getLabel

返回快速视图控件的标签。

quickViewControl.getLabel()
  • 返回值
    类型： 字符串。 快速视图控件的标签。

setLabel

设置快速视图控件的标签。

quickViewControl.setLabel("label")
  • 参数
    类型： 字符串。 快速视图控件的新标签。

isLoaded

返回为快速视图控件中的关系人控件绑定的数据是否完整。

quickViewControl.isLoaded()

  • 返回值
    类型： 布尔。 True 表示为关系人控件绑定的数据完整，否则为 false。

  • 备注
    在主窗体 f451f339-bcee-4260-9904-abc8c0efa153#BKMK_OnloadEvent 过程中，为快速视图控件中的关系人控件绑定的数据可能不完整，因为控件绑定的快速视图窗体可能没有完全加载。 因此，在关系人控件上使用 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getAttribute 或者任何与数据有关的方法可能不起作用。 快速视图控件的 isLoaded 方法帮助确定快速视图控件中的关系人控件的数据绑定状态。

以下示例代码演示如何使用 isLoaded 方法检查绑定状态，然快速视图控件中的关系人控件绑定的属性值。

function getAttributeValue() {
    var quickViewControl = Xrm.Page.ui.quickForms.get("<QuickViewControlName>");
    if (quickViewControl != undefined)
    {
        if (quickViewControl.isLoaded())
        {
            // Access the value of the attribute bound to the constituent control
            var myValue = quickViewControl.getControl(0).getAttribute().getValue();
            console.log(myValue);
            return;
        }
        else
        {
            // Wait for some time and check again
            setTimeout(getAttributeValue, 10);
        }
    }
    else
    {
        console.log("No data to display in the quick view control.");
        return;
    }    
}

刷新

刷新在快速视图控件中显示的数据。

quickViewControl.refresh()

另请参阅

客户端编程引用
脚本即时引用的表单
Xrm.Page.ui（客户端引用）
Xrm.Page.ui 控制方法（客户端引用）
为 Microsoft Dynamics 365 窗体编写代码
使用 Xrm.Page 对象模型

Microsoft Dynamics 365

© 2017 Microsoft。 保留所有权利。 版权