In This Topic ▼

imageViewer Property

Summary

Image viewer control.

Syntax

TypeScript

JavaScript

Object.defineProperty(DocumentViewerView.prototype, 'imageViewer', 
	get: function() 
)

imageViewer: ImageViewer; // read-only

The ImageViewer control used to view the main content of the document.

Remarks

ImageViewer is initialized during CreateDocumentViewer. A new instance of ImageViewer is created and set in this property. The control is added as a child to DocumentViewerCreateOptions.ViewContainer and initialized as follows:

Member	Description
ViewHorizontalAlignment and ViewVerticalAlignment	Center
ImageHorizontalAlignment and ImageVerticalAlignment	Center
ImageBorderThickness	1
ImageBackgroundColor	White color
ItemPadding	4, 4, 4, 4
UseDpi	true
ImageViewer.Tag	Set to the owner DocumentViewer. Be careful not to modify this value in your application.

In addition to the above, the document viewer subscribes to the PostRenderItem event to render the current text selection used by DocumentViewer.Text, the annotations for the pages used by Annotations and any optional debugging rendering done by DocumentViewer.Diagnostics.

After CreateDocumentViewer returns, you can further customize or use this ImageViewer control as needed by your application.

Example

For an example, refer to DocumentViewer.View.

Requirements

Help Version 20.0.2020.4.3