GetDocumentPreview(Stream,String,Int32,Int32,Int32,Boolean,DocumentFormat,Int32,Int32) Method
Retrieves the format of a required document, the total number of pages of that document and produces the thumbnail of its first page
according to the specified parameters. The required document is accessible from a previously instantiated Stream object.
public function GetDocumentPreview(
: Stream;
: String;
: Integer;
: Integer;
: Integer;
: Boolean;
var : DocumentFormat;
var : Integer;
var : Integer
): GdPictureStatus; static;
public static function GetDocumentPreview(
: Stream,
: String,
: int,
: int,
: int,
: boolean,
: DocumentFormat,
: int,
: int
) : GdPictureStatus;
'Declaration
Public Overloads Shared Function GetDocumentPreview( _
ByVal As Stream, _
ByVal As String, _
ByVal As Integer, _
ByVal As Integer, _
ByVal As Integer, _
ByVal As Boolean, _
ByRef As DocumentFormat, _
ByRef As Integer, _
ByRef As Integer _
) As GdPictureStatus
Parameters
- FileStream
- A System.IO.Stream object. This stream object must be initialized before it can be sent into this method
and it should remain open for subsequent use. At the same, the provided stream object must support seeking, otherwise the method will fail.
- FileName
- The name of the original file. It can be an empty string.
Providing this parameter can help the format detection algorithm to distinguish format using the same signature pattern.
- ThumbnailWidth
- The required width of the generated thumbnail of the first page, in pixels.
- ThumbnailHeight
- The required height of the generated thumbnail of the first page, in pixels.
- BackColor
- The required background color of the generated thumbnail, in ARGB format.
- ThumbnailFitToPageSize
- Specifies if the size of the produced thumbnail is automatically adjusted to don't have any margin.
- DocumentFormat
- Output parameter. A member of the DocumentFormat enumeration. The format of the specified document.
- ThumbnailID
- Output parameter. The unique image identifier of a newly generated thumbnail image of the first page of the specified document. Be aware that you need to subsequently release this image from memory using the GdPictureDocumentUtilities.DisposeImage method after you have used it.
- PageCount
- Output parameter. The total number of pages of the specified document.
Return Value
A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.
We strongly recommend always checking this status first.
How to retrieve extended information of an image file stored within a stream.
Using fileStream As FileStream = New FileStream("input.tif", FileMode.Open)
Dim documentFormat As GdPicture14.DocumentFormat = GdPicture14.DocumentFormat.DocumentFormatUNKNOWN
Dim thumbID As Integer = 0, pagesCount As Integer = 0
Dim status As GdPictureStatus = GdPictureDocumentUtilities.GetDocumentPreview(fileStream, "input.tif", 100, 150, (Color.Aqua).ToArgb(), documentFormat, thumbID, pagesCount)
If status = GdPictureStatus.OK Then
MessageBox.Show("Document Preview: " + vbCrLf + " format: " + GdPicture14.DocumentFormat.ToString() + vbCrLf + " number of pages: " + pagesCount.ToString(), "GdPicture")
Else
MessageBox.Show("Error: " + status.ToString(), "GdPicture")
End If
'Do your stuff with thumbID here.
GdPictureDocumentUtilities.DisposeImage(thumbID)
End Using
using (FileStream fileStream = new FileStream("input.tif", FileMode.Open))
{
GdPicture14.DocumentFormat documentFormat = GdPicture14.DocumentFormat.DocumentFormatUNKNOWN;
int thumbID = 0, pagesCount = 0;
GdPictureStatus status = GdPictureDocumentUtilities.GetDocumentPreview(fileStream, "input.tif", 100, 150, (Color.Aqua).ToArgb(), true, ref documentFormat, ref thumbID, ref pagesCount);
if (status == GdPictureStatus.OK)
MessageBox.Show("Document Preview: \n format: " + GdPicture14.DocumentFormat.ToString() + "\n number of pages: " + pagesCount.ToString(), "GdPicture");
else
MessageBox.Show("Error: " + status.ToString(), "GdPicture");
//Do your stuff with thumbID here.
GdPictureDocumentUtilities.DisposeImage(thumbID);
}