ZoomViewer Object (IZoomViewer Interface)

ActiveTool

BoxEditorToolEnum

Specifies the active tool for blocks and image editing.

BottomPaneEnabled

VARIANT_BOOL

Specifies whether the bottom pane of Zoom Viewer is enabled. If this property is FALSE, bottom pane is not displayed.

By default, the value is TRUE.

ContextMenuEnabled

VARIANT_BOOL

Specifies whether the context menu of Zoom Viewer is enabled. If this property is FALSE, context menu is never displayed.

By default, the value is TRUE.

Commands

Commands, read-only

Provides access to the commands available in Zoom Viewer. See the list of commands available in Zoom Viewer.

FRPage

FRPage

Represents the document page connected to Zoom Viewer.

Locked

VARIANT_BOOL

Specifies whether Zoom Viewer is locked.

This property is useful in the following situations:

• analysis, recognition, synthesis, or export operation is called from FineReader Engine API (not from Visual Components), or
• your application receives notifications of certain events (e.g., from the FRDocument object) and processes Windows messages from Visual Components in these events handlers.

In this case, we recommend that you set this property to TRUE before analysis, recognition, synthesis or export, and set it to FALSE after the end of the operation. In this case, the document cannot be spoilt from Zoom Viewer.

By default, the value is FALSE.

ProcessingParams

DocumentProcessingParams

Specifies the default processing parameters for the document. These parameters are used if the analysis and recognition processes are called directly from Zoom Viewer.

SettingsPath

BSTR

Specifies the path to the folder which contains files with the settings of Zoom Viewer. Other Visual Components have the same property. Each Visual Component should use its own folder with settings.

The value of this property is constructed from the path to the folder, in which ABBYY FineReader Engine stores user-specific data, and the name of its subfolder. By default, the folder with user-specific data is the FineReader Engine data folder. It can be changed during initialization of FineReader Engine (via the InitializeEngine function, or via the IEngineLoader::InitializeEngine method). The default name of the subfolder is an arbitrary GUID. To change the name of the subfolder, you should specify the new name in the properties of the component in Visual Studio at design time. If you try to specify the value of the property at run time, this value is ignored.

If you add the component to a form in Visual Studio when designing, the value of the property is defined either automatically with the default value, or manually with a custom value. In both cases the value is defined at design time. If for some reason the value of the property is not defined at design time (e.g., if you generate the component dynamically at run time), the component creates a new folder with the settings each time the component is initialized. To avoid multiplication of the folders, you should delete the created settings folder after the component deinitialization. In this case, you can use only the default settings of the component and cannot save the settings between sessions.

SymbolRect

FRRectangle

Stores the coordinates of the current character rectangle in pixels. The coordinates are relative to the document image.

SymbolRectEnabled

VARIANT_BOOL

Specifies whether the current character should be marked with a yellow rectangle.

By default, the value is TRUE.

ViewScale

int

Specifies the scale of the image in percentage points. This property can be also set to one of the ScaleTypes constants.

By default, the value is ST_PixelToPixel, which means that the image is displayed in the pixel-to-pixel mode.

VisibleDocumentArea

FRRectangle, read-only

Stores the coordinates of the visible document area in pixels. The coordinates are relative to the document image.

WindowHandle

__int64, read-only

Returns the window handle of the client area.