ImageView Class

Caution

This API is preliminary and subject to change.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsAxHost
          Kofax.OmniPageCSDK.ToolBoxesImageView

Namespace: Kofax.OmniPageCSDK.ToolBoxes
Assembly: Kofax.OmniPageCSDK.ToolBoxes (in Kofax.OmniPageCSDK.ToolBoxes.dll) Version: 1.0.0.0

Syntax

C++

Copy

public class ImageView : AxHost, ICmnVisual, 
	ICmnVisualUIHelper, ICmnVisualUIHelperCallbackEvents, IResourceProviderEvents

Public Class ImageView
	Inherits AxHost
	Implements ICmnVisual, ICmnVisualUIHelper, ICmnVisualUIHelperCallbackEvents, IResourceProviderEvents

public ref class ImageView : public AxHost, 
	ICmnVisual, ICmnVisualUIHelper, ICmnVisualUIHelperCallbackEvents, IResourceProviderEvents

The ImageView type exposes the following members.

Constructors

	Name	Description
	ImageView	Initializes a new instance of the ImageView class

Top

Properties

Name

Description

ActiveZone

This property sets or retrieves the index of the active zone - which displays the resizing handles - in the ImageView.

ArrowsVisible

Set this property to true to display the zone order arrows.

AutoZoneColor

This property controls what color is used when painting process (auto) zones.

BackColor

This property controls which color is used when painting the control background.

BorderVisible

This property controls whether a thin 3D border will be displayed around the control or not.

EnableCustomDrawing

Set this property to True in order to enable custom view drawing.

EnableDrag

Caution

This API is preliminary and subject to change.

EnablePrintDialog

Use this property to force the Print dialog box to be displayed when initiating a print operation through the PrintImage method.

EnableZoneChange

This property controls whether the existing zone set can or cannot be modified.

EnableZoneCreating

This property controls whether creating a new zone is allowed in the ImageView or not.

FormZoneColor

This property controls which color is used when painting form zones.

IgnoreZoneColor

This property controls which color is used when painting ignore zones.

ImageZoneColor

This property controls which color is used when painting graphics zones.

LargeToolbarButtons

Obsolete.

LeftVerticalTextZoneColor

This property controls which color is used when painting left vertical text zones.

MenuVisible

This property controls whether displaying context-sensitive popup menus is enabled or not. The default value for this property is True.

OverviewVisible

This property controls whether the overview window is displayed or not.

ProgressIndicationVisible

This property controls whether the ImageView level recognition progress indication is enabled or not.

RecommendedZoneVisible

This property controls whether the zone advisor is turned on or not.

RightVerticalTextZoneColor

This property controls which color is used when painting right vertical text zones.

ScrollXPos

This property returns the current horizontal scroll position of the view in pixels.

ScrollYPos

This property returns the current vertical scroll position of the view in pixels.

TableDividerColor

Caution

This API is preliminary and subject to change.

TableZoneColor

This property controls which color is used when painting table zones.

TextZoneColor

This property controls which color is used when painting text zones.

ToolbarVisible

This property controls whether the ImageView toolbar is displayed or not.

Tooltips

Use this property to update a number of toolbar button related tool tip texts if you wish to replace the default values.

VerticalTextZoneColor

This property controls which color is used when painting vertical text zones.

ViewHeight

This property returns the current view height in pixels.

ViewWidth

This property returns the current view width in pixels.

ZonesVisible

This property controls whether the page zones are drawn or not on the image.

Zoom

This property controls the current zoom rate applied by the ImageView.

Top

Methods

	Name	Description
	Attach	Use this method to attach the control to an existing document object.
	ConvDeviceToImg	Use this function to convert Device coordinates to Image (II_CURRENT) coordinates.
	ConvImgToDevice	Use this function to convert Image (II_CURRENT) coordinates to Device coordinates.
	ConvImgToView	Use this function to convert the Image (II_CURRENT) coordinates to View coordinates.
	ConvImgToWindow	Use this function to convert Image (II_CURRENT) coordinates to Window coordinates.
	ConvViewToImg	Use this function to convert the View coordinates to Image (II_CURRENT) coordinates.
	ConvWindowToImg	Use this function to convert Window coordinates to Image (II_CURRENT) coordinates.
	Detach	Use this method to detach the control from an existing document.
	EnsureVisible	Use this method to scroll a particular image rectangle into the view if it is not already visible.
	ExecuteCommand(Int32)	Executes control specific command if enabled programatically.
	ExecuteCommand(IVCTOOLBARBUTTON)	Use this method to force executing an ImageView command also available through the ImageView toolbar or popup menu.
	GetCommandState(Int32, Boolean, Boolean)	Returns control specific command state as enabled or checked.
	GetCommandState(IVCTOOLBARBUTTON, Boolean, Boolean)	Use this method to request information about a particular toolbar command.
	GetMenu	Returns a full menu about its own commands.
	GetMenuItems	Use this method to return which item is displayed on the menu in a given group.
	GetMenuString	Returns control specific menu string to be displayed in a menu.
	GetMessageString	Returns a detailed control specific menu string to be displayed in a menu.
	GetToolbarButtons	Use this method to return which button is displayed on the menu in a given group.
	HighlightRect	Use this method to frame a particular image rectangle.
	Int_Attach	To attach the control to an existing IPRO object.
	Int_Detach	To detach the control from an existing IPRO object.
	PrintImage	This method prints the currently displayed image.
	PrintImageEx	This method prints the an image range.
	SetCommandHelpID	Pairs a help ID to each command.
	SetHelpID	If set, and F1 is pressed, returns a SetHelp ID from OnSetHelp.
	SetMenuItems	Use this method to set which item is displayed on the menu in a given group.
	SetToolbarButtons	Use this method to set which button is displayed on the menu in a given group.
	SetUILang	Sets UI language from LANGUAGES enumeration of IPRO.
	UpdateCtrl	Use this method to invalidate and redraw the entire view.
	UpdateCtrlRect	Use this method to invalidate and update a partial rectangle of the ImageView.

Top

Events

	Name	Description
	OnActiveZoneChanged	This event is fired whenever another zone becomes active in the ImageView.
	OnAfterCustomPaint	This event is fired when the EnableCustomDrawing property is True, and the control is about to finish painting its content.
	OnAfterZoneCustomDrawing	This event is fired when EnableCustomDrawing and ZonesVisible properties are True, and the control is about to finish painting one of the zones.
	OnAfterZonesChanged	This event is fired after the attributes and / or positions of one or more zones have changed.
	OnBeforeCustomPaint	This event is fired when the EnableCustomDrawing property is True, and the control is about to paint its content.
	OnBeforeZoneCustomDrawing	This event is fired when the EnableCustomDrawing and ZonesVisible properties are True, and the control is about to paint one of the zones.
	OnBeforeZonesChanged	This event is fired before the attributes and / or positions of one or more zones are about to change.
	OnEnterModal
	OnGetResources
	OnLeaveModal
	OnMouseButtonDown	This event is fired whenever a mouse button is pressed while the mouse is over the ImageView.
	OnMouseButtonUp	This event is fired whenever a mouse button is released while the mouse is over the ImageView.
	OnMouseMovedTo	This event is fired whenever the mouse pointer position changes over the ImageView.
	OnReorderingFinished	This event is fired when a previously initiated zone reorder function is terminated.
	OnResourceChanged
	OnResourceCreated
	OnResourceSelectionChanged
	OnSetHelp
	OnSetMessageString
	OnSetToolTip

Top

Reference

Kofax.OmniPageCSDK.ToolBoxes Namespace