客户端上下文(客户端引用)

 

发布日期: 2017年1月

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

您的代码需要在存在大量设计时未知变量的上下文中运行。 上下文对象提供的方法可用于检索组织、用户或传递到页面的参数的特定信息。

通过引用 Xrm.Page.context,上下文对象在窗体中可用。

对于在窗体之外执行的 Web 资源,请使用 GetGlobalContext 函数 来检索上下文对象。

上下文属性和方法

  • 客户
    提供 getClient、getClientState 和 getFormFactor 方法的访问权限,通过这些方法,您可以确定要使用的客户端,是否将客户端连接到服务器,以及使用的是哪类设备。

  • getClientUrl
    返回用于访问应用程序的基本 URL。

  • getCurrentTheme
    返回表示当前 Microsoft Office Outlook 主题(由用户选择)的字符串。

  • getIsAutoSaveEnabled
    返回是否对组织启用自动保存。

  • getOrgLcid
    返回表示组织的基本语言的语言代码标识符 (LCID) 值。

  • getOrgUniqueName
    返回组织名称的唯一文本值。

  • getQueryStringParameters
    返回表示查询字符串参数(该参数被传递到页面)的键值对的词典对象。

  • getTimeZoneOffsetMinutes
    返回本地时与协调世界时 (UTC) 之间的时差。

    此方法与 Microsoft Dynamics CRM Online 2015 更新 1 一同引入。

  • getUserId
    返回当前用户 SystemUser.Id 值的 GUID。

  • getUserLcid
    返回表示用户选作首选语言的配置语言 LCID 值。

  • getUserName
    返回当前用户的名称。

  • getUserRoles
    返回表示每个安全角色 GUID 值的字符串数组,其中安全角色与用户关联或与用户相关的任何团队关联。

  • getVersion
    返回 Dynamics 365 服务器的版本号。

  • prependOrgName
    将组织名称预置到指定路径。

  • 删除的方法
    删除的方法已过时或替换为其他方法。 您应确定这些方法不用于您的脚本。

    getAuthenticationHeadergetServerUrl 方法与 Microsoft Dynamics CRM 2011 已被弃用并且不再位于 Microsoft Dynamics 365(在线或本地)。

    isOutlookClientisOutlookOnline 方法与 Microsoft Dynamics CRM 2013 已被弃用并且不再位于 Microsoft Dynamics 365(在线或本地)。

客户

Microsoft Dynamics CRM 2013 和 Microsoft Dynamics CRM Online 增加了包含 getClient 和 getClientState 方法的客户端对象,以获取客户端的相关信息。

Microsoft Dynamics CRM Online 2015 更新 1 添加了 getFormFactor 方法。

getClient

返回一个值以指明执行脚本的客户端。

context.client.getClient()

使用此方法而不是删除 isOutlookClient 的方法。

  • 返回值
    类型: 字符串

    返回的值为:

    客户

    网页

    浏览器

    Outlook

    Outlook

    移动电话

    移动电话

    移动电话

    交互式服务中心

getClientState

使用此方法而不是删除 isOutlookOnline 的方法。

返回一个值以指明客户端的状态。

context.client.getClientState()
  • 返回值
    类型: 字符串

    返回的值可能为:

    客户

    联机

    Web,Outlook,移动,交互式服务中心

    脱机

    Outlook 与移动电话

getFormFactor

使用此方法可以获取有关用户使用的设备类型的信息。

context.client.getFormFactor()
  • 返回值
    类型: 数字。

    返回的值可能为:

    窗体因素

    0

    未知

    1

    桌面

    2

    平板电脑

    3

    电话

  • 备注
    此方法与 Microsoft Dynamics CRM Online 2015 更新 1 一同引入

getClientUrl

返回用于访问应用程序的基本 URL。

context.getClientUrl()

使用此方法而不是删除 getServerUrl 的方法。

返回的值将类似于下表中所列的值。

客户

http(s)://server/org

Dynamics 365(本地)

https://org.crm.dynamics.com

Microsoft Dynamics 365 (online)

http://localhost:2525

带脱机访问功能的 Microsoft Dynamics 365 for Outlook,当脱机时

  • 返回值
    类型: 字符串

getCurrentTheme

返回表示当前 Microsoft Office Outlook 主题(由用户选择)的字符串。

备注

此函数不支持 Dynamics 365 移动客户端(电话和平板)和交互式服务中心。

context.getCurrentTheme()
  • 返回值
    类型: 字符串

当在 Microsoft Dynamics 365 for Outlook 中查看时,使用此信息选择您 HTML 和 Silverlight Web 资源的适当主题。 下表列出了可以通过此方法返回的值。

备注

窗体不适应 Microsoft Office 主题中的更改,所以唯一的案例是当您使用 HTML web 资源显示导航中的页面时,您可能想适应 Microsoft Office 主题。 甚至在此方案中也可能难以检测视觉差异。

主题

默认

Microsoft Dynamics 365 Web 应用程序

Office12Blue

Microsoft Dynamics 365 for Outlook 2007 或 2010 蓝色主题

Office14Silver

Microsoft Dynamics 365 for Outlook 2007 或 2010 银色或黑色主题

getIsAutoSaveEnabled

此方法与 Microsoft Dynamics CRM 2015 和 Microsoft Dynamics CRM Online 2015 更新 一同引入

返回是否对组织启用自动保存。

context.getIsAutoSaveEnabled()
  • 返回值
    类型: 布尔

    备注

    该函数返回打开页面时设置的值。 在使用该值测试代码时,您必须在更改值后刷新页面,才能获取新值。

    详细信息:TechNet:管理自动保存

getOrgLcid

返回表示组织的基本语言的 LCID 值。

context.getOrgLcid()

getOrgUniqueName

返回组织名称的唯一文本值。

context.getOrgUniqueName()
  • 返回值
    类型: 字符串

    示例: 对应于组织名称值

    "adventureworkscycle"
    

getQueryStringParameters

返回表示查询字符串参数(该参数被传递到页面)的键值对的词典对象。

context.getQueryStringParameters()
  • 返回值
    类型: 对象

getTimeZoneOffsetMinutes

返回本地时与协调世界时 (UTC) 之间的时差。

备注

此方法与 Microsoft Dynamics CRM Online 2015 更新 1 一同引入。

context.getTimeZoneOffsetMinutes()
  • 返回值
    类型: 数字。

getUserId

返回当前用户 SystemUser.Id 值的 GUID。

context.getUserId()
  • 返回值
    类型: 字符串

    示例:

    "{B05EC7CE-5D51-DF11-97E0-00155DB232D0}"
    

getUserLcid

返回表示用户选作首选语言的 Microsoft Dynamics 365 语言包 的 LCID 值。

context.getUserLcid()

getUserName

返回当前用户的名称。

context.getUserName()
  • 返回值
    类型: 字符串

getUserRoles

返回表示每个安全角色 GUID 值的字符串数组,其中安全角色与用户关联或与用户相关的任何团队关联。

有关安全角色的详细信息,请参阅 如何在 Microsoft Dynamics 365 中使用基于角色的安全性控制对实体的访问权限

context.getUserRoles()
  • 返回值
    类型: 数组

    示例: 该用户只具有与其用户帐户关联的安全角色。 具有单个值的此数组的 JSON 表示形式:

    ["cf4cc7ce-5d51-df11-97e0-00155db232d0"]
    

getVersion

返回 Dynamics 365 服务器的版本号。

context.getVersion()
  • 返回值
    类型: 字符串

prependOrgName

将组织名称预置到指定路径。

context.prependOrgName(sPath)
  • 参数
    类型: 字符串

    资源的本地路径。

  • 返回值
    类型: 字符串

    按照该模式返回的值:

    "/"+ OrgName + sPath
    

删除的方法

删除的方法已过时或替换为其他方法。 您应确定这些方法不用于您的脚本。

以下方法和 Microsoft Dynamics 365 早期版本已弃用,且不再位于当前版本:

另请参阅

GetGlobalContext function and ClientGlobalContext.js.aspx(客户端引用)
脚本即时引用的表单
为 Microsoft Dynamics 365 窗体编写代码
使用 Xrm.Page 对象模型
客户端编程引用

Microsoft Dynamics 365

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