Watermark PDF using Ruby
Watermark PDF files. Stamp a PDF with the text.
Watermark PDF features
Add text watermark to PDF files easily with Watermark PDF Ruby SDK.
ConvertAPI Ruby library install
ConvertAPI provides a Ruby Gem that allows you to perform a Watermark PDF conversion with just a few lines of code. First, install the ConvertAPI Ruby SDK:
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:
ConvertApi.configure do |config|
config.api_credentials = 'secret_or_token'
end
Watermark PDF using Ruby in no time!
Once you have your authentication in place, simply copy-paste this pdf to watermark conversion code snippet into your Ruby project:
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
Sets the password to open protected documents.
Set page range. Example 1-10 or 1,2,5.
Specifies the text to use as watermark. The list of supported variables:
%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
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
Specifies the watermark font size.
Specifies the watermark font color.
Specifies font stroke color.
Specifies the stroke width.
Specifies whether fonts should be embedded.
Specifies whether fonts should be subset.
Specifies the font encoding.
Specifies the text rendering mode.
Values: filltext stroketext fillstroke invisible
Specifies the watermark rotation angle in degrees.
Specifies watermark opacity level.
Specifies watermark style, stamp or watermark. The stamp is placed over page content and watermark under page content.
Values: stamp watermark
Specifies the web address to go when the watermark is clicked.
Specifies the page number to go when the watermark is clicked.
Specifies whether to use the page rotation parameter when placing watermark.
Specifies whether to use the page crop box to position watermark.
Specifies the horizontal watermark alignment.
Values: left center right
Specifies the vertical watermark alignment.
Values: top center bottom
Specifies the watermark X coordinate. If set overrides property HorizontalAlignment.
Specifies the watermark Y coordinate. If set overrides property VerticalAlignment.
Specifies measurement unit to use for the PositionX and PositionY properties.
Values: pt in mm cm
Embed fonts in PDF.
Include in the output PDF document only the font characters that are used in the original document.
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.
Set PDF version.
Values: 1.2 1.3 1.4 1.5 1.6 1.7 1.8 2.0
Set PDF resolution.
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.
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.
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.
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.
Set the page number at which the PDF document should open.
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
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
Set PDF color space.
Values: Default RGB CMYK Gray