RecAPI
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Modules Pages
OmniPageCSDK.RecPDF.OptDocument Class Referencesealed

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

Inherits IDisposable.

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

◆ Dispose()

void OmniPageCSDK.RecPDF.OptDocument.Dispose ( )

Close the PDF document.

It doesn't throw exceptions.

◆ OptAddCommand()

void OmniPageCSDK.RecPDF.OptDocument.OptAddCommand ( string command)

...

Parameters
commandcommand

...

Exceptions
ObjectDisposedExceptionThrown when the Manager object is already disposed.
ParameterIsNullExceptionThrown when the fileName parameter is null.
RecAPIErrorThrown when it failed to get the security information.

◆ Optimize()

void OmniPageCSDK.RecPDF.OptDocument.Optimize ( string fileName)

...

Parameters
fileNamePDF file name

...

Exceptions
ObjectDisposedExceptionThrown when the Manager object is already disposed.
ParameterIsNullExceptionThrown when the fileName parameter is null.
RecAPIErrorThrown when it failed to get the security information.

Property Documentation

◆ SafeHandle

DocumentHandle OmniPageCSDK.RecPDF.OptDocument.SafeHandle
get

RPDF_DOC C handle.

Exceptions
ObjectDisposedExceptionThrown when the Document object is already disposed.