iText 7 7.1.9 API
iText.Kernel.Pdf.Annot.PdfAnnotation Class Referenceabstract

This is a super class for the annotation dictionary wrappers. More...

Inheritance diagram for iText.Kernel.Pdf.Annot.PdfAnnotation:
iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary > iText.Kernel.Pdf.Annot.Pdf3DAnnotation iText.Kernel.Pdf.Annot.PdfLinkAnnotation iText.Kernel.Pdf.Annot.PdfMarkupAnnotation iText.Kernel.Pdf.Annot.PdfPopupAnnotation iText.Kernel.Pdf.Annot.PdfPrinterMarkAnnotation iText.Kernel.Pdf.Annot.PdfRichMediaAnnotation iText.Kernel.Pdf.Annot.PdfScreenAnnotation iText.Kernel.Pdf.Annot.PdfTrapNetworkAnnotation iText.Kernel.Pdf.Annot.PdfWatermarkAnnotation iText.Kernel.Pdf.Annot.PdfWidgetAnnotation

Classes

class   PdfUnknownAnnotation
 

Public Member Functions

abstract PdfName  GetSubtype ()
  Gets a iText.Kernel.Pdf.PdfName which value is a subtype of this annotation. More...
 
virtual void  SetLayer (IPdfOCG layer)
  Sets the layer this annotation belongs to. More...
 
virtual PdfString  GetContents ()
  Gets the text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetContents (PdfString contents)
  Sets the text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetContents (String contents)
  Sets the text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form. More...
 
virtual PdfDictionary  GetPageObject ()
  Gets a iText.Kernel.Pdf.PdfDictionary that represents a page of the document on which annotation is placed, i.e. which has this annotation in it's /Annots array. More...
 
virtual PdfPage  GetPage ()
  Gets a iText.Kernel.Pdf.PdfPage on which annotation is placed. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetPage (PdfPage page)
  Method that modifies annotation page property, which defines to which page annotation belongs. More...
 
virtual PdfString  GetName ()
  Gets the annotation name, a text string uniquely identifying it among all the annotations on its page. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetName (PdfString name)
  Sets the annotation name, a text string uniquely identifying it among all the annotations on its page. More...
 
virtual PdfString  GetDate ()
  The date and time when the annotation was most recently modified. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetDate (PdfString date)
  The date and time when the annotation was most recently modified. More...
 
virtual int  GetFlags ()
  A set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, "Annotation Flags"). More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetFlags (int flags)
  Sets a set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, "Annotation Flags"). More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetFlag (int flag)
  Sets a flag that specifies a characteristic of the annotation to enabled state (see ISO-320001 12.5.3, "Annotation Flags"). More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  ResetFlag (int flag)
  Resets a flag that specifies a characteristic of the annotation to disabled state (see ISO-320001 12.5.3, "Annotation Flags"). More...
 
virtual bool  HasFlag (int flag)
  Checks if the certain flag that specifies a characteristic of the annotation is in enabled state (see ISO-320001 12.5.3, "Annotation Flags"). More...
 
virtual PdfDictionary  GetAppearanceDictionary ()
  An appearance dictionary specifying how the annotation shall be presented visually on the page during its interactions with the user (see ISO-320001 12.5.5, "Appearance Streams"). More...
 
virtual PdfDictionary  GetAppearanceObject (PdfName appearanceType)
  Specific appearance object corresponding to the specific appearance type. More...
 
virtual PdfDictionary  GetNormalAppearanceObject ()
  The normal appearance is used when the annotation is not interacting with the user. More...
 
virtual PdfDictionary  GetRolloverAppearanceObject ()
  The rollover appearance is used when the user moves the cursor into the annotation’s active area without pressing the mouse button. More...
 
virtual PdfDictionary  GetDownAppearanceObject ()
  The down appearance is used when the mouse button is pressed or held down within the annotation’s active area. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetAppearance (PdfName appearanceType, PdfDictionary appearance)
  Sets a specific type of the appearance. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetNormalAppearance (PdfDictionary appearance)
  Sets normal appearance. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetRolloverAppearance (PdfDictionary appearance)
  Sets rollover appearance. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetDownAppearance (PdfDictionary appearance)
  Sets down appearance. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetAppearance (PdfName appearanceType, PdfAnnotationAppearance appearance)
  Sets a specific type of the appearance using PdfAnnotationAppearance wrapper. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetNormalAppearance (PdfAnnotationAppearance appearance)
  Sets normal appearance using PdfAnnotationAppearance wrapper. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetRolloverAppearance (PdfAnnotationAppearance appearance)
  Sets rollover appearance using PdfAnnotationAppearance wrapper. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetDownAppearance (PdfAnnotationAppearance appearance)
  Sets down appearance using PdfAnnotationAppearance wrapper. More...
 
virtual PdfName  GetAppearanceState ()
  The annotation’s appearance state, which selects the applicable appearance stream from an appearance subdictionary if there is such. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetAppearanceState (PdfName @as)
  Sets the annotation’s appearance state, which selects the applicable appearance stream from an appearance subdictionary. More...
 
virtual PdfArray  GetBorder ()
  An array specifying the characteristics of the annotation’s border. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetBorder (PdfAnnotationBorder border)
  Sets the characteristics of the annotation’s border. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetBorder (PdfArray border)
  Sets the characteristics of the annotation’s border. More...
 
virtual PdfArray  GetColorObject ()
  An array of numbers in the range 0.0 to 1.0, representing a colour used for the following purposes:

  • The background of the annotation’s icon when closed
  • The title bar of the annotation’s pop-up window
  • The border of a link annotation

The number of array elements determines the colour space in which the colour shall be defined:

  • 0 - No colour; transparent
  • 1 - DeviceGray
  • 3 - DeviceRGB
  • 4 - DeviceCMYK
More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetColor (PdfArray color)
  Sets an annotation color. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetColor (float[] color)
  Sets an annotation color. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetColor (Color color)
  Sets an annotation color. More...
 
virtual int  GetStructParentIndex ()
  The integer key of the annotation’s entry in the structural parent tree (see ISO-320001 14.7.4.4, "Finding Structure Elements from Content Items"). More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetStructParentIndex (int structParentIndex)
  Sets he integer key of the annotation’s entry in the structural parent tree (see ISO-320001 14.7.4.4, "Finding Structure Elements from Content Items"). More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetTitle (PdfString title)
  Sets annotation title. More...
 
virtual PdfString  GetTitle ()
  Annotation title. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetRectangle (PdfArray array)
  The annotation rectangle, defining the location of the annotation on the page in default user space units. More...
 
virtual PdfArray  GetRectangle ()
  The annotation rectangle, defining the location of the annotation on the page in default user space units. More...
 
virtual String  GetLang ()
  PDF 2.0. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetLang (String lang)
  PDF 2.0. More...
 
virtual PdfName  GetBlendMode ()
  PDF 2.0. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetBlendMode (PdfName blendMode)
  PDF 2.0. More...
 
virtual float  GetNonStrokingOpacity ()
  PDF 2.0. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetNonStrokingOpacity (float nonStrokingOpacity)
  PDF 2.0. More...
 
virtual float  GetStrokingOpacity ()
  PDF 2.0. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  SetStrokingOpacity (float strokingOpacity)
  PDF 2.0. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  Put (PdfName key, PdfObject value)
  Inserts the value into into the underlying iText.Kernel.Pdf.PdfDictionary of this PdfAnnotation and associates it with the specified key. More...
 
virtual iText.Kernel.Pdf.Annot.PdfAnnotation  Remove (PdfName key)
  Removes the specified key from the underlying iText.Kernel.Pdf.PdfDictionary of this PdfAnnotation. More...
 
virtual void  AddAssociatedFile (PdfFileSpec fs)
 
virtual PdfArray  GetAssociatedFiles (bool create)
  Returns files associated with PDF annotation. More...
 
override void  Flush ()
  To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. More...
 
- Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
virtual T  GetPdfObject ()
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  MakeIndirect (PdfDocument document, PdfIndirectReference reference)
  Marks object behind wrapper to be saved as indirect. More...
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  MakeIndirect (PdfDocument document)
  Marks object behind wrapper to be saved as indirect. More...
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  SetModified ()
 
virtual bool  IsFlushed ()
 

Static Public Member Functions

static iText.Kernel.Pdf.Annot.PdfAnnotation  MakeAnnotation (PdfObject pdfObject)
  Factory method that creates the type specific PdfAnnotation from the given iText.Kernel.Pdf.PdfObject that represents annotation object. More...
 

Static Public Attributes

const int  INVISIBLE = 1
  Annotation flag. More...
 
const int  HIDDEN = 2
  Annotation flag. More...
 
const int  PRINT = 4
  Annotation flag. More...
 
const int  NO_ZOOM = 8
  Annotation flag. More...
 
const int  NO_ROTATE = 16
  Annotation flag. More...
 
const int  NO_VIEW = 32
  Annotation flag. More...
 
const int  READ_ONLY = 64
  Annotation flag. More...
 
const int  LOCKED = 128
  Annotation flag. More...
 
const int  TOGGLE_NO_VIEW = 256
  Annotation flag. More...
 
const int  LOCKED_CONTENTS = 512
  Annotation flag. More...
 
static readonly PdfName  HIGHLIGHT_NONE = PdfName.N
  Widget annotation highlighting mode. More...
 
static readonly PdfName  HIGHLIGHT_INVERT = PdfName.I
  Widget annotation highlighting mode. More...
 
static readonly PdfName  HIGHLIGHT_OUTLINE = PdfName.O
  Widget annotation highlighting mode. More...
 
static readonly PdfName  HIGHLIGHT_PUSH = PdfName.P
  Widget annotation highlighting mode. More...
 
static readonly PdfName  HIGHLIGHT_TOGGLE = PdfName.T
  Widget annotation highlighting mode. More...
 
static readonly PdfName  STYLE_SOLID = PdfName.S
  Annotation border style. More...
 
static readonly PdfName  STYLE_DASHED = PdfName.D
  Annotation border style. More...
 
static readonly PdfName  STYLE_BEVELED = PdfName.B
  Annotation border style. More...
 
static readonly PdfName  STYLE_INSET = PdfName.I
  Annotation border style. More...
 
static readonly PdfName  STYLE_UNDERLINE = PdfName.U
  Annotation border style. More...
 
static readonly PdfString  Marked = new PdfString("Marked")
  Annotation state. More...
 
static readonly PdfString  Unmarked = new PdfString("Unmarked")
  Annotation state. More...
 
static readonly PdfString  Accepted = new PdfString("Accepted")
  Annotation state. More...
 
static readonly PdfString  Rejected = new PdfString("Rejected")
  Annotation state. More...
 
static readonly PdfString  Canceled = new PdfString("Cancelled")
  Annotation state. More...
 
static readonly PdfString  Completed = new PdfString("Completed")
  Annotation state. More...
 
static readonly PdfString  None = new PdfString("None")
  Annotation state. More...
 
static readonly PdfString  MarkedModel = new PdfString("Marked")
  Annotation state model. More...
 
static readonly PdfString  ReviewModel = new PdfString("Review")
  Annotation state model. More...
 

Detailed Description

This is a super class for the annotation dictionary wrappers.

This is a super class for the annotation dictionary wrappers. Derived classes represent different standard types of annotations. See ISO-320001 12.5.6, "Annotation Types."

Member Function Documentation

◆ AddAssociatedFile()

virtual void iText.Kernel.Pdf.Annot.PdfAnnotation.AddAssociatedFile ( PdfFileSpec  fs )
inlinevirtual

Adds file associated with PDF annotation and identifies the relationship between them.

Adds file associated with PDF annotation and identifies the relationship between them.

Associated files may be used in Pdf/A-3 and Pdf 2.0 documents. The method adds file to array value of the AF key in the annotation dictionary.

For associated files their associated file specification dictionaries shall include the AFRelationship key

Parameters
fs file specification dictionary of associated file

◆ Flush()

override void iText.Kernel.Pdf.Annot.PdfAnnotation.Flush ( )
inlinevirtual

To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference.

To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. Basically this means that before flushing you need to explicitly call iText.Kernel.Pdf.PdfObjectWrapper<T>.MakeIndirect(iText.Kernel.Pdf.PdfDocument). For example: wrapperInstance.makeIndirect(document).flush(); Note that not every wrapper require this, only those that have such warning in documentation.

Reimplemented from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >.

◆ GetAppearanceDictionary()

virtual PdfDictionary iText.Kernel.Pdf.Annot.PdfAnnotation.GetAppearanceDictionary ( )
inlinevirtual

An appearance dictionary specifying how the annotation shall be presented visually on the page during its interactions with the user (see ISO-320001 12.5.5, "Appearance Streams").

An appearance dictionary specifying how the annotation shall be presented visually on the page during its interactions with the user (see ISO-320001 12.5.5, "Appearance Streams"). An appearance dictionary is a dictionary containing one or several appearance streams or subdictionaries.

Returns
an appearance iText.Kernel.Pdf.PdfDictionary or null if it is not specified.

◆ GetAppearanceObject()

virtual PdfDictionary iText.Kernel.Pdf.Annot.PdfAnnotation.GetAppearanceObject ( PdfName  appearanceType )
inlinevirtual

Specific appearance object corresponding to the specific appearance type.

Specific appearance object corresponding to the specific appearance type. This object might be either an appearance stream or an appearance subdictionary. In the latter case, the subdictionary defines multiple appearance streams corresponding to different appearance states of the annotation. See ISO-320001 12.5.5, "Appearance Streams".

Parameters
appearanceType a iText.Kernel.Pdf.PdfName specifying appearance type. Possible types are Normal , Rollover and Down.
Returns
null if their is no such appearance type or an appearance object which might be either an appearance stream or an appearance subdictionary.

◆ GetAppearanceState()

virtual PdfName iText.Kernel.Pdf.Annot.PdfAnnotation.GetAppearanceState ( )
inlinevirtual

The annotation’s appearance state, which selects the applicable appearance stream from an appearance subdictionary if there is such.

The annotation’s appearance state, which selects the applicable appearance stream from an appearance subdictionary if there is such. See GetAppearanceObject(iText.Kernel.Pdf.PdfName) for more info.

Returns
a iText.Kernel.Pdf.PdfName which defines selected appearance state.

◆ GetAssociatedFiles()

virtual PdfArray iText.Kernel.Pdf.Annot.PdfAnnotation.GetAssociatedFiles ( bool  create )
inlinevirtual

Returns files associated with PDF annotation.

Parameters
create iText will create AF array if it doesn't exist and create value is true
Returns
associated files array.

◆ GetBlendMode()

virtual PdfName iText.Kernel.Pdf.Annot.PdfAnnotation.GetBlendMode ( )
inlinevirtual

PDF 2.0.

PDF 2.0. The blend mode that shall be used when painting the annotation onto the page

Returns
the blend mode

◆ GetBorder()

virtual PdfArray iText.Kernel.Pdf.Annot.PdfAnnotation.GetBorder ( )
inlinevirtual

An array specifying the characteristics of the annotation’s border.

An array specifying the characteristics of the annotation’s border. The array consists of three numbers defining the horizontal corner radius, vertical corner radius, and border width, all in default user space units. If the corner radii are 0, the border has square (not rounded) corners; if the border width is 0, no border is drawn.

The array may have a fourth element, an optional dash array (see ISO-320001 8.4.3.6, "Line Dash Pattern").

Returns
an iText.Kernel.Pdf.PdfArray specifying the characteristics of the annotation’s border.

◆ GetColorObject()

virtual PdfArray iText.Kernel.Pdf.Annot.PdfAnnotation.GetColorObject ( )
inlinevirtual

An array of numbers in the range 0.0 to 1.0, representing a colour used for the following purposes:

  • The background of the annotation’s icon when closed
  • The title bar of the annotation’s pop-up window
  • The border of a link annotation

The number of array elements determines the colour space in which the colour shall be defined:

  • 0 - No colour; transparent
  • 1 - DeviceGray
  • 3 - DeviceRGB
  • 4 - DeviceCMYK

Returns
An array of numbers in the range 0.0 to 1.0, representing an annotation colour.

◆ GetContents()

virtual PdfString iText.Kernel.Pdf.Annot.PdfAnnotation.GetContents ( )
inlinevirtual

Gets the text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form.

Returns
annotation text content.

◆ GetDate()

virtual PdfString iText.Kernel.Pdf.Annot.PdfAnnotation.GetDate ( )
inlinevirtual

The date and time when the annotation was most recently modified.

The date and time when the annotation was most recently modified. This is an optional property of the annotation.

Returns
a iText.Kernel.Pdf.PdfString with the modification date as it's value or null if date is not specified.

◆ GetDownAppearanceObject()

virtual PdfDictionary iText.Kernel.Pdf.Annot.PdfAnnotation.GetDownAppearanceObject ( )
inlinevirtual

The down appearance is used when the mouse button is pressed or held down within the annotation’s active area.

The down appearance is used when the mouse button is pressed or held down within the annotation’s active area. If not specified normal appearance is used. See also GetAppearanceObject(iText.Kernel.Pdf.PdfName).

Returns
null if down appearance is not specified or an appearance object which might be either an appearance stream or an appearance subdictionary.

◆ GetFlags()

virtual int iText.Kernel.Pdf.Annot.PdfAnnotation.GetFlags ( )
inlinevirtual

A set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, "Annotation Flags").

A set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, "Annotation Flags"). For specific annotation flag constants see SetFlag(int). Default value: 0.

Returns
an integer interpreted as one-bit flags specifying various characteristics of the annotation.

◆ GetLang()

virtual String iText.Kernel.Pdf.Annot.PdfAnnotation.GetLang ( )
inlinevirtual

PDF 2.0.

PDF 2.0. A language identifier overriding the document’s language identifier to specify the natural language for all text in the annotation except where overridden by other explicit language specifications

Returns
the lang entry

◆ GetName()

virtual PdfString iText.Kernel.Pdf.Annot.PdfAnnotation.GetName ( )
inlinevirtual

Gets the annotation name, a text string uniquely identifying it among all the annotations on its page.

Returns
a iText.Kernel.Pdf.PdfString with annotation name as it's value or null if name is not specified.

◆ GetNonStrokingOpacity()

virtual float iText.Kernel.Pdf.Annot.PdfAnnotation.GetNonStrokingOpacity ( )
inlinevirtual

PDF 2.0.

PDF 2.0. When regenerating the annotation's appearance stream, this is the opacity value that shall be used for all nonstroking operations on all visible elements of the annotation in its closed state (including its background and border) but not the popup window that appears when the annotation is opened.

Returns
opacity value for nonstroking operations. Returns 1.0 (default value) if entry is not present

◆ GetNormalAppearanceObject()

virtual PdfDictionary iText.Kernel.Pdf.Annot.PdfAnnotation.GetNormalAppearanceObject ( )
inlinevirtual

The normal appearance is used when the annotation is not interacting with the user.

The normal appearance is used when the annotation is not interacting with the user. This appearance is also used for printing the annotation. See also GetAppearanceObject(iText.Kernel.Pdf.PdfName).

Returns
an appearance object which might be either an appearance stream or an appearance subdictionary.

◆ GetPage()

virtual PdfPage iText.Kernel.Pdf.Annot.PdfAnnotation.GetPage ( )
inlinevirtual

Gets a iText.Kernel.Pdf.PdfPage on which annotation is placed.

Returns

iText.Kernel.Pdf.PdfPage on which annotation is placed or null if annotation is not placed yet.

◆ GetPageObject()

virtual PdfDictionary iText.Kernel.Pdf.Annot.PdfAnnotation.GetPageObject ( )
inlinevirtual

Gets a iText.Kernel.Pdf.PdfDictionary that represents a page of the document on which annotation is placed, i.e. which has this annotation in it's /Annots array.

Returns

iText.Kernel.Pdf.PdfDictionary that is a page pdf object or null if annotation is not added to the page yet.

◆ GetRectangle()

virtual PdfArray iText.Kernel.Pdf.Annot.PdfAnnotation.GetRectangle ( )
inlinevirtual

The annotation rectangle, defining the location of the annotation on the page in default user space units.

Returns
a iText.Kernel.Pdf.PdfArray which specifies a rectangle by two diagonally opposite corners. Typically, the array is of form [llx lly urx ury].

◆ GetRolloverAppearanceObject()

virtual PdfDictionary iText.Kernel.Pdf.Annot.PdfAnnotation.GetRolloverAppearanceObject ( )
inlinevirtual

The rollover appearance is used when the user moves the cursor into the annotation’s active area without pressing the mouse button.

The rollover appearance is used when the user moves the cursor into the annotation’s active area without pressing the mouse button. If not specified normal appearance is used. See also GetAppearanceObject(iText.Kernel.Pdf.PdfName).

Returns
null if rollover appearance is not specified or an appearance object which might be either an appearance stream or an appearance subdictionary.

◆ GetStrokingOpacity()

virtual float iText.Kernel.Pdf.Annot.PdfAnnotation.GetStrokingOpacity ( )
inlinevirtual

PDF 2.0.

PDF 2.0. When regenerating the annotation's appearance stream, this is the opacity value that shall be used for stroking all visible elements of the annotation in its closed state, including its background and border, but not the popup window that appears when the annotation is opened.

Returns
opacity for stroking operations, including background and border

◆ GetStructParentIndex()

virtual int iText.Kernel.Pdf.Annot.PdfAnnotation.GetStructParentIndex ( )
inlinevirtual

The integer key of the annotation’s entry in the structural parent tree (see ISO-320001 14.7.4.4, "Finding Structure Elements from Content Items").

Returns
integer key in structural parent tree or -1 if annotation is not tagged.

◆ GetSubtype()

◆ GetTitle()

virtual PdfString iText.Kernel.Pdf.Annot.PdfAnnotation.GetTitle ( )
inlinevirtual

Annotation title.

Annotation title. For example for markup annotations, the title is the text label that shall be displayed in the title bar of the annotation’s pop-up window when open and active. For movie annotation Movie actions (ISO-320001 12.6.4.9, "Movie Actions") may use this title to reference the movie annotation.

Returns

iText.Kernel.Pdf.PdfString which value is an annotation title or null if it isn't specifed.

◆ HasFlag()

virtual bool iText.Kernel.Pdf.Annot.PdfAnnotation.HasFlag ( int  flag )
inlinevirtual

Checks if the certain flag that specifies a characteristic of the annotation is in enabled state (see ISO-320001 12.5.3, "Annotation Flags").

Checks if the certain flag that specifies a characteristic of the annotation is in enabled state (see ISO-320001 12.5.3, "Annotation Flags"). This method allows only one flag to be checked at once, use constants listed in SetFlag(int).

Parameters
flag an integer interpreted as set of one-bit flags. Only one bit must be set in this integer, otherwise exception is thrown.
Returns
true if the given flag is in enabled state.

◆ MakeAnnotation()

static iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.MakeAnnotation ( PdfObject  pdfObject )
inlinestatic

Factory method that creates the type specific PdfAnnotation from the given iText.Kernel.Pdf.PdfObject that represents annotation object.

Factory method that creates the type specific PdfAnnotation from the given iText.Kernel.Pdf.PdfObject that represents annotation object. This method is useful for property reading in reading mode or modifying in stamping mode. See derived classes of this class to see possible specific annotation types created.

Parameters
pdfObject a iText.Kernel.Pdf.PdfObject that represents annotation in the document.
Returns
created PdfAnnotation.

◆ Put()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.Put ( PdfName  key,
PdfObject  value 
)
inlinevirtual

Inserts the value into into the underlying iText.Kernel.Pdf.PdfDictionary of this PdfAnnotation and associates it with the specified key.

Inserts the value into into the underlying iText.Kernel.Pdf.PdfDictionary of this PdfAnnotation and associates it with the specified key. If the key is already present in this PdfAnnotation , this method will override the old value with the specified one.

Parameters
key key to insert or to override
value the value to associate with the specified key
Returns
this PdfAnnotation instance.

◆ Remove()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.Remove ( PdfName  key )
inlinevirtual

Removes the specified key from the underlying iText.Kernel.Pdf.PdfDictionary of this PdfAnnotation.

Parameters
key key to be removed
Returns
this PdfAnnotation instance.

◆ ResetFlag()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.ResetFlag ( int  flag )
inlinevirtual

Resets a flag that specifies a characteristic of the annotation to disabled state (see ISO-320001 12.5.3, "Annotation Flags").

Parameters
flag an integer interpreted as set of one-bit flags which will be reset to disabled state.
Returns
this PdfAnnotation instance.

◆ SetAppearance() [1/2]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetAppearance ( PdfName  appearanceType,
PdfAnnotationAppearance  appearance 
)
inlinevirtual

Sets a specific type of the appearance using PdfAnnotationAppearance wrapper.

Sets a specific type of the appearance using PdfAnnotationAppearance wrapper. This method is used to set only an appearance subdictionary. See GetAppearanceObject(iText.Kernel.Pdf.PdfName) and GetAppearanceDictionary() for more info.

Parameters
appearanceType a iText.Kernel.Pdf.PdfName specifying appearance type. Possible types are Normal , Rollover and Down.
appearance an appearance subdictionary wrapped in PdfAnnotationAppearance.
Returns
this PdfAnnotation instance.

◆ SetAppearance() [2/2]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetAppearance ( PdfName  appearanceType,
PdfDictionary  appearance 
)
inlinevirtual

Sets a specific type of the appearance.

Sets a specific type of the appearance. See GetAppearanceObject(iText.Kernel.Pdf.PdfName) and GetAppearanceDictionary() for more info.

Parameters
appearanceType a iText.Kernel.Pdf.PdfName specifying appearance type. Possible types are Normal , Rollover and Down.
appearance an appearance object which might be either an appearance stream or an appearance subdictionary.
Returns
this PdfAnnotation instance.

◆ SetAppearanceState()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetAppearanceState ( PdfName as )
inlinevirtual

Sets the annotation’s appearance state, which selects the applicable appearance stream from an appearance subdictionary.

Sets the annotation’s appearance state, which selects the applicable appearance stream from an appearance subdictionary. See GetAppearanceObject(iText.Kernel.Pdf.PdfName) for more info.

Parameters
as a iText.Kernel.Pdf.PdfName which defines appearance state to be selected.
Returns
this PdfAnnotation instance.

◆ SetBlendMode()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetBlendMode ( PdfName  blendMode )
inlinevirtual

PDF 2.0.

PDF 2.0. The blend mode that shall be used when painting the annotation onto the page

Parameters
blendMode blend mode
Returns
this PdfAnnotation instance

◆ SetBorder() [1/2]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetBorder ( PdfAnnotationBorder  border )
inlinevirtual

Sets the characteristics of the annotation’s border.

Parameters
border an iText.Kernel.Pdf.PdfAnnotationBorder specifying the characteristics of the annotation’s border. See GetBorder() for more detailes.
Returns
this PdfAnnotation instance.

◆ SetBorder() [2/2]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetBorder ( PdfArray  border )
inlinevirtual

Sets the characteristics of the annotation’s border.

Parameters
border an iText.Kernel.Pdf.PdfArray specifying the characteristics of the annotation’s border. See GetBorder() for more detailes.
Returns
this PdfAnnotation instance.

◆ SetColor() [1/3]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetColor ( Color  color )
inlinevirtual

Sets an annotation color.

Sets an annotation color. For more details on annotation color purposes see GetColorObject().

Parameters
color

iText.Kernel.Colors.Color object of the either iText.Kernel.Colors.DeviceGray , iText.Kernel.Colors.DeviceRgb or iText.Kernel.Colors.DeviceCmyk type.

Returns
this PdfAnnotation instance.

◆ SetColor() [2/3]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetColor ( float[]  color )
inlinevirtual

Sets an annotation color.

Sets an annotation color. For more details on annotation color purposes and the format of the passing array see GetColorObject().

Parameters
color an array of numbers in the range 0.0 to 1.0, specifying color.
Returns
this PdfAnnotation instance.

◆ SetColor() [3/3]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetColor ( PdfArray  color )
inlinevirtual

Sets an annotation color.

Sets an annotation color. For more details on annotation color purposes and the format of the passing iText.Kernel.Pdf.PdfArray see GetColorObject().

Parameters
color an array of numbers in the range 0.0 to 1.0, specifying color.
Returns
this PdfAnnotation instance.

◆ SetContents() [1/2]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetContents ( PdfString  contents )
inlinevirtual

Sets the text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form.

Parameters
contents a iText.Kernel.Pdf.PdfString containing text content to be set to the annotation.
Returns
this PdfAnnotation instance.

◆ SetContents() [2/2]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetContents ( String  contents )
inlinevirtual

Sets the text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form.

Parameters
contents a java System.String containing text content to be set to the annotation.
Returns
this PdfAnnotation instance.

◆ SetDate()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetDate ( PdfString  date )
inlinevirtual

The date and time when the annotation was most recently modified.

Parameters
date a iText.Kernel.Pdf.PdfString with date. The format should be a date string as described in ISO-320001 7.9.4, "Dates".
Returns
this PdfAnnotation instance.

◆ SetDownAppearance() [1/2]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetDownAppearance ( PdfAnnotationAppearance  appearance )
inlinevirtual

Sets down appearance using PdfAnnotationAppearance wrapper.

Sets down appearance using PdfAnnotationAppearance wrapper. This method is used to set only appearance subdictionary. See GetDownAppearanceObject() and GetAppearanceDictionary() for more info.

Parameters
appearance an appearance subdictionary wrapped in PdfAnnotationAppearance.
Returns
this PdfAnnotation instance.

◆ SetDownAppearance() [2/2]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetDownAppearance ( PdfDictionary  appearance )
inlinevirtual

Sets down appearance.

Sets down appearance. See GetDownAppearanceObject() and GetAppearanceDictionary() for more info.

Parameters
appearance an appearance object which might be either an appearance stream or an appearance subdictionary.
Returns
this PdfAnnotation instance.

◆ SetFlag()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetFlag ( int  flag )
inlinevirtual

Sets a flag that specifies a characteristic of the annotation to enabled state (see ISO-320001 12.5.3, "Annotation Flags").

Sets a flag that specifies a characteristic of the annotation to enabled state (see ISO-320001 12.5.3, "Annotation Flags"). On the contrary from SetFlags(int) , this method sets only specified flags to enabled state, but doesn't disable other flags. Possible flags:

  • INVISIBLE
    • If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such unknown annotation using an appearance stream specified by its appearance dictionary, if any.
  • HIDDEN
    • If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available.
  • PRINT
    • If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen.
  • NO_ZOOM
    • If set, do not scale the annotation’s appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper-left corner of its annotation rectangle) shall remain fixed, regardless of the page magnification.}
  • NO_ROTATE
    • If set, do not rotate the annotation’s appearance to match the rotation of the page. The upper-left corner of the annotation rectangle shall remain in a fixed location on the page, regardless of the page rotation.
  • NO_VIEW
    • If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction.
  • READ_ONLY
    • If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse clicks or change its appearance in response to mouse motions.
  • LOCKED
    • If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation’s contents, such as the value of a form field.
  • TOGGLE_NO_VIEW
    • If set, invert the interpretation of the NoView flag for certain events.
  • LOCKED_CONTENTS
    • If set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.
Parameters
flag - an integer interpreted as set of one-bit flags which will be enabled for this annotation.
Returns
this PdfAnnotation instance.

◆ SetFlags()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetFlags ( int  flags )
inlinevirtual

Sets a set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, "Annotation Flags").

Sets a set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, "Annotation Flags"). On the contrary from SetFlag(int) , this method sets a complete set of enabled and disabled flags at once. If not set specifically the default value is 0.

Parameters
flags an integer interpreted as set of one-bit flags specifying various characteristics of the annotation.
Returns
this PdfAnnotation instance.

◆ SetLang()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetLang ( String  lang )
inlinevirtual

PDF 2.0.

PDF 2.0. A language identifier overriding the document’s language identifier to specify the natural language for all text in the annotation except where overridden by other explicit language specifications

Parameters
lang language identifier
Returns
this PdfAnnotation instance

◆ SetLayer()

virtual void iText.Kernel.Pdf.Annot.PdfAnnotation.SetLayer ( IPdfOCG  layer )
inlinevirtual

Sets the layer this annotation belongs to.

Parameters
layer the layer this annotation belongs to

◆ SetName()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetName ( PdfString  name )
inlinevirtual

Sets the annotation name, a text string uniquely identifying it among all the annotations on its page.

Parameters
name a iText.Kernel.Pdf.PdfString to be set as annotation name.
Returns
this PdfAnnotation instance.

◆ SetNonStrokingOpacity()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetNonStrokingOpacity ( float  nonStrokingOpacity )
inlinevirtual

PDF 2.0.

PDF 2.0. When regenerating the annotation's appearance stream, this is the opacity value that shall be used for all nonstroking operations on all visible elements of the annotation in its closed state (including its background and border) but not the popup window that appears when the annotation is opened.

Parameters
nonStrokingOpacity opacity for nonstroking operations
Returns
this PdfAnnotation instance

◆ SetNormalAppearance() [1/2]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetNormalAppearance ( PdfAnnotationAppearance  appearance )
inlinevirtual

Sets normal appearance using PdfAnnotationAppearance wrapper.

Sets normal appearance using PdfAnnotationAppearance wrapper. This method is used to set only appearance subdictionary. See GetNormalAppearanceObject() and GetAppearanceDictionary() for more info.

Parameters
appearance an appearance subdictionary wrapped in PdfAnnotationAppearance.
Returns
this PdfAnnotation instance.

◆ SetNormalAppearance() [2/2]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetNormalAppearance ( PdfDictionary  appearance )
inlinevirtual

Sets normal appearance.

Sets normal appearance. See GetNormalAppearanceObject() and GetAppearanceDictionary() for more info.

Parameters
appearance an appearance object which might be either an appearance stream or an appearance subdictionary.
Returns
this PdfAnnotation instance.

◆ SetPage()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetPage ( PdfPage  page )
inlinevirtual

Method that modifies annotation page property, which defines to which page annotation belongs.

Method that modifies annotation page property, which defines to which page annotation belongs. Keep in mind that this doesn't actually add an annotation to the page, it should be done via iText.Kernel.Pdf.PdfPage.AddAnnotation(PdfAnnotation). Also you don't need to set this property manually, this is done automatically on addition to the page.

Parameters
page the iText.Kernel.Pdf.PdfPage to which annotation will be added.
Returns
this PdfAnnotation instance.

◆ SetRectangle()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetRectangle ( PdfArray  array )
inlinevirtual

The annotation rectangle, defining the location of the annotation on the page in default user space units.

Parameters
array a iText.Kernel.Pdf.PdfArray which specifies a rectangle by two diagonally opposite corners. Typically, the array is of form [llx lly urx ury].
Returns
this PdfAnnotation instance.

◆ SetRolloverAppearance() [1/2]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetRolloverAppearance ( PdfAnnotationAppearance  appearance )
inlinevirtual

Sets rollover appearance using PdfAnnotationAppearance wrapper.

Sets rollover appearance using PdfAnnotationAppearance wrapper. This method is used to set only appearance subdictionary. See GetRolloverAppearanceObject() and GetAppearanceDictionary() for more info.

Parameters
appearance an appearance subdictionary wrapped in PdfAnnotationAppearance.
Returns
this PdfAnnotation instance.

◆ SetRolloverAppearance() [2/2]

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetRolloverAppearance ( PdfDictionary  appearance )
inlinevirtual

Sets rollover appearance.

Sets rollover appearance. See GetRolloverAppearanceObject() and GetAppearanceDictionary() for more info.

Parameters
appearance an appearance object which might be either an appearance stream or an appearance subdictionary.
Returns
this PdfAnnotation instance.

◆ SetStrokingOpacity()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetStrokingOpacity ( float  strokingOpacity )
inlinevirtual

PDF 2.0.

PDF 2.0. When regenerating the annotation's appearance stream, this is the opacity value that shall be used for stroking all visible elements of the annotation in its closed state, including its background and border, but not the popup window that appears when the annotation is opened.

Parameters
strokingOpacity opacity for stroking operations, including background and border
Returns
this PdfAnnotation object

◆ SetStructParentIndex()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetStructParentIndex ( int  structParentIndex )
inlinevirtual

Sets he integer key of the annotation’s entry in the structural parent tree (see ISO-320001 14.7.4.4, "Finding Structure Elements from Content Items").

Sets he integer key of the annotation’s entry in the structural parent tree (see ISO-320001 14.7.4.4, "Finding Structure Elements from Content Items"). Note: Normally, there is no need to take care of this manually, struct parent index is set automatically if annotation is added to the tagged document's page.

Parameters
structParentIndex integer which is to be the key of the annotation's entry in structural parent tree.
Returns
this PdfAnnotation instance.

◆ SetTitle()

virtual iText.Kernel.Pdf.Annot.PdfAnnotation iText.Kernel.Pdf.Annot.PdfAnnotation.SetTitle ( PdfString  title )
inlinevirtual

Sets annotation title.

Sets annotation title. This property affects not all annotation types.

Parameters
title a iText.Kernel.Pdf.PdfString which value is to be annotation title.
Returns
this PdfAnnotation instance.

Member Data Documentation

◆ Accepted

readonly PdfString iText.Kernel.Pdf.Annot.PdfAnnotation.Accepted = new PdfString("Accepted")
static

Annotation state.

Annotation state. See ISO-320001 12.5.6.3 "Annotation States" and Table 171 in particular. Also see PdfTextAnnotation.SetState(iText.Kernel.Pdf.PdfString).

◆ Canceled

readonly PdfString iText.Kernel.Pdf.Annot.PdfAnnotation.Canceled = new PdfString("Cancelled")
static

Annotation state.

Annotation state. See ISO-320001 12.5.6.3 "Annotation States" and Table 171 in particular. Also see PdfTextAnnotation.SetState(iText.Kernel.Pdf.PdfString).

◆ Completed

readonly PdfString iText.Kernel.Pdf.Annot.PdfAnnotation.Completed = new PdfString("Completed")
static

Annotation state.

Annotation state. See ISO-320001 12.5.6.3 "Annotation States" and Table 171 in particular. Also see PdfTextAnnotation.SetState(iText.Kernel.Pdf.PdfString).

◆ HIDDEN

const int iText.Kernel.Pdf.Annot.PdfAnnotation.HIDDEN = 2
static

Annotation flag.

Annotation flag. See also SetFlag(int) and ISO-320001, table 165.

◆ HIGHLIGHT_INVERT

readonly PdfName iText.Kernel.Pdf.Annot.PdfAnnotation.HIGHLIGHT_INVERT = PdfName.I
static

Widget annotation highlighting mode.

Widget annotation highlighting mode. See ISO-320001, Table 188 (H key). Also see PdfWidgetAnnotation.SetHighlightMode(iText.Kernel.Pdf.PdfName).

◆ HIGHLIGHT_NONE

readonly PdfName iText.Kernel.Pdf.Annot.PdfAnnotation.HIGHLIGHT_NONE = PdfName.N
static

Widget annotation highlighting mode.

Widget annotation highlighting mode. See ISO-320001, Table 188 (H key). Also see PdfWidgetAnnotation.SetHighlightMode(iText.Kernel.Pdf.PdfName).

◆ HIGHLIGHT_OUTLINE

readonly PdfName iText.Kernel.Pdf.Annot.PdfAnnotation.HIGHLIGHT_OUTLINE = PdfName.O
static

Widget annotation highlighting mode.

Widget annotation highlighting mode. See ISO-320001, Table 188 (H key). Also see PdfWidgetAnnotation.SetHighlightMode(iText.Kernel.Pdf.PdfName).

◆ HIGHLIGHT_PUSH

readonly PdfName iText.Kernel.Pdf.Annot.PdfAnnotation.HIGHLIGHT_PUSH = PdfName.P
static

Widget annotation highlighting mode.

Widget annotation highlighting mode. See ISO-320001, Table 188 (H key). Also see PdfWidgetAnnotation.SetHighlightMode(iText.Kernel.Pdf.PdfName).

◆ HIGHLIGHT_TOGGLE

readonly PdfName iText.Kernel.Pdf.Annot.PdfAnnotation.HIGHLIGHT_TOGGLE = PdfName.T
static

Widget annotation highlighting mode.

Widget annotation highlighting mode. See ISO-320001, Table 188 (H key). Also see PdfWidgetAnnotation.SetHighlightMode(iText.Kernel.Pdf.PdfName).

◆ INVISIBLE

const int iText.Kernel.Pdf.Annot.PdfAnnotation.INVISIBLE = 1
static

Annotation flag.

Annotation flag. See also SetFlag(int) and ISO-320001, table 165.

◆ LOCKED

const int iText.Kernel.Pdf.Annot.PdfAnnotation.LOCKED = 128
static

Annotation flag.

Annotation flag. See also SetFlag(int) and ISO-320001, table 165.

◆ LOCKED_CONTENTS

const int iText.Kernel.Pdf.Annot.PdfAnnotation.LOCKED_CONTENTS = 512
static

Annotation flag.

Annotation flag. See also SetFlag(int) and ISO-320001, table 165.

◆ Marked

readonly PdfString iText.Kernel.Pdf.Annot.PdfAnnotation.Marked = new PdfString("Marked")
static

Annotation state.

Annotation state. See ISO-320001 12.5.6.3 "Annotation States" and Table 171 in particular. Also see PdfTextAnnotation.SetState(iText.Kernel.Pdf.PdfString).

◆ MarkedModel

readonly PdfString iText.Kernel.Pdf.Annot.PdfAnnotation.MarkedModel = new PdfString("Marked")
static

Annotation state model.

Annotation state model. See ISO-320001, Table 172 (StateModel key). Also see PdfTextAnnotation.SetStateModel(iText.Kernel.Pdf.PdfString).

◆ NO_ROTATE

const int iText.Kernel.Pdf.Annot.PdfAnnotation.NO_ROTATE = 16
static

Annotation flag.

Annotation flag. See also SetFlag(int) and ISO-320001, table 165.

◆ NO_VIEW

const int iText.Kernel.Pdf.Annot.PdfAnnotation.NO_VIEW = 32
static

Annotation flag.

Annotation flag. See also SetFlag(int) and ISO-320001, table 165.

◆ NO_ZOOM

const int iText.Kernel.Pdf.Annot.PdfAnnotation.NO_ZOOM = 8
static

Annotation flag.

Annotation flag. See also SetFlag(int) and ISO-320001, table 165.

◆ None

readonly PdfString iText.Kernel.Pdf.Annot.PdfAnnotation.None = new PdfString("None")
static

Annotation state.

Annotation state. See ISO-320001 12.5.6.3 "Annotation States" and Table 171 in particular. Also see PdfTextAnnotation.SetState(iText.Kernel.Pdf.PdfString).

◆ PRINT

const int iText.Kernel.Pdf.Annot.PdfAnnotation.PRINT = 4
static

Annotation flag.

Annotation flag. See also SetFlag(int) and ISO-320001, table 165.

◆ READ_ONLY

const int iText.Kernel.Pdf.Annot.PdfAnnotation.READ_ONLY = 64
static

Annotation flag.

Annotation flag. See also SetFlag(int) and ISO-320001, table 165.

◆ Rejected

readonly PdfString iText.Kernel.Pdf.Annot.PdfAnnotation.Rejected = new PdfString("Rejected")
static

Annotation state.

Annotation state. See ISO-320001 12.5.6.3 "Annotation States" and Table 171 in particular. Also see PdfTextAnnotation.SetState(iText.Kernel.Pdf.PdfString).

◆ ReviewModel

readonly PdfString iText.Kernel.Pdf.Annot.PdfAnnotation.ReviewModel = new PdfString("Review")
static

Annotation state model.

Annotation state model. See ISO-320001, Table 172 (StateModel key). Also see PdfTextAnnotation.SetStateModel(iText.Kernel.Pdf.PdfString).

◆ STYLE_BEVELED

readonly PdfName iText.Kernel.Pdf.Annot.PdfAnnotation.STYLE_BEVELED = PdfName.B
static

Annotation border style.

Annotation border style. See ISO-320001, Table 166 (S key).

◆ STYLE_DASHED

readonly PdfName iText.Kernel.Pdf.Annot.PdfAnnotation.STYLE_DASHED = PdfName.D
static

Annotation border style.

Annotation border style. See ISO-320001, Table 166 (S key).

◆ STYLE_INSET

readonly PdfName iText.Kernel.Pdf.Annot.PdfAnnotation.STYLE_INSET = PdfName.I
static

Annotation border style.

Annotation border style. See ISO-320001, Table 166 (S key).

◆ STYLE_SOLID

readonly PdfName iText.Kernel.Pdf.Annot.PdfAnnotation.STYLE_SOLID = PdfName.S
static

Annotation border style.

Annotation border style. See ISO-320001, Table 166 (S key).

◆ STYLE_UNDERLINE

readonly PdfName iText.Kernel.Pdf.Annot.PdfAnnotation.STYLE_UNDERLINE = PdfName.U
static

Annotation border style.

Annotation border style. See ISO-320001, Table 166 (S key).

◆ TOGGLE_NO_VIEW

const int iText.Kernel.Pdf.Annot.PdfAnnotation.TOGGLE_NO_VIEW = 256
static

Annotation flag.

Annotation flag. See also SetFlag(int) and ISO-320001, table 165.

◆ Unmarked

readonly PdfString iText.Kernel.Pdf.Annot.PdfAnnotation.Unmarked = new PdfString("Unmarked")
static

Annotation state.

Annotation state. See ISO-320001 12.5.6.3 "Annotation States" and Table 171 in particular. Also see PdfTextAnnotation.SetState(iText.Kernel.Pdf.PdfString).