Skip to main content
Skip table of contents

PdfAnnotation (1)

PdfAnnotation Public class

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph iTextSharp.text.pdf
  iTextSharp.text.pdf.PdfAnnotation[[PdfAnnotation]]
  iTextSharp.text.pdf.PdfDictionary[[PdfDictionary]]
  end
  subgraph iTextSharp.text.pdf.interfaces
  iTextSharp.text.pdf.interfaces.IAccessibleElement[[IAccessibleElement]]
  class iTextSharp.text.pdf.interfaces.IAccessibleElement interfaceStyle;
  end
iTextSharp.text.pdf.interfaces.IAccessibleElement --> iTextSharp.text.pdf.PdfAnnotation
iTextSharp.text.pdf.PdfDictionary --> iTextSharp.text.pdf.PdfAnnotation

Members

Properties

Public properties
Internal properties
TypeNameMethods
PdfDictionaryMKget

Methods

Public Static methods
ReturnsName
PdfAnnotationCreateFileAttachment(...)
PdfAnnotationCreateFreeText(PdfWriter writer, Rectangle rect, string contents, PdfContentByte defaultAppearance)
PdfAnnotationCreateInk(PdfWriter writer, Rectangle rect, string contents, float``[][] inkList)
PdfAnnotationCreateLine(PdfWriter writer, Rectangle rect, string contents, float x1, float y1, float x2, float y2)
PdfAnnotationCreateLink(...)
PdfAnnotationCreateMarkup(PdfWriter writer, Rectangle rect, string contents, int type, float``[] quadPoints)
PdfAnnotationCreatePolygonPolyline(PdfWriter writer, Rectangle rect, string contents, bool polygon, PdfArray vertices)
PdfAnnotationCreatePopup(PdfWriter writer, Rectangle rect, string contents, bool open)
PdfAnnotationCreateScreen(PdfWriter writer, Rectangle rect, string clipTitle, PdfFileSpecification fs, string mimeType, bool playOnDisplay)
PdfAnnotationCreateSquareCircle(PdfWriter writer, Rectangle rect, string contents, bool square)
PdfAnnotationCreateStamp(PdfWriter writer, Rectangle rect, string contents, string name)
PdfAnnotationCreateText(PdfWriter writer, Rectangle rect, string title, string contents, bool open, string icon)
PdfArrayGetMKColor(BaseColor color)
PdfAnnotationShallowDuplicate(PdfAnnotation annot)
Protected Static methods
ReturnsName
PdfAnnotationCreateLink(PdfWriter writer, Rectangle rect, PdfName highlight)
Public methods
ReturnsName
voidApplyCTM(...)
PdfObjectGetAccessibleAttribute(PdfName key)
Dictionary<PdfName, PdfObject>GetAccessibleAttributes()
HashSet2<PdfTemplate>GetTemplates()
boolIsAnnotation()
boolIsForm()
voidSetAccessibleAttribute(PdfName key, PdfObject value)
voidSetAdditionalActions(PdfName key, PdfAction action)
voidSetAppearance(...)
voidSetHighlighting(PdfName highlight)
voidSetMKIconFit(PdfName scale, PdfName scalingType, float leftoverLeft, float leftoverBottom, bool fitInBounds)
voidSetPage()
voidSetUsed()
voidToPdf(PdfWriter writer, Stream os)
Internal methods
ReturnsName
boolIsUsed()

Details

Inheritance

Nested types

Classes
  • PdfImportedLink

Constructors

PdfAnnotation [1/3]

Source code

public PdfAnnotation(PdfWriter writer, Rectangle rect)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
PdfAnnotation [2/3]

Source code

public PdfAnnotation(PdfWriter writer, float llx, float lly, float urx, float ury, PdfString title, PdfString content)
Arguments
TypeNameDescription
PdfWriterwriter
floatllx
floatlly
floaturx
floatury
PdfStringtitle
PdfStringcontent
PdfAnnotation [3/3]

Source code

public PdfAnnotation(PdfWriter writer, float llx, float lly, float urx, float ury, PdfAction action)
Arguments
TypeNameDescription
PdfWriterwriter
floatllx
floatlly
floaturx
floatury
PdfActionaction

Methods

CreateScreen

Source code

public static PdfAnnotation CreateScreen(PdfWriter writer, Rectangle rect, string clipTitle, PdfFileSpecification fs, string mimeType, bool playOnDisplay)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
stringclipTitle
PdfFileSpecificationfs
stringmimeType
boolplayOnDisplay
CreateText

Source code

public static PdfAnnotation CreateText(PdfWriter writer, Rectangle rect, string title, string contents, bool open, string icon)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
stringtitle
stringcontents
boolopen
stringicon
CreateLink [1/4]

Source code

protected static PdfAnnotation CreateLink(PdfWriter writer, Rectangle rect, PdfName highlight)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
PdfNamehighlight
CreateLink [2/4]

Source code

public static PdfAnnotation CreateLink(PdfWriter writer, Rectangle rect, PdfName highlight, PdfAction action)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
PdfNamehighlight
PdfActionaction
CreateLink [3/4]

Source code

public static PdfAnnotation CreateLink(PdfWriter writer, Rectangle rect, PdfName highlight, string namedDestination)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
PdfNamehighlight
stringnamedDestination
CreateLink [4/4]

Source code

public static PdfAnnotation CreateLink(PdfWriter writer, Rectangle rect, PdfName highlight, int page, PdfDestination dest)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
PdfNamehighlight
intpage
PdfDestinationdest
CreateFreeText

Source code

public static PdfAnnotation CreateFreeText(PdfWriter writer, Rectangle rect, string contents, PdfContentByte defaultAppearance)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
stringcontents
PdfContentBytedefaultAppearance
CreateLine

Source code

public static PdfAnnotation CreateLine(PdfWriter writer, Rectangle rect, string contents, float x1, float y1, float x2, float y2)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
stringcontents
floatx1
floaty1
floatx2
floaty2
CreateSquareCircle

Source code

public static PdfAnnotation CreateSquareCircle(PdfWriter writer, Rectangle rect, string contents, bool square)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
stringcontents
boolsquare
CreateMarkup

Source code

public static PdfAnnotation CreateMarkup(PdfWriter writer, Rectangle rect, string contents, int type, float[] quadPoints)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
stringcontents
inttype
float``[]quadPoints
CreateStamp

Source code

public static PdfAnnotation CreateStamp(PdfWriter writer, Rectangle rect, string contents, string name)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
stringcontents
stringname
CreateInk

Source code

public static PdfAnnotation CreateInk(PdfWriter writer, Rectangle rect, string contents, float[][] inkList)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
stringcontents
float``[][]inkList
CreateFileAttachment [1/2]

Source code

public static PdfAnnotation CreateFileAttachment(PdfWriter writer, Rectangle rect, string contents, byte[] fileStore, string file, string fileDisplay)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
stringcontents
byte``[]fileStore
stringfile
stringfileDisplay
CreateFileAttachment [2/2]

Source code

public static PdfAnnotation CreateFileAttachment(PdfWriter writer, Rectangle rect, string contents, PdfFileSpecification fs)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
stringcontents
PdfFileSpecificationfs
CreatePopup

Source code

public static PdfAnnotation CreatePopup(PdfWriter writer, Rectangle rect, string contents, bool open)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
stringcontents
boolopen
CreatePolygonPolyline

Source code

public static PdfAnnotation CreatePolygonPolyline(PdfWriter writer, Rectangle rect, string contents, bool polygon, PdfArray vertices)
Arguments
TypeNameDescription
PdfWriterwriter
Rectanglerect
stringcontents
boolpolygon
PdfArrayvertices
SetHighlighting

Source code

public virtual void SetHighlighting(PdfName highlight)
Arguments
TypeNameDescription
PdfNamehighlight
SetAppearance [1/2]

Source code

public virtual void SetAppearance(PdfName ap, PdfTemplate template)
Arguments
TypeNameDescription
PdfNameap
PdfTemplatetemplate
SetAppearance [2/2]

Source code

public virtual void SetAppearance(PdfName ap, string state, PdfTemplate template)
Arguments
TypeNameDescription
PdfNameap
stringstate
PdfTemplatetemplate
SetAdditionalActions

Source code

public virtual void SetAdditionalActions(PdfName key, PdfAction action)
Arguments
TypeNameDescription
PdfNamekey
PdfActionaction
IsUsed

Source code

internal virtual bool IsUsed()
SetUsed

Source code

public virtual void SetUsed()
GetTemplates

Source code

public virtual HashSet2<PdfTemplate> GetTemplates()
IsForm

Source code

public virtual bool IsForm()
IsAnnotation

Source code

public virtual bool IsAnnotation()
SetPage

Source code

public virtual void SetPage()
ShallowDuplicate

Source code

public static PdfAnnotation ShallowDuplicate(PdfAnnotation annot)
Arguments
TypeNameDescription
PdfAnnotationannot
GetMKColor

Source code

public static PdfArray GetMKColor(BaseColor color)
Arguments
TypeNameDescription
BaseColorcolor
SetMKIconFit

Source code

public virtual void SetMKIconFit(PdfName scale, PdfName scalingType, float leftoverLeft, float leftoverBottom, bool fitInBounds)
Arguments
TypeNameDescription
PdfNamescale
PdfNamescalingType
floatleftoverLeft
floatleftoverBottom
boolfitInBounds
ApplyCTM [1/2]

Source code

public virtual void ApplyCTM(AffineTransform ctm)
Arguments
TypeNameDescription
AffineTransformctm
ApplyCTM [2/2]

Source code

public void ApplyCTM(Matrix ctm)
Arguments
TypeNameDescription
Matrixctm
ToPdf

Source code

public override void ToPdf(PdfWriter writer, Stream os)
Arguments
TypeNameDescription
PdfWriterwriter
Streamos
GetAccessibleAttribute

Source code

public virtual PdfObject GetAccessibleAttribute(PdfName key)
Arguments
TypeNameDescription
PdfNamekey
SetAccessibleAttribute

Source code

public virtual void SetAccessibleAttribute(PdfName key, PdfObject value)
Arguments
TypeNameDescription
PdfNamekey
PdfObjectvalue
GetAccessibleAttributes

Source code

public virtual Dictionary<PdfName, PdfObject> GetAccessibleAttributes()

Properties

IndirectReference
public virtual PdfIndirectReference IndirectReference { get; }
DefaultAppearanceString
public virtual PdfContentByte DefaultAppearanceString { set; }
Flags
public virtual int Flags { set; }
Border
public virtual PdfBorderArray Border { set; }
BorderStyle
public virtual PdfBorderDictionary BorderStyle { set; }
AppearanceState
public virtual string AppearanceState { set; }
Color
public virtual BaseColor Color { set; }
Title
public virtual string Title { set; }
Popup
public virtual PdfAnnotation Popup { set; }
Action
public virtual PdfAction Action { set; }
Templates
public virtual Dictionary<PdfTemplate, object> Templates { get; }
Page
public virtual int Page { set; }
PlaceInPage
public virtual int PlaceInPage { get; set; }
Rotate
public virtual int Rotate { set; }
MK
internal PdfDictionary MK { get; }
MKRotation
public virtual int MKRotation { set; }
MKBorderColor
public virtual BaseColor MKBorderColor { set; }
MKBackgroundColor
public virtual BaseColor MKBackgroundColor { set; }
MKNormalCaption
public virtual string MKNormalCaption { set; }
MKRolloverCaption
public virtual string MKRolloverCaption { set; }
MKAlternateCaption
public virtual string MKAlternateCaption { set; }
MKNormalIcon
public virtual PdfTemplate MKNormalIcon { set; }
MKRolloverIcon
public virtual PdfTemplate MKRolloverIcon { set; }
MKAlternateIcon
public virtual PdfTemplate MKAlternateIcon { set; }
MKTextPosition
public virtual int MKTextPosition { set; }
Layer
public virtual IPdfOCG Layer { set; }
Name
public virtual string Name { set; }
Role
public virtual PdfName Role { get; set; }
ID
public virtual AccessibleElementId ID { get; set; }
IsInline
public virtual bool IsInline { get; }

Generated with ModularDoc

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.