SaveTemplate Event

Summary

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

Syntax
C#
VB
C++
public event EventHandler<TwainTemplateEventArgs> SaveTemplate 
Public Event SaveTemplate As EventHandler(Of TwainTemplateEventArgs) 
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.

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.

Example
C#
VB
using Leadtools; 
using Leadtools.Twain; 
 
public void twain_SaveTemplate(object sender, TwainTemplateEventArgs e) 
{ 
   // ... 
   // ... 
   // set your code here 
   // ... 
} 
 
public void SaveTemplateExample_Runner() 
{ 
   Form parent = new Form(); 
   SaveTemplateExample(parent.Handle); 
} 
public void SaveTemplateExample(IntPtr 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"; 
} 
Imports Leadtools 
Imports Leadtools.Twain 
 
Public Sub twain_SaveTemplate(ByVal sender As Object, ByVal e As TwainTemplateEventArgs) 
   ' ... 
   ' ... 
   ' set your code here 
   ' ... 
End Sub 
Public Sub SaveTemplateExample_Runner() 
   Dim parent As New Form() 
   SaveTemplateExample(parent.Handle) 
End Sub 
 
Public Sub SaveTemplateExample(ByVal parent As IntPtr) 
   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 

Requirements

Target Platforms

Help Version 20.0.2020.3.31
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Twain Assembly