LoadDocument(Stream,Int32,Int32) Method

In This Topic

Syntax
Exceptions
Remarks
See Also

Loads a range of pages from an image.

Syntax

public static ImGearDocument LoadDocument( 
   Stream stream,
   int startPageNumber,
   int count
)

public: static ImGearDocument* LoadDocument( 
   Stream* stream,
   int startPageNumber,
   int count
)

public:
static ImGearDocument^ LoadDocument( 
   Stream^ stream,
   int startPageNumber,
   int count
)

'Declaration
 
Public Overloads Shared Function LoadDocument( _
   ByVal stream As Stream, _
   ByVal startPageNumber As Integer, _
   ByVal count As Integer _
) As ImGearDocument

'Usage
 
Dim stream As Stream
Dim startPageNumber As Integer
Dim count As Integer
Dim value As ImGearDocument
 
value = ImGearFileFormats.LoadDocument(stream, startPageNumber, count)

Parameters

stream: The data stream containing an image.
startPageNumber: The number of the first page to load.
count: Total number of pages to load.

Return Value

A new instance of ImageGear.Core.ImGearDocument class.

Exceptions

Exception	Description
System.NotSupportedException	Office document is protected by password.

Remarks

This method allows you to load several pages in a single call and get access to the document level metadata of an image. It is recommended to use this method when working with PDF format since pages inside a PDF file depend on each other, and thus, loading them at once (as a document) is preferable to loading pages individually. If the format of an image cannot be detected, an exception is thrown. If the document size is close to 2GB, an exception of System.OutOfMemoryException will be thrown.

Reference

ImGearFileFormats Class
ImGearFileFormats Members
Overload List

Get Product Support