Preview Method

Summary

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

Syntax

C++/CLI

Python

[OperationContractAttribute(Name="Preview", 
   Action="Preview", 
   AsyncPattern=false, 
   IsOneWay=false, 
   IsInitiating=true, 
   IsTerminating=false)] 
[WebGetAttribute(BodyStyle=1, 
   RequestFormat=1, 
   ResponseFormat=1, 
   UriTemplate="Preview?id={id}&pageNumber={pageNumber}&commandName={commandName}&arguments={argu" + "ments}&width={width}&height={height}&format={format}&bpp={bpp}&userData={userDat" + "a}")] 
public Stream Preview( 
   string id, 
   int pageNumber, 
   string commandName, 
   string arguments, 
   int width, 
   int height, 
   RasterImageFormat format, 
   int bpp, 
   object userData 
)

public:  
   [OperationContractAttribute(Name=L"Preview", 
      Action=L"Preview", 
      AsyncPattern=false, 
      IsOneWay=false, 
      IsInitiating=true, 
      IsTerminating=false)] 
   [WebGetAttribute(BodyStyle=1, 
      RequestFormat=1, 
      ResponseFormat=1, 
      UriTemplate=L"Preview\?id={id}&pageNumber={pageNumber}&commandName={commandName}&arguments={argu" L"ments}&width={width}&height={height}&format={format}&bpp={bpp}&userData={userDat" L"a}")] 
   Stream^ Preview( 
       String^ id, 
      Int32 pageNumber, 
      String^ commandName, 
      String^ arguments, 
      Int32 width, 
      Int32 height, 
      RasterImageFormat^ format, 
      Int32 bpp, 
      Object^ userData 
   )

def Preview(self,id,pageNumber,commandName,arguments,width,height,format,bpp,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

Download our FREE evaluation

Help Version 22.0.2023.3.31

Leadtools.Services.Twain Assembly

Introduction

Getting Started

Namespaces

Leadtools.Services.Twain Namespace

Assemblies