openWebResource (Client API reference)

Opens an HTML web resource in a new window.

Syntax

Xrm.Navigation.openWebResource(webResourceName,windowOptions,data)

Parameters

Name	Type	Required	Description
webResourceName	String	Yes	Name of the HTML web resource to open.
windowOptions	Object	No	Window options for opening the web resource. The object contains the following values: - height: (Optional) Number. Height of the window to open in pixels. - width: (Optional) Number. Width of the window to open in pixels.
data	String	No	Data to be passed into the data parameter.

Remarks

You must use this method to display web resources instead of the deprecated Xrm.Utility.openWebResource method.

An HTML web resource can accept the parameter values described in Pass parameters to HTML web resources. This function only provides for passing in the optional data parameter. To pass values for the other valid parameters, you must append them to the webResourceName parameter.

Note

The Xrm object isn't available in HTML web resources. Therefore, scripts containing Xrm.* methods aren't supported in HTML web resources. parent.Xrm.* will work if the HTML web resource is loaded in a form container. However, for other places, such as loading an HTML web resource as part of the SiteMap, parent.Xrm.* also won't work. More information: GetGlobalContext function and ClientGlobalContext.js.aspx

Examples

• Open an HTML web resource named "new_webResource.htm":

  Xrm.Navigation.openWebResource("new_webResource.htm");

• Open an HTML web resource, setting the windowOptions:

  var windowOptions = { height: 400, width: 400 };
  Xrm.Navigation.openWebResource("new_webResource.htm",windowOptions);
  

• Open an HTML web resource including a single item of data for the data parameter

  Xrm.Navigation.openWebResource("new_webResource.htm",null,"dataItemValue");

Related articles

Xrm.Navigation