PdfFreeTextAnnotation Class

Represents a free text annotation

Inheritance Hierarchy

SystemObject
  Patagames.Pdf.Net.WrappersPdfWrapper
    Patagames.Pdf.Net.AnnotationsPdfAnnotation
      Patagames.Pdf.Net.AnnotationsPdfMarkupAnnotation
        Patagames.Pdf.Net.AnnotationsPdfFreeTextAnnotation

Namespace: Patagames.Pdf.Net.Annotations
Assemblies: Patagames.Pdf.Xamarin.iOS (in Patagames.Pdf.Xamarin.iOS.dll) Version: 4.55.2704
Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.55.2704

Syntax

C++

JavaScript

Copy

public class PdfFreeTextAnnotation : PdfMarkupAnnotation

Public Class PdfFreeTextAnnotation
	Inherits PdfMarkupAnnotation

public ref class PdfFreeTextAnnotation : public PdfMarkupAnnotation

type PdfFreeTextAnnotation =  
    class
        inherit PdfMarkupAnnotation
    end

public class PdfFreeTextAnnotation extends PdfMarkupAnnotation

Patagames.Pdf.Net.Annotations.PdfFreeTextAnnotation = function();

Type.createClass(
	'Patagames.Pdf.Net.Annotations.PdfFreeTextAnnotation',
	Patagames.Pdf.Net.Annotations.PdfMarkupAnnotation);

The PdfFreeTextAnnotation type exposes the following members.

Constructors

	Name	Description
	PdfFreeTextAnnotation(PdfPage)	Creates a new PdfFreeTextAnnotation.
	PdfFreeTextAnnotation(PdfPage, PdfTypeBase)	Initializes a new instance of the PdfFreeTextAnnotation class based on the specified dictionary.
	PdfFreeTextAnnotation(PdfPage, PdfTextObject, Single, Single, Single, Single)	Create a new PdfFreeTextAnnotation with PdfTextObject and parameters as specified.

Top

Properties

	Name	Description
	BorderEffect	Gets or sets a border effect (PdfBorderEffect) used in conjunction with the BorderStyle.
	BorderStyle	Gets or sets a border style (see PdfBorderStyle) specifying the line width and dash pattern to be used in drawing the annotation’s border.
	CalloutLine	Gets or sets a collection of the FS_POINTF that represent callout line attached to the free text annotation.
	DefaultAppearance	Gets or sets the default appearance string to be used in formatting the text.
	DefaultStyle	Gets or sets a default style string.
	InnerRectangle	Gets or sets a four numbers describing the inner rectangle of the annotation.
	Intent	Gets or sets a name describing the intent of the free text annotation.
	LineEnding	Gets or sets a list of line ending styles to be used in drawing the CalloutLine.
	TextAlignment	Gets or sets the horizontal alignment of text content.

Top

Methods

	Name	Description
	RegenerateAppearances	Re-creates the appearance of the annotation based on its properties (Overrides PdfMarkupAnnotationRegenerateAppearances.)

Top

Remarks

A free text annotation (PDF 1.3) displays text directly on the page. Unlike an ordinary text annotation (see PdfTextAnnotation), a free text annotation has no open or closed state; instead of being displayed in a pop-up window, the text is always visible.

Reference

Patagames.Pdf.Net.Annotations Namespace