Pages Class

This property returns the Pages collection, containing the document Page objects.

Inheritance Hierarchy

SystemObject
Kofax.OmniPageCSDK.IproPlusIproPlusClass
Kofax.OmniPageCSDK.IproPlusPages

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

Syntax

C++

Copy

public class Pages : IproPlusClass, IDisposable

Public Class Pages
	Inherits IproPlusClass
	Implements IDisposable

public ref class Pages : public IproPlusClass, 
	IDisposable

The Pages type exposes the following members.

Properties

	Name	Description
	ActivePageID	Sets/returns the active page.
	ActivePageIndex	Use this property to get or set the index of the active page.
	CanRedo	This property returns whether the action can be redone.
	CanUndo	This property returns whether the action can be undone.
	Count	This property returns the number of Page objects stored in the collection.

Top

Methods

	Name	Description
	CopyAllPages	Copies all pages from this document to another IPRO document.
	CopyPages	This method copies one or more pages from this document to another IPRO document.
	CopySelectedPages	Copies selected pages from this document to another IPRO document.
	CountByState	Returns the number of specified Page objects stored in the collection.
	DeselectAll	Calling this method sets the Document object's Modified property to True.
	Dispose	Releases all resources used by the Pages
	GetDocument	Returns the parent Document object.
	GetEngine	Returns the Engine object.
	GetEnumerator
	GetItem	This property returns the requested Page object from the collection.
	Indices	Returns the indices of specified Pages objects stored in the collection.
	ItemByUniqueID	Returns the requested Page object from the collection.
	MoveAllPages	Moves all pages.
	MoveAt	Calling this method moves the page located at OldPosition to NewPosition.
	MovePages	This method is similar to the CopyPages method, but moves the pages (i.e. the original pages in the source document are deleted).
	MoveSelectedPages	Moves the selected pages.
	Redo	Revokes the last action.
	Remove	This method removes the specified page from the collection.
	RemoveAllPages	Removes all pages from the collection.
	RemovePages	Removes one or more pages from the collection.
	RemoveSelectedPages	Removes the selected pages from the collection.
	SelectAll	This method selects all pages.
	SelectPages	Selects specified pages from the collection.
	Undo	Revokes the last action.
	UniqueIDs	Returns the IDs of specified Pages objects stored in the collection.

Top

Events

	Name	Description
	OnActivePageChanged	This event is fired when the active page is changed.
	OnImageChanged	This event is fired when an image is changed.
	OnPageInserted	This event is fired when a page is inserted into the document.
	OnPageMoved	This event is fired when a page of the document is moved.
	OnPageRemoved	This event is fired when a page is removed from the document.
	OnPagesMoved	This event is fired when a number of pages are moved in the document.
	OnPagesRemoved	This event is fired when a number of pages are removed from the document.
	OnPagesReordered	This event is fired when the pages of the document are reordered.
	OnPageStateChanged	This event is fired when the state of a page is changed.
	OnStatisticsChanged	This event is fired when the page is modified.

Top

Reference

Kofax.OmniPageCSDK.IproPlus Namespace