EditorView Class

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

public class EditorView : AxHost, ICmnVisual, 
	ICmnVisualUIHelper, IResourceUser, ICmnVisualUIHelperCallbackEvents

Public Class EditorView
	Inherits AxHost
	Implements ICmnVisual, ICmnVisualUIHelper, IResourceUser, ICmnVisualUIHelperCallbackEvents

public ref class EditorView : public AxHost, 
	ICmnVisual, ICmnVisualUIHelper, IResourceUser, ICmnVisualUIHelperCallbackEvents

	Name	Description
	EditorView	Initializes a new instance of the EditorView class

Top

	Name	Description
	ActiveZone	This property controls the current zone index when the control is in Zone Validating Mode.
	BorderVisible	This property controls whether a thin 3D border will be displayed around the control or not.
	CharacterMapVisible	This property controls whether or not the character map is displayed.
	CustomMenuVisible	Use this function to programmatically configure the custom menu visibility.
	CustomToolbarVisible	Use this function to programmatically configure the custom toolbar visibility.
	CustomTooltips	Use this property to update a number of custom toolbar button related tooltip texts if you wish to replace the default values.
	DefaultMenuVisible	Use this function to programmatically configure the default menu visibility.
	EnableIntelliTrain	This property controls whether the IntelliTrain mode is enabled or not.
	EnableNondictWordMarking	This property controls whether the non-dictionary word marking (red wavy underline) is enabled or not.
	EnablePrintDialog	This property controls whether the Print dialog is displayed or not when the PrintText method is invoked.
	EnableProofReadDoneDialog	This property controls whether the proofread done dialog is displayed or not.
	EnableRedactDocumentDialog	This property controls whether the redact document dialog is displayed or not.
	EnableVerifier	This property controls whether displaying the Verifier is enabled or not.
	EnableWordWrap	This property controls whether word wrapping is enabled or not.
	FormArrangementToolbarVisible	This property controls whether the form object arrangement toolbar is displayed or not.
	Format	This property controls the formatting level for recognition result display.
	FormattingToolbarVisible	This property controls whether the text formatting toolbar is displayed or not.
	FormDrawingToolbarVisible	This property controls whether the Form object drawing toolbar is displayed or not.
	HeaderFooterVisible	This property controls whether headers and footers are displayed by the control or not.
	HighlightFillableFields	This property controls whether fill-able form fields are highlighted or not.
	LargeToolbarButtons	This property controls using large icons on toolbars.
	LearntCharColor	This property controls the font color of trained characters in the TEC control.
	MarkersVisible	This property controls whether markers related to recognition, training and proofing are displayed or not.
	MarkTextToolbarVisible	This property toggles text marking specific combos (highlight, strikeout, etc.) on the toolbar.
	MaxScrollX	This property controls the editor menu X coordinate.
	MaxScrollY	This property controls the editor menu Y coordinate.
	Measurement	This property controls which measurement unit is used when displaying or specifying measurement units on the UI or on particular dialog boxes.
	MissingCharColor	This property controls the color of the missing character highlights.
	NondictWordColor	This color controls the color of the non-dictionary word marking.
	NonPrintingCharsVisible	This property controls whether the non-printing, control characters - like new line, tabs and spacing dots - are displayed or not.
	ProofingBarVisible	This property controls whether the dock-able editor proofing bar is displayed or not.
	ProofStopOn	This property controls the "proof stop on" condition.
	ReadingOrderVisible	This property controls whether the zone reading order is displayed by the control or not.
	ReadOnly	This property controls whether the control is in read-only mode or not.
	RejectCharColor	This property controls the font color of the reject character.
	RulerVisible	This property controls whether the ruler bar is displayed or not.
	ScrollX	This property scrolls to the given X coordinate.
	ScrollY	This property scrolls to the given Y coordinate.
	SelAlignment	This property sets or returns the text alignment for the current selection.
	SelBkColor	This property sets the selection background color.
	SelBold	This property controls whether all the selected characters are bold or not.
	SelBullet	This property controls whether the current selection is bulleted or not.
	SelColor	This property sets or returns the font color for the current selection.
	SelFontName	This property sets or returns the font for the current selection.
	SelFontSize	This property sets or returns the font size for the current selection.
	SelHangingIndent	This property sets or returns the hanging text indent for the current selection.
	SelItalic	This property controls whether all the selected characters are italic or not.
	SelLeftIndent	This property sets or returns the left text indent for the current selection.
	SelLength	This property controls the length (number of characters) of the current selection.
	SelNumbering	This property controls whether the current selection is numbered or not.
	SelRightIndent	This property sets or returns the right text indent for the current selection.
	SelStart	This property controls the character index of the first character in the current selection.
	SelStrikeThru	This property controls whether all the selected characters are struck through or not.
	SelSubscript	This property controls whether all the selected characters are subscripted or not.
	SelSuperscript	This property controls whether all the selected characters are superscripted or not.
	SelText	This property returns the currently selected character string.
	SelUnderline	This property controls whether all the underlined characters are bold or not.
	ShortcutKeysInToolTipsVisible	Use this function to programmatically configure the shortcut key visibility in tooltips.
	SpeechAvailable	This property controls whether text reading is supported or not.
	SuspectCharColor	This property controls the color of the suspect character highlights.
	SuspectCharConfidenceThreshold	This parameter controls how much suspect markup (yellow highlight) will appear in the editor.
	SuspectWordColor	This property controls the color of the suspect word wavy underlining.
	Text	This property returns the plain text currently displayed by the TEC.
	TextLength	This property returns the length of the text (the number of characters) on the current page; it can be queried using the Text property.
	ToolTipsVisible	Use this function to programmatically configure the tooltip visibility on toolbar buttons.
	VerifierDynamic	This property controls the Verifier mode.
	VerifierVisible	This property controls whether the Verifier is visible or not.
	ZoneText	This property sets or returns the text associated with the current zone.
	ZoneValidationMode	This property turns on or off the zone validation mode.
	Zoom	This property controls the zoom. The value can be a TECSPECZOOMFACTORS value, or a certain zoom factor expressed in percentages.

Top

	Name	Description
	Attach	Use this method to attach the control to an existing document object.
	ClearTrainingData	Use this method to clear OCR-learnt recognition patterns.
	Copy	Use this function to copy the current selection to the clipboard.
	Cut	Use this function to move the current selection to the clipboard.
	Detach	Use this method to detach the control from an existing document.
	ExecuteCommand(Int32)	Executes control specific command if enabled programatically.
	ExecuteCommand(TECCOMMAND)	Use this method to force the execution of a TEC command that is also available through the custom TEC toolbar or popup menu.
	FindText	This method finds and selects the next occurrence of the word specified by the FindWhat parameter starting from the current insertion position.
	GetCommandState(Int32, Boolean, Boolean)	Returns control specific command state as enabled or checked.
	GetCommandState(TECCOMMAND, Boolean, Boolean)	Use this method to request information about a particular toolbar command.
	GetCustomMenuItems	Use this method to return which item is displayed on a custom menu in a given group.
	GetCustomToolbarButtons	Use this method to return which button is on the customized toolbar in the given group.
	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.
	GetTextExtent	Use this to retrieve the horizontal and vertical extents of the selected text in pixels.
	GetTrainingData	Returns with the current training data file name.
	Int_Attach	To attach the control to an existing IPRO object.
	Int_Detach	To detach the control from an existing IPRO object.
	IsTrainingDataModified	This checks whether the training data is modified or not.
	MergeCells	Use this to merge the selected table cells.
	Paste	Us this to pastes the current clipboard data at the current insertion position.
	PrintText	This method prints the currently displayed page.
	PrintTextEx	This method prints a page range.
	ProofChange	This replaces the last flagged word found with the new string specified by the ChangedTo parameter.
	ProofFindNext	This finds the next flagged word using the proofing conditions and returns values listed in TECPROOFRESULTS or 0 if not found.
	ProofGetChangeTo	This returns the content of the Change To edit field on the Proofing bar.
	ProofGetFoundWord	This returns the last found flagged word.
	ProofGetSuggestions	This returns the suggestion list for the last flagged word found.
	ProofSetChangeTo	This sets the content of the Change To edit field on the Proofing bar.
	Redo	Call this method to redo the last undone operation.
	ReplaceAllText	This method finds and replaces all occurrences of the word specified by the FindWhat parameter starting from the current insertion position with the word specified by the ReplaceWith parameter.
	ReplaceText	This method finds and replaces the next occurrence of the word specified by the FindWhat parameter starting from the current insertion position.
	ResourceAdded	Use this method to provide information on the type of resource that changed.
	ResourceChanged	Use this method to provide information on the change in the internal resource content.
	ResourceDeleted	Use this method to provide information on the deleted resource.
	ResourceInvalidated	Use this method to provide information on unknown resource changes.
	ResourceSelectionChanged	Use this method to provide information on the meaning of a selection change.
	SaveTrainingData	Use this to save the current training data, however it was created - automatically by IntelliTrain or by user interaction.
	SetCommandHelpID	Pairs a help ID to each command.
	SetCustomMenuItems	Use this method to set which item is displayed on a custom menu in a given group.
	SetCustomToolbarButtons	Use this method to set which button is on the customized toolbar in the given group.
	SetHelpID	If set, and F1 is pressed, returns a SetHelp ID from OnSetHelp.
	SetUILang	Sets UI language from LANGUAGES enumeration of IPRO.
	ShowFindDialog	Call this method to display the Find dialog.
	ShowFindDialogEx	Call this method to initialize and display the Find dialog.
	ShowReplaceDialog	Call this method to display the text replace dialog.
	ShowReplaceDialogEx	Call this method to display the text range replace dialog.
	ShowTrainEditDialog	Displays the Edit Training Dialog which allows already trained characters to be viewed and certain ones deleted from the training set.
	SpeakText
	SplitCells	Use this to split the selected table cell.
	StartProofing	This initiates the proofing procedure either using the Proofing dialog or the Proofing bar depending on the UseProofingDlg parameter.
	StartTraining	Call this method to display the Training Dialog which allows a selected, misrecognized character to be taught.
	StopSpeaking	Call this method to stop reading pages if speak is supported on the PC.
	Undo	Call this method to undo the last editing operation.
	UpdateCtrl	Use this method to invalidate and redraw the entire view.

Top

	Name	Description
	OnCharacterProperties	This event is fired to provide details about the character being focused.
	OnEnterModal
	OnLeaveModal
	OnPopupRect	This event is fired whenever the popup verifier becomes displayed.
	OnSelChange	This event is fired whenever the selection or the current insertion position changes.
	OnSetHelp
	OnSetMessageString
	OnSetToolTip
	OnTrainingDataChange	This event is fired whenever the current training data file is about to change, before a new training data file is loaded.
	OnUserDictRequired	This event is fired before adding new word to the user dictionary.

Top

There are three different display modes in TEC, each rendering the recognition results with different levels of formatting.

True Page® rendering mode returns the original image layout, with columns, headings, tables, pictures etc.
Formatted Text mode ignores the page structure, but displays formatted text in a single column, including titles, tables, pictures etc.
Plain Text mode shows the recognition result similarly, but with plain text in a fixed font size, with no formatting or text attributes, such as bold, italic or underlines.

The text editor can optionally display a set of delivery tools in a toolbar, and also a customizable toolbar allowing quick access to the features provided by the editor. A character map can also be displayed which contains a wide range of special characters that are not directly available from the keyboard. It includes a ribbon of recently used characters. Its purpose is to make an easy way to enter special characters into the text being edited.

Under a typical scenario, the Text Editor Control looks like this:

There are three different proofing capabilities supported by the control. The first is displaying a separate proofing dialog window enabling operators to proofread the recognition result. The second is a docked proofing bar which can be used parallel with the text editor's other services. The third option is the editor's ZVC mode which is described here.

Beginning with version 15, TEC also contains a special mode in which the control window allows users to navigate the editor text from zone to zone with the Verifier displayed. This means zone-level proofing is available which is by far the most effective zone validation method. In this scenario, together with the recognized text, the Verifier displays the original image, tracks and highlights the editor caret movements, and the control basically allows all the editing features to be used to correct recognition errors.

TEC does not support Asian languages. Such texts should not be passed to it. You might design your application to prevent this.

TEC plays a role in form design. When using LFR to activate a form or to prepare a form template, the only place to view and modify the form controls is in TEC.

Reference

Kofax.OmniPageCSDK.ToolBoxes Namespace