Leadtools TWAIN (Leadtools.Twain assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.30
ShowTemplateDialog Method
See Also 
Leadtools.Twain Namespace > TwainSession Class : ShowTemplateDialog Method



templateFile
The name of the file in which to save the capabilities of the selected source, if the OK (or SCAN) button is pressed.
templateFile
The name of the file in which to save the capabilities of the selected source, if the OK (or SCAN) button is pressed.
Displays the TWAIN source manufacturer's template dialog, without actually acquiring an image.

Syntax

Visual Basic (Declaration) 
Public Function ShowTemplateDialog( _
   ByVal templateFile As String _
) As DialogResult
Visual Basic (Usage)Copy Code
Dim instance As TwainSession
Dim templateFile As String
Dim value As DialogResult
 
value = instance.ShowTemplateDialog(templateFile)
C# 
public DialogResult ShowTemplateDialog( 
   string templateFile
)
C++/CLI 
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.

Example

Visual BasicCopy Code
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
C#Copy Code
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";
}

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.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also