Kofax::OmniPageCSDK::RecPDF::OptDocument Class Reference

A PDF document for PDF optimizing operations. More...

List of all members.

Public Member Functions
void	OptAddCommand (string command)
	...
void	Optimize (string fileName)
	...
void	Dispose ()
	Close the PDF document.
Properties
DocumentHandle	SafeHandle [get]
	RPDF_DOC C handle.

---

Detailed Description

A PDF document for PDF optimizing operations.

Inherited from the System.IDisposable interface. The Dispose method closes the file. This object represents a PDF document. The represented PDF document can be changed by a PDF operation (Operation) if the Document is attached to the Operation object.

---

Member Function Documentation

void Kofax::OmniPageCSDK::RecPDF::OptDocument::Dispose

(

)

Close the PDF document.

It doesn't throw exceptions.

void Kofax::OmniPageCSDK::RecPDF::OptDocument::OptAddCommand

(

string

command

)

...

Parameters:

command

command

...

Exceptions:

ObjectDisposedException	Thrown when the Manager object is already disposed.
ParameterIsNullException	Thrown when the fileName parameter is null.
RecAPIError	Thrown when it failed to get the security information.

void Kofax::OmniPageCSDK::RecPDF::OptDocument::Optimize

(

string

fileName

)

...

Parameters:

fileName

PDF file name

...

Exceptions:

ObjectDisposedException	Thrown when the Manager object is already disposed.
ParameterIsNullException	Thrown when the fileName parameter is null.
RecAPIError	Thrown when it failed to get the security information.

---

Property Documentation

DocumentHandle Kofax::OmniPageCSDK::RecPDF::OptDocument::SafeHandle [get]

RPDF_DOC C handle.

Exceptions:

ObjectDisposedException

Thrown when the Document object is already disposed.