FramePen Property

Summary

Pen for the bounding rectangle of text annotation.

Syntax

C++/CLI

Java

Python

public PDFPen FramePen { get; set; }

public PDFPen getFramePen(); 
public void setFramePen( 
   PDFPen pDFPen 
);

public: 
property PDFPen FramePen { 
   PDFPen get(); 
   void set (    PDFPen ); 
}

FramePen # get and set (PDFTextAnnotation)

Property Value

A PDFPen that represents pen properties for the bounding rectangle of text annotation.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Pdf; 
using Leadtools.WinForms; 
using Leadtools.Drawing; 
 
 
public void PDFTextAnnotationExample() 
{ 
   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>(); 
   PDFTextAnnotation text = new PDFTextAnnotation(); 
   PDFPen pen = new PDFPen(); 
   PDFBrush brush = new PDFBrush(); 
 
   // Assign pen properties 
   // Create dashed red pen with width of 2 
   pen.Color = RasterColor.FromKnownColor(RasterKnownColor.Red); 
   pen.PenStyle = PDFPen.Dashed; 
   pen.Width = 2; 
 
   // Assign brush properties 
   // Create green solid brush 
   brush.BrushStyle = PDFBrush.Solid; 
   brush.Color = RasterColor.FromKnownColor(RasterKnownColor.Green); 
 
   text.FramePen = pen; 
   text.FrameBrush = brush; 
   text.FontHeight = 30; 
   text.Color = RasterColor.FromKnownColor(RasterKnownColor.Magenta); 
   text.FontName = "Arial"; 
   text.Content = "This is annotation text"; 
   text.Justification = PDFTextJustification.Left; 
   text.FrameBounds = new PDFRect(200, 500, 500, 300); 
   Annotations.Add(text); 
 
   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.pdf.*; 
 
 
public void pdfTextAnnotationExample() { 
 
   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>(); 
   PDFTextAnnotation text = new PDFTextAnnotation(); 
   PDFPen pen = new PDFPen(); 
   PDFBrush brush = new PDFBrush(); 
 
   // Assign pen properties 
   // Create dashed red pen with width of 2 
   pen.setColor(RasterColor.fromKnownColor(RasterKnownColor.RED)); 
   pen.setPenStyle(PDFPen.DASHED); 
   pen.setWidth(2); 
 
   // Assign brush properties 
   // Create green solid brush 
   brush.setBrushStyle(PDFBrush.SOLID); 
   brush.setColor(RasterColor.fromKnownColor(RasterKnownColor.GREEN)); 
 
   text.setFramePen(pen); 
   text.setFrameBrush(brush); 
   text.setFontHeight(30); 
   text.setColor(RasterColor.fromKnownColor(RasterKnownColor.MAGENTA)); 
   text.setFontName("Arial"); 
   text.setContent("This is annotation text"); 
   text.setJustification(PDFTextJustification.LEFT); 
   text.setFrameBounds(new PDFRect(200, 500, 500, 300)); 
   annotations.add(text); 
 
   pdfFile.writeAnnotations(annotations, pdfDestFileName); 
 
   int count = 0; 
   for (PDFAnnotation p : annotations) { 
      if (p.equals(text)) { 
         count++; 
      } 
   } 
   assertTrue(count > 0); 
}

Requirements

Target Platforms

Reference

PDFTextAnnotation Class

PDFTextAnnotation Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Pdf Assembly

Introduction

Getting Started

Namespaces

Leadtools.Pdf Namespace

Assemblies