ConvertersView Class

Caution

This API is preliminary and subject to change.

Inheritance Hierarchy

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

Syntax

public class ConvertersView : AxHost, 
	ICmnVisual, ICmnVisualUIHelper, ICmnVisualUIHelperCallbackEvents

Public Class ConvertersView
	Inherits AxHost
	Implements ICmnVisual, ICmnVisualUIHelper, ICmnVisualUIHelperCallbackEvents

public ref class ConvertersView : public AxHost, 
	ICmnVisual, ICmnVisualUIHelper, ICmnVisualUIHelperCallbackEvents

The ConvertersView type exposes the following members.

Constructors

	Name	Description
	ConvertersView	Initializes a new instance of the ConvertersView class

Properties

	Name	Description
	BorderVisible	Use this method to draw border around a control.
	Selected	Returns the selected converter's name. If nothing is selected, an empty string is returned.
	SelectedConverter	Returns the selected Ipro converter object.

Methods

	Name	Description
	Attach	To attach a ConvertersView control to an existing converter object.
	Detach	Use this method to detach a ConvertersView control from an existing converter.
	ExecuteCommand(Int32)	Executes control specific command if enabled programatically.
	ExecuteCommand(CONVERTERSVIEWCOMMAND)	To force executing a ConverterViews command.
	GetCommandState(Int32, Boolean, Boolean)	Returns control specific command state as enabled or checked.
	GetCommandState(CONVERTERSVIEWCOMMAND, Boolean, Boolean)	To request information about a ConverterViews command.
	GetMenu	Returns a full menu about its own commands.
	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.
	Int_Attach	To attach the control to an existing IPRO object.
	Int_Detach	To detach the control from an existing IPRO object.
	SetCommandHelpID	Pairs a help ID to each command.
	SetHelpID	If set, and F1 is pressed, returns a SetHelp ID from OnSetHelp
	SetUILang	Sets UI language from LANGUAGES enumeration of IPRO.

Events

	Name	Description
	OnAddConverter	Informs the user about addition of each converter when internal converter list is filled in.
	OnCloneConverter	Creates a copy of a factory converter whose settings can be modified for specific purposes.
	OnEditConverter	Enables addition of further converter properties in a dialog.
	OnEnterModal
	OnLeaveModal
	OnRemoveConverter	Removes the cloned converter created with CloneConverter method.
	OnSelectConverter	Selects the individual converters.
	OnSetHelp
	OnSetMessageString
	OnSetToolTip