Documents Class

The Documents collection is a sorted set of Document objects, where each element represents a document handled by the Engine.

Inheritance Hierarchy

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

Syntax

public class Documents : IproPlusClass, IDisposable

Public Class Documents
	Inherits IproPlusClass
	Implements IDisposable

public ref class Documents : public IproPlusClass, 
	IDisposable

The Documents type exposes the following members.

Properties

	Name	Description
	ActiveDocumentMode	This property allows you to control the active document mode.
	Count	This property returns the number of Document objects stored in the collection.

Methods

	Name	Description
	Add	This method creates a new document, adds it to the collection and returns a reference to the newly created Document object.
	Dispose	Releases all resources used by the Documents
	GetEngine	Returns the Engine object.
	GetEnumerator
	GetItem	This property returns the specified Document object from the collection.
	ItemByUniqueID	This method returns a Document object from the collection specified by its UniqueID.
	Remove	This method removes the specified Document from the collection without saving it.

Events

	Name	Description
	OnDocumentActivated	Fires after a Document in the Documents collection becomes Active.
	OnDocumentAdded	Fires when a new Document was added to the Documents collection.
	OnDocumentChanged	Fires when the WorkingFileName of a Document in the Documents collection was changed.
	OnDocumentClosed	Fires when a Document in the Documents collection was closed.
	OnDocumentRemoved	Fires when a Document was removed from the Documents collection.
	OnDocumentTitleChanged	Fires when the Title of a Document in the Documents collection was changed.
	OnEnterUIMode	Fires before a Document in the Documents collection accesses the UI.
	OnLeaveUIMode	Fires after a Document in the Documents collection left the UI.
	OnWaitForUIMode	Fires when a Document in the Documents collection can not access the UI because it is not Active.

Kofax.OmniPageCSDK.IproPlusDocuments