Class

# PDFLine

<div class="rst-class">

forsearch

</div>

PDF

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

## Description

An indicator line that can appear on a page.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                               | Type                                                             | Read-Only | Shared |
|----------------------------------------------------|------------------------------------------------------------------|-----------|--------|
| `BorderStyle<pdfline.borderstyle>`                 | `PDFAnnotation.BorderStyles<pdfannotation.borderstyles>`         |           |        |
| `DashPattern()<pdfline.dashpattern>`               | `Double</api/data_types/double>`                                 |           |        |
| `DrawingColor<pdfline.drawingcolor>`               | `Color</api/data_types/color>`                                   |           |        |
| `EndPoint<pdfline.endpoint>`                       | `Point</api/graphics/point>`                                     |           |        |
| `EndPointStyleStyle<pdfline.endpointstyle>`        | `PDFAnnotation.LineEndingStyles<pdfannotation.lineendingstyles>` |           |        |
| `FontSize<pdfline.fontsize>`                       | `Double</api/data_types/double>`                                 |           |        |
| `LeaderLineExtension<pdfline.leaderlineextension>` | `Double</api/data_types/double>`                                 |           |        |
| `LeaderLineHeight<pdfline.leaderlineheight>`       | `Double</api/data_types/double>`                                 |           |        |
| `LineWidth<pdfline.linewidth>`                     | `Double</api/data_types/double>`                                 |           |        |
| `OffsetX<pdfline.offsetx>`                         | `Double</api/data_types/double>`                                 |           |        |
| `StartPoint<pdfline.startpoint>`                   | `Point</api/graphics/point>`                                     |           |        |
| `StartPointStyle<pdfline.startpointstyle>`         | `PDFAnnotation.LineEndingStyles<pdfannotation.lineendingstyles>` |           |        |
| `Text<pdfline.text>`                               | `String</api/data_types/string>`                                 |           |        |
| `TextPosition<pdfline.textposition>`               | `PDFLine.TextPositions<pdfline.textpositions>`                   |           |        |

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                               | Parameters                                                                                                                     | Returns | Shared |
|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|---------|--------|
| `Constructor<pdfline.constructor>` | text As `String</api/data_types/string>`, startPoint As `Point</api/graphics/point>`, endPoint As `Point</api/graphics/point>` |         |        |

## Enumerations

<div id="pdfline.textpositions">

<div class="rst-class">

forsearch

</div>

</div>

PDFLine.TextPositions

### TextPositions

> The positions at which the text can be displayed relative to the line.
>
> | Name   |
> |--------|
> | Inline |
> | Top    |

## Property descriptions

<div id="pdfline.borderstyle">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.BorderStyle

**BorderStyle** As `PDFAnnotation.BorderStyles<pdfannotation.borderstyles>`

> Determines the line style of the border.

<div id="pdfline.dashpattern">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.DashPattern

**DashPattern()** As `Double</api/data_types/double>`

> Determines the spacing between lines used when drawing the border.

<div id="pdfline.drawingcolor">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.DrawingColor

**DrawingColor** As `Color</api/data_types/color>`

> The color that will be used to draw the line.

<div id="pdfline.endpoint">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.EndPoint

**EndPoint** As `Point</api/graphics/point>`

> The location of one end of the line.

<div id="pdfline.endpointstyle">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.EndPointStyle

**EndPointStyle** As `PDFAnnotation.LineEndingStyles<pdfannotation.lineendingstyles>`

> The way in which the end point is drawn.

<div id="pdfline.fontsize">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.FontSize

**FontSize** As `Double</api/data_types/double>`

> The size of the text assigned via the `Text<pdfline.text>` property.

<div id="pdfline.leaderlineextension">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.LeaderLineExtension

**LeaderLineExtension** As `Double</api/data_types/double>`

> The length of the leader lines.

<div id="pdfline.leaderlineHeight">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.LeaderLineHeight

**LeaderLineHeight** As `Double</api/data_types/double>`

> The height of the leader lines.

<div id="pdfline.linewidth">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.LineWidth

**LineWidth** As `Double</api/data_types/double>`

> The width (in points) of the line.

<div id="pdfline.offsetx">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.OffsetX

**OffsetX** As `Double</api/data_types/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<pdfline.startpoint>` and `EndPoint<pdfline.endpoint>`.

<div id="pdfline.startpoint">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.StartPoint

**StartPoint** As `Point</api/graphics/point>`

> The location of one end of the line.

<div id="pdfline.startpointstyle">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.StartPointStyle

**StartPointStyle** As `PDFAnnotation.LineEndingStyles<pdfannotation.lineendingstyles>`

> The way in which the start point is drawn.

<div id="pdfline.text">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.Text

**Text** As `String</api/data_types/string>`

> The text that appears as part of the line.

<div id="pdfline.textposition">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.TextPosition

**TextPosition** As `PDFLine.TextPositions<pdfline.textpositions>`

> The location of the `Text<pdfline.text>` on the line.

## Method descriptions

<div id="pdfline.constructor">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

PDFLine.Constructor

**Constructor**(text As `String</api/data_types/string>`, startPoint As `Point</api/graphics/point>`, endPoint As `Point</api/graphics/point>`)

> Creates a new <span class="title-ref">PDFLine</span> from the parameters passed.

## Sample Code

``` xojo
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.LeaderLineHeight = 10.0
tline.EndPointStyle = PDFAnnotation.LineEndingStyles.Circle
tLine.TextPosition = PDFLine.TextPositions.Inline

d.AddLine(tLine)
```

## Compatibility

|                       |     |
|-----------------------|-----|
| **Project Types**     | All |
| **Operating Systems** | All |

<div class="seealso">

`PDFAnnotation</api/pdf/pdfannotation>` parent class; `PDFCallout</api/pdf/pdfcallout>` and `PDFShape</api/pdf/pdfshape>` classes

</div>