EnableShowUserInterfaceOnly Property

Gets or sets flag that indicates whether to display the Twain user interface with or without the Scan button, if supported.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public bool EnableShowUserInterfaceOnly {get; set;}

'Declaration
 
Public Property EnableShowUserInterfaceOnly As Boolean

'Usage
 
Dim instance As TwainSession
Dim value As Boolean
 
instance.EnableShowUserInterfaceOnly = value
 
value = instance.EnableShowUserInterfaceOnly

public bool EnableShowUserInterfaceOnly {get; set;}

 get_EnableShowUserInterfaceOnly();
 set_EnableShowUserInterfaceOnly(value);

public:
property bool EnableShowUserInterfaceOnly {
   bool get();
   void set (    bool value);
}

Property Value

Indicates whether to display the Twain user interface with or without the Scan button, if supported. Possible values are:
true: displays the progress indicator during image acquisition.
false: hides the progress indicator during image acquisition

Remarks

To display the Twain driver user interface without the scan button, pass true to this property. Then call ShowTemplateDialog method to display the template dialog. If you pass false to this property, the template dialog will display the normal Twain user interface, with the scan button.

Example

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

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

      session.SelectSource(String.Empty)
      session.EnableShowUserInterfaceOnly = True
      session.ShowTemplateDialog(Path.Combine(LEAD_VARS.ImagesDir, "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 TestEnableShowUI(IWin32Window parent)
   {
      TwainSession session = new TwainSession();
      session.Startup(parent, "manufacturer", "productFamily", "version", "application", TwainStartupFlags.None);

      session.SelectSource(string.Empty);
      session.EnableShowUserInterfaceOnly = true;
      session.ShowTemplateDialog(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.SaveTemplate
SaveTemplateFile Method
Leadtools.Twain.TwainSession.LoadTemplate
LoadTemplateFile Method
ShowTemplateDialog Method