LoadTemplateFile Method

Summary

Loads the TWAIN capability values stored in the specified template file and sets the selected TWAIN source using these values.

Syntax
C#
VB
C++
public void LoadTemplateFile( 
   string templateFileName 
) 
Public Sub LoadTemplateFile( _ 
   ByVal templateFileName As String _ 
)  
public: 
void LoadTemplateFile(  
   String^ templateFileName 
)  

Parameters

templateFileName
The name of the template file from which to load the TWAIN capabilities.

Remarks

For each capability loaded by this method, an LoadTemplate event occurs. For more information, refer to Handling Template Files.

Example
C#
VB
using Leadtools; 
using Leadtools.Twain; 
 
public void LoadTemplateFileExample(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; 
 
   short item = (short)Leadtools.Twain.TwainCapabilityValue.TransferMechanismNative; 
 
   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 = item; 
 
   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"; 
} 
Imports Leadtools 
Imports Leadtools.Twain 
 
Public Sub LoadTemplateFileExample(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 
 
   Dim item As Short = CShort(Leadtools.Twain.TwainCapabilityValue.TransferMechanismNative) 
 
   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 = item 
 
   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 

Requirements

Target Platforms

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

Leadtools.Twain Assembly