evCreate API 5.7 Help

OpenDocument Function

Opens an Envision document located on the Canvas Envision Portal cloud solution in the current browser tab with the embedded front-end app of the Canvas Envision Creator.

OpenDocument(file?: [[[EvCloudFile|evcloudfile-interface.html]]]): Promise<undefined | [[[EvCloudFile|evcloudfile-interface.html]]]>

Parameters

file?: EvCloudFile

An EvCloudFile object with the location of an opened .evdoc file on the Canvas Envision Portal cloud solution. If it is not given, a dialog pops up to search for and select the file.

Return value

Promise<undefined | EvCloudFile>

A Promise that, if fulfilled, resolves to either:

  • undefined: the OpenDocument function cannot be used for some reason, for example, it has been called for a full Canvas Envision Creator app instance. However, an error is thrown in most error cases.

  • EvCloudFile: an object with the location of the successfully opened file.

Discussion

The OpenDocument function is available only for an embedded front-end app of the Canvas Envision Creator.

11 February 2025