Preview Method

Summary

Gets the preview for the command.

Syntax
C#
VB
C++
public virtual Stream Preview( 
   string id, 
   int pageNumber, 
   string commandName, 
   string arguments, 
   int width, 
   int height, 
   RasterImageFormat format, 
   int bpp, 
   object userData 
) 
  
Public Overridable Function Preview( _ 
   ByVal id As String, _ 
   ByVal pageNumber As Integer, _ 
   ByVal commandName As String, _ 
   ByVal arguments As String, _ 
   ByVal width As Integer, _ 
   ByVal height As Integer, _ 
   ByVal format As RasterImageFormat, _ 
   ByVal bpp As Integer, _ 
   ByVal userData As Object _ 
) As Stream 
public: 
virtual Stream^ Preview(  
   String^ id, 
   int pageNumber, 
   String^ commandName, 
   String^ arguments, 
   int width, 
   int height, 
   RasterImageFormat format, 
   int bpp, 
   Object^ userData 
)  

Parameters

id
The scanning session Id.

pageNumber
1-based page number.

commandName
The command name.

arguments
The command arguments.

width
The image width.

height
The image height.

format
The image format.

bpp
The image bits-per-pixel.

userData
The user data.

Return Value

Gets an image of the preview of the command.

Requirements

Target Platforms

Help Version 20.0.2020.3.31
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Services.Twain Assembly