OmniPageCSDK.RecPDF.Document Class Reference

A PDF document. More...

Inherits IDisposable.

Public Member Functions
bool	HasPageText (int position)
	Does the page have text?
void	Dispose ()
	Close the PDF document.

Properties
string	Path [get]
	Path of the PDF document.
bool	HasText [get]
	PDF file has a text.
uint	PageCount [get]
	Page count
Operation	Operation [get]
	Assigned operation if there is any.
DocumentHandle	SafeHandle [get]
	RPDF_DOC C handle.

Detailed Description

A PDF document.

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.Document.Dispose

(

)

Close the PDF document.

It doesn't throw exceptions.

HasPageText()

bool OmniPageCSDK.RecPDF.Document.HasPageText

(

int

position

)

Does the page have text?

Parameters

position

Page index

Returns

Whether the page has text or not?

Exceptions

ObjectDisposedException	Thrown when the Document object is already disposed.
RecAPIError	Thrown when it failed to check if the given page of the document has text on it.

Property Documentation

HasText

bool OmniPageCSDK.RecPDF.Document.HasText

get

PDF file has a text.

Exceptions

ObjectDisposedException	Thrown when the Document object is already disposed.
RecAPIError	Thrown when it failed to get if there is text in the document.

Operation

Operation OmniPageCSDK.RecPDF.Document.Operation

get

Assigned operation if there is any.

Exceptions

ObjectDisposedException	Thrown when the Document object or the Operation object is already disposed.
RecAPIError	Thrown when it failed to get the operation the document attached to.

PageCount

uint OmniPageCSDK.RecPDF.Document.PageCount

get

Page count

Exceptions

ObjectDisposedException	Thrown when the Document object is already disposed.
RecAPIError	Thrown when it failed to get the count of pages.

Path

string OmniPageCSDK.RecPDF.Document.Path

get

Path of the PDF document.

Exceptions

ObjectDisposedException	Thrown when the Document object is already disposed.
RecAPIError	Thrown when it failed to get the path of the PDF file.

SafeHandle

DocumentHandle OmniPageCSDK.RecPDF.Document.SafeHandle

get

RPDF_DOC C handle.

Exceptions

ObjectDisposedException

Thrown when the Document object is already disposed.

Referenced by OmniPageCSDK.RecPDF.Operation.AddDocument(), and OmniPageCSDK.RecPDF.Operation.RotatePage().