.NET Framework Class Library

IDocument Members

<< Click to Display Table of Contents >>

Navigation:  Gnostice Document Studio .NET > Reference Documentation > API Reference > Gnostice.Core.DOM Namespace > IDocument Interface >

.NET Framework Class Library

IDocument Members

The IDocument type exposes the following members.

Methods

 

Name

Description

Public method

CanCopyFrom

Returns whether current document can be converted to the format of the specified document.

Public method

Check(Stream)

Only for internal use. Returns whether the supplied stream conforms to the document format supported by this document engine.

Public method

Check(String)

Only for internal use. Returns whether the supplied file conforms to the document format supported by this document engine.

Public method

CloseDocument

Close the document.

Public method

CopyFrom(IDocument)

Copies specified document to specified document.

Public method

CopyFrom(IDocument, PageRange, String)

Copies specified pages from the document to specified document.

Public method

Dispose

(Inherited from IDisposable.)

Public method

DisposePage

Request the engine to dispose the specified page thereby freeing resources used by it.

Public method

GetDocumentText

Gets the text contained in the document.

Public method

GetFileInfo(Stream, String)

Returns file information such as MIME type, size, whether open password is required to open the document and other essential information.

Public method

GetFileInfo(String, String)

Returns file information such as MIME type, size, whether open password is required to open the document and other essential information.

Public method

LoadDocument(Stream, String)

Loads a document from specified stream and decrypts it with specified password.

Public method

LoadDocument(String, String)

Loads a document from specified file and decrypts it with specified password.

Public method

SaveDocument(Stream)

Saves document to specified stream.

Public method

SaveDocument(String)

Saves document to specified directory with specified file name prefix.

Public method

UpdatePage

Request the engine to load the specified page if it has been disposed.

Properties

 

Name

Description

Public property

BaseBuilder

Internal use only.

Public property

Count

Indicates number of pages in the document. Note that the page count can change unless IsLoadingCompleted is true.

Public property

CursorPosition

Current cursor position.

Public property

DigitizerSettings

Gets settings related to OCR.

Public property

DocInfo

Indicates document information.

Public property

EncoderSettings

Gets or sets file-format conversion settings.

Public property

FileExtension

(Inherited from IDocumentInfo.)

Public property

FileName

Indicates file name of the document.

Public property

FormatType

Gets format of the document.

Public property

InputStream


Public property

IsDefaultEngine

Internal use only.

Public property

IsLoadingCompleted

Boolean to indicate if the entire document (all pages) have been read and are therefore available for access.

Public property

IsLoadingFaultTolerant

Property to indicate if the document engine can handle corrupted documents by fixing faults encountered in the document during the loading process.

Public property

Item

Internal use only. Returns the corresponding page.

Public property

LoadCompletedNotifier

Triggered when document is fully loaded (all pages are available for access).

Public property

MimeType

(Inherited from IDocumentInfo.)

Public property

Preferences

Gets preferences for the document engine.

Public property

SupportedFileExtensions

(Inherited from IDocumentInfo.)

Public property

SupportedMimeTypes

(Inherited from IDocumentInfo.)

Events

 

Name

Description

Public event

NeedFileName

Called when a page or the whole document is about to be saved to a file.

Public event

NeedPassword

Called when a password is required to decrypt a document.

Public event

NeedStream

Called when a stream is required to save an document.

Public event

OperationProgress

Called when progress occurs in a document-processing operation.

Public event

ProcessingError

Called when an error occurs in a document-processing operation.

See Also

IDocument Interface

Gnostice.Core.DOM Namespace