Update Word - Add Headers and Footers

Overview

The 'Update Word - Add Headers and Footers' flow action adds a HTML header and/or footer to the Microsoft Word document provided.

The following file types are supported:

  • docx
  • dotx
  • doc
  • dot
  • docm
  • dotm
  • rtf

Credit Count

This action consumes 1 credit per operation.

Note, different Encodian actions can consume different number credits. Please always check the action specific documentation and read What is an Encodian Action for a full description of how credits are consumed.

Parameters

The default 'Update Word - Add Headers and Footers' flow action parameters are detailed below:

  • File Content: The file content of the source Microsoft Word file
  • Header - All Pages: The HTML header to add to all pages
  • Footer - All Pages: The HTML footer to add to all pages

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 'Update Word - Add Headers and Footers' flow action parameters are detailed below:

  • Header - First Page: The HTML header to add to the first page
  • Header - Even Pages: The HTML header to add to all even pages
  • Header - Odd Pages: The HTML header to add to all odd pages
  • Footer - First Page: The HTML footer to add to the first page
  • Footer - Even Pages: The HTML footer to add to all even pages
  • Footer - Odd Pages: The HTML footer to add to all odd pages
  • Culture Name: This setting is used to set the culture for the document prior to conversion. Please refer to the Culture Names article for a list of supported cultures

Return Parameters

The 'Update Word - Add Headers and Footers' flow action returns the following data:

Action Specific Values

  • File Content - The processed word document (Base64)

Standard Return Values

  • OperationId - The unique ID assigned to this operation.
  • HttpStatusCode - The HTTP Status code for the response.
  • HttpStatusMessage - The HTTP Status message for the response.
  • Errors - An array of error messages should an error occur.
  • Operation Status - Indicates whether the operation has been completed, has been queued or has failed.

Example

The following HTML fragment will generate this example header:

<div style="padding: 20px 20px 20px 20px;">
<div style="float:left; width:50%; font-family:Helvetica Neue,Helvetica,Arial,sans-serif;">
<p style="margin: 5px; font-size: 10px">Encodian</p>
<p style="margin: 5px;font-size: 10px">Blythe Valley IC, Central Boulevard, Blythe Valley Business Park, Solihull, B90 8AJ</p>
<p style="margin: 5px; padding-bottom: 3px; font-size: 8px"><a href="https://www.encodian.com" target="_blank" style="color:#9F0DA3;">www.encodian.com</a></p>
<p style="margin: 5px; font-size: 8px; color:#999;">Commercial in Confidence</p>
<p style="margin: 5px; font-size: 8px; color:#999;">Encodian Solutions Ltd is registered in England and Wales No 10200243</p>
</div>
<div style="float:left; width:50%;">
<img style="float:right; max-width:100px; height:auto;" src="https://prod-cdn-general.azureedge.net/logos/icons/32x32t.png" />
</div>
</div>

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk