PdfPageFacade.AddInkAnnotation(IList<IList<PdfPoint>>) Method

Creates an ink annotation comprised of one or multiple points on the page.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v23.2.Core.dll

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public PdfInkAnnotationFacade AddInkAnnotation(
    IList<IList<PdfPoint>> inks
)

VB.NET

Public Function AddInkAnnotation(
    inks As IList(Of IList(Of PdfPoint))
) As PdfInkAnnotationFacade

Parameters

Name	Type	Description
inks	IList<IList<PdfPoint>>	A list of points used create an annotation.

Returns

Type	Description
PdfInkAnnotationFacade	An object that contains ink annotation properties.

Example

The code sample below creates an ink annotation:

C#

using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
{
  // Load a document
  processor.LoadDocument("..\\..\\Document.pdf");

  // Access page properties
  PdfPageFacade pageFacade = processor.DocumentFacade.Pages[0];

  // Define ink vertices
  PdfPoint point1 = new PdfPoint(100, 100);
  PdfPoint point2 = new PdfPoint(110, 110);
  PdfPoint point3 = new PdfPoint(120, 100);
  PdfPoint point4 = new PdfPoint(130, 110);
  PdfPoint point5 = new PdfPoint(140, 100);
  PdfPoint point6 = new PdfPoint(150, 150);
  PdfPoint[] points = new PdfPoint[]
  {
      point1,
      point2,
      point3,
      point4,
      point5,
      point6
  };

  List<IList<PdfPoint>> inks = new List<IList<PdfPoint>> { points };

  // Create an ink annotation
  PdfInkAnnotationFacade inkAnnotation = pageFacade.AddInkAnnotation(inks);
  inkAnnotation.Author = "Brian Zetc";
  inkAnnotation.BorderWidth = 1.0;

  // Save the result
  processor.SaveDocument("..\\..\\Result.pdf");
}

VB.NET

Using processor As New PdfDocumentProcessor()
  ' Load a document
  processor.LoadDocument("..\..\Document.pdf")

  ' Access page properties
  Dim pageFacade As PdfPageFacade = processor.DocumentFacade.Pages(0)

  ' Define ink vertices
  Dim point1 As New PdfPoint(100, 100)
  Dim point2 As New PdfPoint(110, 110)
  Dim point3 As New PdfPoint(120, 100)
  Dim point4 As New PdfPoint(130, 110)
  Dim point5 As New PdfPoint(140, 100)
  Dim point6 As New PdfPoint(150, 150)
  Dim points() As PdfPoint = { point1, point2, point3, point4, point5, point6 }

  Dim inks As New List(Of IList(Of PdfPoint))() From {points}

  ' Create an ink annotation
  Dim inkAnnotation As PdfInkAnnotationFacade = pageFacade.AddInkAnnotation(inks)
  inkAnnotation.Author = "Brian Zetc"
  inkAnnotation.BorderWidth = 1.0

  ' Save the result
  processor.SaveDocument("..\..\Result.pdf")
End Using