如何在 Dynamics 365 9.0 的 Ribbon 命令中获取 formContext

Question

在 Dynamics 365 9.0 中，关于如何访问表单属性和控件发生了相当大的变化 - 我们应该将 executionContext 传递给函数，而不是 Xrm.Page 命名空间，并使用 getFormContext() 函数获取 formContext。这工作正常，我在使用这种方法时从来没有遇到过问题。

但是我还没有弄清楚如何在从功能区调用的函数中正确访问formContext。文档说这应该非常简单：

https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/customize-dev/pass-dynamics-365-data-page-parameter-ribbon-actions

function myFunction(executionContext) {
    var formContext = executionContext.getFormContext();
    var focusFieldValue = formContext.ui.controls.get(PrimaryControlId).getAttribute().getValue();
}

但它没有说明如何将executionContext 传递给 Ribbon 函数。在普通函数中有一个复选框“将执行上下文作为第一个参数传递”，但是 Ribbon 函数呢？我们可以将一些参数传递给这些函数，但它们只是所选记录的 GUID，或所选记录的类型，甚至是对象列表，但如果有等于 executionContext 的参数，我在文档中找不到。有人已经解决了这个问题吗？

我也知道我可以使用 Xrm.Page 并且它会工作（至少现在......）但我想知道，如何使用 9.0 版中的最新指南来完成它

更新 1：

根据 Scott 的建议和 this article，我将 PrimaryControl 传递给我的 Ribbon 命令，但不幸的是，参数类型为 Mscrm.FormControlLite，并且它没有 getAttribute 函数或任何允许访问 formContext 的函数（在至少我没有看到任何有用的东西）。开发者工具的一些截图：

所以它看起来像某种形式的表示形式，但可能与 formContext 无关（我假设如果从记录列表中调用功能区，则该项目可以是网格类型或类似的类型）

Answer 1

根据https://docs.microsoft.com/en-us/dynamics365/get-started/whats-new/customer-engagement/important-changes-coming#some-client-apis-are-deprecated，您将其作为 PrimaryControl 参数传递。

因此，如果您将 PrimaryControl 作为第二个参数传递给这样的命令函数，您可以使用

arguments[1].getAttribute(…)

Answer 2

按照@scott-durow 的建议传递primaryControl 后，最好不要使用primaryControl.getFormContext() 而是使用primaryControl，就好像它是formContext。

根据文档 (1/2/2019)：https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/customize-dev/pass-dynamics-365-data-page-parameter-ribbon-actions#form-and-grid-context-in-ribbon-actions，应该对 primaryControl 执行操作，就好像它是 formContext。

function mySampleFunction(primaryControl) {
    var formContext = primaryControl;
    // Perform operations using the formContext object
}

但是，提供的示例的关键部分是这样的：// 使用 formContext 对象执行操作作为关键（不知道为什么他们添加了 var formContext = primaryControl 行，imo，它会如果他们只是显示一个示例，会更清楚：primaryControl.getAttribute('xxxx');

我怀疑 primaryControl.getFormContext() 代码开始被使用，因为这就是您在处理表单时获取 formContext 的方式 (https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/clientapi/clientapi-form-context#using-the-formcontext-object-instead-of-the-xrmpage-object)。

使用 primaryControl.getFormContext() 的问题在于它适用于普通 Web 界面，但与 UCI 不兼容。但是，如果您将 primaryControl 用作表单上下文，那么它适用于旧版 Web 客户端和 uci 接口。

这是我使用的一个函数：

function getFormContext(executionContext) {
     var formContext = null;
     if (executionContext !== null) {
         if (typeof executionContext.getAttribute === 'function') {
             formContext = executionContext; //most likely called from the ribbon.
         } else if (typeof executionContext.getFormContext === 'function' 
                 && typeof(executionContext.getFormContext()).getAttribute === 'function') {
            formContext = executionContext.getFormContext(); // most likely called from the form via a handler
         } else {
            throw 'formContext was not found'; //you could do formContext = Xrm.Page; if you like.
        }
    }
    return formContext;
}

Answer 3

我也遇到了同样的问题。我发现，Microsoft doco 中有一个错误。请遵循 Scott 提到的从功能区命令操作传递 CRM 参数的任何内容。 在javascript函数中，请尝试以下获取表单上下文

var formContext = primaryControl.getFormContext();

这解决了我的问题。

Answer 4

您可以做一个小技巧，以不必使用 RibbonWorkbench 实用程序将主控件作为 Crm 参数传递，或者如果这样做了，它对您不起作用，因为如果您尝试这样做，可能会发生这种情况在主网格功能区中。

var context=Xrm.Utility.getGlobalContext();

我希望这对您或其他任何人都有效。