DocViewer properties
The document viewer is always accessed via the verification form and has the following customizable properties:
- ActivePageIndex
-
Returns the zero-based page index of the displayed page. For the Thin Clients this status property may return an unpredictable value during the DocumentLoaded event.
- DisplayPage
-
Displays the page specified by zero-based page index in the document viewer.
DisplayPage(ByVal PageIndex As Long)
- XOffSet
-
Returns the offset in X direction. This property is read-only and cannot be changed.
This property is not supported for Thin Clients. If needed, you can use the ProjectExecutionModuleType property to ensure that it is executed for rich clients only.
- YOffSet
-
Returns the offset in Y direction. This property is read-only and cannot be changed.
This property is not supported for Thin Clients. If needed, you can use the ProjectExecutionModuleType property to ensure that it is executed for rich clients only.
- ZoomIn
-
Increases the size of the document in the viewer.
- ZoomMode
-
Sets or returns one of the following zoom modes for the document viewer.
-
CSCBestFit - Displays document so that it is fully visible inside viewer.
-
CSCFitToWidth - Displays document so that it fits to width of viewer.
-
CSCFitToHeight - Displays document so that it fits to height of viewer.
-
CSCCustomZoom - Document resized according to current zoom value.
-
- ZoomOut
-
Decreases the size of the document in the viewer.
- ZoomToRectangle
-
Zooms to a rectangle in the document defined by the left position "x," the top position "y," width, and height.
ZoomToRectangle(ByVal x As Long, ByVal y As Long, ByVal Width As Long, ByVal Height As Long)
- ZoomValue
-
Sets or returns the zoom value.
For the Thin Clients you can use one zoom operation only, such as ZoomIn, ZoomOut, ZoomValue, ZoomToRectangle and ZoomMode, per event for the document viewer. If you implement several ones within the same event the last zoom operation is applied to the document all other zoom operations are ignored.
* For Thin Clients documents are loaded asynchronously in the background so that not all status information of the form elements is available when the Document_Loaded event is fired. That means that the value may not have the correct result.