PdfTextAnnotation Class

Represents a text annotation

Inheritance Hierarchy

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

Namespace: Patagames.Pdf.Net.Annotations
Assembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.111.2704

Syntax

C++

JavaScript

Copy

public class PdfTextAnnotation : PdfMarkupAnnotation

Public Class PdfTextAnnotation
	Inherits PdfMarkupAnnotation

public ref class PdfTextAnnotation : public PdfMarkupAnnotation

type PdfTextAnnotation = 
    class
        inherit PdfMarkupAnnotation
    end

public class PdfTextAnnotation extends PdfMarkupAnnotation

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

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

The PdfTextAnnotation type exposes the following members.

Constructors

	Name	Description
	PdfTextAnnotation(PdfPage)	Creates a new PdfTextAnnotation.
	PdfTextAnnotation(PdfPage, PdfTypeBase)	Initializes a new instance of the PdfTextAnnotation class based on the specified dictionary.
	PdfTextAnnotation(PdfPage, IconNames, String, String, Single, Single)	Creates a new PdfTextAnnotation.
	PdfTextAnnotation(PdfPage, IconNames, FS_COLOR, String, String, Single, Single)	Creates a new PdfTextAnnotation with specified parameters.

Top

Properties

	Name	Description
	ExtendedIconName	The name of an icon to be used in displaying the annotation.
	IsOpen	Gets or sets a flag specifying whether the annotation should initially be displayed open.
	StandardIconName	The name of an icon to be used in displaying the annotation.
	State	Gets orsets the state to which the original annotation should be set;
	StateModel	Gets orsets the state model corresponding to State;

Top

Methods

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

Top

Remarks

A text annotation represents a “sticky note” attached to a point in the PDF document. When closed, the annotation appears as an icon; when open, it displays a pop-up window containing the text of the note in a font and size chosen by the viewer application. Text annotations do not scale and rotate with the page; they behave as if the NoZoom and NoRotate annotation flags (see AnnotationFlags) were always set.

Reference

Patagames.Pdf.Net.Annotations Namespace