Color Property

Summary

Color of the underline annotations.

Syntax

C++/CLI

Java

Python

public RasterColor Color { get; set; }

public RasterColor getColor(); 
public void setColor( 
   RasterColor rasterColor 
);

public: 
property RasterColor Color { 
   RasterColor get(); 
   void set (    RasterColor ); 
}

Color # get and set (PDFUnderlineAnnotation)

Property Value

A Leadtools.RasterColor structure that represents the color of the underline annotations. The default value is an empty Leadtools.RasterColor structure.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Pdf; 
using Leadtools.WinForms; 
using Leadtools.Drawing; 
 
 
public void PDFUnderlineAnnotationExample() 
{ 
   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>(); 
   PDFUnderlineAnnotation underline = new PDFUnderlineAnnotation(); 
 
   // Add underline points 
   underline.Points.Add(new PDFPoint(100, 100)); 
   underline.Points.Add(new PDFPoint(100, 200)); 
   underline.Points.Add(new PDFPoint(200, 200)); 
   underline.Points.Add(new PDFPoint(200, 100)); 
 
   underline.Color = RasterColor.FromKnownColor(RasterKnownColor.Black); 
   Annotations.Add(underline); 
 
   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.List; 
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 pdfUnderlineAnnotationExample() { 
 
   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); 
   List<PDFAnnotation> annotations = new ArrayList<PDFAnnotation>(); 
   PDFUnderlineAnnotation underline = new PDFUnderlineAnnotation(); 
 
   // Add underline points 
   underline.getPoints().add(new PDFPoint(100, 100)); 
   underline.getPoints().add(new PDFPoint(100, 200)); 
   underline.getPoints().add(new PDFPoint(200, 200)); 
   underline.getPoints().add(new PDFPoint(200, 100)); 
 
   underline.setColor(RasterColor.fromKnownColor(RasterKnownColor.BLACK)); 
   annotations.add(underline); 
 
   pdfFile.writeAnnotations(annotations, pdfDestFileName); 
   assertTrue("File exists", new File(pdfDestFileName).exists()); 
   System.out.println("Command run and image exported to: " + pdfDestFileName); 
 
   LEADDocument exportedPdf = DocumentFactory.loadFromFile(pdfDestFileName, 
         new LoadDocumentOptions()); 
 
   assertTrue(exportedPdf.getAnnotations().getAnnotations(false)[0].getChildren().get(0).getClass().toString() 
         .equals("class leadtools.annotations.engine.AnnTextUnderlineObject")); 
 
}

Requirements

Target Platforms

Reference

PDFUnderlineAnnotation Class

PDFUnderlineAnnotation Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Pdf Assembly

Introduction

Getting Started

Namespaces

Leadtools.Pdf Namespace

Assemblies