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
    9. Rubber Stamp Annotation Class
    10. Widget Annotation Class
      1. Introduction
      2. Methods
    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. Refactor Old SetaPDF Code
  24. API Reference

Widget Annotation Class

Table of Contents

  1. Introduction
    1. Methods

      Introduction

      A widget annotation represents the appearance of form fields in an interactive PDF form. It is represented by the SetaPDF_Core_Document_Page_Annotation_Widget class.

      Technically a widget annotation can be created with SetaPDF but its usage requires much more low level logic. You should only use this class from existing document instances.  

      This class doesn't offers functionalities to edit form field values!
      You may check out the SetaPDF-FormFiller component for such task. 

      Methods

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

      getAction()

      Get the action of the annotation.

      getAppearanceCharacteristics()

      Get the appearance characteristics object.

      getHeight()

      Get the height of the annotation.

      getWidth()

      Get the width of the annotation.

      setAction()

      Set the action of the annotation.

      © 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)