Class PdfMarkupAnnotation

Namespace

iText.Kernel.Pdf.Annot

Assembly

itext.kernel.dll

This is a super class for the annotations which are defined as markup annotations because they are used primarily to mark up PDF documents.

public abstract class PdfMarkupAnnotation : PdfAnnotation

Inheritance

object

PdfObjectWrapper<PdfDictionary>

PdfAnnotation

PdfMarkupAnnotation

Derived

PdfCaretAnnotation

PdfCircleAnnotation

PdfFileAttachmentAnnotation

PdfFreeTextAnnotation

PdfInkAnnotation

PdfLineAnnotation

PdfPolyGeomAnnotation

PdfRedactAnnotation

PdfSoundAnnotation

PdfSquareAnnotation

PdfStampAnnotation

PdfTextAnnotation

PdfTextMarkupAnnotation

Inherited Members

PdfAnnotation.INVISIBLE

PdfAnnotation.HIDDEN

PdfAnnotation.PRINT

PdfAnnotation.NO_ZOOM

PdfAnnotation.NO_ROTATE

PdfAnnotation.NO_VIEW

PdfAnnotation.READ_ONLY

PdfAnnotation.LOCKED

PdfAnnotation.TOGGLE_NO_VIEW

PdfAnnotation.LOCKED_CONTENTS

PdfAnnotation.HIGHLIGHT_NONE

PdfAnnotation.HIGHLIGHT_INVERT

PdfAnnotation.HIGHLIGHT_OUTLINE

PdfAnnotation.HIGHLIGHT_PUSH

PdfAnnotation.HIGHLIGHT_TOGGLE

PdfAnnotation.STYLE_SOLID

PdfAnnotation.STYLE_DASHED

PdfAnnotation.STYLE_BEVELED

PdfAnnotation.STYLE_INSET

PdfAnnotation.STYLE_UNDERLINE

PdfAnnotation.Marked

PdfAnnotation.Unmarked

PdfAnnotation.Accepted

PdfAnnotation.Rejected

PdfAnnotation.Canceled

PdfAnnotation.Completed

PdfAnnotation.None

PdfAnnotation.MarkedModel

PdfAnnotation.ReviewModel

PdfAnnotation.page

PdfAnnotation.MakeAnnotation(PdfObject)

PdfAnnotation.GetSubtype()

PdfAnnotation.SetLayer(IPdfOCG)

PdfAnnotation.GetContents()

PdfAnnotation.SetContents(PdfString)

PdfAnnotation.SetContents(string)

PdfAnnotation.GetPageObject()

PdfAnnotation.GetPage()

PdfAnnotation.SetPage(PdfPage)

PdfAnnotation.GetName()

PdfAnnotation.SetName(PdfString)

PdfAnnotation.GetDate()

PdfAnnotation.SetDate(PdfString)

PdfAnnotation.GetFlags()

PdfAnnotation.SetFlags(int)

PdfAnnotation.SetFlag(int)

PdfAnnotation.ResetFlag(int)

PdfAnnotation.HasFlag(int)

PdfAnnotation.GetAppearanceDictionary()

PdfAnnotation.GetAppearanceObject(PdfName)

PdfAnnotation.GetNormalAppearanceObject()

PdfAnnotation.GetRolloverAppearanceObject()

PdfAnnotation.GetDownAppearanceObject()

PdfAnnotation.SetAppearance(PdfName, PdfDictionary)

PdfAnnotation.SetNormalAppearance(PdfDictionary)

PdfAnnotation.SetRolloverAppearance(PdfDictionary)

PdfAnnotation.SetDownAppearance(PdfDictionary)

PdfAnnotation.SetAppearance(PdfName, PdfAnnotationAppearance)

PdfAnnotation.SetNormalAppearance(PdfAnnotationAppearance)

PdfAnnotation.SetRolloverAppearance(PdfAnnotationAppearance)

PdfAnnotation.SetDownAppearance(PdfAnnotationAppearance)

PdfAnnotation.GetAppearanceState()

PdfAnnotation.SetAppearanceState(PdfName)

PdfAnnotation.GetBorder()

PdfAnnotation.SetBorder(PdfAnnotationBorder)

PdfAnnotation.SetBorder(PdfArray)

PdfAnnotation.GetColorObject()

PdfAnnotation.SetColor(PdfArray)

PdfAnnotation.SetColor(float[])

PdfAnnotation.SetColor(Color)

PdfAnnotation.GetStructParentIndex()

PdfAnnotation.SetStructParentIndex(int)

PdfAnnotation.SetTitle(PdfString)

PdfAnnotation.GetTitle()

PdfAnnotation.SetRectangle(PdfArray)

PdfAnnotation.GetRectangle()

PdfAnnotation.GetLang()

PdfAnnotation.SetLang(string)

PdfAnnotation.GetBlendMode()

PdfAnnotation.SetBlendMode(PdfName)

PdfAnnotation.GetNonStrokingOpacity()

PdfAnnotation.SetNonStrokingOpacity(float)

PdfAnnotation.GetStrokingOpacity()

PdfAnnotation.SetStrokingOpacity(float)

PdfAnnotation.Put(PdfName, PdfObject)

PdfAnnotation.Remove(PdfName)

PdfAnnotation.AddAssociatedFile(PdfFileSpec)

PdfAnnotation.GetAssociatedFiles(bool)

PdfAnnotation.Flush()

PdfAnnotation.IsWrappedObjectMustBeIndirect()

PdfObjectWrapper<PdfDictionary>.GetPdfObject()

PdfObjectWrapper<PdfDictionary>.MakeIndirect(PdfDocument, PdfIndirectReference)

PdfObjectWrapper<PdfDictionary>.MakeIndirect(PdfDocument)

PdfObjectWrapper<PdfDictionary>.SetModified()

PdfObjectWrapper<PdfDictionary>.IsFlushed()

PdfObjectWrapper<PdfDictionary>.SetPdfObject(PdfDictionary)

PdfObjectWrapper<PdfDictionary>.SetForbidRelease()

PdfObjectWrapper<PdfDictionary>.UnsetForbidRelease()

PdfObjectWrapper<PdfDictionary>.EnsureUnderlyingObjectHasIndirectReference()

PdfObjectWrapper<PdfDictionary>.MarkObjectAsIndirect(PdfObject)

PdfObjectWrapper<PdfDictionary>.EnsureObjectIsAddedToDocument(PdfObject)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

This is a super class for the annotations which are defined as markup annotations because they are used primarily to mark up PDF documents. These annotations have text that appears as part of the annotation and may be displayed in other ways by a conforming reader, such as in a Comments pane. See also ISO-320001 12.5.6.2 "Markup Annotations".

Constructors

PdfMarkupAnnotation(Rectangle)

protected PdfMarkupAnnotation(Rectangle rect)

Parameters

rect Rectangle

PdfMarkupAnnotation(PdfDictionary)

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

protected PdfMarkupAnnotation(PdfDictionary pdfObject)

Parameters

pdfObject PdfDictionary

the PdfDictionary representing annotation object

See Also

MakeAnnotation(PdfObject)

Fields

inReplyTo

protected PdfAnnotation inReplyTo

Field Value

PdfAnnotation

popup

protected PdfPopupAnnotation popup

Field Value

PdfPopupAnnotation

Methods

GetCreationDate()

The date and time when the annotation was created.

public virtual PdfString GetCreationDate()

Returns

PdfString

a PdfString which value should be in the date format specified in (ISO-320001 7.9.4, "Dates").

GetExternalData()

An external data dictionary specifying data that shall be associated with the annotation.

public virtual PdfDictionary GetExternalData()

Returns

PdfDictionary

An external data PdfDictionary , or null if not specified.

Remarks

An external data dictionary specifying data that shall be associated with the annotation. This dictionary contains the following entries:

• Type - (optional) If present, shall be ExData.
• Subtype - (required) a name specifying the type of data that the markup annotation shall be associated with. The only defined value is Markup3D . Table 298 (ISO-320001) lists the values that correspond to a subtype of Markup3D (See also Pdf3DAnnotation ).

GetInReplyTo()

An annotation that this annotation is "in reply to." Both annotations shall be on the same page of the document.

public virtual PdfAnnotation GetInReplyTo()

Returns

PdfAnnotation

a PdfAnnotation that this annotation is "in reply to."

Remarks

An annotation that this annotation is "in reply to." Both annotations shall be on the same page of the document. The relationship between the two annotations shall be specified by the RT entry (see GetReplyType() ).

GetInReplyToObject()

An annotation object that this annotation is "in reply to." Both annotations shall be on the same page of the document.

public virtual PdfDictionary GetInReplyToObject()

Returns

PdfDictionary

a PdfDictionary that represents an annotation that this annotation is "in reply to."

Remarks

An annotation object that this annotation is "in reply to." Both annotations shall be on the same page of the document. The relationship between the two annotations shall be specified by the RT entry (see GetReplyType() ).

GetIntent()

A name describing the intent of the markup annotation.

public virtual PdfName GetIntent()

Returns

PdfName

a PdfName describing the intent of the markup annotation, or null if not specified.

Remarks

A name describing the intent of the markup annotation. See SetIntent(PdfName) for more info.

GetOpacity()

The constant opacity value that will be used in painting the annotation.

public virtual PdfNumber GetOpacity()

Returns

PdfNumber

a PdfNumber which value is in range between 0 and 1, which specifies the level of opacity. This method returns null if opacity is not specified; in this case default value is used, which is 1.

Remarks

The constant opacity value that will be used in painting the annotation. This value is applied to all visible elements of the annotation in its closed state (including its background and border) but not to the pop-up window that appears when the annotation is opened. Default value: 1.0.

GetPopup()

An associated pop-up annotation for entering or editing the text associated with this annotation.

public virtual PdfPopupAnnotation GetPopup()

Returns

PdfPopupAnnotation

an PdfPopupAnnotation that is associated with this annotation, or null if there is none.

Remarks

An associated pop-up annotation for entering or editing the text associated with this annotation. Pop-up annotation defines an associated with this annotation pop-up window that may contain text. The Contents (see GetContents() ) entry of the annotation that has an associated popup specifies the text that shall be displayed when the pop-up window is opened.

GetPopupObject()

An associated pop-up annotation object.

public virtual PdfDictionary GetPopupObject()

Returns

PdfDictionary

a PdfDictionary that represents an associated pop-up annotation, or null if popup annotation is not specified.

Remarks

An associated pop-up annotation object. See GetPopup() for more info.

GetReplyType()

A name specifying the relationship (the "reply type") between this annotation and one specified by IRT entry (see GetInReplyTo() ).

public virtual PdfName GetReplyType()

Returns

PdfName

a PdfName specifying relationship with the specified by the IRT entry; or null if reply type is not specified, in this case the default value is R.

Remarks

A name specifying the relationship (the "reply type") between this annotation and one specified by IRT entry (see GetInReplyTo() ). Valid values are:

• R - The annotation shall be considered a reply to the annotation specified by IRT. Conforming readers shall not display replies to an annotation individually but together in the form of threaded comments.
• Group - The annotation shall be grouped with the annotation specified by IRT.

GetRichText()

A rich text string (see ISO-320001 12.7.3.4, "Rich Text Strings") that shall be displayed in the pop-up window when the annotation is opened.

public virtual PdfObject GetRichText()

Returns

PdfObject

text string or text stream that specifies rich text or null if rich text is not specified.

GetSubject()

Text representing a short description of the subject being addressed by the annotation.

public virtual PdfString GetSubject()

Returns

PdfString

a PdfString which value is a annotation subject.

GetText()

The text label that will be displayed in the title bar of the annotation's pop-up window when open and active.

public virtual PdfString GetText()

Returns

PdfString

PdfString which value is an annotation text label content or null if text is not specified.

Remarks

The text label that will be displayed in the title bar of the annotation's pop-up window when open and active. This entry shall identify the user who added the annotation.

SetCreationDate(PdfString)

Sets the date and time when the annotation was created.

public virtual PdfMarkupAnnotation SetCreationDate(PdfString creationDate)

Parameters

creationDate PdfString

PdfString which value should be in the date format specified in (ISO-320001 7.9.4, "Dates").

Returns

PdfMarkupAnnotation

this PdfMarkupAnnotation instance.

SetExternalData(PdfDictionary)

Sets an external data dictionary specifying data that shall be associated with the annotation.

public virtual PdfMarkupAnnotation SetExternalData(PdfDictionary exData)

Parameters

exData PdfDictionary

the external data dictionary

Returns

PdfMarkupAnnotation

this PdfMarkupAnnotation instance

Remarks

Sets an external data dictionary specifying data that shall be associated with the annotation. This dictionary should contain the following entries:

• Type - (optional) If present, shall be ExData.
• Subtype - (required) a name specifying the type of data that the markup annotation shall be associated with. The only defined value is Markup3D . Table 298 (ISO-320001) lists the values that correspond to a subtype of Markup3D (See also Pdf3DAnnotation ).

SetInReplyTo(PdfAnnotation)

Sets an annotation that this annotation is "in reply to." Both annotations shall be on the same page of the document.

public virtual PdfMarkupAnnotation SetInReplyTo(PdfAnnotation inReplyTo)

Parameters

inReplyTo PdfAnnotation

a PdfAnnotation that this annotation is "in reply to."

Returns

PdfMarkupAnnotation

this PdfMarkupAnnotation instance.

Remarks

Sets an annotation that this annotation is "in reply to." Both annotations shall be on the same page of the document. The relationship between the two annotations shall be specified by the RT entry (see GetReplyType() ).

SetIntent(PdfName)

Sets a name describing the intent of the markup annotation.

public virtual PdfMarkupAnnotation SetIntent(PdfName intent)

Parameters

intent PdfName

a PdfName describing the intent of the markup annotation.

Returns

PdfMarkupAnnotation

this PdfMarkupAnnotation instance.

Remarks

Sets a name describing the intent of the markup annotation. Intents allow conforming readers to distinguish between different uses and behaviors of a single markup annotation type. If this entry is not present or its value is the same as the annotation type, the annotation shall have no explicit intent and should behave in a generic manner in a conforming reader.

See ISO-320001, free text annotations (Table 174), line annotations (Table 175), polygon annotations (Table 178), and polyline annotations (Table 178) for the specific intent values for those types.

SetOpacity(PdfNumber)

Sets the constant opacity value that will be used in painting the annotation.

public virtual PdfMarkupAnnotation SetOpacity(PdfNumber ca)

Parameters

ca PdfNumber

a PdfNumber which value is in range between 0 and 1, which specifies the level of opacity.

Returns

PdfMarkupAnnotation

this PdfMarkupAnnotation instance.

See Also

GetOpacity()

SetPopup(PdfPopupAnnotation)

Sets a pop-up annotation for entering or editing the text associated with this annotation.

public virtual PdfMarkupAnnotation SetPopup(PdfPopupAnnotation popup)

Parameters

popup PdfPopupAnnotation

an PdfPopupAnnotation that will be associated with this annotation.

Returns

PdfMarkupAnnotation

this PdfMarkupAnnotation instance.

Remarks

Sets a pop-up annotation for entering or editing the text associated with this annotation. Pop-up annotation defines an associated with this annotation pop-up window that may contain text. The Contents (see SetContents(PdfString) ) entry of the annotation that has an associated popup specifies the text that shall be displayed when the pop-up window is opened.

SetReplyType(PdfName)

Sets the relationship (the "reply type") between this annotation and one specified by IRT entry (see SetInReplyTo(PdfAnnotation) ).

public virtual PdfMarkupAnnotation SetReplyType(PdfName replyType)

Parameters

replyType PdfName

a PdfName specifying relationship with the specified by the IRT entry.

Returns

PdfMarkupAnnotation

this PdfMarkupAnnotation instance.

Remarks

Sets the relationship (the "reply type") between this annotation and one specified by IRT entry (see SetInReplyTo(PdfAnnotation) ). For valid values see GetInReplyTo().

SetRichText(PdfObject)

Sets a rich text string (see ISO-320001 12.7.3.4, "Rich Text Strings") that shall be displayed in the pop-up window when the annotation is opened.

public virtual PdfMarkupAnnotation SetRichText(PdfObject richText)

Parameters

richText PdfObject

text string or text stream that specifies rich text.

Returns

PdfMarkupAnnotation

this PdfMarkupAnnotation instance.

SetSubject(PdfString)

Sets the text representing a short description of the subject being addressed by the annotation.

public virtual PdfMarkupAnnotation SetSubject(PdfString subject)

Parameters

subject PdfString

a PdfString which value is a annotation subject.

Returns

PdfMarkupAnnotation

this PdfMarkupAnnotation instance.

SetText(PdfString)

Sets the text label that will be displayed in the title bar of the annotation's pop-up window when open and active.

public virtual PdfMarkupAnnotation SetText(PdfString text)

Parameters

text PdfString

PdfString which value is an annotation text label content.

Returns

PdfMarkupAnnotation

this PdfMarkupAnnotation instance.

Remarks

Sets the text label that will be displayed in the title bar of the annotation's pop-up window when open and active. This entry shall identify the user who added the annotation.