Class

PDFCallout

Description

A type of 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.

Note

While Acrobat Reader supports all PDF annotations, other readers may not.

Properties

Name	Type	Read-Only	Shared
BorderEffect	PDFAnnotation.BorderEffectTypes
BorderStyle	PDFAnnotation.BorderStyles
DashPattern()	Double
DrawingColor	Color
EndPoint	Point
FontSize	Double
LineEndingStyle	PDFAnnotation.LineEndingStyles
LineWidth	Double
MiddlePoint	Point
StartPoint	Point
Text	String
TextBoxHeight	Double
TextBoxWidth	Double

Methods

Name	Parameters	Returns	Shared
Constructor	value As String, startPoint As Point, middlePoint As Point, endPoint As Point, rectangleWidth As Double, rectangleHeight As Double

Property descriptions

PDFCallout.BorderEffect

BorderEffect As PDFAnnotation.BorderEffectTypes

Determines how the border of the callout will be drawn.

PDFCallout.BorderStyle

BorderStyle As PDFAnnotation.BorderStyles

Determines the line style of the border.

PDFCallout.DashPattern

DashPattern() As Double

Determines the spacing between lines used when drawing the border.

PDFCallout.DrawingColor

DrawingColor As Color

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

PDFCallout.EndPoint

EndPoint As 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.

PDFCallout.FontSize

FontSize As Double

The size of the text assigned via the Text property.

PDFCallout.LineEndingStyle

LineEndingStyle As 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.

PDFCallout.LineWidth

LineWidth As Double

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

PDFCallout.MiddlePoint

MiddlePoint As Point

The point at which the indicator line may bend to allow it to both start at the StartPoint and end at the EndPoint.

PDFCallout.StartPoint

StartPoint As Point

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

PDFCallout.Text

Text As String

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

PDFCallout.TextBoxHeight

TextBoxHeight As Double

The height of the text box.

PDFCallout.TextBoxWidth

TextBoxWidth As Double

The width of the text box.

Method descriptions

PDFCallout.Constructor

Constructor(value As String, startPoint As Point, middlePoint As Point, endPoint As Point, rectangleWidth As Double, rectangleHeight As Double)

Creates the callout from the parameters passed.

Sample Code

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

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