Class

PDFLine

Description

An indicator line that can appear on a page.

Properties

Name	Type	Read-Only	Shared
BorderStyle	PDFAnnotation.BorderStyles
DashPattern()	Double
DrawingColor	Color
EndPoint	Double
EndPointStyleStyle	PDFAnnotation.LineEndingStyles
FontSize	Double
LeaderLineExtension	Double
LeaderLineHeight	Double
LineWidth	Double
OffsetX	Double
StartPoint	Point
StartPointStyle	PDFAnnotation.LineEndingStyles
Text	String
TextPosition	PDFLine.TextPositions

Methods

Name	Parameters	Returns	Shared
Constructor	text As String, startPoint As Point, endPoint As Point = Nil

Enumerations

PDFLine.TextPositions

TextPositions

The positions at which the text can be displayed relative to the line.

Name
Inline
Top

Property descriptions

PDFLine.BorderStyle

BorderStyle As PDFAnnotation.BorderStyles

Determines the line style of the border.

PDFLine.DashPattern

DashPattern() As Double

Determines the spacing between lines used when drawing the border.

PDFLine.DrawingColor

DrawingColor As Color

The color that will be used to draw the line.

PDFLine.EndPoint

EndPoint As Point

The location of one end of the line.

PDFLine.EndPointStyle

EndPointStyle As PDFAnnotation.LineEndingStyles

The way in which the end point is drawn.

PDFLine.FontSize

FontSize As Double

The size of the text assigned via the Text property.

PDFLine.LeaderLineExtension

LeaderLineExtension As Double

The length of the leader lines.

PDFLine.LeaderLineHeight

LeaderLineHeight As Double

The height of the leader lines.

PDFLine.LineWidth

LineWidth As Double

The width (in points) of the line.

PDFLine.OffsetX

OffsetX As Double

The amount by which to offset the entire image (line, leader line and text) from the lesser of the X values of the StartPoint and EndPoint.

PDFLine.StartPoint

StartPoint As Point

The location of one end of the line.

PDFLine.StartPointStyle

StartPointStyle As PDFAnnotation.LineEndingStyles

The way in which the start point is drawn.

PDFLine.Text

Text As String

The text that appears as part of the line.

PDFLine.TextPosition

TextPosition As PDFLine.TextPositions

The location of the Text on the line.

Method descriptions

PDFLine.Constructor

Constructor(text As String, startPoint As Point, endPoint As Point = Nil)

Creates a new PDFLine from the parameters passed. If endPoint is not passed, the values are set to StartPoint.X + 100 and StartPoint.Y.

Sample Code

Var d As New PDFDocument

Var tLine As New PDFLine("This is a Line Annotation", New Point(40, 200), New Point(200, 220))
tLine.DrawingColor = Color.Red
tline.LeaderLineSize = 10.0
tline.EndPointStyle = PDFAnnotation.LineEndingStyles.Circle
tLine.TextPosition = PDFLine.TextPositions.Inline

d.AddLine(tLine)

Compatibility

Desktop, console, web and iOS project types on all supported operating systems.