←Select platform

PageNumberingTemplate Property

Summary

Template to use for the individual file names when the output format does not support multi-pages.

Syntax
C#
VB
Java
C++
public string PageNumberingTemplate { get; set; } 
Public Property PageNumberingTemplate() As String 
   Get 
   Set 
public:  
   property String^ PageNumberingTemplate 
   { 
      String^ get() 
      void set(String^ value) 
   } 
public String getPageNumberingTemplate() 
public void setPageNumberingTemplate(String value) 

Property Value

A string that contains the template to use for the individual file names when the output format does not support multi-pages. 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 multi-page 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 DocumentConverterJobData.OutputDocumentFileName. In the example of PDF input and PNG output above assume the user passed C:\Dir\Output.png as the value for OutputDocumentFileName, and assume the PDF file has 4 pages. After the conversion is performed, the following files are created if the default template is used:

C:\Dir\Output_Page1.png 
C:\Dir\Output_Page2.png 
C:\Dir\Output_Page3.png 
C:\Dir\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:

C:\Dir\result_Page1.png 
C:\Dir\result_Page2.png 
C:\Dir\result_Page3.png 
C:\Dir\result_Page4.png 

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

OutputSinglePages can be used to override the behavior when converting to raster documents (such as TIF and Raster PDF).

Requirements

Target Platforms

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

Leadtools.Document.Converter Assembly