[]
        
(Showing Draft Content)

GrapeCity.Documents.Pdf.Annotations.FreeTextAnnotation

Class FreeTextAnnotation

Namespace
GrapeCity.Documents.Pdf.Annotations
Assembly
GcDocs.Pdf.dll

Represents a free text annotation that displays text directly on a page. Unlike an ordinary text annotation (see TextAnnotation), a free text annotation has no open or closed state. Instead of being displayed in a pop-up window, the text is always visible.

public class FreeTextAnnotation : MarkupAnnotation, IOwnedObject, IContentItem, IPdfDict
Inheritance
object
FreeTextAnnotation
Implements
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Extension Methods

Constructors

FreeTextAnnotation()

Initializes a new instance of the FreeTextAnnotation class.

public FreeTextAnnotation()

Properties

CalloutLine

Gets or sets an array of 2 or 3 System.Drawing.PointF structures specifying a callout line attached to the free text annotation. 3 points represent the starting coordinates, the knee point, and the ending coordinates of the line. 2 points represent the starting and ending coordinates of the line. The coordinates are in default user space relative to the upper left corner of the page's media box, with the Y (vertical) coordinates increasing from top to bottom.

public IReadOnlyList<PointF> CalloutLine { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<T><System.Drawing.PointF>

Color

Gets or sets the annotation color.

public Color Color { get; set; }

Property Value

System.Drawing.Color

DefaultAppearance

Gets the DefaultAppearance object that specifies the visual properties (font, font size etc.) used to format the content of the annotation.

public DefaultAppearance DefaultAppearance { get; }

Property Value

DefaultAppearance

Justification

Gets or sets the justification to be used in displaying the annotation’s text. See PDF specification for details.

public VariableTextJustification Justification { get; set; }

Property Value

VariableTextJustification

LineDashPattern

Gets or sets the line dash pattern. Null means a solid line.

public float[] LineDashPattern { get; set; }

Property Value

float[]

LineEndStyle

Gets or sets the style of end callout line.

public LineEndingStyle LineEndStyle { get; set; }

Property Value

LineEndingStyle

LineWidth

Gets or sets the line width in points.

public float LineWidth { get; set; }

Property Value

float

Opacity

public float Opacity { get; set; }

Property Value

float

PdfCalloutLine

Gets or sets an array of 2 or 3 System.Drawing.PointF structures specifying a callout line attached to the free text annotation. 3 points represent the starting coordinates, the knee point, and the ending coordinates of the line. 2 points represent the starting and ending coordinates of the line. The coordinates are specified in PDF user space. The positive X axis extends horizontally to the right, and the positive Y axis extends vertically upward, with the origin usually in the lower left corner of the page.

public IReadOnlyList<PointF> PdfCalloutLine { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<T><System.Drawing.PointF>

StyleString

Gets or sets the default style string. See PDF specification for details.

public string StyleString { get; set; }

Property Value

string

TextOffsets

Gets or sets the Offsets structure that defines the numerical differences between two rectangles: the Rect and an inner rectangle contained within that rectangle. The inner rectangle is where the FreeTextAnnotation’s text should be displayed.

Note that if this rectangle is not specified then Rect is used as the text rectangle.

public Offsets? TextOffsets { get; set; }

Property Value

Offsets?