Product:

Get started

Samples

Open/Save Document

Learn more

Viewer

UI Customization

Annotation

Collaboration

MS Office

Generate via template

Conversion

PDF/A

Forms

Generate

Page manipulation

Editing page content

Extraction

Digital signature

Bookmarks

Compare files

Optimization

Layers (OCGs)

Measurement

Redaction

Security

Portfolios

Low-level PDF API

Changelogs

Create annotations

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

Add text annotation (sticky note) to PDFs

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

1PDFDoc doc = new PDFDoc(filename);
2Page page = doc.getPage(1);
3
4// Create the sticky note (Text annotation)
5Text txt = Text.create(doc, new Rect( 10, 20, 30, 40 ));
6txt.setIcon("UserIcon");
7txt.setContents("The quick brown fox ate the lazy mouse.");
8txt.setColor(new ColorPt(0,1,0));
9txt.refreshAppearance();
10page.annotPushBack(txt);

1val doc = PDFDoc(filename)
2val page = doc.getPage(1)
3
4// Create the sticky note (Text annotation)
5val txt = Text.create(doc, Rect(10.0, 20.0, 30.0, 40.0))
6txt.setIcon("UserIcon")
7txt.contents = "The quick brown fox ate the lazy mouse."
8txt.setColor(ColorPt(0.0,1.0,0.0))
9txt.refreshAppearance()
10page.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).

Add PDF link annotation

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

1PDFDoc doc = new PDFDoc(filename);
2Page page = doc.getPage(1);
3
4// Create a hyperlink
5Link hyperlink = Link.create(doc, new Rect(85, 570, 503, 524), Action.createURI(doc, "http://www.apryse.com"));
6hyperlink.refreshAppearance();
7page.annotPushBack(hyperlink);
8
9// Create an intra-document link
10Action goto_page_3 = Action.createGoto(Destination.createFitH(doc.getPage(3), 0));
11Link link = com.pdftron.pdf.annots.Link.create(doc.getSDFDoc(), new Rect(85, 458, 503, 502), goto_page_3);
12link.refreshAppearance();
13page.annotPushBack(link);

1val doc = PDFDoc(filename)
2val page = doc.getPage(1)
3
4// Create a hyperlink
5val hyperlink = Link.create(doc, Rect(85.0, 570.0, 503.0, 524.0), Action.createURI(doc, "http://www.apryse.com"))
6hyperlink.refreshAppearance()
7page.annotPushBack(hyperlink)
8
9// Create an intra-document link
10val goto_page_3 = Action.createGoto(Destination.createFitH(doc.getPage(3), 0.0))
11val link = Link.create(doc.sdfDoc, Rect(85.0, 458.0, 503.0, 502.0), goto_page_3)
12link.refreshAppearance()
13page.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).

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.

1PDFDoc doc = new PDFDoc(filename);
2Stamper s = new Stamper(Stamper.e_relative_scale, .05, .05);
3
4// Specifies if the stamp is to be stamped as an annotation.
5// note that stamps created with this setting do not work with SetAsBackground, HasStamps, and DeleteStamps, if annotation is true.
6//s.setAsAnnotation(true);
7
8s.setAlignment(Stamper.e_horizontal_right, Stamper.e_vertical_bottom);
9s.setAlignment(Stamper.e_horizontal_center, Stamper.e_vertical_top);
10s.setFont(Font.create(doc, Font.e_courier, true));
11ColorPt red = new ColorPt(1, 0, 0, 0);
12s.setFontColor(red); //set color to red
13s.setTextAlignment(Stamper.e_align_right);
14s.setAsBackground(true); //set text stamp as background
15PageSet ps = new PageSet(1, 2);
16s.stampText(doc, "This is a title!", ps);
17
18Image img = Image.create(doc, imagename);
19s.setAsBackground(false); // set image stamp as foreground
20PageSet first_page_ps = new PageSet(1);
21s.stampImage(doc, img, first_page_ps);
22
23PDFDoc src_doc = new PDFDoc(src_filename);
24Page src_page = src_doc.getPage(1);
25s.stampPage(doc, src_page, first_page_ps);

1val doc = PDFDoc(filename)
2val s = Stamper(Stamper.e_relative_scale, .05, .05)
3
4// Specifies if the stamp is to be stamped as an annotation.
5// note that stamps created with this setting do not work with SetAsBackground, HasStamps, and DeleteStamps, if annotation is true.
6//s.setAsAnnotation(true)
7
8s.setAlignment(Stamper.e_horizontal_right, Stamper.e_vertical_bottom)
9s.setAlignment(Stamper.e_horizontal_center, Stamper.e_vertical_top)
10s.setFont(Font.create(doc, Font.e_courier, true))
11val red = ColorPt(1.0, 0.0, 0.0, 0.0)
12s.setFontColor(red) //set color to red
13s.setTextAlignment(Stamper.e_align_right)
14s.setAsBackground(true) //set text stamp as background
15val ps = PageSet(1, 2)
16s.stampText(doc, "This is a title!", ps)
17
18val img = Image.create(doc, imagename)
19s.setAsBackground(false) // set image stamp as foreground
20val first_page_ps = PageSet(1)
21s.stampImage(doc, img, first_page_ps)
22
23val src_doc = PDFDoc(src_filename)
24val src_page = src.getPage(1)
25s.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 .

Add a highlight annotation to a PDF in Android

To add a highlight annotation to a PDF Document page.

1PDFDoc doc = new PDFDoc(filename);
2Page page = doc.getPage(1);
3
4// Create a highlight
5Highlight hl = Highlight.create(doc, new Rect(100, 490, 150, 515));
6hl.setColor(new ColorPt(0, 1, 0), 3);
7hl.refreshAppearance();
8page.annotPushBack(hl);

1val doc = PDFDoc(filename)
2val page = doc.getPage(1)
3
4// Create a highlight
5val hl = Highlight.create(doc, Rect(100.0, 490.0, 150.0, 515.0))
6hl.setColor(ColorPt(0.0, 1.0, 0.0), 3)
7hl.refreshAppearance()
8page.annotPushBack(hl)

Add a free text annotation to a PDF in Android

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

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

1val doc = PDFDoc(filename)
2val page = doc.getPage(1)
3
4// Create a free text
5val txtannot = FreeText.create(doc, Rect(100.0, 100.0, 350.0, 500.0))
6txtannot.contentRect = Rect(200.0, 200.0, 350.0, 500.0)
7txtannot.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!"
8txtannot.setCalloutLinePoints(Point(200.0, 300.0), Point(150.0, 290.0), Point(110.0, 110.0))
9txtannot.borderStyle = BorderStyle(BorderStyle.e_solid, 1, 10, 20)
10txtannot.endingStyle = Line.e_ClosedArrow
11txtannot.setColor(ColorPt(0.0, 1.0, 0.0))
12txtannot.quaddingFormat = 1
13page.annotPushBack(txtannot)
14txtannot.refreshAppearance()

Add a rectangle annotation to a PDF in Android

To add a rectangle annotation to a PDF Document page.

1PDFDoc doc = new PDFDoc(filename);
2Page page = doc.getPage(1);
3
4// Create a rectangle
5Square sq = Square.create(doc, new Rect(500, 200, 580, 300));
6sq.setColor(new ColorPt(1, 0, 0), 3);
7sq.setInteriorColor(new ColorPt(0, 1, 1), 3);
8double[] dash = {4, 2};
9sq.setBorderStyle(new Annot.BorderStyle(Annot.BorderStyle.e_dashed, 6, 0, 0, dash));
10sq.setPadding(4);
11sq.refreshAppearance();
12page.annotPushBack(sq);

1val doc = PDFDoc(filename)
2val page = doc.getPage(1)
3
4// Create a rectangle
5val sq = Square.create(doc, Rect(500.0, 200.0, 580.0, 300.0))
6sq.setColor(ColorPt(1.0, 0.0, 0.0), 3)
7sq.setInteriorColor(ColorPt(0.0, 1.0, 1.0), 3)
8val dash = doubleArrayOf(4.0, 2.0)
9sq.borderStyle = BorderStyle(BorderStyle.e_dashed, 6, 0, 0, dash)
10sq.setPadding(4.0)
11sq.refreshAppearance()
12page.annotPushBack(sq)

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales