ShowTemplateDialog Method

Displays the TWAIN source manufacturer's template dialog, without actually acquiring an image.

Syntax

C#
Visual Basic
Java
Objective-C
C++

public DialogResult ShowTemplateDialog( 
   string templateFile
)

'Declaration

Public Function ShowTemplateDialog( _
   ByVal templateFile As String _
) As DialogResult

'Usage

Dim instance As TwainSession
Dim templateFile As String
Dim value As DialogResult
 
value = instance.ShowTemplateDialog(templateFile)

public:
DialogResult ShowTemplateDialog( 
   String^ templateFile
)

Parameters

templateFile: The name of the file to which to save the capabilities of the selected source, if the OK (or SCAN) button is pressed.

Remarks

Clicking the OK button on the dialog will enumerate all supported TWAIN capability values and save them to the specified file.
For more information, refer to Handling Template Files.

Example

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Twain

Public Sub ShowTemplateDialogExample(ByVal parent As IntPtr)
   Dim session As TwainSession = New TwainSession()
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None)
   session.ShowTemplateDialog(Path.Combine(LEAD_VARS.ImagesDir, "test.ltt"))
   session.Shutdown()
End Sub

Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

using Leadtools;
using Leadtools.Twain;

public void ShowTemplateDialogExample(IntPtr parent)
{
   TwainSession session = new TwainSession();
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None);
   session.ShowTemplateDialog(Path.Combine(LEAD_VARS.ImagesDir, "Out_test.ltt"));
   session.Shutdown();
}

static class LEAD_VARS
{
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

Requirements

Target Platforms

Reference

TwainSession Class
TwainSession Members
Leadtools.Twain.TwainSession.SaveTemplate
SaveTemplateFile(String) Method
Leadtools.Twain.TwainSession.LoadTemplate
LoadTemplateFile Method