A PDF operation. More...

Public Member Functions
void	MovePage (Document document, uint destPosition, params UIntPtr[] srcPositions)
	Move pages from one place to another place.
void	MovePage (Document document, uint destPosition, IEnumerable< UIntPtr > srcPositions)
	Move pages from one place to another place.
void	AddDocument (Document document)
	Add a PDF file to the operation.
void	CopyPage (Document destination, uint destPosition, Document source, params UIntPtr[] srcPositions)
	Copy pages from one place to another place.
void	CopyPage (Document destination, uint destPosition, Document source, IEnumerable< UIntPtr > srcPositions)
	Copy pages from one place to another place.
void	AppendPage (Document destination, Document source, params UIntPtr[] srcPositions)
	Copy pages from one place to the end of a PDF document.
void	AppendPage (Document destination, Document source, IEnumerable< UIntPtr > srcPositions)
	Copy pages from one place to the end of a PDF document.
void	DeletePage (Document destination, params UIntPtr[] destPositions)
	Delete pages from a document.
void	DeletePage (Document destination, IEnumerable< UIntPtr > destPositions)
	Delete pages from a document.
void	RotatePage (Rotation rotation, Document destination, uint destPosition)
	Rotate page in a document.
void	InsertImage (Document destination, uint destPosition, bool imageOnly, params IntPtr[] srcPages)
	Insert pages given by HPAGE.
void	InsertImage (Document destination, uint destPosition, bool imageOnly, IEnumerable< IntPtr > srcPages)
	Insert pages given by HPAGE.
void	AppendImage (Document destination, bool imageOnly, params IntPtr[] srcPages)
	Insert pages given by HPAGE to the end of a PDF document.
void	AppendImage (Document destination, bool imageOnly, IEnumerable< IntPtr > srcPages)
	Insert pages given by HPAGE to the end of a PDF document.
void	MergeText (Document destination, uint destPosition, params IntPtr[] srcPages)
	Insert a text content of the given HPAGE handles to the specified PDF pages.
void	MergeText (Document destination, uint destPosition, IEnumerable< IntPtr > srcPages)
	Insert a text content of the given HPAGE handles to the specified PDF pages.
void	Execute ()
	Execute operation.
void	Dispose ()
	Cancel the PDF operation.
Properties
IList< Document >	Documents `[get]`
	List of documents taking part in this operation.
OperationHandle	SafeHandle `[get]`
	RPDF_OPERATION C handle.

Detailed Description

A PDF operation.

Inherited from the System.IDisposable interface. With this object a series of PDF file manipulation can be achieved in an optimized way. The operations will be cumulated since the calling of Execute method, which disposes the object as well. All information got from the documents taking part in the operation shows the status of the document as if the file manipulation would taken place already, but really they will executed in the Execute method. To cancel the operation dispose it.

Member Function Documentation

void Kofax::OmniPageCSDK::RecPDF::Operation::AddDocument ( Document document )

Add a PDF file to the operation.

Parameters:

document PDF document

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the parameter is null.
RecAPIError	Thrown when it failed to attach document to operation.

void Kofax::OmniPageCSDK::RecPDF::Operation::AppendImage	(	Document	destination,
		bool	imageOnly,
		params IntPtr[]	srcPages
	)

Insert pages given by HPAGE to the end of a PDF document.

Parameters:

destination	Destination document
imageOnly	Without text
srcPages	Pages given by HPAGE

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document or the source pages parameter is null.
RecAPIError	Thrown when it failed to insert HPAGEs.

void Kofax::OmniPageCSDK::RecPDF::Operation::AppendImage	(	Document	destination,
		bool	imageOnly,
		IEnumerable< IntPtr >	srcPages
	)

Insert pages given by HPAGE to the end of a PDF document.

Parameters:

destination	Destination document
imageOnly	Without text
srcPages	Pages given HPAGE

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document or the source pages parameter is null.
RecAPIError	Thrown when it failed to insert HPAGEs.

void Kofax::OmniPageCSDK::RecPDF::Operation::AppendPage	(	Document	destination,
		Document	source,
		params UIntPtr[]	srcPositions
	)

Copy pages from one place to the end of a PDF document.

Parameters:

destination	Destination document
source	Source document
srcPositions	Source page indices

The source and destination documents may be the same file.

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document or the source positions parameter is null.
RecAPIError	Thrown when it failed to copy the pages.

void Kofax::OmniPageCSDK::RecPDF::Operation::AppendPage	(	Document	destination,
		Document	source,
		IEnumerable< UIntPtr >	srcPositions
	)

Copy pages from one place to the end of a PDF document.

Parameters:

destination	Destination document
source	Source document
srcPositions	Source page indices

The source and destination documents may be the same file.

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document or the source positions parameter is null.
RecAPIError	Thrown when it failed to copy the pages.

void Kofax::OmniPageCSDK::RecPDF::Operation::CopyPage	(	Document	destination,
		uint	destPosition,
		Document	source,
		params UIntPtr[]	srcPositions
	)

Copy pages from one place to another place.

Parameters:

destination	Destination document
destPosition	Destination page index
source	Source document
srcPositions	Source page indices

The source and destination documents may be the same file. The pages will be inserted in order of listing before the destination page index. To append a file set the destination page index to the count of pages in the destination file or set to uint.MaxValue or use the AppendPage method.

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document or the source positions parameter is null.
RecAPIError	Thrown when it failed to copy the pages.

void Kofax::OmniPageCSDK::RecPDF::Operation::CopyPage	(	Document	destination,
		uint	destPosition,
		Document	source,
		IEnumerable< UIntPtr >	srcPositions
	)

Copy pages from one place to another place.

Parameters:

destination	Destination document
destPosition	Destination page index
source	Source document
srcPositions	Source page indices

The source and destination documents may be the same file. The pages will be inserted in order of listing before the destination page index. To append a file set the destination page index to the count of pages in the destination file or set to uint.MaxValue or use the AppendPage method.

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document or source positions parameter is null.
RecAPIError	Thrown when it failed to copy the pages.

void Kofax::OmniPageCSDK::RecPDF::Operation::DeletePage	(	Document	destination,
		params UIntPtr[]	destPositions
	)

Delete pages from a document.

Parameters:

destination	Document
destPositions	Page indices

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document or the destination positions parameter is null.
RecAPIError	Thrown when it failed to delete pages.

void Kofax::OmniPageCSDK::RecPDF::Operation::DeletePage	(	Document	destination,
		IEnumerable< UIntPtr >	destPositions
	)

Delete pages from a document.

Parameters:

destination	Document
destPositions	Page indices

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document or the destination positions parameter is null.
RecAPIError	Thrown when it failed to delete pages.

void Kofax::OmniPageCSDK::RecPDF::Operation::Dispose ( )

Cancel the PDF operation.

Can be called multiple times or after Execute as well. It doesn't throws any exception.

void Kofax::OmniPageCSDK::RecPDF::Operation::Execute ( )

Execute operation.

After execution the operation will be automatically disposed. To cancel an operation dispose it instead of execution. If Dispose is called after Execute, it won't do anything, because the object has been already disposed.

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
RecAPIError	Thrown when it failed to execute the operation.

void Kofax::OmniPageCSDK::RecPDF::Operation::InsertImage	(	Document	destination,
		uint	destPosition,
		bool	imageOnly,
		params IntPtr[]	srcPages
	)

Insert pages given by HPAGE.

Parameters:

destination	Destination document
destPosition	Destination page index
imageOnly	Without text
srcPages	Pages given by HPAGE

The pages will be inserted in order of listing before the destination page index. To append a file set the destination page index to the count of pages in the destination file or set to uint.MaxValue.

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document or the source pages parameter is null.
RecAPIError	Thrown when it failed to insert HPAGEs.

void Kofax::OmniPageCSDK::RecPDF::Operation::InsertImage	(	Document	destination,
		uint	destPosition,
		bool	imageOnly,
		IEnumerable< IntPtr >	srcPages
	)

Insert pages given by HPAGE.

Parameters:

destination	Destination document
destPosition	Destination page index
imageOnly	Without text
srcPages	Pages given by HPAGE

The pages will be inserted in order of listing before the destination page index. To append a file set the destination page index to the count of pages in the destination file or set to uint.MaxValue.

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document or the source pages parameter is null.
RecAPIError	Thrown when it failed to insert HPAGEs.

void Kofax::OmniPageCSDK::RecPDF::Operation::MergeText	(	Document	destination,
		uint	destPosition,
		IEnumerable< IntPtr >	srcPages
	)

Insert a text content of the given HPAGE handles to the specified PDF pages.

Parameters:

destination	Destination document
destPosition	First destination page index
srcPages	Pages given by HPAGE

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document or the source pages parameter is null.
RecAPIError	Thrown when it failed to merge text.

void Kofax::OmniPageCSDK::RecPDF::Operation::MergeText	(	Document	destination,
		uint	destPosition,
		params IntPtr[]	srcPages
	)

Insert a text content of the given HPAGE handles to the specified PDF pages.

Parameters:

destination	Destination document
destPosition	First destination page index
srcPages	Pages given by HPAGE

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document or the source pages parameter is null.
RecAPIError	Thrown when it failed to merge text.

void Kofax::OmniPageCSDK::RecPDF::Operation::MovePage	(	Document	document,
		uint	destPosition,
		params UIntPtr[]	srcPositions
	)

Move pages from one place to another place.

Parameters:

document	Document
destPosition	Destination page index
srcPositions	Source page indices

The pages will be inserted in order of listing before the destination page index. To append a file set the destination page index to the count of pages in the destination file or set to uint.MaxValue.

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document or the destination positions parameter is null.
RecAPIError	Thrown when it failed to move pages.

void Kofax::OmniPageCSDK::RecPDF::Operation::MovePage	(	Document	document,
		uint	destPosition,
		IEnumerable< UIntPtr >	srcPositions
	)

Move pages from one place to another place.

Parameters:

document	Document
destPosition	Destination page index
srcPositions	Source page indices

The pages will be inserted in order of listing before the destination page index. To append a file set the destination page index to the count of pages in the destination file or set to uint.MaxValue.

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document or the destination positions parameter is null.
RecAPIError	Thrown when it failed to move pages.

void Kofax::OmniPageCSDK::RecPDF::Operation::RotatePage	(	Rotation	rotation,
		Document	destination,
		uint	destPosition
	)

Rotate page in a document.

Parameters:

rotation	Degree and direction of rotation
destination	Document
destPosition	Page index

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
ParameterIsNullException	Thrown when the destination document parameter is null.
RecAPIError	Thrown when it failed to rotate the page.

Property Documentation

IList<Document> Kofax::OmniPageCSDK::RecPDF::Operation::Documents [get]

List of documents taking part in this operation.

Exceptions:

ObjectDisposedException	Thrown when the Operation object is already disposed.
RecAPIError	Thrown when it failed to get the list of documents.

OperationHandle Kofax::OmniPageCSDK::RecPDF::Operation::SafeHandle [get]

RPDF_OPERATION C handle.

Exceptions:

ObjectDisposedException Thrown when the Operation object is already disposed.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation