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



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

Syntax

Visual Basic (Declaration) 
Public Event LoadTemplate As EventHandler(Of TwainTemplateEventArgs)
Visual Basic (Usage)Copy Code
Dim instance As TwainSession
Dim handler As EventHandler(Of TwainTemplateEventArgs)
 
AddHandler instance.LoadTemplate, handler
C# 
public event EventHandler<TwainTemplateEventArgs> LoadTemplate
C++/CLI 
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.

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

Example

Visual BasicCopy Code
Public Sub LoadTemplateExample(ByVal parent As IWin32Window)
      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
C#Copy Code
public void LoadTemplateExample(IWin32Window 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";
}

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.

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