Class

# PDFCallout

<div class="rst-class">

forsearch

</div>

PDF

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

## Description

A type of `PDFAnnotation</api/pdf/pdfannotation>` that displays a text box with an indicator line pointing to location on the page. The indicator line starts at the point on the page being called out and ends at the text box.

<div class="note">

<div class="title">

Note

</div>

While [Acrobat Reader](https://get.adobe.com/reader/) supports all PDF annotations, other readers may not.

</div>

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                          | Type                                                               | Read-Only | Shared |
|-----------------------------------------------|--------------------------------------------------------------------|-----------|--------|
| `BorderEffect<pdfcallout.bordereffect>`       | `PDFAnnotation.BorderEffectTypes<pdfannotation.bordereffecttypes>` |           |        |
| `BorderStyle<pdfcallout.borderstyle>`         | `PDFAnnotation.BorderStyles<pdfannotation.borderstyles>`           |           |        |
| `DashPattern()<pdfcallout.dashpattern>`       | `Double</api/data_types/double>`                                   |           |        |
| `DrawingColor<pdfcallout.drawingcolor>`       | `Color</api/data_types/color>`                                     |           |        |
| `EndPoint<pdfcallout.endpoint>`               | `Point</api/graphics/point>`                                       |           |        |
| `FontSize<pdfcallout.fontsize>`               | `Double</api/data_types/double>`                                   |           |        |
| `LineEndingStyle<pdfcallout.lineendingstyle>` | `PDFAnnotation.LineEndingStyles<pdfannotation.lineendingstyles>`   |           |        |
| `LineWidth<pdfcallout.linewidth>`             | `Double</api/data_types/double>`                                   |           |        |
| `MiddlePoint<pdfcallout.middlepoint>`         | `Point</api/graphics/point>`                                       |           |        |
| `StartPoint<pdfcallout.startpoint>`           | `Point</api/graphics/point>`                                       |           |        |
| `Text<pdfcallout.text>`                       | `String</api/data_types/string>`                                   |           |        |
| `TextBoxHeight<pdfcallout.textboxheight>`     | `Double</api/data_types/double>`                                   |           |        |
| `TextBoxWidth<pdfcallout.textboxwidth>`       | `Double</api/data_types/double>`                                   |           |        |

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                                  | Parameters                                                                                                                                                                                                                                                                            | Returns | Shared |
|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|--------|
| `Constructor<pdfcallout.constructor>` | value As `String</api/data_types/string>`, startPoint As `Point</api/graphics/point>`, middlePoint As `Point</api/graphics/point>`, endPoint As `Point</api/graphics/point>`, rectangleWidth As `Double</api/data_types/double>`, rectangleHeight As `Double</api/data_types/double>` |         |        |

## Property descriptions

<div id="pdfcallout.bordereffect">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFCallout.BorderEffect

**BorderEffect** As `PDFAnnotation.BorderEffectTypes<pdfannotation.bordereffecttypes>`

> Determines how the border of the callout will be drawn.

<div id="pdfcallout.borderstyle">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFCallout.BorderStyle

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

> Determines the line style of the border.

<div id="pdfcallout.dashpattern">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFCallout.DashPattern

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

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

<div id="pdfcallout.drawingcolor">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFCallout.DrawingColor

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

> The color that will be used to draw the background of the callout.

<div id="pdfcallout.endpoint">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFCallout.EndPoint

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

> The point where the indicator line connects to the text box. It is always in the middle of the left side of the text box. Thus this also controls where the text box appears.

<div id="pdfcallout.fontsize">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFCallout.FontSize

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

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

<div id="pdfcallout.lineendingstyle">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFCallout.LineEndingStyle

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

> Determines what will be drawn at the end of the indicator line that typically points to part of the page being called out.

<div id="pdfcallout.linewidth">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFCallout.LineWidth

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

> The width of the lines in the callout including the indicator line and the border of the text box.

<div id="pdfcallout.middlepoint">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFCallout.MiddlePoint

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

> The point at which the indicator line may bend to allow it to both start at the `StartPoint<pdfcallout.startpoint>` and end at the `EndPoint<pdfcallout.endpoint>`.

<div id="pdfcallout.startpoint">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFCallout.StartPoint

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

> The point on the page near the item being called out.

<div id="pdfcallout.text">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFCallout.Text

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

> The text that appears in the text box of the callout.

<div id="pdfcallout.textboxheight">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFCallout.TextBoxHeight

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

> The height of the text box.

<div id="pdfcallout.textboxwidth">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFCallout.TextBoxWidth

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

> The width of the text box.

## Method descriptions

<div id="pdfcallout.constructor">

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

</div>

<div class="rst-class">

forsearch

</div>

PDFCallout.Constructor

**Constructor**(value As `String</api/data_types/string>`, startPoint As `Point</api/graphics/point>`, middlePoint As `Point</api/graphics/point>`, endPoint As `Point</api/graphics/point>`, rectangleWidth As `Double</api/data_types/double>`, rectangleHeight As `Double</api/data_types/double>`)

> Creates the callout from the parameters passed.

## Sample Code

``` xojo
Var d As New PDFDocument

Var tCallOut As New PDFCallout("Callout", New Point(20, 70), New Point(120, 200), New Point(160, 200), 300, 200)
tCallOut.LineWidth = 1
tCallOut.DrawingColor = &cBBFFFF00
tCallOut.Text = "This is a text in a Callout Annotation."
tCallOut.LineEndingStyle = PDFAnnotation.LineEndingStyles.OpenArrow
tCallOut.DashPattern = Array(2.0, 2.0)
tCallOut.FontSize = 9.5

d.AddCallout(tCallOut)
```

## Compatibility

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

<div class="seealso">

`PDFAnnotation</api/pdf/pdfannotation>` parent class; `PDFLine</api/pdf/pdfline>` and `PDFShape</api/pdf/pdfshape>` classes

</div>