用戶端內容 (用戶端參考)

  • 發行項

 

發行︰ 2016年11月

適用於： Dynamics CRM 2015

您的程式碼需要在設計時間有許多未知變數的內容中執行。 內容物件提供方法，可擷取傳遞至頁面的組織、使用者或參數的特定資訊。

內容物件可在表單透過參照 Xrm.Page.context 使用。

對於在表單外執行的 Web 資源，請使用 GetGlobalContext 函數 擷取內容物件。

內容屬性及方法

  • client
    讓您存取 getClient、getClientState 和 getFormFactor 方法，用來判斷正在使用的用戶端、用戶端是否是連線至伺服器，以及使用何種裝置。

  • getClientUrl
    傳回用來存取應用程式的基底 URL。

  • getCurrentTheme
    傳回字串，代表使用者選取的目前 Microsoft Office Outlook 主題。

  • getIsAutoSaveEnabled
    傳回 Autosave 是否為組織啟用。

  • getOrgLcid
    傳回語言識別代碼 (LCID) 值，代表組織的基礎語言。

  • getOrgUniqueName
    傳回組織名稱的唯一文字值。

  • getQueryStringParameters
    傳回索引鍵值組的字典物件，表示傳遞至頁面的查詢字串引數。

  • getTimeZoneOffsetMinutes
    傳回當地時間和國際標準時間 (UTC) 之間的時差。

    此方法已在 Microsoft Dynamics CRM Online 2015 更新 1 中引進。

  • getUserId
    傳回目前使用者之 SystemUser.Id 值的 GUID。

  • getUserLcid
    傳回 LCID 值，代表使用者選擇為慣用語言的已佈建語言。

  • getUserName
    傳回目前使用者名稱。

  • getUserRoles
    傳回字串陣列，其代表與使用者相關聯的或與使用者所屬團隊相關聯的每個資訊安全角色的 GUID 值。

  • prependOrgName
    在指定的路徑前面加上組織名稱。

  • 已移除的方法
    移除的方法已過時或取代成其他方法。 您應確認這些方法並未用於指令碼。

    getAuthenticationHeader 與 getServerUrl 方法已取代成 Microsoft Dynamics CRM 2011，不再出現於 Microsoft Dynamics CRM 2015 和 Microsoft Dynamics CRM Online 2015 更新。

    isOutlookClient 與 isOutlookOnline 方法已取代成 Microsoft Dynamics CRM 2013，不再出現於 Microsoft Dynamics CRM 2015 和 Microsoft Dynamics CRM Online 2015 更新。

client

Microsoft Dynamics CRM 2013 和 Microsoft Dynamics CRM Online 新增了用戶端物件，其中包含 getClient 和 getClientState 方法以取得關於用戶端的資訊。

Microsoft Dynamics CRM Online 2015 更新 1 中新增了 getFormFactor 方法。

getClient

回傳一個值指出指令碼在哪一個用戶端中執行。

context.client.getClient()

用來取代已移除的方法 isOutlookClient。

  • 傳回值
    **類型：**字串

    傳回的值為：

    用戶端

    值

    瀏覽器

    Web

    Outlook

    Outlook

    行動

    行動

getClientState

用來取代已移除的方法 isOutlookOnline。

回傳一個值指出用戶端的狀態。

context.client.getClientState()

  • 傳回值
    **類型：**字串

    傳回的可能值為：

    用戶端

    傳回的值

    Web、Outlook、Mobile

    線上

    Outlook、Mobile

    離線

getFormFactor

使用此方法取得使用者使用何種裝置的相關資訊。

context.client.getFormFactor()

  • 傳回值
    **類型：**數字

    傳回的可能值為：

    值

    尺寸

    0

    不明

    1

    桌上型電腦

    2

    平板電腦

    3

    電話

  • 備註
    此方法已在 Microsoft Dynamics CRM Online 2015 更新 1 中引進

getClientUrl

傳回用來存取應用程式的基底 URL。

context.getClientUrl()

用來取代已移除的方法 getServerUrl。

傳回的值類似下表所列的值。

用戶端

值

Microsoft Dynamics CRM (內部部署)

http(s)://server/org

Microsoft Dynamics CRM Online

https://org.crm.dynamics.com

Microsoft Dynamics CRM for Outlook with Offline Access (離線時)

https://localhost:2525
  • 傳回值
    **類型：**字串

getCurrentTheme

傳回字串，代表使用者選取的目前 Microsoft Office Outlook 主題。

注意

此函數無法與 平板電腦專用 Microsoft Dynamics CRM 搭配使用。

context.getCurrentTheme()
  • 傳回值
    **類型：**字串

在 Microsoft Dynamics CRM for Outlook 中檢視時，使用此資訊，為 HTML 和 Silverlight Web 資源選取一個適當主題。 下表列出可從此方法傳回的值。

注意

表單不會隨 Microsoft Office 主題中的變更而調整，因此，您可能配合 Microsoft Office 主題調整的唯一案例是在使用 HTML Web 資源，在導覽中顯示頁面時。 即使在本案例，視覺差異可能難以偵測。

值

佈景主題

default

Microsoft Dynamics 365 Web 應用程式

Office12Blue

Microsoft Dynamics CRM for Outlook 2007 或 2010 藍色佈景主題

Office14Silver

Microsoft Dynamics CRM for Outlook 2007 或 2010 銀色或黑色佈景主題

getIsAutoSaveEnabled

這是 Microsoft Dynamics CRM 2015 和 Microsoft Dynamics CRM Online 2015 更新 的新方法

傳回 Autosave 是否為組織啟用。

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

傳回 LCID 值，代表使用者選擇為慣用語言的Microsoft Dynamics CRM語言套件。

context.getUserLcid()

getUserName

傳回目前使用者名稱。

context.getUserName()
  • 傳回值
    **類型：**字串

getUserRoles

傳回字串陣列，其代表與使用者相關聯的或與使用者所屬團隊相關聯的每個資訊安全角色的 GUID 值。

如需資訊安全角色的詳細資訊，請參閱 角色型安全性如何用於控制 Microsoft Dynamics CRM 2015 實體的存取。

context.getUserRoles()

  • 傳回值
    **類型：**陣列

    **範例：**此使用者只有與使用者帳戶相關聯的資訊安全角色。 此陣列的單一值 JSON 表示為：

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

prependOrgName

在指定的路徑前面加上組織名稱。

context.prependOrgName(sPath)

  • 引數
    **類型：**字串

    資源的本機路徑。

  • 傳回值
    **類型：**字串

    傳回的值遵循此模式：

    "/"+ OrgName + sPath

已移除的方法

移除的方法已過時或取代成其他方法。 您應確認這些方法並未用於指令碼。

下列方法在舊版 Microsoft Dynamics 365 中已被取代，不再出現於目前版本：

另請參閱

GetGlobalContext 函數和 ClientGlobalContext.js.aspx (用戶端參考)
表單指令碼快速參考
撰寫 Microsoft Dynamics CRM 2015 表單的程式碼
使用 Xrm.Page 物件模型
用戶端程式設計參考

© 2017 Microsoft. 著作權所有，並保留一切權利。 著作權