In This Topic ▼

createDocumentViewer Method

Summary

Creates a new instance of DocumentViewer from the specified options.

Syntax

TypeScript

JavaScript

createDocumentViewer = function( 
   createOptions 
)

static createDocumentViewer( 
   createOptions: DocumentViewerCreateOptions 
): DocumentViewer;

createOptions

Options to use when creating the DocumentViewer. This parameter cannot be null.

The new DocumentViewer object.

Remarks

This method works as follows:

Commands is created.
If ViewContainer is not null, then View is created in ViewContainer.
If ThumbnailsContainer is not null, then Thumbnails is created and added to it.
Bookmarks is created.
If UseAnnotations is true, then Annotations is created.
Diagnostics is created.
Finally, the interactiveSelectText command is run to set this mode as the default interactive mode for the view. Run any other interactive mode commands after this method returns to set the initial mode to a different value (for example, calling DocumentViewerInstance.Commands.Run(documentviewercommands.interactiveautopan), null) to set auto-pan as the default interactive mode).

After DocumentViewer is created and initialized, use it by loading a LEADDocument object and calling the SetDocument method to view the document.

Example

For an example, refer to DocumentViewer.

Requirements

Help Version 20.0.2020.4.3