Monday, October 31, 2011

Useful JavaScript commands for Microsoft CRM 2011 - Part 1: Xrm.Page.context

Useful JavaScript commands for Microsoft CRM 2011 - Part 1: Xrm.Page.context
Xrm.Page.context – provides methods to obtain information specific to the organization, user or parameters that were passed in the form of a query string.
Command

Description
.getAuthenticationHeader()
Returns the encoded header SOAP-request for Web service in the style of MSCRM 4.0.
.getCurrentTheme()
Returns the current user's Outlook theme.
.getOrgLcid()
Returns the value of the LCID for the main language of the organization.

Example:
Xrm.Page.context. getOrgLcid();
.getOrgUniqueName()
Returns the unique name of the organization.
.getQueryStringParameters()
Returns an array of key-value pairs passed in the query string.
.getServerUrl()
Returns the base server URL. When a user is working offline with Microsoft Dynamics CRM for Microsoft Office Outlook, the URL is to the local Microsoft Dynamics CRM Web services.
.getUserId()
Returns the GUID value of the SystemUser.id value for the current user.

Example:
Xrm.Page.context.getUserId();
.getUserLcid()
Returns the LCID value that represents the Microsoft Dynamics CRM Language Pack that is the user selected as their preferred language.

Example:
Xrm.Page.context.getUserLcid();
.getUserRoles()
Returns an array of strings representing the GUID values of each of the security roles that the user is associated with.

Example:
Xrm.Page.context.getUserRoles();
.isOutlookClient()
Returns a Boolean value indicating if the user is using Microsoft Dynamics CRM for Microsoft Office Outlook.

Example:
Xrm.Page.context.isOutlookClient();
.isOutlookOnline()
Returns a Boolean value indicating whether the user is connected to the Microsoft Dynamics CRM server while using Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access. When this function returns false, the user is working offline without a connection to the server. They are interacting with an instance of Microsoft Dynamics CRM running on their local computer.

Example:
Xrm.Page.context.isOutlookOnline();
.prependOrgName()
Adds the name of the organization to the specified path.

1 comment: