Leadtools.Twain Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
LoadTemplateFile Method
See Also  Example
Leadtools.Twain Namespace > TwainSession Class : LoadTemplateFile Method



templateFileName
The name of the template file from which to load the TWAIN capabilities.
templateFileName
The name of the template file from which to load the TWAIN capabilities.
Loads the TWAIN capability values stored in the specified template file and sets the selected TWAIN source using these values.

Syntax

Visual Basic (Declaration) 
Public Sub LoadTemplateFile( _
   ByVal templateFileName As String _
)
Visual Basic (Usage)Copy Code
Dim instance As TwainSession
Dim templateFileName As String
 
instance.LoadTemplateFile(templateFileName)
C# 
public void LoadTemplateFile( 
   string templateFileName
)
C++/CLI 
public:
void LoadTemplateFile( 
   String^ templateFileName
)

Parameters

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

Example

Visual BasicCopy Code
Public Sub LoadTemplateFileExample(ByVal parent As IWin32Window)
    Dim session As TwainSession = New TwainSession()
    session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None)

    session.LoadTemplateFile(LeadtoolsExamples.Common.ImagesPath.Path + "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(LeadtoolsExamples.Common.ImagesPath.Path + "test.ltt")

    session.Shutdown()
End Sub
C#Copy Code
public void LoadTemplateFileExample(IWin32Window parent) 
{ 
   TwainSession session = new TwainSession(); 
   session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None); 
 
   session.LoadTemplateFile(LeadtoolsExamples.Common.ImagesPath.Path + "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(LeadtoolsExamples.Common.ImagesPath.Path + "test.ltt"); 
 
   session.Shutdown(); 
}

Remarks

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

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also