'Declaration
Public Overloads Shared Function GetDocumentPreview( _ ByVal FilePath As String, _ ByVal ThumbnailWidth As Integer, _ ByVal ThumbnailHeight As Integer, _ ByVal BackColor As Integer, _ ByRef DocumentFormat As DocumentFormat, _ ByRef ThumbnailID As Integer, _ ByRef PageCount As Integer _ ) As GdPictureStatus
public static GdPictureStatus GetDocumentPreview( string FilePath, int ThumbnailWidth, int ThumbnailHeight, int BackColor, ref DocumentFormat DocumentFormat, ref int ThumbnailID, ref int PageCount )
public function GetDocumentPreview( FilePath: String; ThumbnailWidth: Integer; ThumbnailHeight: Integer; BackColor: Integer; var DocumentFormat: DocumentFormat; var ThumbnailID: Integer; var PageCount: Integer ): GdPictureStatus; static;
public static function GetDocumentPreview( FilePath : String, ThumbnailWidth : int, ThumbnailHeight : int, BackColor : int, DocumentFormat : DocumentFormat, ThumbnailID : int, PageCount : int ) : GdPictureStatus;
public: static GdPictureStatus GetDocumentPreview( string* FilePath, int ThumbnailWidth, int ThumbnailHeight, int BackColor, ref DocumentFormat DocumentFormat, ref int ThumbnailID, ref int PageCount )
public: static GdPictureStatus GetDocumentPreview( String^ FilePath, int ThumbnailWidth, int ThumbnailHeight, int BackColor, DocumentFormat% DocumentFormat, int% ThumbnailID, int% PageCount )
Parameters
- FilePath
- The full file path of the specified document.
- 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.
- 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.