Preview Method (IImageProcessingService)

Gets a preview for a command for the specified page of an image in the Leadtools.Services.Twain session manager.

Syntax

C#
Visual Basic
Objective-C
Java
C++

[OperationContractAttribute(Name="Preview", Action="Preview")]
[WebGetAttribute(BodyStyle=WebMessageBodyStyle.Wrapped, 
   IsBodyStyleSetExplicitly=true, 
   IsRequestFormatSetExplicitly=true, 
   IsResponseFormatSetExplicitly=true, 
   RequestFormat=WebMessageFormat.Json, 
   ResponseFormat=WebMessageFormat.Json, 
   UriTemplate="Preview?id={id}&pageNumber={pageNumber}&commandName={commandName}&arguments={arguments}&width={width}&height={height}&format={format}&bpp={bpp}&userData={userData}")]
Stream Preview( 
   string id,
   int pageNumber,
   string commandName,
   string arguments,
   int width,
   int height,
   RasterImageFormat format,
   int bpp,
   object userData
)

'Declaration
 
<OperationContractAttribute(Name="Preview", Action="Preview")>
<WebGetAttribute(BodyStyle=WebMessageBodyStyle.Wrapped, 
   IsBodyStyleSetExplicitly=True, 
   IsRequestFormatSetExplicitly=True, 
   IsResponseFormatSetExplicitly=True, 
   RequestFormat=WebMessageFormat.Json, 
   ResponseFormat=WebMessageFormat.Json, 
   UriTemplate="Preview?id={id}&pageNumber={pageNumber}&commandName={commandName}&arguments={arguments}&width={width}&height={height}&format={format}&bpp={bpp}&userData={userData}")>
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

'Usage
 
Dim instance As IImageProcessingService
Dim id As String
Dim pageNumber As Integer
Dim commandName As String
Dim arguments As String
Dim width As Integer
Dim height As Integer
Dim format As RasterImageFormat
Dim bpp As Integer
Dim userData As Object
Dim value As Stream
 
value = instance.Preview(id, pageNumber, commandName, arguments, width, height, format, bpp, userData)

[OperationContractAttribute(Name="Preview", Action="Preview")]
[WebGetAttribute(BodyStyle=WebMessageBodyStyle.Wrapped, 
   IsBodyStyleSetExplicitly=true, 
   IsRequestFormatSetExplicitly=true, 
   IsResponseFormatSetExplicitly=true, 
   RequestFormat=WebMessageFormat.Json, 
   ResponseFormat=WebMessageFormat.Json, 
   UriTemplate="Preview?id={id}&pageNumber={pageNumber}&commandName={commandName}&arguments={arguments}&width={width}&height={height}&format={format}&bpp={bpp}&userData={userData}")]
Stream^ Preview( 
   String^ id,
   int pageNumber,
   String^ commandName,
   String^ arguments,
   int width,
   int height,
   RasterImageFormat format,
   int bpp,
   Object^ userData
)

Parameters

id: Scanning session Id.
pageNumber: Page to process. pageNumber is one-based.
commandName: Name of the command to preview.
arguments: Arguments to pass to the command to preview.
width: Width of the preview image to return.
height: Height of the preview image to return.
format: File format of the preview image to return.
bpp: Bits-per-pixel of the preview image to return.
userData: User data object.

Return Value

Image in the format, bits per pixel, dimensions and processed with the command and arguments specified.

Remarks

Processes the image page without changing the image stored in the session manager.

Requirements

Target Platforms

Reference

IImageProcessingService Interface
IImageProcessingService Members