THPDFPage.AddLineAnnotation

THPDFPage

Adds new Line annotation on the current page.

Delphi syntax:

procedure AddLineAnnotation ( Contents: AnsiString; BeginPoint: THPDFCurrPoint; EndPoint: THPDFCurrPoint; Color: TColor = clRed );

TPDFCurrPoint defines a point.

Unit
HPDFDoc

type
    THPDFCurrPoint = record
        X: Extended;
        Y: Extended;
end;

Description:
The THPDFCurrPoint type defines a pixel location. X specifies the horizontal coordinate of the point, Y specifies the vertical coordinate.

C++ syntax:

void __fastcall AddLineAnnotation ( AnsiString Contents, THPDFCurrPoint &BeginPoint, THPDFCurrPoint &EndPoint, Graphics::TColor Color );

Description

Use AddLineAnnotation to add new Line annotation specified text message ( Contents), begin point, end point and color on the current page.

Overload with line-ending styles (HotPDF v2.119.16)

procedure AddLineAnnotation ( Contents: AnsiString; BeginPoint, EndPoint: THPDFCurrPoint; BeginStyle, EndStyle: THPDFLineEndingStyle; Color: TColor = clRed );

This overload emits the PDF /LE [/<begin> /<end>] line-ending array per ISO 32000-1 §12.5.6.7 Table 175 + Table 176. The viewer then renders the supplied endpoint marks (arrows, ticks, shapes) without the caller having to draw them on the page. THPDFLineEndingStyle covers the full Table 176 set:

   lesNone — no endpoint marker (PDF spec default)
   lesSquare — filled square
   lesCircle — filled circle
   lesDiamond — filled diamond
   lesOpenArrow — open arrowhead
   lesClosedArrow — triangular closed arrowhead
   lesButt — short perpendicular tick
   lesROpenArrow — reverse-direction open arrow
   lesRClosedArrow — reverse-direction closed arrow
   lesSlash — ~30° clockwise short tick

Example

PDF.CurrentPage.AddLineAnnotation('Width = 120mm',
  Point1, Point2, lesClosedArrow, lesClosedArrow, clBlue);