LoadTemplate Event

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

Syntax

C#
Visual Basic
Java
Objective-C
C++

public event EventHandler<TwainTemplateEventArgs> LoadTemplate

'Declaration

Public Event LoadTemplate As EventHandler(Of TwainTemplateEventArgs)

'Usage

Dim instance As TwainSession
Dim handler As EventHandler(Of TwainTemplateEventArgs)
 
AddHandler instance.LoadTemplate, handler

public:
event EventHandler<TwainTemplateEventArgs^>^ LoadTemplate

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 loading the capability from the file, but before the capability value has been set for the currently selected TWAIN source.

Example

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

Copy Code

Imports Leadtools
Imports Leadtools.Twain

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

   session.LoadTemplateFile(Path.Combine(LEAD_VARS.ImagesDir, "test.ltt"))
   Dim cap As TwainCapability

   cap = New TwainCapability()
   cap.Information.ContainerType = Leadtools.Twain.TwainContainerType.OneValue
   cap.Information.Type = Leadtools.Twain.TwainCapabilityType.ImageTransferMechanism
   cap.OneValueCapability.ItemType = Leadtools.Twain.TwainItemType.Uint16

   cap.OneValueCapability.Value = Leadtools.Twain.TwainCapabilityValue.TransferMechanismNative

   session.SetCapability(cap, TwainSetCapabilityMode.Set)
   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

using Leadtools;
using Leadtools.Twain;

public void LoadTemplateExample(IntPtr parent)
{
   TwainSession session = new TwainSession();
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None);
   session.LoadTemplateFile(Path.Combine(LEAD_VARS.ImagesDir,"test.ltt"));
   TwainCapability cap;

   cap = new TwainCapability();
   cap.Information.ContainerType = Leadtools.Twain.TwainContainerType.OneValue;
   cap.Information.Type = Leadtools.Twain.TwainCapabilityType.ImageTransferMechanism;
   cap.OneValueCapability.ItemType = Leadtools.Twain.TwainItemType.Uint16;

   cap.OneValueCapability.Value = Leadtools.Twain.TwainCapabilityValue.TransferMechanismNative;

   session.SetCapability(cap, TwainSetCapabilityMode.Set);
   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

Reference

TwainSession Class
TwainSession Members
Leadtools.Twain.TwainSession.SaveTemplate
LoadTemplateFile Method
SaveTemplateFile(String) Method