SaveOptions(String) Method

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

public void SaveOptions( 
   string fileName
)

'Declaration

Public Overloads Sub SaveOptions( _
   ByVal fileName As String _
)

'Usage

Dim instance As DocumentWriter
Dim fileName As String
 
instance.SaveOptions(fileName)

public void SaveOptions( 
   string fileName
)

OSX Only:
- (BOOL)saveOptionsToFile:(NSString *)fileName error:(NSError **)error

public void saveOptions(String fileName)

 function Leadtools.Forms.DocumentWriters.DocumentWriter.SaveOptions(String)( 
   fileName 
)

public:
void SaveOptions( 
   String^ fileName
)

Parameters

fileName: The name of XML file to save the options to.

To load the options saved into a disk file by the SaveOptions(string) method, use LoadOptions(string).

To load and save the options to an XML stream instead of a file, use LoadOptions(Stream) and SaveOptions(Stream).

Saving the options to an XML file allows the options to be set the required way once and then re-used in multiple sessions (or multiple DocumentWriter instances). Each document format supported by the LEADTOOLS Document Writer contain extra functionality and options that can be accessed with the GetOptions and SetOptions methods. For more information, refer to DocumentOptions.

The following options are saved to the XML:

This example will change some of the options in a DocumentWriter object, saves them to disk and then re-load them in a new instance.

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

Copy Code

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.Forms.DocumentWriters
Imports Leadtools.Forms.Ocr

      
Public Sub DocumentOptionsDiskExample()
   Dim xmlFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "DocumentWriterOptions.xml")
   ' Create a new instance of the LEADTOOLS Document Writer
   Dim docWriter1 As New DocumentWriter()

   ' Show the default PDF and HTML options before
   ShowOptions("Default options for docWriter1", docWriter1)

   ' Change the PDF options and HTML options
   Dim pdfOptions As PdfDocumentOptions = DirectCast(docWriter1.GetOptions(DocumentFormat.Pdf), PdfDocumentOptions)
   pdfOptions.DocumentType = PdfDocumentType.PdfA
   pdfOptions.ImageOverText = True
   docWriter1.SetOptions(DocumentFormat.Pdf, pdfOptions)

   Dim htmlOptions As HtmlDocumentOptions = DirectCast(docWriter1.GetOptions(DocumentFormat.Html), HtmlDocumentOptions)
   htmlOptions.DocumentType = HtmlDocumentType.IENetscape
   htmlOptions.UseBackgroundColor = True
   htmlOptions.BackgroundColor = RasterColor.FromKnownColor(RasterKnownColor.LightBlue)
   docWriter1.SetOptions(DocumentFormat.Html, htmlOptions)

   ' Show the options again
   ShowOptions("New options for docWriter1", docWriter1)

   ' Save these options to disk
   docWriter1.SaveOptions(xmlFileName)

   ' Create a new DocumentWriter object
   Dim docWriter2 As New DocumentWriter()

   ' Show its options, should be the defaults
   ShowOptions("Default options for docWriter2", docWriter2)

   ' Load the options from disk to this object
   docWriter2.LoadOptions(xmlFileName)

   ' Show the options now, should be the saved ones
   ShowOptions("Options for docWriter2 after loading from the XML file", docWriter2)
End Sub

Private Sub ShowOptions(message As String, docWriter As DocumentWriter)
   Console.WriteLine(message)

   Dim pdfOptions As PdfDocumentOptions = DirectCast(docWriter.GetOptions(DocumentFormat.Pdf), PdfDocumentOptions)
   Console.WriteLine("  PDF options: ")
   Console.WriteLine("    DocumentType:  " + pdfOptions.DocumentType.ToString())
   Console.WriteLine("    FontEmbedMode: " + pdfOptions.FontEmbedMode.ToString())
   Console.WriteLine("    ImageOverText: " + pdfOptions.ImageOverText.ToString())

   Dim htmlOptions As HtmlDocumentOptions = DirectCast(docWriter.GetOptions(DocumentFormat.Html), HtmlDocumentOptions)
   Console.WriteLine("  HTML options: ")
   Console.WriteLine("    DocumentType:       " + htmlOptions.DocumentType.ToString())
   Console.WriteLine("    FontEmbedMode:      " + htmlOptions.FontEmbedMode.ToString())
   Console.WriteLine("    UseBackgroundColor: " + htmlOptions.UseBackgroundColor.ToString())
   Console.WriteLine("    BackgroundColor:    " + htmlOptions.BackgroundColor.ToString())
   Console.WriteLine("-------------------------")
End Sub

using Leadtools;
using Leadtools.Codecs;
using Leadtools.Forms.DocumentWriters;
using Leadtools.Forms.Ocr;

public void DocumentOptionsDiskExample()
{
   var xmlFileName = Path.Combine(LEAD_VARS.ImagesDir, "DocumentWriterOptions.xml");
   // Create a new instance of the LEADTOOLS Document Writer
   var docWriter1 = new DocumentWriter();

   // Show the default PDF and HTML options before
   ShowOptions("Default options for docWriter1", docWriter1);

   // Change the PDF options and HTML options
   var pdfOptions = docWriter1.GetOptions(DocumentFormat.Pdf) as PdfDocumentOptions;
   pdfOptions.DocumentType = PdfDocumentType.PdfA;
   pdfOptions.ImageOverText = true;
   docWriter1.SetOptions(DocumentFormat.Pdf, pdfOptions);

   var htmlOptions = docWriter1.GetOptions(DocumentFormat.Html) as HtmlDocumentOptions;
   htmlOptions.DocumentType = HtmlDocumentType.IENetscape;
   htmlOptions.UseBackgroundColor = true;
   htmlOptions.BackgroundColor = RasterColor.FromKnownColor(RasterKnownColor.LightBlue);
   docWriter1.SetOptions(DocumentFormat.Html, htmlOptions);

   // Show the options again
   ShowOptions("New options for docWriter1", docWriter1);

   // Save these options to disk
   docWriter1.SaveOptions(xmlFileName);

   // Create a new DocumentWriter object
   var docWriter2 = new DocumentWriter();

   // Show its options, should be the defaults
   ShowOptions("Default options for docWriter2", docWriter2);

   // Load the options from disk to this object
   docWriter2.LoadOptions(xmlFileName);

   // Show the options now, should be the saved ones
   ShowOptions("Options for docWriter2 after loading from the XML file", docWriter2);
}

private void ShowOptions(string message, DocumentWriter docWriter)
{
   Console.WriteLine(message);

   var pdfOptions = docWriter.GetOptions(DocumentFormat.Pdf) as PdfDocumentOptions;
   Console.WriteLine("  PDF options: ");
   Console.WriteLine("    DocumentType:  " + pdfOptions.DocumentType);
   Console.WriteLine("    FontEmbedMode: " + pdfOptions.FontEmbedMode);
   Console.WriteLine("    ImageOverText: " + pdfOptions.ImageOverText);

   var htmlOptions = docWriter.GetOptions(DocumentFormat.Html) as HtmlDocumentOptions;
   Console.WriteLine("  HTML options: ");
   Console.WriteLine("    DocumentType:       " + htmlOptions.DocumentType);
   Console.WriteLine("    FontEmbedMode:      " + htmlOptions.FontEmbedMode);
   Console.WriteLine("    UseBackgroundColor: " + htmlOptions.UseBackgroundColor);
   Console.WriteLine("    BackgroundColor:    " + htmlOptions.BackgroundColor);
   Console.WriteLine("-------------------------");
}

Target Platforms

Reference

DocumentWriter Class
DocumentWriter Members
Overload List
DocumentPage Class
DocumentFormat Enumeration
Programming with LEADTOOLS Document Writers
Files to be Included with Your Application
Unlocking Special LEAD Features