PdfDocumentOptions Class

The options set in the PdfDocumentOptions class will be used when the user saves a document using the DocumentFormat.Pdf format.

Before using the LEADTOOLS Document Writer to create PDF documents, you must unlock the RasterSupportType.DocumentWritersPdf key unless the document writers are being used from the LEADTOOLS OCR engine. For more information, refer to Unlocking Special LEAD Features.

To change the options used with the PDF format, perform the following steps:

1. Use the DocumentWriter.GetOptions method of the DocumentWriter object being used. Passing DocumentFormat.Pdf to the format parameter. Note that the resulting object from the base DocumentOptions class needs to be cast to PdfDocumentOptions.
2. Use the various PdfDocumentOptions properties to change the options.
3. Use DocumentWriter.SetOptions to set the new options in the engine.
4. Now you can call the DocumentWriter.BeginDocument method (again, with DocumentFormat.Pdf for the format parameter) to create a new document and add the pages.

The PdfDocumentOptions class contains the following features:

Saving PDF files with minimum file size

The following table shows the suggested PDF document options to use to achieve the smallest output PDF file size while maintaining an acceptable quality.

The following code snippet shows how to set the PDF options to produce minimum file size with acceptable quality:

             void SetPDFOptions(DocumentWriter documentWriter, bool useImageOverText)
             {
                // Get the current PDF options
                PdfDocumentOptions pdfOptions = documentWriter.GetOptions(DocumentFormat.Pdf) as PdfDocumentOptions;
            
                // Use JBIG2 for B/W images
                pdfOptions.OneBitImageCompression = OneBitImageCompressionType.Jbig2;
                // Use JPEG2000 or Flate for colored images
                pdfOptions.ColoredImageCompression = ColoredImageCompressionType.FlateJpx;
                // Embed fonts automatically
                pdfOptions.FontEmbedMode = DocumentFontEmbedMode.Auto;
            
                if (useImageOverText)
                {
                   // Use image over text
                   pdfOptions.ImageOverText = true;
                   // Re-size the overlay image by 2
                   pdfOptions.ImageOverTextSize = DocumentImageOverTextSize.Half;
                   // Convert grayscale to black and white if possible
                   pdfOptions.ImageOverTextMode = DocumentImageOverTextMode.Relaxed;
                   // Use quality factor of 50
                   pdfOptions.QualityFactor = 50;
                }
                else
                {
                   // Will not use image over text
                   pdfOptions.ImageOverText = false;
                   // Use quality factor of 100
                   pdfOptions.QualityFactor = 100;
                }
            
                // Set our options
                documentWriter.SetOptions(DocumentFormat.Pdf, pdfOptions);
             }
             

This example will create a new Adobe Portable Document Format document (PDF) file using the various supported options.

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

Copy Code  

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

      
Public Sub PdfDocumentOptionsExample()
   Dim inputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.docx")
   Dim outputFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Example.pdf")
   ' Setup a new RasterCodecs object
   Dim codecs As New RasterCodecs()
   codecs.Options.RasterizeDocument.Load.Resolution = 300

   ' Get the number of pages in the input document
   Dim pageCount As Integer = codecs.GetTotalPages(inputFileName)

   ' Create a new instance of the LEADTOOLS Document Writer
   Dim docWriter As New DocumentWriter()

   ' Change the PDF options
   Dim pdfOptions As PdfDocumentOptions = DirectCast(docWriter.GetOptions(DocumentFormat.Pdf), PdfDocumentOptions)
   pdfOptions.DocumentType = PdfDocumentType.Pdf
   pdfOptions.FontEmbedMode = DocumentFontEmbedMode.None
   pdfOptions.ImageOverText = False
   pdfOptions.Linearized = False
   pdfOptions.Title = "Add your title here"
   pdfOptions.Subject = "Add your subject here"
   pdfOptions.Keywords = "Add your keywords here"
   pdfOptions.Author = "Add author name here"
   pdfOptions.Protected = True
   pdfOptions.UserPassword = "User password"
   pdfOptions.OwnerPassword = "Owner password"
   pdfOptions.EncryptionMode = PdfDocumentEncryptionMode.RC128Bit
   pdfOptions.PrintEnabled = False
   pdfOptions.HighQualityPrintEnabled = True
   pdfOptions.CopyEnabled = False
   pdfOptions.EditEnabled = True
   pdfOptions.AnnotationsEnabled = True
   pdfOptions.AssemblyEnabled = False
   pdfOptions.OneBitImageCompression = OneBitImageCompressionType.Flate
   pdfOptions.ColoredImageCompression = ColoredImageCompressionType.FlateJpeg
   pdfOptions.QualityFactor = 2

   ' Use default resolution
   pdfOptions.DocumentResolution = 0
   pdfOptions.PageRestriction = DocumentPageRestriction.Relaxed

   ' Setup empty page size (Letter size)
   pdfOptions.EmptyPageWidth = 8.5
   pdfOptions.EmptyPageHeight = 11
   pdfOptions.EmptyPageResolution = 300

   docWriter.SetOptions(DocumentFormat.Pdf, pdfOptions)

   ' Create a new PDF document
   Console.WriteLine("Creating new PDF document: {0}", outputFileName)
   docWriter.BeginDocument(outputFileName, DocumentFormat.Pdf)

   ' Loop through all the pages
   For pageNumber As Integer = 1 To pageCount
      ' Get the page as SVG
      Console.WriteLine("Loading page {0}", pageNumber)
      Dim page As New DocumentSvgPage()
      page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, Nothing)

      ' Add the page
      Console.WriteLine("Adding page {0}", pageNumber)
      docWriter.AddPage(page)

      page.SvgDocument.Dispose()
   Next

   ' Finally finish writing the PDF file on disk
   docWriter.EndDocument()
   codecs.Dispose()
End Sub

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

public void PdfDocumentOptionsExample()
{
   var inputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.docx");
   var outputFileName = Path.Combine(LEAD_VARS.ImagesDir, "Example.pdf");
   // Setup a new RasterCodecs object
   var codecs = new RasterCodecs();
   codecs.Options.RasterizeDocument.Load.Resolution = 300;

   // Get the number of pages in the input document
   var pageCount = codecs.GetTotalPages(inputFileName);

   // Create a new instance of the LEADTOOLS Document Writer
   var docWriter = new DocumentWriter();

   // Change the PDF options
   var pdfOptions = docWriter.GetOptions(DocumentFormat.Pdf) as PdfDocumentOptions;
   pdfOptions.DocumentType = PdfDocumentType.Pdf;
   pdfOptions.FontEmbedMode = DocumentFontEmbedMode.None;
   pdfOptions.ImageOverText = false;
   pdfOptions.Linearized = false;
   pdfOptions.Title = "Add your title here";
   pdfOptions.Subject = "Add your subject here";
   pdfOptions.Keywords = "Add your keywords here";
   pdfOptions.Author = "Add author name here";
   pdfOptions.Protected = true;
   pdfOptions.UserPassword = "User password";
   pdfOptions.OwnerPassword = "Owner password";
   pdfOptions.EncryptionMode = PdfDocumentEncryptionMode.RC128Bit;
   pdfOptions.PrintEnabled = false;
   pdfOptions.HighQualityPrintEnabled = true;
   pdfOptions.CopyEnabled = false;
   pdfOptions.EditEnabled = true;
   pdfOptions.AnnotationsEnabled = true;
   pdfOptions.AssemblyEnabled = false;
   pdfOptions.OneBitImageCompression = OneBitImageCompressionType.Flate;
   pdfOptions.ColoredImageCompression = ColoredImageCompressionType.FlateJpeg;
   pdfOptions.QualityFactor = 2;

   // Use default resolution
   pdfOptions.DocumentResolution = 0;
   pdfOptions.PageRestriction = DocumentPageRestriction.Relaxed;

   // Setup empty page size (Letter size)
   pdfOptions.EmptyPageWidth = 8.5;
   pdfOptions.EmptyPageHeight = 11;
   pdfOptions.EmptyPageResolution = 300;

   docWriter.SetOptions(DocumentFormat.Pdf, pdfOptions);

   // Create a new PDF document
   Console.WriteLine("Creating new PDF document: {0}", outputFileName);
   docWriter.BeginDocument(outputFileName, DocumentFormat.Pdf);

   // Loop through all the pages
   for (var pageNumber = 1; pageNumber <= pageCount; pageNumber++)
   {
      // Get the page as SVG
      Console.WriteLine("Loading page {0}", pageNumber);
      var page = new DocumentSvgPage();
      page.SvgDocument = codecs.LoadSvg(inputFileName, pageNumber, null);

      // Add the page
      Console.WriteLine("Adding page {0}", pageNumber);
      docWriter.AddPage(page);

      page.SvgDocument.Dispose();
   }

   // Finally finish writing the PDF file on disk
   docWriter.EndDocument();
   codecs.Dispose();
}

Target Platforms

Reference

PdfDocumentOptions Members
Leadtools.Forms.DocumentWriters Namespace
DocumentWriter Class
Programming with LEADTOOLS Document Writers
Files to be Included with Your Application
Unlocking Special LEAD Features