Create annotations

A variety of annotations can be created such as sticky note (text annotations), link annotations, stamp annotations, and more.

Text

Add text annotation (sticky note) to PDFs

To add a sticky note (text annotation) to a PDF Document.

Java

PDFDoc doc = new PDFDoc(filename);
Page page = doc.getPage(1);

// Create the sticky note (Text annotation)
Text txt = Text.create(doc, new Rect( 10, 20, 30, 40 ));
txt.setIcon("UserIcon");
txt.setContents("The quick brown fox ate the lazy mouse.");
txt.setColor(new ColorPt(0,1,0));
txt.refreshAppearance();
page.annotPushBack(txt);

Kotlin

val doc = PDFDoc(filename)
val page = doc.getPage(1)

// Create the sticky note (Text annotation)
val txt = Text.create(doc, Rect(10.0, 20.0, 30.0, 40.0))
txt.setIcon("UserIcon")
txt.contents = "The quick brown fox ate the lazy mouse."
txt.setColor(ColorPt(0.0,1.0,0.0))
txt.refreshAppearance()
page.annotPushBack(txt)

Add or edit PDF annotations Full code sample which shows how to add or edit PDF annotations (e.g. hyperlink, intra-document link, stamp, rubber stamp, file attachment, sound, text, free-text, line, circle, square, polygon, polyline, highlight, squiggly, caret, and ink).

Link

Add PDF link annotation

To add a hyperlink or intra-document link annotation to a PDF Document page.

Java

PDFDoc doc = new PDFDoc(filename);
Page page = doc.getPage(1);

// Create a hyperlink
Link hyperlink = Link.create(doc, new Rect(85, 570, 503, 524), Action.createURI(doc, "http://www.apryse.com"));
hyperlink.refreshAppearance();
page.annotPushBack(hyperlink);

// Create an intra-document link
Action goto_page_3 = Action.createGoto(Destination.createFitH(doc.getPage(3), 0));
Link link = com.pdftron.pdf.annots.Link.create(doc.getSDFDoc(), new Rect(85, 458, 503, 502), goto_page_3);
link.refreshAppearance();
page.annotPushBack(link);

Kotlin

val doc = PDFDoc(filename)
val page = doc.getPage(1)

// Create a hyperlink
val hyperlink = Link.create(doc, Rect(85.0, 570.0, 503.0, 524.0), Action.createURI(doc, "http://www.apryse.com"))
hyperlink.refreshAppearance()
page.annotPushBack(hyperlink)

// Create an intra-document link
val goto_page_3 = Action.createGoto(Destination.createFitH(doc.getPage(3), 0.0))
val link = Link.create(doc.sdfDoc, Rect(85.0, 458.0, 503.0, 502.0), goto_page_3)
link.refreshAppearance()
page.annotPushBack(link)

Add or edit PDF annotations sample Full code sample which shows how to add or edit PDF annotations (e.g. hyperlink, intra-document link, stamp, rubber stamp, file attachment, sound, text, free-text, line, circle, square, polygon, polyline, highlight, squiggly, caret, and ink).

Stamp

Add a stamp annotation

A stamp in a PDF document is analogous to applying a rubber stamp on a paper document.

Apryse SDK benefits include:

• Stamp PDF pages with text, images, or with other PDF pages.
• Embed fonts and images, and copy graphical elements from one page to another.

Use Stamper to stamp content (text, image, PDF page)

To stamp text, image, and a PDF page to a PDF document.

Java

PDFDoc doc = new PDFDoc(filename);
Stamper s = new Stamper(Stamper.e_relative_scale, .05, .05);

// Specifies if the stamp is to be stamped as an annotation.
// note that stamps created with this setting do not work with SetAsBackground, HasStamps, and DeleteStamps, if annotation is true.
//s.setAsAnnotation(true);

s.setAlignment(Stamper.e_horizontal_right, Stamper.e_vertical_bottom);
s.setAlignment(Stamper.e_horizontal_center, Stamper.e_vertical_top);
s.setFont(Font.create(doc, Font.e_courier, true));
ColorPt red = new ColorPt(1, 0, 0, 0);
s.setFontColor(red); //set color to red
s.setTextAlignment(Stamper.e_align_right);
s.setAsBackground(true); //set text stamp as background
PageSet ps = new PageSet(1, 2);
s.stampText(doc, "This is a title!", ps);

Image img = Image.create(doc, imagename);
s.setAsBackground(false); // set image stamp as foreground
PageSet first_page_ps = new PageSet(1);
s.stampImage(doc, img, first_page_ps);

PDFDoc src_doc = new PDFDoc(src_filename);
Page src_page = src_doc.getPage(1);
s.stampPage(doc, src_page, first_page_ps);

Kotlin

val doc = PDFDoc(filename)
val s = Stamper(Stamper.e_relative_scale, .05, .05)

// Specifies if the stamp is to be stamped as an annotation.
// note that stamps created with this setting do not work with SetAsBackground, HasStamps, and DeleteStamps, if annotation is true.
//s.setAsAnnotation(true)

s.setAlignment(Stamper.e_horizontal_right, Stamper.e_vertical_bottom)
s.setAlignment(Stamper.e_horizontal_center, Stamper.e_vertical_top)
s.setFont(Font.create(doc, Font.e_courier, true))
val red = ColorPt(1.0, 0.0, 0.0, 0.0)
s.setFontColor(red) //set color to red
s.setTextAlignment(Stamper.e_align_right)
s.setAsBackground(true) //set text stamp as background
val ps = PageSet(1, 2)
s.stampText(doc, "This is a title!", ps)

val img = Image.create(doc, imagename)
s.setAsBackground(false) // set image stamp as foreground
val first_page_ps = PageSet(1)
s.stampImage(doc, img, first_page_ps)

val src_doc = PDFDoc(src_filename)
val src_page = src.getPage(1)
s.stampPage(doc, src_page, ps)

Stamp a PDF File Full code sample which shows how to stamp PDF pages with text, images, or with other PDF pages and how to add new content (or watermark).

About Stamper

Stamper can be used for PDF pages with text, images, or with other PDF content in only a few lines of code. Although Stamper is very simple to use compared to ElementBuilder/ElementWriter it is not as powerful or flexible. In case you need full control over PDF creation use ElementBuilder/ElementWriter to add new content to existing PDF pages as shown in the ElementBuilder sample project .

Highlight

Add a highlight annotation to a PDF in Android

To add a highlight annotation to a PDF Document page.

Java

PDFDoc doc = new PDFDoc(filename);
Page page = doc.getPage(1);

// Create a highlight
Highlight hl = Highlight.create(doc, new Rect(100, 490, 150, 515));
hl.setColor(new ColorPt(0, 1, 0), 3);
hl.refreshAppearance();
page.annotPushBack(hl);

Kotlin

val doc = PDFDoc(filename)
val page = doc.getPage(1)

// Create a highlight
val hl = Highlight.create(doc, Rect(100.0, 490.0, 150.0, 515.0))
hl.setColor(ColorPt(0.0, 1.0, 0.0), 3)
hl.refreshAppearance()
page.annotPushBack(hl)

Add or edit PDF annotations sample Full code sample which shows how to add or edit PDF annotations (e.g. hyperlink, intra-document link, stamp, rubber stamp, file attachment, sound, text, free-text, line, circle, square, polygon, polyline, highlight, squiggly, caret, and ink).

Free text

Add a free text annotation to a PDF in Android

To add a free text annotation to a PDF Document page.

Java

PDFDoc doc = new PDFDoc(filename);
Page page = doc.getPage(1);

// Create a free text
FreeText txtannot = FreeText.create(doc, new Rect(100, 100, 350, 500));
txtannot.setContentRect(new Rect(200, 200, 350, 500));
txtannot.setContents("\n\nSome swift brown fox snatched a gray hare out of the air by freezing it with an angry glare." +
        "\n\nAha!\n\nAnd there was much rejoicing!");
txtannot.setCalloutLinePoints(new Point(200, 300), new Point(150, 290), new Point(110, 110));
txtannot.setBorderStyle(new Annot.BorderStyle(Annot.BorderStyle.e_solid, 1, 10, 20));
txtannot.setEndingStyle(Line.e_ClosedArrow);
txtannot.setColor(new ColorPt(0, 1, 0));
txtannot.setQuaddingFormat(1);
page.annotPushBack(txtannot);
txtannot.refreshAppearance();

Kotlin

val doc = PDFDoc(filename)
val page = doc.getPage(1)

// Create a free text
val txtannot = FreeText.create(doc, Rect(100.0, 100.0, 350.0, 500.0))
txtannot.contentRect = Rect(200.0, 200.0, 350.0, 500.0)
txtannot.contents = "\n\nSome swift brown fox snatched a gray hare out of the air by freezing it with an angry glare." + "\n\nAha!\n\nAnd there was much rejoicing!"
txtannot.setCalloutLinePoints(Point(200.0, 300.0), Point(150.0, 290.0), Point(110.0, 110.0))
txtannot.borderStyle = BorderStyle(BorderStyle.e_solid, 1, 10, 20)
txtannot.endingStyle = Line.e_ClosedArrow
txtannot.setColor(ColorPt(0.0, 1.0, 0.0))
txtannot.quaddingFormat = 1
page.annotPushBack(txtannot)
txtannot.refreshAppearance()

Add or edit PDF annotations sample Full code sample which shows how to add or edit PDF annotations (e.g. hyperlink, intra-document link, stamp, rubber stamp, file attachment, sound, text, free-text, line, circle, square, polygon, polyline, free text, squiggly, caret, and ink).

Rectangle

Add a rectangle annotation to a PDF in Android

To add a rectangle annotation to a PDF Document page.

Java

PDFDoc doc = new PDFDoc(filename);
Page page = doc.getPage(1);

// Create a rectangle
Square sq = Square.create(doc, new Rect(500, 200, 580, 300));
sq.setColor(new ColorPt(1, 0, 0), 3);
sq.setInteriorColor(new ColorPt(0, 1, 1), 3);
double[] dash = {4, 2};
sq.setBorderStyle(new Annot.BorderStyle(Annot.BorderStyle.e_dashed, 6, 0, 0, dash));
sq.setPadding(4);
sq.refreshAppearance();
page.annotPushBack(sq);

Kotlin

val doc = PDFDoc(filename)
val page = doc.getPage(1)

// Create a rectangle
val sq = Square.create(doc, Rect(500.0, 200.0, 580.0, 300.0))
sq.setColor(ColorPt(1.0, 0.0, 0.0), 3)
sq.setInteriorColor(ColorPt(0.0, 1.0, 1.0), 3)
val dash = doubleArrayOf(4.0, 2.0)
sq.borderStyle = BorderStyle(BorderStyle.e_dashed, 6, 0, 0, dash)
sq.setPadding(4.0)
sq.refreshAppearance()
page.annotPushBack(sq)

Add or edit PDF annotations sample Full code sample which shows how to add or edit PDF annotations (e.g. hyperlink, intra-document link, stamp, rubber stamp, file attachment, sound, text, free-text, line, circle, square, polygon, polyline, rectangle, squiggly, caret, and ink).