Overview
The 'PDF - Add Text Watermark (Advanced)' action adds the specified text watermark to the PDF document provided. This action provides enhanced configuration control over the standard Add Text Watermark action.
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 'PDF - Add Text Watermark (Advanced)' flow action parameters are detailed below:
- Filename: The filename (including the file extension) of the source PDF file.
- File Content: A Base64 encoded representation of the source PDF file.
- Text: The text to embed as a watermark within the PDF document.
- Skip First Page: Set whether to skip applying the watermark to the first page.
- Font: Set the font applied to the text watermark, the default font is Helvetica.
- Text Colour: The HTML colour applied to the text watermark, the default colour is #E81123.
- Text Size: The size of the font applied to the text watermark, the default size is 34.
- Opacity: The opacity of the text watermark, valid values range from 0.0+ to 1.0, the default value is 1.
- Encoding Type: The encoding type to apply to the text watermark, the default value is Winansi.
- Horizontal Alignment: Set the horizontal alignment of the watermark, the default value is Center.
- Vertical Alignment: Set the vertical alignment of the watermark, the default value is Center.
- Text Alignment: Set the text alignment of the watermark, the default value is Center.
- Apply To: Set which pages in the document the watermark should be applied to.
- Page Numbers: Sets the page numbers to the watermark should be added. This setting only applies when the 'Apply To' parameter is set to 'Specific'.
- Ignore Page Numbers: Sets the page numbers the watermark should not be added to. This setting only applies when the 'Apply To' parameter is set to 'Specific'.
- Rotation Angle: Set the rotation angle of the text watermark.
- Text Wrap: Set whether the text watermark should automatically wrap.
- Text Wrap Row Width: Set the row width applied when the watermark is set to automatically wrap.
- Auto Scale: Set whether the text should be automatically sized to fit the width of the container.
- Auto Scale Text Width: Set the width of the watermark container when automatic scaling is enabled.
- Auto Scale Text Height: Set the height of the watermark container when automatic scaling is enabled.
- Text Layer: Set whether the watermark should be added to the top or bottom layer. If ‘True’ the watermark is added to the bottom layer.
- Y Indent: Set the vertical watermark indent, starting from the bottom and overriding the VerticalAlignment property.
- X Indent: Set the horizontal watermark indent, starting from the left and overriding the HorizontalAlignment property.
- Apply as an Image: Set whether the text watermark should be added as text or an image.
- Watermark ID: Override and manually set an identifier for the applied watermark
NOTE: If either the 'X Indent' or 'Y Indent' properties have been set then these properties will be used to align the watermark and not the 'Horizontal Alignment' and 'Vertical Alignment' properties.
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 'PDF - Add Text Watermark (Advanced)' flow action parameters are detailed below:
- Operation ID: (Advanced) The ID of a parent operation, please refer to Flow Action Return Options: File Content vs. Operation ID
- Return File: (Advanced) Sets whether the action should return a file or alternatively an operation ID: Flow Action Return Options: File Content vs. Operation ID
Examples
- Font: Helvetica
- Text Colour: #FF6E26
- Text Size: 30
- Opacity: 0.7
- Encoding Type: Winansi
- Horizontal Alignment: None
- Vertical Alignment: None
- Text Alignment: None
- Apply To: FirstPage
- Rotation Angle: 45
- Text Wrap: No
- Text Wrap Row Width: 0
- Auto Scale: Yes
- Auto Scale Text Width: 300
- Auto Scale Text Height: 80
- Text Layer: No
- Y Indent: 0
- X Indent: 0
- Apply as an Image: No
- Font: Helvetica
- Text Colour: #FF6E26
- Text Size: 30
- Opacity: 1
- Encoding Type: Winansi
- Horizontal Alignment: Center
- Vertical Alignment: Bottom
- Text Alignment: Center
- Apply To: FirstPage
- Rotation Angle: 0
- Text Wrap: No
- Text Wrap Row Width: 0
- Auto Scale: No
- Auto Scale Text Width: 0
- Auto Scale Text Height:0
- Text Layer: No
- Y Indent: 0
- X Indent: 0
- Apply as an Image: No
0 Comments