PdfDocumentOptions Object

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

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:

             function createPDFOptions(useImageOverText) {
                 // Create options
                 var pdfOptions = new lt.Documents.Writers.PdfDocumentOptions();
            
                 // Use JBIG2 for B/W images
                 pdfOptions.oneBitImageCompression = lt.Documents.Writers.OneBitImageCompressionType.jbig2;;
            
                 // Use JPEG2000 or Flate for colored images
                 pdfOptions.coloredImageCompression = lt.Documents.Writers.ColoredImageCompressionType.flateJpx;
            
                 // Embed fonts automatically
                 pdfOptions.fontEmbedMode = lt.Documents.Writers.DocumentFontEmbedMode.auto;
            
                 if (useImageOverText) {
                     // Use image over text
                     pdfOptions.imageOverText = true;
            
                     // Re-size the overlay image by 2
                     pdfOptions.imageOverTextSize = lt.Documents.Writers.DocumentImageOverTextSize.half;
            
                     // Convert grayscale to black and white if possible
                     pdfOptions.imageOverTextMode = lt.Documents.Writers.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;
                 }
            
                 // Use this
                 return pdfOptions;
             }
             

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

function convertToPDFExample(document) {
   // Create a new PDF document with: PDF and no image/text
   var pdfOptions = new lt.Documents.Writers.PdfDocumentOptions();
   pdfOptions.documentType = lt.Documents.Writers.PdfDocumentType.pdf;
   pdfOptions.fontEmbedMode = lt.Documents.Writers.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.isProtected = true;
   pdfOptions.userPassword = "User password";
   pdfOptions.ownerPassword = "Owner password";
   pdfOptions.encryptionMode = lt.Documents.Writers.PdfDocumentEncryptionMode.rc128Bit;
   pdfOptions.printEnabled = false;
   pdfOptions.highQualityPrintEnabled = true;
   pdfOptions.copyEnabled = false;
   pdfOptions.editEnabled = true;
   pdfOptions.annotationsEnabled = true;
   pdfOptions.assemblyEnabled = false;
   pdfOptions.oneBitImageCompression = lt.Documents.Writers.OneBitImageCompressionType.flate;
   pdfOptions.coloredImageCompression = lt.Documents.Writers.ColoredImageCompressionType.flateJpeg;
   pdfOptions.qualityFactor = 2;

   var jobData = new lt.Documents.DocumentConverterJobData();
   jobData.documentFormat = lt.Documents.Writers.DocumentFormat.pdf;
   jobData.rasterImageFormat = lt.Documents.RasterImageFormat.unknown;

   // Set document options
   jobData.documentOptions = pdfOptions;
   document.convert(jobData)
      .done(function (result) {
         console.log("Converted...");
         // Show it in a new tab
         // This is generic code, we know the result is in "document" since PDF supports that
         // But this code checks if the results have been archived into a ZIP file if this
         // example was converting to, say SVG
         var resultDocument = result.document != null ? result.document.url : result.archive.url;
         window.open(resultDocument);
      })
      .fail(function (jqXHR, statusText, errorThrown) {
         alert("Error converting document " + errorThrown);
      });
}