LoadOptions(String) Method

Visual Basic
C#
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public void LoadOptions( 
   string fileName
)

'Declaration
 
Public Overloads Sub LoadOptions( _
   ByVal fileName As String _
)

'Usage
 
Dim instance As BarcodeWriter
Dim fileName As String
 
instance.LoadOptions(fileName)

public void LoadOptions( 
   string fileName
)

ObjectiveC Syntax

 function Leadtools.Barcode.BarcodeWriter.LoadOptions(String)( 
   fileName 
)

public:
void LoadOptions( 
   String^ fileName
)

Parameters

fileName: The XML file containing the data.

The load/save methods are provided as helper methods for the user. The BarcodeEngine, BarcodeWriter and BarcodeWriter do not use these methods internally.

The default write options can be retrieved using the GetDefaultOptions or GetAllDefaultOptions methods. You can then change the values of the BarcodeWriteOptions object returned (or cast it back to the appropriate derived class). These options are used by the WriteBarcode method when no explicit options are passed by the user.

To save the default options to an XML file, use BarcodeWriter.SaveOptions(string fileName).

To save and load data to an XML stream, use BarcodeWriter.SaveOptions(Stream stream) and BarcodeWriter.LoadOptions(Stream stream).

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

Copy Code

Public Sub BarcodeWriter_LoadSaveOptionsExample()
      Dim xmlFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "MyWriteOptions.xml")

      Dim engine1 As New BarcodeEngine()
      Dim writer1 As BarcodeWriter = engine1.Writer

      ' Show a few of the default options
      ShowWriterOptions("Default options 1:", writer1)

      ' Change some options
      Dim oneDWriteOptions As OneDBarcodeWriteOptions = DirectCast(writer1.GetDefaultOptions(BarcodeSymbology.UPCA), OneDBarcodeWriteOptions)
      oneDWriteOptions.UseXModule = True
      Dim qrWriteOptions As QRBarcodeWriteOptions = DirectCast(writer1.GetDefaultOptions(BarcodeSymbology.QR), QRBarcodeWriteOptions)
      qrWriteOptions.HorizontalAlignment = BarcodeAlignment.Far

      ' Show them
      ShowWriterOptions("New options 1:", writer1)

      ' Save the options to an XML file
      writer1.SaveOptions(xmlFileName)

      ' Now create another BarcodeWriter
      ' We could use the same one, but this example will show that changing the options
      ' for one BarcodeWriter will not change it in any other in the application

      Dim engine2 As New BarcodeEngine()
      Dim writer2 As BarcodeWriter = engine2.Writer

      ' Show a few of the default options, should be the same as the first default options
      ShowWriterOptions("Default options 2:", writer2)

      ' Load the options we just saved
      writer2.LoadOptions(xmlFileName)

      ' Show them, should be the same as the new options in wirter1
      ShowWriterOptions("Loaded options 2:", writer2)
   End Sub

   Private Sub ShowWriterOptions(ByVal message As String, ByVal writer As BarcodeWriter)
      Console.WriteLine(message)

      Dim oneDWriteOptions As OneDBarcodeWriteOptions = DirectCast(writer.GetDefaultOptions(BarcodeSymbology.UPCA), OneDBarcodeWriteOptions)
      Console.WriteLine("OneDBarcodeWriteOptions.UseXModule: {0}", oneDWriteOptions.UseXModule)
      Dim qrWriteOptions As QRBarcodeWriteOptions = DirectCast(writer.GetDefaultOptions(BarcodeSymbology.QR), QRBarcodeWriteOptions)
      Console.WriteLine("QRBarcodeWriteOptions.HorizontalAlignment: {0}", qrWriteOptions.HorizontalAlignment)
      Console.WriteLine("---------------")
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

public void BarcodeWriter_LoadSaveOptionsExample()
   {
      string xmlFileName = Path.Combine(LEAD_VARS.ImagesDir, "MyWriteOptions.xml");

      BarcodeEngine engine1 = new BarcodeEngine();
      BarcodeWriter writer1 = engine1.Writer;

      // Show a few of the default options
      ShowWriterOptions("Default options 1:", writer1);

      // Change some options
      OneDBarcodeWriteOptions oneDWriteOptions = writer1.GetDefaultOptions(BarcodeSymbology.UPCA) as OneDBarcodeWriteOptions;
      oneDWriteOptions.UseXModule = true;
      QRBarcodeWriteOptions qrWriteOptions = writer1.GetDefaultOptions(BarcodeSymbology.QR) as QRBarcodeWriteOptions;
      qrWriteOptions.HorizontalAlignment = BarcodeAlignment.Far;

      // Show them
      ShowWriterOptions("New options 1:", writer1);

      // Save the options to an XML file
      writer1.SaveOptions(xmlFileName);

      // Now create another BarcodeWriter
      // We could use the same one, but this example will show that changing the options
      // for one BarcodeWriter will not change it in any other in the application

      BarcodeEngine engine2 = new BarcodeEngine();
      BarcodeWriter writer2 = engine2.Writer;

      // Show a few of the default options, should be the same as the first default options
      ShowWriterOptions("Default options 2:", writer2);

      // Load the options we just saved
      writer2.LoadOptions(xmlFileName);

      // Show them, should be the same as the new options in wirter1
      ShowWriterOptions("Loaded options 2:", writer2);
   }

   private void ShowWriterOptions(string message, BarcodeWriter writer)
   {
      Console.WriteLine(message);

      OneDBarcodeWriteOptions oneDWriteOptions = writer.GetDefaultOptions(BarcodeSymbology.UPCA) as OneDBarcodeWriteOptions;
      Console.WriteLine("OneDBarcodeWriteOptions.UseXModule: {0}", oneDWriteOptions.UseXModule);
      QRBarcodeWriteOptions qrWriteOptions = writer.GetDefaultOptions(BarcodeSymbology.QR) as QRBarcodeWriteOptions;
      Console.WriteLine("QRBarcodeWriteOptions.HorizontalAlignment: {0}", qrWriteOptions.HorizontalAlignment);
      Console.WriteLine("---------------");
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

//[TestMethod]
//public void BarcodeWriter_LoadSaveOptionsExample()
//{
//   string xmlFileName = "MyWriteOptions.xml";
//   BarcodeEngine engine1 = new BarcodeEngine();
//   BarcodeWriter writer1 = engine1.Writer;

//   // Show a few of the default options
//   ShowWriterOptions("Default options 1:", writer1);

//   // Change some options
//   OneDBarcodeWriteOptions oneDWriteOptions = writer1.GetDefaultOptions(BarcodeSymbology.UPCA) as OneDBarcodeWriteOptions;
//   oneDWriteOptions.UseXModule = true;
//   QRBarcodeWriteOptions qrWriteOptions = writer1.GetDefaultOptions(BarcodeSymbology.QR) as QRBarcodeWriteOptions;
//   qrWriteOptions.HorizontalAlignment = BarcodeAlignment.Far;

//   // Show them
//   ShowWriterOptions("New options 1:", writer1);

//   // Save the options to an XML file
//   writer1.SaveOptions(xmlFileName);

//   // Now create another BarcodeWriter
//   // We could use the same one, but this example will show that changing the options
//   // for one BarcodeWriter will not change it in any other in the application

//   BarcodeEngine engine2 = new BarcodeEngine();
//   BarcodeWriter writer2 = engine2.Writer;

//   // Show a few of the default options, should be the same as the first default options
//   ShowWriterOptions("Default options 2:", writer2);

//   // Load the options we just saved
//   writer2.LoadOptions(xmlFileName);

//   // Show them, should be the same as the new options in wirter1
//   ShowWriterOptions("Loaded options 2:", writer2);
//}

//private void ShowWriterOptions(string message, BarcodeWriter writer)
//{
//   Debug.WriteLine(message);

//   OneDBarcodeWriteOptions oneDWriteOptions = writer.GetDefaultOptions(BarcodeSymbology.UPCA) as OneDBarcodeWriteOptions;
//   Debug.WriteLine("OneDBarcodeWriteOptions.UseXModule: {0}", oneDWriteOptions.UseXModule);
//   QRBarcodeWriteOptions qrWriteOptions = writer.GetDefaultOptions(BarcodeSymbology.QR) as QRBarcodeWriteOptions;
//   Debug.WriteLine("QRBarcodeWriteOptions.HorizontalAlignment: {0}", qrWriteOptions.HorizontalAlignment);
//   Debug.WriteLine("---------------");
//}

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

BarcodeWriter Class
BarcodeWriter Members
Overload List