Table of Contents

Class PdfTextAnnotation

Namespace
iText.Kernel.Pdf.Annot
Assembly
itext.kernel.dll
public class PdfTextAnnotation : PdfMarkupAnnotation
Inheritance
PdfTextAnnotation
Inherited Members

Constructors

PdfTextAnnotation(Rectangle) 

public PdfTextAnnotation(Rectangle rect)

Parameters

rect Rectangle

PdfTextAnnotation(PdfDictionary)

Instantiates a new PdfTextAnnotation instance based on PdfDictionary instance, that represents existing annotation object in the document.

protected PdfTextAnnotation(PdfDictionary pdfObject)

Parameters

pdfObject PdfDictionary

the PdfDictionary representing annotation object

See Also

Methods

GetIconName()

The name of an icon that is used in displaying the annotation.

public virtual PdfName GetIconName()

Returns

PdfName

a PdfName that specifies the icon for displaying annotation, or null if icon name is not specified.

Remarks

The name of an icon that is used in displaying the annotation. Possible values are described in SetIconName(PdfName).

GetOpen()

A flag specifying whether the annotation shall initially be displayed open.

public virtual bool GetOpen()

Returns

bool

true if annotation is initially open, false - if closed.

Remarks

A flag specifying whether the annotation shall initially be displayed open. This flag has affect to not all kinds of annotations.

GetState() 

public virtual PdfString GetState()

Returns

PdfString

GetStateModel() 

public virtual PdfString GetStateModel()

Returns

PdfString

GetSubtype() 

public override PdfName GetSubtype()

Returns

PdfName

SetIconName(PdfName)

The name of an icon that is used in displaying the annotation.

public virtual PdfTextAnnotation SetIconName(PdfName name)

Parameters

name PdfName

a PdfName that specifies the icon for displaying annotation. Possible values are:

  • Comment
  • Key
  • Note
  • Help
  • NewParagraph
  • Paragraph
  • Insert

Returns

PdfTextAnnotation

this PdfTextAnnotation instance.

SetOpen(bool)

Sets a flag specifying whether the annotation shall initially be displayed open.

public virtual PdfTextAnnotation SetOpen(bool open)

Parameters

open bool

true if annotation shall initially be open, false - if closed.

Returns

PdfTextAnnotation

this PdfTextAnnotation instance.

Remarks

Sets a flag specifying whether the annotation shall initially be displayed open. This flag has affect to not all kinds of annotations.

SetState(PdfString) 

public virtual PdfTextAnnotation SetState(PdfString state)

Parameters

state PdfString

Returns

PdfTextAnnotation

SetStateModel(PdfString) 

public virtual PdfTextAnnotation SetStateModel(PdfString stateModel)

Parameters

stateModel PdfString

Returns

PdfTextAnnotation