Add Page Numbers

Overview

The 'Add Page Numbers' flow action inserts page numbers into the provided PDF document as per the configuration supplied. 

Default Parameters

The default 'Add Page Numbers' flow action parameters are detailed below:

  • Filename: The PDF filename to be processed (including file extension).
  • File Content: (Optional) A Base64 encoded representation of the PDF document (.pdf) file to be processed.
  • Operation ID: (Optional) The ID of a parent operation, please refer to: Flow Action Return Options: File Content vs. Operation ID
  • Start Page: Set which page to start adding page number(s) from
  • Start Number: Set the starting number for the page number(s) added to the document
  • Page Number Format: Set the format of the page number(s) added to the document, where [PageNumber] is replaced by the current page number and [TotalPages] is replaced by the total number of pages.
  • Horizontal Alignment: Set the horizontal alignment of the page number(s) added to the document, the default value is 'Center'.

1.jpg

Please refer to the Obtaining the 'File Contents' Parameter article for guidance on how to obtain the 'File Content' parameter ready to provide to an Encodian flow action.

Advanced Parameters

The advanced 'Add Page Numbers' flow action parameters are detailed below:

  • Margin Top: Set the top margin value (pt). The default value is set to '20'
  • Margin Right Set the right margin value (pt). The default value is set to '20'
  • Margin Bottom: Set the bottom margin value (pt). The default value is set to '20'
  • Margin Left: Set the left margin value (pt). The default value is set to '20'
  • Add to Background: Set whether the page number(s) should be added to top or bottom layer of the PDF document. The default setting (false) adds the page number(s) to the top layer
  • Font: Specify the name of the font, if the font cannot be found the default 'Arial' font will be used.
  • Font Colour: Set the HTML colour of the font, the default colour is set to '#000000'
  • Font Size: Set the size of the font, the default size is set to '14'.
  • Opacity: Set the opacity of the page number(s), valid values range from 0.0+ to 1.0, the default value is '1'
  • Final Operation: Sets whether the this is last Encodian flow action.

2.jpg 

Please refer to the Flow Action Return Options: File Content vs. Operation ID article for further details on the 'Final Operation' parameter.

Example 

  • Start Page: 1
  • Start Number: 1
  • Page Number Format: [PageNumber] of [TotalPages]
  • Horizontal Alignment: Center
  • Margin Top: 0
  • Margin Right: 0
  • Margin Bottom: 8
  • Margin Left: 0
  • Add to Background: false
  • Font: Arial
  • Font Colour: #FFFFFF
  • Font Size: 8
  • Opacity: 1

3.jpg

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk