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
C#
WinRT C#
WinRT JavaScript
C++

public event EventHandler<TwainTemplateEventArgs> SaveTemplate

'Declaration
 
Public Event SaveTemplate As EventHandler(Of TwainTemplateEventArgs)

'Usage
 
Dim instance As TwainSession
Dim handler As EventHandler(Of TwainTemplateEventArgs)
 
AddHandler instance.SaveTemplate, handler

public event EventHandler<TwainTemplateEventArgs> SaveTemplate

add_SaveTemplate(function(sender, e))
remove_SaveTemplate(function(sender, e))

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.

Property	Description
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

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

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

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";
}

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.LoadTemplate
LoadTemplateFile Method
SaveTemplateFile Method