'Declaration
 
Public Function AddLineAnnotation( _
   ByVal StartX As Single, _
   ByVal StartY As Single, _
   ByVal DstX As Single, _
   ByVal DstY As Single, _
   ByVal Title As String, _
   ByVal Contents As String, _
   ByVal StartCap As PdfAnnotationLineEndingStyle, _
   ByVal EndCap As PdfAnnotationLineEndingStyle, _
   ByVal ShowContent As Boolean, _
   ByVal LineWidth As Single, _
   ByVal LineStyle As PdfAnnotationBorderStyle, _
   ByVal LineDashOn As Single, _
   ByVal LineDashOff As Single, _
   ByVal Opacity As Single, _
   ByVal Red As Byte, _
   ByVal Green As Byte, _
   ByVal Blue As Byte _
) As Integer

public int AddLineAnnotation( 
   float StartX,
   float StartY,
   float DstX,
   float DstY,
   string Title,
   string Contents,
   PdfAnnotationLineEndingStyle StartCap,
   PdfAnnotationLineEndingStyle EndCap,
   bool ShowContent,
   float LineWidth,
   PdfAnnotationBorderStyle LineStyle,
   float LineDashOn,
   float LineDashOff,
   float Opacity,
   byte Red,
   byte Green,
   byte Blue
)

public function AddLineAnnotation( 
    StartX: Single;
    StartY: Single;
    DstX: Single;
    DstY: Single;
    Title: String;
    Contents: String;
    StartCap: PdfAnnotationLineEndingStyle;
    EndCap: PdfAnnotationLineEndingStyle;
    ShowContent: Boolean;
    LineWidth: Single;
    LineStyle: PdfAnnotationBorderStyle;
    LineDashOn: Single;
    LineDashOff: Single;
    Opacity: Single;
    Red: Byte;
    Green: Byte;
    Blue: Byte
): Integer; 

public function AddLineAnnotation( 
   StartX : float,
   StartY : float,
   DstX : float,
   DstY : float,
   Title : String,
   Contents : String,
   StartCap : PdfAnnotationLineEndingStyle,
   EndCap : PdfAnnotationLineEndingStyle,
   ShowContent : boolean,
   LineWidth : float,
   LineStyle : PdfAnnotationBorderStyle,
   LineDashOn : float,
   LineDashOff : float,
   Opacity : float,
   Red : byte,
   Green : byte,
   Blue : byte
) : int;

public: int AddLineAnnotation( 
   float StartX,
   float StartY,
   float DstX,
   float DstY,
   string* Title,
   string* Contents,
   PdfAnnotationLineEndingStyle StartCap,
   PdfAnnotationLineEndingStyle EndCap,
   bool ShowContent,
   float LineWidth,
   PdfAnnotationBorderStyle LineStyle,
   float LineDashOn,
   float LineDashOff,
   float Opacity,
   byte Red,
   byte Green,
   byte Blue
) 

public:
int AddLineAnnotation( 
   float StartX,
   float StartY,
   float DstX,
   float DstY,
   String^ Title,
   String^ Contents,
   PdfAnnotationLineEndingStyle StartCap,
   PdfAnnotationLineEndingStyle EndCap,
   bool ShowContent,
   float LineWidth,
   PdfAnnotationBorderStyle LineStyle,
   float LineDashOn,
   float LineDashOff,
   float Opacity,
   byte Red,
   byte Green,
   byte Blue
) 

Parameters

StartX

The horizontal (X) coordinate of the starting point of the line to be drawn. The value of this coordinate is expressed in the currently set units according to the currently used coordinate space, see the Remarks section below.

StartY

The vertical (Y) coordinate of the starting point of the line to be drawn. The value of this coordinate is expressed in the currently set units according to the currently used coordinate space, see the Remarks section below.

DstX

The horizontal (X) coordinate of the ending point of the line to be drawn. The value of this coordinate is expressed in the currently set units according to the currently used coordinate space, see the Remarks section below.

DstY

The vertical (Y) coordinate of the ending point of the line to be drawn. The value of this coordinate is expressed in the currently set units according to the currently used coordinate space, see the Remarks section below.

Title

The title of the newly added annotation object, by convention it represents the author of the annotation.

Contents

The content of the newly added annotation object, that means the text displayed in the annotation's note and in its associated pop-up window.

StartCap

A member of the PdfAnnotationLineEndingStyle enumeration. It is the line ending style used for the starting point when drawing a line.

EndCap

A member of the PdfAnnotationLineEndingStyle enumeration. It is the line ending style used for the ending point when drawing a line.

ShowContent

Set this parameter to true, if you want to display the text specified by the Contents parameter as a caption in the appearance of the line, otherwise set it to false. The text should be rendered in a manner appropriate to the content, taking into account factors such as writing direction. The initial value is false.

LineWidth

The width of the line used to draw the line annotation, expressed in the current units specified by the SetMeasurementUnit method.

LineStyle

A member of the PdfAnnotationBorderStyle enumeration. The style of the line used to draw the line annotation.

LineDashOn

If the style of the line (the LineStyle parameter) is dashed, this value defines the width of the dashes in the dash pattern used to draw the line. Otherwise, this parameter is ignored. The value is expressed in the current units specified by the SetMeasurementUnit method.

LineDashOff

If the style of the line (the LineStyle parameter) is dashed, this value defines the width of the gaps in the dash pattern used to draw the line. Otherwise, this parameter is ignored. The value is expressed in the current units specified by the SetMeasurementUnit method.

Opacity

The opacity value of the newly added annotation object, from 0 (full transparency) to 1 (full opacity).

Red

The amount of red color to be used for the resulting color of the drawn line. Use the value between 0 and 255.

Green

The amount of green color to be used for the resulting color of the drawn line. Use the value between 0 and 255.

Blue

The amount of blue color to be used for the resulting color of the drawn line. Use the value between 0 and 255.

Return Value

It is recommend to use the GdPicturePDF.GetStat method to identify the specific reason for the method's failure, if any.

Please always ensure that you have selected the correct page using the GdPicturePDF.SelectPage method before adding a required annotation. Likewise, just to inform you, that the toolkit doesn't create (unlike other applications can) a standalone associated pop-up annotation object within the internal document structure when creating the new line annotation.

You also need to be aware that the values of coordinates and dimensions are expressed in the current units defined by the GdPicturePDF.SetMeasurementUnit method according to the current coordinate space defined by the GdPicturePDF.SetOrigin method.

Reference

GdPicturePDF Class
GdPicturePDF Members
GetStat Method
SelectPage Method
SetMeasurementUnit Method
SetOrigin Method
GetAnnotationCount Method
GetStat Method
SelectPage Method
GetAnnotationCount Method
GetAnnotationType Method
GetAnnotationSubType Method
AddCircleAnnotation Method
AddSquareAnnotation Method