←Select platform

PDFAnnotationType Enumeration

Summary
Specifies the type of PDF annotation.
Syntax
C#
C++/CLI
Java
Python
[SerializableAttribute()] 
public enum PDFAnnotationType  
public final class PDFAnnotationType 
    extends java.lang.Enum<PDFAnnotationType> 
[SerializableAttribute()] 
public enum class PDFAnnotationType  
class PDFAnnotationType(Enum): 
   Note = 0 
   Text = 1 
   Line = 2 
   Rectangle = 3 
   Ellipse = 4 
   Polyline = 5 
   Polygon = 6 
   Pencil = 7 
   Highlight = 8 
   Underline = 9 
   Strikeout = 10 
   Squiggly = 11 
Members
ValueMemberDescription
0Note Note annotation
1Text Text annotation
2Line Line annotation
3Rectangle Rectangle annotation
4Ellipse Ellipse annotation
5Polyline Polyline annotation
6Polygon Polygon annotation
7Pencil Pencil annotation
8Highlight Highlight annotation
9Underline Underline annotation
10Strikeout Strikeout annotation
11Squiggly Squiggly annotation
Remarks

PDFAnnotationType is used as the type for the PDFAnnotation.AnnotationType property.

Each member of the PDFAnnotationType enumeration listed below can be converted from and to LEAD AnnObject annotations. Below is a table showing the mapping between an AnnObject and a PDFAnnotationType using the AnnPDFConvertor Class:

PDFAnnotationType AnnObject
Ellipse AnnEllipseObject
Highlight AnnHiliteObject
Line AnnPolyLineObject (single line)
Note AnnStickyNoteObject
Pencil AnnPolyLineObject (freehand style)
Polygon AnnPolyLineObject (closed figure)
Polyline AnnPolyLineObject (2+ lines)
Rectangle AnnRectangleObject
Strikeout AnnTextStrikeoutObject
Text AnnTextObject
Text (with IntentFreeTextCallout) AnnTextPointerObject
Underline AnnTextUnderlineObject
Example
C#
Java
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Pdf; 
using Leadtools.WinForms; 
using Leadtools.Drawing; 
 
 
public void PDFHighlightAnnotationExample() 
{ 
   string pdfSrcFileName = Path.Combine(LEAD_VARS.ImagesDir, @"Leadtools.pdf"); 
   string pdfDestFileName = Path.Combine(LEAD_VARS.ImagesDir, @"LEAD_Annotations.pdf"); 
 
   PDFFile pdfFile = new PDFFile(pdfSrcFileName); 
   List<PDFAnnotation> Annotations = new List<PDFAnnotation>(); 
   PDFHighlightAnnotation highlight = new PDFHighlightAnnotation(); 
 
   // Add highlight points 
   highlight.Points.Add(new PDFPoint(100, 100)); 
   highlight.Points.Add(new PDFPoint(100, 200)); 
   highlight.Points.Add(new PDFPoint(200, 200)); 
   highlight.Points.Add(new PDFPoint(200, 100)); 
 
   highlight.Color = RasterColor.FromKnownColor(RasterKnownColor.YellowGreen); 
   Annotations.Add(highlight); 
 
   pdfFile.WriteAnnotations(Annotations, pdfDestFileName); 
} 
 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
} 
 
import java.io.File; 
import java.io.IOException; 
import java.util.ArrayList; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.assertTrue; 
 
import leadtools.*; 
import leadtools.document.*; 
import leadtools.pdf.*; 
 
 
public void pdfHighlightAnnotationExample() { 
 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String pdfSrcFileName = combine(LEAD_VARS_IMAGES_DIR, "Leadtools.pdf"); 
   String pdfDestFileName = combine(LEAD_VARS_IMAGES_DIR, "LEAD_Annotations.pdf"); 
 
   PDFFile pdfFile = new PDFFile(pdfSrcFileName); 
   ArrayList<PDFAnnotation> annotations = new ArrayList<PDFAnnotation>(); 
   PDFHighlightAnnotation highlight = new PDFHighlightAnnotation(); 
 
   // Add highlight points 
   highlight.getPoints().add(new PDFPoint(100, 100)); 
   highlight.getPoints().add(new PDFPoint(100, 200)); 
   highlight.getPoints().add(new PDFPoint(200, 200)); 
   highlight.getPoints().add(new PDFPoint(200, 100)); 
 
   highlight.setColor(RasterColor.fromKnownColor(RasterKnownColor.YELLOW_GREEN)); 
   annotations.add(highlight); 
 
   pdfFile.writeAnnotations(annotations, pdfDestFileName); 
 
   LEADDocument exportedPdf = DocumentFactory.loadFromFile(pdfDestFileName, 
         new LoadDocumentOptions()); 
 
   System.out.printf("Document exported successfully to %1s%nPage 1 has %2s annotation(s) of %3s%n", pdfDestFileName, 
         exportedPdf.getAnnotations().getAnnotations(false)[0].getChildren().size(), 
         exportedPdf.getAnnotations().getAnnotations(false)[0].getChildren().get(0).getClass()); 
 
   assertTrue(exportedPdf.getAnnotations().getAnnotations(false)[0].getChildren().size() > 0 
         && exportedPdf.getAnnotations().getAnnotations(false)[0].getChildren().get(0).getClass().toString() 
               .equals("class leadtools.annotations.engine.AnnTextHiliteObject")); 
 
} 
Requirements

Target Platforms

See Also

Reference

Leadtools.Pdf Namespace

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Pdf Assembly

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.