Xrm.Utility JavaScript methods in Dynamics 365 Version 9.x

Xrm.Utility: 

Method
Description
closeProgressIndicator
Closes a progress dialog box.
Xrm.Utility.closeProgressIndicator()
getAllowedStatusTransitions
Returns the valid state transitions for the specified entity type and state code.
Xrm.Utility.getAllowedStatusTransitions(entityName,stateCode).then(successCallback, errorCallback)
getEntityMetadata
Returns the entity metadata for the specified entity.
Xrm.Utility.getEntityMetadata(entityName,attributes).then(successCallback, errorCallback)
getGlobalContext
Gets the global context.
getLearningPathAttributeName
Returns the name of the DOM attribute expected by the Learning Path (guided help) Content Designer for identifying UI controls in the Dynamics 365 Customer Engagement forms.
Xrm.Utility.getLearningPathAttributeName()
getResourceString
Returns the localized string for a given key associated with the specified web resource.
Xrm.Utility.getResourceString(webResourceName,key)
invokeProcessAction
Invokes an action based on the specified parameters.
Xrm.Utility.invokeProcessAction(name,parameters).then(successCallback, errorCallback)
lookupObjects
Opens a lookup control to select one or more items.
Xrm.Utility.lookupObjects(lookupOptions).then(successCallback, cancelCallback)
lookupOptions: Object. Defines the options for opening the lookup dialog. Has the following properties:
Property Name
Type
Required
Description
allowMultiSelect
Boolean
No
Indicates whether the lookup allows more than one item to be selected.
defaultEntityType
String
No
The default entity type to use.
defaultViewId
String
No
The default view to use.
entityTypes
Array
No
The entity types to display.
showBarcodeScanner
Boolean
No
Indicates whether the lookup control should show the barcode scanner in mobile clients.
viewIds
Array
No
The views to be available in the view picker. Only system views are supported.
successCallback
Function
Yes
A function to call when the lookup control is invoked. An object with the following properties is passed:
entityType: String. Entity type of the record selected in the lookup control.
id: String. ID of the record selected in the lookup control.
name: String. Name of the record selected in the lookup control.
errorCallback
Function
Yes
A function to call when you cancel the lookup control or the operation fails.
refreshParentGrid
Refreshes the parent grid containing the specified record.
Xrm.Utility.refreshParentGrid(lookupOptions)
lookupOptions: An object with the following properties to specify the record:+
Property Name
Type
Required
Description
entityType
String
Yes
Entity type of the record.
id
String
Yes
ID of the record.
name
String
No
Name of the record.
showProgressIndicator
Displays a progress dialog with the specified message.
Xrm.Utility.showProgressIndicator(message)

Deprecated methods

The following table lists the new methods you should use instead of the deprecated methods in the Xrm.Utility namespace.
These methods were deprecated in Dynamics 365 (online), version 9.0.

Deprecated Method
New method to be used
alertDialog
Xrm.Navigation.openAlertDialog
confirmDialog
Xrm.Navigation.openConfirmDialog
getBarcodeValue
Xrm.Device.getBarcodeValue
getCurrentPosition
Xrm.Device.getCurrentPosition
openEntityForm
Xrm.Navigation.openForm
openQuickCreate
Xrm.Navigation.openForm
openWebResource
Xrm.Navigation.openWebResource

0 comments:

Post a comment

Popular Posts