WriteAnnotations Method

Summary

Writes annotations to an existing PDF file.

Syntax

C++

Java

public void WriteAnnotations( 
   IList<PDFAnnotation> annotations, 
   string destinationFileName 
)

Public Sub WriteAnnotations( _ 
   ByVal annotations As IList(Of PDFAnnotation), _ 
   ByVal destinationFileName As String _ 
)

public void writeAnnotations( 
   java.util.List<PDFAnnotation> annotations, 
   java.lang.String destinationFileName 
);

public: 
void WriteAnnotations(  
   IList<PDFAnnotation^>^ annotations, 
   String^ destinationFileName 
)

Parameters

annotations
A list of PDFAnnotation objects to write. This must not be null and must be a list of 1 or more items. An empty list (count is zero) will throw an exception.

destinationFileName
Name of the destination PDF file to be created. If the value of this parameter is null then the filename set in FileName will be updated.

Remarks

WriteAnnotations does not clear the existing annotations, only adds the new objects. To replace the annotations in an existing file with new ones, use ClearAnnotations first to delete any existing objects and then WriteAnnotations to add the new objects.

Example

For an example on retrieving annotations of PDF pages, refer to PDFDocumentPage.

Requirements

Target Platforms

Reference

PDFFile Class

PDFFile Members

Download our FREE evaluation

Help Version 21.0.2021.7.6

Leadtools.Pdf Assembly

Introduction

Getting Started

Namespaces

Leadtools.Pdf Namespace

Assemblies