DocumentView Class |
 Caution |
|---|
This API is preliminary and subject to change.
Inheritance HierarchySystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
System.Windows.FormsControl
System.Windows.FormsAxHost
Kofax.OmniPageCSDK.ToolBoxesDocumentView
SystemMarshalByRefObject
System.ComponentModelComponent
System.Windows.FormsControl
System.Windows.FormsAxHost
Kofax.OmniPageCSDK.ToolBoxesDocumentView
Namespace: Kofax.OmniPageCSDK.ToolBoxes
Assembly: Kofax.OmniPageCSDK.ToolBoxes (in Kofax.OmniPageCSDK.ToolBoxes.dll) Version: 1.0.0.0
SyntaxThe DocumentView type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DocumentView | Initializes a new instance of the DocumentView class |
Properties| Name | Description | |
|---|---|---|
 | BackgroundColor |
Use this method to set the background color in the DocumentView Properties dialog.
|
| BorderVisible |
Use this method to draw border around a DocumentView control.
|
| Count |
Get information about how many documents a DocumentView control is aware of.
|
| Current |
Returns the index of the document the user is currently watching.
|
| EnableAlphaBlend |
Obsolete
|
| EnableMulticolumn |
Obsolete
|
| EnablePageDrag |
Use this method to enable dragging of selected page; default setting is true.
|
| EnablePageDropFromOtherDocument |
Use this method to enable dropping of pages from other documents.
|
| EnablePageDropFromSameDocument |
Use this method to enable dropping of pages from same documents.
|
| EnableTooltips |
Use this method to show tooltips for individual images.
|
| IconBackgroundColor |
Obsolete
|
| MeasurementUnits |
This property controls which UNITTYPE unit is used when displaying information in thumbnail tooltips.
|
| OneClickActivate |
Makes a page active on one click.
|
| ThumbnailView |
Returns the ThumbnailView assigned to active document.
|
Methods| Name | Description | |
|---|---|---|
| Add |
Adds a new document.
|
| Attach |
Use this method to attach the control to the Engine.Documents object.
|
| Detach |
Use this method to detach the control from the Engine.Documents object.
|
| DetachAll |
If n documents are open, the control is able to close all of them at the same time.
|
| ExecuteCommand(Int32) |
Executes control specific command if enabled programatically.
|
| ExecuteCommand(THUMBNAILVIEWCOMMAND) |
To force executing a DocumentView command.
|
| GetCommandState(Int32, Boolean, Boolean) |
Returns control specific command state as enabled or checked.
|
| GetCommandState(THUMBNAILVIEWCOMMAND, Boolean, Boolean) |
To request information about a DocumentView 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.
|
| GetTitle |
Returns the document title; can rename the document to anything.
|
| Int_Attach |
To attach the control to an existing IPRO object.
|
| Int_Detach |
To detach the control from an existing IPRO object.
|
| Remove |
Removes a document from the Document View.
|
| Select |
Selects an active document in the Document View.
|
| SetCommandHelpID |
Pairs a help ID to each command.
|
| SetHelpID |
If set, and F1 is pressed, returns a SetHelp ID from OnSetHelp |
| SetTitle |
Sets the document title.
|
| SetUILang |
Sets UI language from LANGUAGES enumeration of IPRO.
|
| UpdateCtrl |
Obsolete
|
Events| Name | Description | |
|---|---|---|
 | OnCloseDocument |
Fired when DocumentView wants to close a document.
|
| OnDocumentTitleChanged |
Fired when the document title changed.
|
| OnEnterModal | |
| OnLeaveModal | |
| OnRegisterDocument |
Fired when documents are recovered after a crash.
|
| OnRemovePages |
Fired when the user is informed about which pages to delete.
|
| OnSelectedDocumentChanged |
Fired when the user changes active document in DocumentView.
|
| OnSetHelp | |
| OnSetMessageString | |
| OnSetToolTip | |
| OnUnregisterDocument |
Fired when temporary files are deleted on successful change.
|
See Also