Index

  1. Installation
  2. Getting Started
  3. Memory Usage
  4. Readers and Writers
  5. The Document Class
  6. Metadata
  7. Pages
  8. Canvas
  9. Page Layout and Mode
  10. Viewer Preferences
  11. Document Outline
  12. Page Labels
  13. Actions
  14. Destinations
  15. Annotations
    1. Introduction
    2. The Annotations Helper
    3. Annotation Class
    4. Markup Annotation Class
    5. Text Annotation Class
    6. Link Annotation Class
    7. Square and Circle Annotation Classes
    8. Text Markup Annotation Classes
      1. Introduction
      2. Methods
      3. Example
    9. Rubber Stamp Annotation Class
    10. Widget Annotation Class
    11. File Attachment Annotation Class
  16. Embedded File Streams
  17. Colors and Color Spaces
  18. Page Formats and Boundaries
  19. Standard and Public Key Encryption
  20. Fonts and Encodings
  21. Corrupted Documents
  22. Reader Enabled Documents
  23. Migrating
  24. API Reference

Text Markup Annotation Classes Highlight, Underline, Strikeout and Jagged/Squiggly Underline

Table of Contents

  1. Introduction
    1. Methods
      1. Example

        Introduction

        Text markup annotations shall appear as highlights, underlines, strikeouts, or jagged (“squiggly”) underlines in the text of a document. They are represented in SetaPDF by following classes:

        All of them are both a text markup and markup annotation. 

        Methods

        The classes implements getter and setter methods to access the individual annotation data:

        getQuadPoints()

        Get the quad points.

        setQuadPoints()

        Set the quad points.

        Example

        PHP
        <?php

use setasign\SetaPDF2\Core\Document;
use setasign\SetaPDF2\Core\PageFormats;
use setasign\SetaPDF2\Core\Writer\HttpWriter;

require_once('library/SetaPDF/Autoload.php');

$writer = new HttpWriter('text-markup-annotation.pdf', true);
$document = new Document($writer);

// let's create a page
$pages = $document->getCatalog()->getPages();
$page = $pages->create(PageFormats::A4);

$annotations = $page->getAnnotations();

// create a highlight annotation
$annotation = new Document\Page\Annotation\HighlightAnnotation([50, 680, 70, 700]);
$annotation->setContents("A simple highlight annotation.");
$annotation->setTextLabel("John Dow"); // Used as Author in a Reader application
$annotation->setColor([1, 0, 0]);
$annotation->setSubject('A sticky note to a highlight annotation');
$annotations->add($annotation);

// create the popup
$popup = $annotation->createPopup();
$annotations->add($popup);
// assign the popup to the text annotation
$annotation->setPopup($popup);

$document->save()->finish();
        © 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)