In This Topic ▼

documentName Property

Summary

Name of the document to be generated by this conversion.

Syntax

TypeScript

JavaScript

Object.defineProperty(DocumentConverterJobData.prototype, 'documentName', 
   get: function(), 
   set: function(value) 
)

documentName: string;

Property Value

Name of the document to be generated by this conversion. The default value is null.

Remarks

If the output file format used (either DocumentFormat or RasterImageFormat) does not support multipage files and the input document contains multiple pages, then the value of PageNumberingTemplate is used to generate the names of the files created by the job.

If DocumentName is null, then the generic "file" is used instead.

For more information, refer to DocumentConvertResult.

Example

Convert.ts

DocumentHelper.ts

Convert.js

DocumentHelper.js

Convert.html

import { DocumentHelper } from "../../utilities/DocumentHelper"; 
 
export class LEADDocument_ConvertExample { 
   public constructor() { 
      lt.RasterSupport.setLicenseUri("https://demo.leadtools.com/licenses/js/LEADTOOLSEVAL.txt", "EVAL", null); 
      DocumentHelper.initFactory(); 
   } 
 
   public run = (buttonID: string) => { 
      const exampleButton = document.getElementById(buttonID); 
      exampleButton.onclick = this.convert; 
   } 
 
   /** 
     * Converts a LEADDocument 
     */ 
   convert = () => { 
      const url = "https://demo.leadtools.com/images/pdf/leadtools.pdf"; 
      const loadDocumentOptions = new lt.Document.LoadDocumentOptions(); 
 
      DocumentHelper.log("Loading document..."); 
      lt.Document.DocumentFactory.loadFromUri(url, loadDocumentOptions) 
         .done((document: lt.Document.LEADDocument) => { 
            DocumentHelper.log("Loaded, converting..."); 
            const jobData = new lt.Document.DocumentConverterJobData(); 
            jobData.documentFormat = lt.Document.Writer.DocumentFormat.docx; 
            jobData.rasterImageFormat = lt.Document.RasterImageFormat.unknown; 
 
            // Set document options 
            const docxOptions = new lt.Document.Writer.DocxDocumentOptions(); 
            docxOptions.textMode = lt.Document.Writer.DocumentTextMode.auto; 
            jobData.documentOptions = docxOptions; 
 
            document.convert(jobData) 
               .done((result: any) => { 
                  // This is generic code, we know the result is in "document" since DOCX supports that 
                  // But this code checks if the results have been archived into a ZIP file if this 
                  // example was converting to, say SVG 
                  const resultDocument = result.document != null ? result.document.url : result.archive.url; 
                  const link = window.document.createElement("a"); 
                  const url = lt.Document.DocumentFactory.serviceUri + "/" + resultDocument; 
                  link.href = url; 
                  link.innerHTML = url; 
                  link.target = "_default"; 
                  DocumentHelper.log("Converted: " + url, url); 
 
               }) 
               .fail(DocumentHelper.showServiceError); 
         }) 
         .fail(DocumentHelper.showServiceError); 
   } 
}

export class DocumentHelper { 
   static showServiceError = (jqXHR, statusText, errorThrown) => { 
      alert("Error returned from service. See the console for details."); 
      const serviceError = lt.Document.ServiceError.parseError(jqXHR, statusText, errorThrown); 
      console.error(serviceError); 
   } 
 
   static log = (message: string, data?: any) => { 
      const outputElement = document.getElementById("output"); 
      if (outputElement) { 
         const time = (new Date()).toLocaleTimeString(); 
         const textElement = document.createElement("p"); 
         textElement.innerHTML = (outputElement.childElementCount + 1) + " [" + time + "]: " + message; 
         outputElement.insertBefore(textElement, outputElement.firstChild); 
      } 
 
      if (!data) 
         console.log(message); 
      else 
         console.log(message, data); 
   } 
 
   static initFactory = () => { 
      // To communicate with the DocumentsService, it must be running! 
      // Change these parameters to match the path to the service. 
      lt.Document.DocumentFactory.serviceHost = "http://localhost:40000"; 
      lt.Document.DocumentFactory.servicePath = ""; 
      lt.Document.DocumentFactory.serviceApiPath = "api"; 
   } 
}

import { DocumentHelper } from "../../utilities/DocumentHelper"; 
 
export class LEADDocument_ConvertExample { 
   constructor() { 
      lt.RasterSupport.setLicenseUri("https://demo.leadtools.com/licenses/js/LEADTOOLSEVAL.txt", "EVAL", null); 
      DocumentHelper.initFactory(); 
   } 
 
   run = (buttonID) => { 
      const exampleButton = document.getElementById(buttonID); 
      exampleButton.onclick = this.convert; 
   } 
 
   /** 
     * Converts a LEADDocument 
     */ 
   convert = () => { 
      const url = "https://demo.leadtools.com/images/pdf/leadtools.pdf"; 
      const loadDocumentOptions = new lt.Document.LoadDocumentOptions(); 
 
      DocumentHelper.log("Loading document..."); 
      lt.Document.DocumentFactory.loadFromUri(url, loadDocumentOptions) 
         .done((document) => { 
            DocumentHelper.log("Loaded, converting..."); 
            const jobData = new lt.Document.DocumentConverterJobData(); 
            jobData.documentFormat = lt.Document.Writer.DocumentFormat.docx; 
            jobData.rasterImageFormat = lt.Document.RasterImageFormat.unknown; 
 
            // Set document options 
            const docxOptions = new lt.Document.Writer.DocxDocumentOptions(); 
            docxOptions.textMode = lt.Document.Writer.DocumentTextMode.auto; 
            jobData.documentOptions = docxOptions; 
 
            document.convert(jobData) 
               .done((result) => { 
                  // This is generic code, we know the result is in "document" since DOCX supports that 
                  // But this code checks if the results have been archived into a ZIP file if this 
                  // example was converting to, say SVG 
                  const resultDocument = result.document != null ? result.document.url : result.archive.url; 
                  const link = window.document.createElement("a"); 
                  const url = lt.Document.DocumentFactory.serviceUri + "/" + resultDocument; 
                  link.href = url; 
                  link.innerHTML = url; 
                  link.target = "_default"; 
                  DocumentHelper.log("Converted: " + url, url); 
 
               }) 
               .fail(DocumentHelper.showServiceError); 
         }) 
         .fail(DocumentHelper.showServiceError); 
   } 
}

export class DocumentHelper { 
   static showServiceError = (jqXHR, statusText, errorThrown) => { 
      alert("Error returned from service. See the console for details."); 
      const serviceError = lt.Document.ServiceError.parseError(jqXHR, statusText, errorThrown); 
      console.error(serviceError); 
   } 
 
   static log = (message, data) => { 
      const outputElement = document.getElementById("output"); 
      if (outputElement) { 
         const time = (new Date()).toLocaleTimeString(); 
         const textElement = document.createElement("p"); 
         textElement.innerHTML = (outputElement.childElementCount + 1) + " [" + time + "]: " + message; 
         outputElement.insertBefore(textElement, outputElement.firstChild); 
      } 
 
      if (!data) 
         console.log(message); 
      else 
         console.log(message, data); 
   } 
 
   static initFactory = () => { 
      // To communicate with the DocumentsService, it must be running! 
      // Change these parameters to match the path to the service. 
      lt.Document.DocumentFactory.serviceHost = "http://localhost:40000"; 
      lt.Document.DocumentFactory.servicePath = ""; 
      lt.Document.DocumentFactory.serviceApiPath = "api"; 
   } 
}

<!doctype html> 
<html lang="en"> 
<title>Document Example | Convert</title> 
 
<head> 
   <script src="https://code.jquery.com/jquery-2.2.4.min.js" 
      integrity="sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=" crossorigin="anonymous"></script> 
 
   <script src="../../LT/Leadtools.js"></script> 
   <script src="../../LT/Leadtools.Controls.js"></script> 
   <script src="../../LT/Leadtools.Annotations.Engine.js"></script> 
   <script src="../../LT/Leadtools.Annotations.Designers.js"></script> 
   <script src="../../LT/Leadtools.Annotations.Rendering.Javascript.js"></script> 
   <script src="../../LT/Leadtools.Annotations.Automation.js"></script> 
   <script src="../../LT/Leadtools.ImageProcessing.Main.js"></script> 
   <script src="../../LT/Leadtools.ImageProcessing.Color.js"></script> 
   <script src="../../LT/Leadtools.ImageProcessing.Core.js"></script> 
   <script src="../../LT/Leadtools.ImageProcessing.Effects.js"></script> 
   <script src="../../LT/Leadtools.Document.js"></script> 
   <script src="../../LT/Leadtools.Document.Viewer.js"></script> 
   <link rel="stylesheet" type="text/css" href="../../css/examples.css"> 
 
   <!-- All demo files are bundled and appended to the window --> 
   <script src="../../bundle.js" type="text/javascript"></script> 
</head> 
 
<body> 
   <div> 
      <button type="button" id="exampleButton">Run Example</button> 
   </div> 
   <div id="output"></div> 
   <div> 
      <img id="img" /> 
   </div> 
</body> 
 
<script> 
   window.onload = () => { 
      const example = new window.examples.LEADDocument.Convert(); 
      example.run("exampleButton"); 
   }; 
</script> 
</html>