Interface Navigation

Interface for the Xrm.Navigation API

Hierarchy

Navigation

Index

Methods

navigateTo openAlertDialog openConfirmDialog openErrorDialog openFile openForm openUrl openWebResource

Methods

navigateTo

navigateTo(pageInput, navigationOptions?): PromiseLike<any>
Navigates to the specified page.
Parameters
- pageInput: PageInputEntityRecord | PageInputEntityList | CustomPage | PageInputHtmlWebResource | Dashboard
  
  Input about the page to navigate to. The object definition changes depending on the type of page to navigate to: entity list or HTML web resource.
- Optional navigationOptions: NavigationOptions
  
  Options for navigating to a page: whether to open inline or in a dialog. If you don't specify this parameter, page is opened inline by default.
Returns PromiseLike<any>
- Defined in node_modules/@types/xrm/index.d.ts:5590

openAlertDialog

openAlertDialog(alertStrings, alertOptions?): PromiseLike<any>
Displays an alert dialog containing a message and a button.
Parameters
- alertStrings: AlertStrings
  
  The strings to be used in the alert dialog.
- Optional alertOptions: DialogSizeOptions
  
  The height and width options for alert dialog
Returns PromiseLike<any>
- Defined in node_modules/@types/xrm/index.d.ts:5605

openConfirmDialog

openConfirmDialog(confirmStrings, confirmOptions?): PromiseLike<ConfirmResult>
Displays a confirmation dialog box containing a message and two buttons.
Parameters
- confirmStrings: ConfirmStrings
  
  The strings to be used in the confirm dialog.
- Optional confirmOptions: DialogSizeOptions
  
  The height and width options for alert dialog
Returns PromiseLike<ConfirmResult>
- Defined in node_modules/@types/xrm/index.d.ts:5615

openErrorDialog

openErrorDialog(errorOptions): PromiseLike<any>
Displays an error dialog.
Parameters
- errorOptions: ErrorDialogOptions
  
  An object to specify the options for error dialog.
Returns PromiseLike<any>
- Defined in node_modules/@types/xrm/index.d.ts:5624

openFile

openFile(file, openFileOptions?): void
Opens a file.
Parameters
- file: FileDetails
- Optional openFileOptions: Xrm.Navigation.OpenFileOptions
Returns void
- Defined in node_modules/@types/xrm/index.d.ts:5629

openForm

openForm(entityFormOptions, formParameters?): PromiseLike<OpenFormResult>
Opens an entity form or a quick create form.
Parameters
- entityFormOptions: EntityFormOptions
- Optional formParameters: OpenParameters
Returns PromiseLike<OpenFormResult>
- Defined in node_modules/@types/xrm/index.d.ts:5634

openUrl

openUrl(url, openUrlOptions?): void
Opens a URL, including file URLs.
Parameters
- url: string
  
  URL to open.
- Optional openUrlOptions: DialogSizeOptions
  
  Options to open the URL
Returns void
- Defined in node_modules/@types/xrm/index.d.ts:5644

openWebResource

openWebResource(webResourceName, windowOptions?, data?): void
Opens an HTML web resource.
Parameters
- webResourceName: string
  
  Name of the HTML web resource.
- Optional windowOptions: OpenWebresourceOptions
  
  (Optional) Window options for opening the web resource. It is advised to use encodeURIcomponent() to encode the value.
- Optional data: string
Returns void
- Defined in node_modules/@types/xrm/index.d.ts:5652

Interface Navigation

Hierarchy

Index

Methods

Methods

navigateTo

Parameters

pageInput: PageInputEntityRecord | PageInputEntityList | CustomPage | PageInputHtmlWebResource | Dashboard

Optional navigationOptions: NavigationOptions

Returns PromiseLike<any>

openAlertDialog

Parameters

alertStrings: AlertStrings

Optional alertOptions: DialogSizeOptions

Returns PromiseLike<any>

openConfirmDialog

Parameters

confirmStrings: ConfirmStrings

Optional confirmOptions: DialogSizeOptions

Returns PromiseLike<ConfirmResult>

openErrorDialog

Parameters

errorOptions: ErrorDialogOptions

Returns PromiseLike<any>

openFile

Parameters

file: FileDetails

Optional openFileOptions: Xrm.Navigation.OpenFileOptions

Returns void

openForm

Parameters

entityFormOptions: EntityFormOptions

Optional formParameters: OpenParameters

Returns PromiseLike<OpenFormResult>

openUrl

Parameters

url: string

Optional openUrlOptions: DialogSizeOptions

Returns void

openWebResource

Parameters

webResourceName: string

Optional windowOptions: OpenWebresourceOptions

Optional data: string

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` navigationOptions: NavigationOptions

`Optional` alertOptions: DialogSizeOptions

`Optional` confirmOptions: DialogSizeOptions

`Optional` openFileOptions: Xrm.Navigation.OpenFileOptions

`Optional` formParameters: OpenParameters

`Optional` openUrlOptions: DialogSizeOptions

`Optional` windowOptions: OpenWebresourceOptions

`Optional` data: string