ShowTemplateDialog Method

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

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
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
)

 function Leadtools.Twain.TwainSession.ShowTemplateDialog( 
   templateFile 
)

public:
DialogResult ShowTemplateDialog( 
   String^ templateFile
)

Parameters

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

Remarks

Pressing 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

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

Public Sub ShowTemplateDialogExample(ByVal parent As IWin32Window)
      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

public void ShowTemplateDialogExample(IWin32Window 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: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

TwainSession Class
TwainSession Members
Leadtools.Twain.TwainSession.SaveTemplate
SaveTemplateFile Method
Leadtools.Twain.TwainSession.LoadTemplate
LoadTemplateFile Method