Some test text!

Search & replace PDF text or images in Ruby

More languages

JavaScript

Java (Android)

C++

C# (.NET Core)

Java

Kotlin

Obj-C

JS (Node.js)

PHP

Python

Ruby

Swift

C# (UWP)

C# (Xamarin)

Sample Ruby code to use PDFTron SDK for searching and replacing text strings and images inside existing PDF files (e.g. business cards and other PDF templates). Unlike PDF forms, the ContentReplacer works on actual PDF content and is not limited to static rectangular annotation regions. Learn more about our Ruby PDF Library and PDF Editing & Manipulation Library.

Get Started Samples Download

To run this sample, get started with a free trial of Apryse SDK.

#---------------------------------------------------------------------------------------
# Copyright (c) 2001-2023 by Apryse Software Inc. All Rights Reserved.
# Consult LICENSE.txt regarding license information.
#---------------------------------------------------------------------------------------

require '../../../PDFNetC/Lib/PDFNetRuby'
include PDFNetRuby
require '../../LicenseKey/RUBY/LicenseKey'

$stdout.sync = true

#-----------------------------------------------------------------------------------------
# The sample code illustrates how to read and edit existing outline items and create 
# new bookmarks using the high-level API.
#-----------------------------------------------------------------------------------------

# Relative path to the folder containing the test files.
input_path = "../../TestFiles/"
output_path = "../../TestFiles/Output/"

#-----------------------------------------------------------------------------------------
# The sample code illustrates how to use the ContentReplacer class to make using 
# 'template' pdf documents easier.
#-----------------------------------------------------------------------------------------
	PDFNet.Initialize(PDFTronLicense.Key)
	
	# Example 1) Update a business card template with personalized info
	
	doc = PDFDoc.new(input_path + "BusinessCardTemplate.pdf")
	doc.InitSecurityHandler()
	
	# first, replace the image on the first page
	replacer = ContentReplacer.new()
	page = doc.GetPage(1)
	img = Image.Create(doc.GetSDFDoc(), input_path + "peppers.jpg")
	replacer.AddImage(page.GetMediaBox(), img.GetSDFObj())
	# next, replace the text place holders on the second page
	replacer.AddString("NAME", "John Smith")
	replacer.AddString("QUALIFICATIONS", "Philosophy Doctor")
	replacer.AddString("JOB_TITLE", "Software Developer")
	replacer.AddString("ADDRESS_LINE1", "#100 123 Software Rd")
	replacer.AddString("ADDRESS_LINE2", "Vancouver, BC")
	replacer.AddString("PHONE_OFFICE", "604-730-8989")
	replacer.AddString("PHONE_MOBILE", "604-765-4321")
	replacer.AddString("EMAIL", "info@pdftron.com")
	replacer.AddString("WEBSITE_URL", "http://www.pdftron.com")
	# finally, apply
	replacer.Process(page)
	
	doc.Save(output_path + "BusinessCard.pdf", 0)
	doc.Close()
	puts "Done. Result saved in BusinessCard.pdf"

	# Example 2) Replace text in a region with new text
	
	doc = PDFDoc.new(input_path + "newsletter.pdf")
	doc.InitSecurityHandler()
	
	replacer = ContentReplacer.new()
	page = doc.GetPage(1)
	replacer.AddText(page.GetMediaBox(), "hello hello hello hello hello hello hello hello hello hello")
	replacer.Process(page)
	
	doc.Save(output_path + "ContentReplaced.pdf", SDFDoc::E_linearized)
	doc.Close()
	puts "Done. Result saved in ContentReplaced.pdf"
	PDFNet.Terminate
	puts "Done."