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



Occurs when saving TWAIN capabilities from the currently selected TWAIN source to a template file by calling the SaveTemplateFile method.

Syntax

Visual Basic (Declaration) 
Public Event SaveTemplate As EventHandler(Of TwainTemplateEventArgs)
Visual Basic (Usage)Copy Code
Dim instance As TwainSession
Dim handler As EventHandler(Of TwainTemplateEventArgs)
 
AddHandler instance.SaveTemplate, handler
C# 
public event EventHandler<TwainTemplateEventArgs> SaveTemplate
C++/CLI 
public:
event EventHandler<TwainTemplateEventArgs^>^ SaveTemplate

Event Data

The event handler receives an argument of type TwainTemplateEventArgs containing data related to this event. The following TwainTemplateEventArgs properties provide information specific to this event.

PropertyDescription
Capability Gets the TwainCapability currently being processed by the event.

Example

Visual BasicCopy Code
Public Sub twain_SaveTemplate(ByVal sender As Object, ByVal e As TwainTemplateEventArgs)
      ' ...
      ' ...
      ' set your code here
      ' ...
   End Sub

   Public Sub SaveTemplateExample(ByVal parent As IWin32Window)
      Dim session As TwainSession = New TwainSession()
      session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None)

      AddHandler session.SaveTemplate, AddressOf twain_SaveTemplate
      session.SaveTemplateFile(Path.Combine(LEAD_VARS.ImagesDir, "out_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 twain_SaveTemplate(object sender, TwainTemplateEventArgs e)
   {
      // ...
      // ...
      // set your code here
      // ...
   }

   public void SaveTemplateExample(IWin32Window parent)
   {
      TwainSession session = new TwainSession();
      session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None);

      session.SaveTemplate += new EventHandler<TwainTemplateEventArgs>(twain_SaveTemplate);
      session.SaveTemplateFile(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

This event is called after enumerating the capability from the TWAIN source, but before the capability value has been saved to the template file.

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