Class: ContentReplacer

PDFDoc doc("../../TestFiles/BusinessCardTemplate.pdf");
doc.InitSecurityHandler();
ContentReplacer replacer;
Page page = doc.GetPage(1);
Image img = Image::Create(doc, "../../TestFiles/peppers.jpg");
replacer.AddImage(page.GetMediaBox(), img.GetSDFObj());
replacer.AddString("NAME", "John Smith");
replacer.AddString("JOB_TITLE", "Software Developer");
replacer.Process(page);

Extends

• PDFNet.Destroyable

Methods

---

<static> create()

Create a new ContentReplacer object, to which replacement rules will be added. The same object can be used to 'Process' multiple pages.

Returns:

A promise that resolves to an object of type: "PDFNet.ContentReplacer"

Type

Promise.<PDFNet.ContentReplacer>

---

addImage(target_region, replacement_image)

Replace the image that best fits into 'target_region' with 'replacement_image'.

Parameters:

Name	Type	Description
target_region	PDFNet.Rect	The rectangle defining the area in which an image that best fits the rectangle will be replaced by 'replacement_image'.
replacement_image	PDFNet.Obj	The 'SDF.Obj' of a 'PDF.Image' object. Note: The best fit is the image that closest matches 'target_region'. For example if there are two images on the page, one taking up all of the page, and the other smaller, and the smaller one has similar dimensions and position of 'target_region', then the smaller image would be replaced, not the larger. Furthermore, if 'target_region' encloses multiple images, then only the image with the largest area in 'target_region' will be replaced.

Returns:

Type

Promise.<void>

---

addString(template_text, replacement_text)

Any text of the form "[template_text]" will be replaced by "replacement_text".

Parameters:

Name	Type	Description
template_text	string	The text to remove.
replacement_text	string	The new text that will appear in place of 'template_text'. Note: Only text wrapped in '[' and ']' will be checked, and if it matches 'template_text', then 'template_text' and the surrounding square braces will be replaced by 'replacement_text'. For example AddString("TITLE", "Doctor") will replace any text consisting of "[TITLE]" with "Doctor".

Returns:

Type

Promise.<void>

---

addText(target_region, replacement_text)

All text inside 'target_region' will be deleted and replaced with 'replacement_text'.

Parameters:

Name	Type	Description
target_region	PDFNet.Rect	The rectangle defining the area in which all text will be replaced by 'replacement_text'.
replacement_text	string	The new text that will replace the existing text in 'target_region'. Note: The 'replacement_text' will be styled in the same font/color/style that is used by the original text. If there are multiple font styles, the most prevalent style will be used. Also, the 'replacement_text' will wrap within the 'target_region', but if it is too long, the overflow text will not be visible, and no surrounding content will be affected.

Returns:

Type

Promise.<void>

---

destroy()

Destructor

Inherited From:

• PDFNet.Destroyable#destroy

Returns:

Type

Promise.<void>

---

process(page)

Apply the replacement instructions to the target page. Subsequent calls to 'Process' can be made on other pages, and it will apply the same rules.

Parameters:

Name	Type	Description
page	PDFNet.Page	The page to apply the content replacement instructions to.

Returns:

Type

Promise.<void>

---

setMatchStrings(start_str, end_str)

Change the delimiters from '[' and ']' to arbitary strings.

Parameters:

Name	Type	Description
start_str	string	The starting delimiter string.
end_str	string	The ending delimiter string. Note: While empty strings are allowed as delimiters, a warning is displayed. Otherwise there are no restrictions. For example, after SetMatchStrings("<<", ">>"), AddString("TITLE", "Doctor") will replace any text consisting of "<