pageNumberingTemplate Property

Summary

Template to use for the individual file names when the output format does not support multipages.

Syntax
TypeScript
JavaScript
Object.defineProperty(DocumentConverterJobData.prototype, 'pageNumberingTemplate', 
   get: function(), 
   set: function(value) 
) 
pageNumberingTemplate: string;

Property Value

A string that contains the template to use for the individual file names when the output format does not support multipages. Default value is ##name##_Page(##page##).##extension##".

Remarks

This template is used when the input document has multiple pages but the output format chosen contains does not support creating files with multiple pages. For example, when converting from a multipage PDF file to PNG raster image format.

The converter understands the following placeholders:

  • ##name##: Will be replaced by the file name without the extension

  • ##page##: Will be replaced by the 1-based page number of the source file

  • ##extension##: Will be replaced by extension of the output format

This template will be applied to the value of DocumentName In the example of PDF input and PNG output above assume the user passed Output.png as the value for DocumentName, and assume the PDF file has 4 pages. After the conversion is performed, the following files are created and returned if the default template is used: 

Output_Page1.png 
Output_Page2.png 
Output_Page3.png 
Output_Page4.png

You can omit any part of the template when modifying it. For example, if you set the value to result_##page##.##extension## then the files created are: 

result_Page1.png 
result_Page2.png 
result_Page3.png 
result_Page4.png

And the text "Output" is omitted and not used.

Requirements

Target Platforms

Help Version 22.0.2023.2.1
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document Assembly
Introduction
Getting Started
Namespaces
Leadtools.Document Namespace
Leadtools.Document.Analytics Namespace
Leadtools.Barcode Namespace
Leadtools.Document.Compare Namespace
Leadtools.Document.Converter Namespace
Leadtools.Document.Service.Compare Namespace
Leadtools.Document.Service Namespace
Leadtools.Document.Writer Namespace
Assemblies
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.