Text Box Watermark PDF using Ruby

Stamp a PDF with the text box.

Try for FREE

Text Box Watermark PDF features

Stamp or watermark a PDF with the text box.

ConvertAPI Ruby library install

ConvertAPI provides a Ruby Gem that allows you to perform a Text Box Watermark PDF conversion with just a few lines of code. First, install the ConvertAPI Ruby SDK:

Add this line to your application's Gemfile:
gem 'convert_api'

Authenticate your Ruby library

You can obtain your secret key by signing up for a free account. Once you sign up, you'll receive 250 free conversions instantly! Grab your authentication secret from the account dashboard, and authenticate the ConvertAPI Ruby library like this:

# get your secret key here: https://www.convertapi.com/a/auth
ConvertApi.configure do |config|
   config.api_secret = 'your-api-secret'
end

Text Box Watermark PDF using Ruby in no time!

Once you have your authentication in place, simply copy-paste this pdf to watermark-textbox conversion code snippet into your Ruby project:

// Code snippet is using the ConvertAPI JavaScript Client: https://github.com/ConvertAPI/convertapi-js

// Code snippet is using the ConvertAPI Node.js Client: https://github.com/ConvertAPI/convertapi-nodejs

// Code snippet is using the ConvertAPI PHP Client: https://github.com/ConvertAPI/convertapi-php

// Code snippet is using the ConvertAPI Java Client: https://github.com/ConvertAPI/convertapi-java

// Code snippet is using the ConvertAPI C# Client: https://github.com/ConvertAPI/convertapi-dotnet

# Code snippet is using the ConvertAPI Ruby Client: https://github.com/ConvertAPI/convertapi-ruby

# Code snippet is using the ConvertAPI Python Client: https://github.com/ConvertAPI/convertapi-python

// Code snippet is using the ConvertAPI Go Client: https://github.com/ConvertAPI/convertapi-go

REM Code snippet is using the command line utility program: https://github.com/ConvertAPI/convertapi-cli

<!-- For conversions with the multiple file result please refer to this example: https://repl.it/@ConvertAPI/HTML-Form-with-multiple-file-result -->

Try the conversion online - no coding required!

You can try out advanced conversion parameters and test the conversion result online using our interactive demo tool. This tool will produce the same conversion output as if you were using the library from your solution, and it will auto-generate the code snippet for you!

Try for FREE!

Conversion parameters

Password String

Sets the password to open protected documents.

PageRange String

Set page range. Example 1-10 or 1,2,5.

Text String

Specifies the text to use as text box watermark. The list of supported variables: %N% - new line, %PAGE% - current page number, %PAGES% - total number of pages, %FILENAME% - name of the file, %WEEKDAY% - full weekday name, %WEEKDAY_SHORT% - abbreviated weekday name, %MONTH% - month number (1-12), %MONTHNAME% - full month name, %MONTHNAME_SHORT% - abbreviated month name, %YEAR% - year with century (YYYY), %YEAR_SHORT% - year without century (YY), %DAY% - day of month, %DAY_YEAR% - day of the year (1 -366), %HOUR% - hour (01- 12), %HOURS% - hour (00-23), %MINUTES% - minutes (00-59), %SECONDS% - seconds (00-59), %AMPM% - AM PM, %DATE% - local date representation, %TIME% - local time representation, %DATETIME% - local date and time, %AUTHOR% - document Author, %TITLE% - document Title, %SUBJECT% - document Subject, %KEYWORDS% - document Keywords.

TextAlign Collection

Specifies the watermark text align.

Values:   left center right

WordWrap Bool

Specifies whether to enable word wrap in case text does not fit in one line.

LineSpacing Integer

Specifies the watermark text line spacing.

FontName Collection

Specifies the watermark font name. Contact us if you are looking for a specific font for a watermark that is missing from the list.

Values:   Arial Bahnschrift Calibri Cambria Consolas Constantia Courier New Georgia Tahoma Times New Roman Verdana

FontSize Integer

Specifies the watermark font size.

FontColor String

Specifies the watermark font color.

StrokeColor String

Specifies font stroke color.

StrokeWidth Integer

Specifies the stroke width.

FontEmbed Bool

Specifies whether fonts should be embedded.

FontSubset Bool

Specifies whether fonts should be subset.

FontEncoding String

Specifies the font encoding.

TextRenderingMode Collection

Specifies the text rendering mode.

Values:   filltext stroketext fillstroke invisible

Rotate Integer

Specifies the watermark rotation angle in degrees.

Opacity Integer

Specifies watermark opacity level.

Style Collection

Specifies watermark style, stamp or watermark. The stamp is placed over page content and watermark under page content.

Values:   stamp watermark

GoToLink String

Specifies the web address to go when the watermark is clicked.

GoToPage String

Specifies the page number to go when the watermark is clicked.

PageRotation Bool

Specifies whether to use the page rotation parameter when placing watermark.

CropBox Bool

Specifies whether to use the page crop box to position watermark.

HorizontalAlignment Collection

Specifies the horizontal watermark alignment.

Values:   left center right

VerticalAlignment Collection

Specifies the vertical watermark alignment.

Values:   top center bottom

PositionX Integer

Specifies the watermark X coordinate. If set overrides property HorizontalAlignment.

PositionY Integer

Specifies the watermark Y coordinate. If set overrides property VerticalAlignment.

PositionUnit Collection

Specifies measurement unit to use for the PositionX and PositionY properties.

Values:   pt in mm cm

Height Integer

Specifies the watermark height.

Width Integer

Specifies the watermark width.

EmbedFonts Bool

Embed fonts in PDF.

SubsetFonts Bool

Include in the output PDF document only the font characters that are used in the original document.

SubsetFontsThreshold Integer

Sets the Subset Fonts threshold. If the percentage of used characters, compared with total characters of the particular font, exceeds this threshold, the entire font is embedded.

PdfVersion Collection

Set PDF version.

Values:   1.2 1.3 1.4 1.5 1.6 1.7 1.8 2.0

PdfResolution Integer

Set PDF resolution.

PdfTitle String

Provide a value to customize the PDF title. Otherwise, the default document title will be used. Use single quotes and a space (' ') to remove the title.

PdfSubject String

Provide a value to customize the PDF subject. Otherwise, the default document subject will be used. Use single quotes and a space (' ') to remove the subject.

PdfAuthor String

Provide a value to customize the PDF author. Otherwise, the default document author will be used. Use single quotes and a space (' ') to remove the author.

PdfKeywords String

Provide a value to customize the PDF keywords. Otherwise, the default document keywords will be used. Use single quotes and a space (' ') to remove the keywords.

OpenPage Integer

Set the page number at which the PDF document should open.

OpenZoom Collection

Set the default zoom percentage for when you open PDF files .

Values:   Default ActualSize FitPage FitWidth FitHeight FitVisible 25 50 75 100 125 150 200 400 800 1600 2400 3200 6400

RotatePage Collection

Automatically rotate pages based on the orientation of the text. By Page option will rotate each page based on the direction of the text on that page. All option will rotate all pages in the document based on the orientation of the majority of text.

Values:   Disabled ByPage All

ColorSpace Collection

Set PDF color space.

Values:   Default RGB CMYK Gray

Try Text Box Watermark PDF for free!