HiraokaHyperTools.iTextSharp-LGPL  0.2.5
iTextSharp.text.pdf.PdfAnnotation Class Reference
Inheritance diagram for iTextSharp.text.pdf.PdfAnnotation:
iTextSharp.text.pdf.PdfDictionary iTextSharp.text.pdf.PdfObject iTextSharp.text.pdf.PdfFormField

Classes

class  PdfImportedLink
 

Public Member Functions

 PdfAnnotation (PdfWriter writer, Rectangle rect)
 
 PdfAnnotation (PdfWriter writer, float llx, float lly, float urx, float ury, PdfString title, PdfString content)
 
 PdfAnnotation (PdfWriter writer, float llx, float lly, float urx, float ury, PdfAction action)
 
void SetHighlighting (PdfName highlight)
 
void SetAppearance (PdfName ap, PdfTemplate template)
 
void SetAppearance (PdfName ap, string state, PdfTemplate template)
 
void SetAdditionalActions (PdfName key, PdfAction action)
 
virtual void SetUsed ()
 
bool IsForm ()
 
bool IsAnnotation ()
 
void SetPage ()
 
void SetMKIconFit (PdfName scale, PdfName scalingType, float leftoverLeft, float leftoverBottom, bool fitInBounds)
 
- Public Member Functions inherited from iTextSharp.text.pdf.PdfDictionary
 PdfDictionary ()
 
 PdfDictionary (PdfName type)
 
override void ToPdf (PdfWriter writer, Stream os)
 
void Put (PdfName key, PdfObject value)
 
void PutEx (PdfName key, PdfObject value)
 
void Remove (PdfName key)
 
PdfObject Get (PdfName key)
 
bool IsFont ()
 
bool IsPage ()
 
bool IsPages ()
 
bool IsCatalog ()
 
bool IsOutlineTree ()
 
void Merge (PdfDictionary other)
 
void MergeDifferent (PdfDictionary other)
 
bool Contains (PdfName key)
 
virtual IDictionaryEnumerator GetEnumerator ()
 
override String ToString ()
 
PdfObject GetDirectObject (PdfName key)
 
PdfDictionary GetAsDict (PdfName key)
 
PdfArray GetAsArray (PdfName key)
 
PdfStream GetAsStream (PdfName key)
 
PdfString GetAsString (PdfName key)
 
PdfNumber GetAsNumber (PdfName key)
 
PdfName GetAsName (PdfName key)
 
PdfBoolean GetAsBoolean (PdfName key)
 
PdfIndirectReference GetAsIndirectObject (PdfName key)
 
- Public Member Functions inherited from iTextSharp.text.pdf.PdfObject
virtual byte[] GetBytes ()
 
bool CanBeInObjStm ()
 
override string ToString ()
 
bool IsNull ()
 
bool IsBoolean ()
 
bool IsNumber ()
 
bool IsString ()
 
bool IsName ()
 
bool IsArray ()
 
bool IsDictionary ()
 
bool IsStream ()
 
bool IsIndirect ()
 

Static Public Member Functions

static PdfAnnotation CreateScreen (PdfWriter writer, Rectangle rect, String clipTitle, PdfFileSpecification fs, String mimeType, bool playOnDisplay)
 
static PdfAnnotation CreateText (PdfWriter writer, Rectangle rect, string title, string contents, bool open, string icon)
 
static PdfAnnotation CreateLink (PdfWriter writer, Rectangle rect, PdfName highlight, PdfAction action)
 
static PdfAnnotation CreateLink (PdfWriter writer, Rectangle rect, PdfName highlight, string namedDestination)
 
static PdfAnnotation CreateLink (PdfWriter writer, Rectangle rect, PdfName highlight, int page, PdfDestination dest)
 
static PdfAnnotation CreateFreeText (PdfWriter writer, Rectangle rect, string contents, PdfContentByte defaultAppearance)
 
static PdfAnnotation CreateLine (PdfWriter writer, Rectangle rect, string contents, float x1, float y1, float x2, float y2)
 
static PdfAnnotation CreateSquareCircle (PdfWriter writer, Rectangle rect, string contents, bool square)
 
static PdfAnnotation CreateMarkup (PdfWriter writer, Rectangle rect, string contents, int type, float[] quadPoints)
 
static PdfAnnotation CreateStamp (PdfWriter writer, Rectangle rect, string contents, string name)
 
static PdfAnnotation CreateInk (PdfWriter writer, Rectangle rect, string contents, float[][] inkList)
 
static PdfAnnotation CreateFileAttachment (PdfWriter writer, Rectangle rect, String contents, byte[] fileStore, String file, String fileDisplay)
 
static PdfAnnotation CreateFileAttachment (PdfWriter writer, Rectangle rect, String contents, PdfFileSpecification fs)
 
static PdfAnnotation CreatePopup (PdfWriter writer, Rectangle rect, string contents, bool open)
 
static PdfAnnotation ShallowDuplicate (PdfAnnotation annot)
 
static PdfArray GetMKColor (Color color)
 
static PdfAnnotation CreatePolygonPolyline (PdfWriter writer, Rectangle rect, string contents, bool polygon, PdfArray vertices)
 

Static Public Attributes

static readonly PdfName HIGHLIGHT_NONE = PdfName.N
 
static readonly PdfName HIGHLIGHT_INVERT = PdfName.I
 
static readonly PdfName HIGHLIGHT_OUTLINE = PdfName.O
 
static readonly PdfName HIGHLIGHT_PUSH = PdfName.P
 
static readonly PdfName HIGHLIGHT_TOGGLE = PdfName.T
 
const int FLAGS_INVISIBLE = 1
 
const int FLAGS_HIDDEN = 2
 
const int FLAGS_PRINT = 4
 
const int FLAGS_NOZOOM = 8
 
const int FLAGS_NOROTATE = 16
 
const int FLAGS_NOVIEW = 32
 
const int FLAGS_READONLY = 64
 
const int FLAGS_LOCKED = 128
 
const int FLAGS_TOGGLENOVIEW = 256
 
static readonly PdfName APPEARANCE_NORMAL = PdfName.N
 
static readonly PdfName APPEARANCE_ROLLOVER = PdfName.R
 
static readonly PdfName APPEARANCE_DOWN = PdfName.D
 
static readonly PdfName AA_ENTER = PdfName.E
 
static readonly PdfName AA_EXIT = PdfName.X
 
static readonly PdfName AA_DOWN = PdfName.D
 
static readonly PdfName AA_UP = PdfName.U
 
static readonly PdfName AA_FOCUS = PdfName.FO
 
static readonly PdfName AA_BLUR = PdfName.BL
 
static readonly PdfName AA_JS_KEY = PdfName.K
 
static readonly PdfName AA_JS_FORMAT = PdfName.F
 
static readonly PdfName AA_JS_CHANGE = PdfName.V
 
static readonly PdfName AA_JS_OTHER_CHANGE = PdfName.C
 
const int MARKUP_HIGHLIGHT = 0
 
const int MARKUP_UNDERLINE = 1
 
const int MARKUP_STRIKEOUT = 2
 
const int MARKUP_SQUIGGLY = 3
 
- Static Public Attributes inherited from iTextSharp.text.pdf.PdfDictionary
static PdfName FONT = PdfName.FONT
 
static PdfName OUTLINES = PdfName.OUTLINES
 
static PdfName PAGE = PdfName.PAGE
 
static PdfName PAGES = PdfName.PAGES
 
static PdfName CATALOG = PdfName.CATALOG
 
- Static Public Attributes inherited from iTextSharp.text.pdf.PdfObject
const int BOOLEAN = 1
 
const int NUMBER = 2
 
const int STRING = 3
 
const int NAME = 4
 
const int ARRAY = 5
 
const int DICTIONARY = 6
 
const int STREAM = 7
 
const int NULL = 8
 
const int INDIRECT = 10
 
const string NOTHING = ""
 
const string TEXT_PDFDOCENCODING = "PDF"
 
const string TEXT_UNICODE = "UnicodeBig"
 

Static Protected Member Functions

static PdfAnnotation CreateLink (PdfWriter writer, Rectangle rect, PdfName highlight)
 

Properties

PdfIndirectReference IndirectReference [get]
 
PdfContentByte DefaultAppearanceString [set]
 
int Flags [set]
 
PdfBorderArray Border [set]
 
PdfBorderDictionary BorderStyle [set]
 
string AppearanceState [set]
 
Color Color [set]
 
string Title [set]
 
PdfAnnotation Popup [set]
 
PdfAction Action [set]
 
Hashtable Templates [get]
 
int Page [set]
 
int PlaceInPage [get, set]
 
int Rotate [set]
 
int MKRotation [set]
 
Color MKBorderColor [set]
 
Color MKBackgroundColor [set]
 
string MKNormalCaption [set]
 
string MKRolloverCaption [set]
 
string MKAlternateCaption [set]
 
PdfTemplate MKNormalIcon [set]
 
PdfTemplate MKRolloverIcon [set]
 
PdfTemplate MKAlternateIcon [set]
 
int MKTextPosition [set]
 
IPdfOCG Layer [set]
 
String Name [set]
 
- Properties inherited from iTextSharp.text.pdf.PdfDictionary
ICollection Keys [get]
 
int Size [get]
 
- Properties inherited from iTextSharp.text.pdf.PdfObject
int Length [get]
 
string Content [set]
 
int Type [get]
 
PRIndirectReference IndRef [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from iTextSharp.text.pdf.PdfObject
 PdfObject (int type)
 
 PdfObject (int type, string content)
 
 PdfObject (int type, byte[] bytes)
 
- Protected Attributes inherited from iTextSharp.text.pdf.PdfObject
byte[] bytes
 
int type
 
PRIndirectReference indRef
 

Detailed Description

A PdfAnnotation is a note that is associated with a page.

See also
PdfDictionary

Constructor & Destructor Documentation

◆ PdfAnnotation() [1/3]

iTextSharp.text.pdf.PdfAnnotation.PdfAnnotation ( PdfWriter  writer,
Rectangle  rect 
)

◆ PdfAnnotation() [2/3]

iTextSharp.text.pdf.PdfAnnotation.PdfAnnotation ( PdfWriter  writer,
float  llx,
float  lly,
float  urx,
float  ury,
PdfString  title,
PdfString  content 
)

Constructs a new PdfAnnotation of subtype text.

◆ PdfAnnotation() [3/3]

iTextSharp.text.pdf.PdfAnnotation.PdfAnnotation ( PdfWriter  writer,
float  llx,
float  lly,
float  urx,
float  ury,
PdfAction  action 
)

Constructs a new PdfAnnotation of subtype link (Action).

Member Function Documentation

◆ CreateFileAttachment() [1/2]

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreateFileAttachment ( PdfWriter  writer,
Rectangle  rect,
String  contents,
byte[]  fileStore,
String  file,
String  fileDisplay 
)
static

Creates a file attachment annotation.

Parameters
writerthe PdfWriter
rectthe dimensions in the page of the annotation
contentsthe file description
fileStorean array with the file. If it's null the file will be read from the disk
filethe path to the file. It will only be used if fileStore is not null
fileDisplaythe actual file name stored in the pdf
Exceptions
IOExceptionon error
Returns
the annotation

◆ CreateFileAttachment() [2/2]

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreateFileAttachment ( PdfWriter  writer,
Rectangle  rect,
String  contents,
PdfFileSpecification  fs 
)
static

Creates a file attachment annotation

Parameters
writer
rect
contents
fs
Returns
the annotation
Exceptions
IOException

◆ CreateFreeText()

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreateFreeText ( PdfWriter  writer,
Rectangle  rect,
string  contents,
PdfContentByte  defaultAppearance 
)
static

◆ CreateInk()

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreateInk ( PdfWriter  writer,
Rectangle  rect,
string  contents,
float  inkList[][] 
)
static

◆ CreateLine()

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreateLine ( PdfWriter  writer,
Rectangle  rect,
string  contents,
float  x1,
float  y1,
float  x2,
float  y2 
)
static

◆ CreateLink() [1/4]

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreateLink ( PdfWriter  writer,
Rectangle  rect,
PdfName  highlight 
)
staticprotected

◆ CreateLink() [2/4]

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreateLink ( PdfWriter  writer,
Rectangle  rect,
PdfName  highlight,
int  page,
PdfDestination  dest 
)
static

◆ CreateLink() [3/4]

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreateLink ( PdfWriter  writer,
Rectangle  rect,
PdfName  highlight,
PdfAction  action 
)
static

◆ CreateLink() [4/4]

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreateLink ( PdfWriter  writer,
Rectangle  rect,
PdfName  highlight,
string  namedDestination 
)
static

◆ CreateMarkup()

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreateMarkup ( PdfWriter  writer,
Rectangle  rect,
string  contents,
int  type,
float[]  quadPoints 
)
static

◆ CreatePolygonPolyline()

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreatePolygonPolyline ( PdfWriter  writer,
Rectangle  rect,
string  contents,
bool  polygon,
PdfArray  vertices 
)
static

◆ CreatePopup()

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreatePopup ( PdfWriter  writer,
Rectangle  rect,
string  contents,
bool  open 
)
static

◆ CreateScreen()

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreateScreen ( PdfWriter  writer,
Rectangle  rect,
String  clipTitle,
PdfFileSpecification  fs,
String  mimeType,
bool  playOnDisplay 
)
static

Creates a screen PdfAnnotation

Parameters
writer
rect
clipTitle
fs
mimeType
playOnDisplay
Returns
a screen PdfAnnotation
Exceptions
IOException

◆ CreateSquareCircle()

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreateSquareCircle ( PdfWriter  writer,
Rectangle  rect,
string  contents,
bool  square 
)
static

◆ CreateStamp()

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreateStamp ( PdfWriter  writer,
Rectangle  rect,
string  contents,
string  name 
)
static

◆ CreateText()

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.CreateText ( PdfWriter  writer,
Rectangle  rect,
string  title,
string  contents,
bool  open,
string  icon 
)
static

◆ GetMKColor()

static PdfArray iTextSharp.text.pdf.PdfAnnotation.GetMKColor ( Color  color)
static

◆ IsAnnotation()

bool iTextSharp.text.pdf.PdfAnnotation.IsAnnotation ( )

Getter for property annotation.

Returns
Value of property annotation.

◆ IsForm()

bool iTextSharp.text.pdf.PdfAnnotation.IsForm ( )

Getter for property form.

Returns
Value of property form.

◆ SetAdditionalActions()

void iTextSharp.text.pdf.PdfAnnotation.SetAdditionalActions ( PdfName  key,
PdfAction  action 
)

◆ SetAppearance() [1/2]

void iTextSharp.text.pdf.PdfAnnotation.SetAppearance ( PdfName  ap,
PdfTemplate  template 
)

◆ SetAppearance() [2/2]

void iTextSharp.text.pdf.PdfAnnotation.SetAppearance ( PdfName  ap,
string  state,
PdfTemplate  template 
)

◆ SetHighlighting()

void iTextSharp.text.pdf.PdfAnnotation.SetHighlighting ( PdfName  highlight)

Sets the annotation's highlighting mode. The values can be HIGHLIGHT_NONE, HIGHLIGHT_INVERT, HIGHLIGHT_OUTLINE and HIGHLIGHT_PUSH;

Parameters
highlightthe annotation's highlighting mode

◆ SetMKIconFit()

void iTextSharp.text.pdf.PdfAnnotation.SetMKIconFit ( PdfName  scale,
PdfName  scalingType,
float  leftoverLeft,
float  leftoverBottom,
bool  fitInBounds 
)

◆ SetPage()

void iTextSharp.text.pdf.PdfAnnotation.SetPage ( )

◆ SetUsed()

virtual void iTextSharp.text.pdf.PdfAnnotation.SetUsed ( )
virtual

◆ ShallowDuplicate()

static PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.ShallowDuplicate ( PdfAnnotation  annot)
static

Member Data Documentation

◆ AA_BLUR

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.AA_BLUR = PdfName.BL
static

◆ AA_DOWN

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.AA_DOWN = PdfName.D
static

◆ AA_ENTER

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.AA_ENTER = PdfName.E
static

◆ AA_EXIT

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.AA_EXIT = PdfName.X
static

◆ AA_FOCUS

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.AA_FOCUS = PdfName.FO
static

◆ AA_JS_CHANGE

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.AA_JS_CHANGE = PdfName.V
static

◆ AA_JS_FORMAT

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.AA_JS_FORMAT = PdfName.F
static

◆ AA_JS_KEY

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.AA_JS_KEY = PdfName.K
static

◆ AA_JS_OTHER_CHANGE

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.AA_JS_OTHER_CHANGE = PdfName.C
static

◆ AA_UP

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.AA_UP = PdfName.U
static

◆ APPEARANCE_DOWN

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.APPEARANCE_DOWN = PdfName.D
static

◆ APPEARANCE_NORMAL

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.APPEARANCE_NORMAL = PdfName.N
static

◆ APPEARANCE_ROLLOVER

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.APPEARANCE_ROLLOVER = PdfName.R
static

◆ FLAGS_HIDDEN

const int iTextSharp.text.pdf.PdfAnnotation.FLAGS_HIDDEN = 2
static

◆ FLAGS_INVISIBLE

const int iTextSharp.text.pdf.PdfAnnotation.FLAGS_INVISIBLE = 1
static

◆ FLAGS_LOCKED

const int iTextSharp.text.pdf.PdfAnnotation.FLAGS_LOCKED = 128
static

◆ FLAGS_NOROTATE

const int iTextSharp.text.pdf.PdfAnnotation.FLAGS_NOROTATE = 16
static

◆ FLAGS_NOVIEW

const int iTextSharp.text.pdf.PdfAnnotation.FLAGS_NOVIEW = 32
static

◆ FLAGS_NOZOOM

const int iTextSharp.text.pdf.PdfAnnotation.FLAGS_NOZOOM = 8
static

◆ FLAGS_PRINT

const int iTextSharp.text.pdf.PdfAnnotation.FLAGS_PRINT = 4
static

◆ FLAGS_READONLY

const int iTextSharp.text.pdf.PdfAnnotation.FLAGS_READONLY = 64
static

◆ FLAGS_TOGGLENOVIEW

const int iTextSharp.text.pdf.PdfAnnotation.FLAGS_TOGGLENOVIEW = 256
static

◆ HIGHLIGHT_INVERT

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.HIGHLIGHT_INVERT = PdfName.I
static

◆ HIGHLIGHT_NONE

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.HIGHLIGHT_NONE = PdfName.N
static

◆ HIGHLIGHT_OUTLINE

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.HIGHLIGHT_OUTLINE = PdfName.O
static

◆ HIGHLIGHT_PUSH

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.HIGHLIGHT_PUSH = PdfName.P
static

◆ HIGHLIGHT_TOGGLE

readonly PdfName iTextSharp.text.pdf.PdfAnnotation.HIGHLIGHT_TOGGLE = PdfName.T
static

◆ MARKUP_HIGHLIGHT

const int iTextSharp.text.pdf.PdfAnnotation.MARKUP_HIGHLIGHT = 0
static

◆ MARKUP_SQUIGGLY

const int iTextSharp.text.pdf.PdfAnnotation.MARKUP_SQUIGGLY = 3
static

attributevalue

◆ MARKUP_STRIKEOUT

const int iTextSharp.text.pdf.PdfAnnotation.MARKUP_STRIKEOUT = 2
static

◆ MARKUP_UNDERLINE

const int iTextSharp.text.pdf.PdfAnnotation.MARKUP_UNDERLINE = 1
static

Property Documentation

◆ Action

PdfAction iTextSharp.text.pdf.PdfAnnotation.Action
set

◆ AppearanceState

string iTextSharp.text.pdf.PdfAnnotation.AppearanceState
set

◆ Border

PdfBorderArray iTextSharp.text.pdf.PdfAnnotation.Border
set

◆ BorderStyle

PdfBorderDictionary iTextSharp.text.pdf.PdfAnnotation.BorderStyle
set

◆ Color

Color iTextSharp.text.pdf.PdfAnnotation.Color
set

◆ DefaultAppearanceString

PdfContentByte iTextSharp.text.pdf.PdfAnnotation.DefaultAppearanceString
set

◆ Flags

int iTextSharp.text.pdf.PdfAnnotation.Flags
set

◆ IndirectReference

PdfIndirectReference iTextSharp.text.pdf.PdfAnnotation.IndirectReference
get

◆ Layer

IPdfOCG iTextSharp.text.pdf.PdfAnnotation.Layer
set

Sets the layer this annotation belongs to.

Parameters
layerthe layer this annotation belongs to

◆ MKAlternateCaption

string iTextSharp.text.pdf.PdfAnnotation.MKAlternateCaption
set

◆ MKAlternateIcon

PdfTemplate iTextSharp.text.pdf.PdfAnnotation.MKAlternateIcon
set

◆ MKBackgroundColor

Color iTextSharp.text.pdf.PdfAnnotation.MKBackgroundColor
set

◆ MKBorderColor

Color iTextSharp.text.pdf.PdfAnnotation.MKBorderColor
set

◆ MKNormalCaption

string iTextSharp.text.pdf.PdfAnnotation.MKNormalCaption
set

◆ MKNormalIcon

PdfTemplate iTextSharp.text.pdf.PdfAnnotation.MKNormalIcon
set

◆ MKRolloverCaption

string iTextSharp.text.pdf.PdfAnnotation.MKRolloverCaption
set

◆ MKRolloverIcon

PdfTemplate iTextSharp.text.pdf.PdfAnnotation.MKRolloverIcon
set

◆ MKRotation

int iTextSharp.text.pdf.PdfAnnotation.MKRotation
set

◆ MKTextPosition

int iTextSharp.text.pdf.PdfAnnotation.MKTextPosition
set

◆ Name

String iTextSharp.text.pdf.PdfAnnotation.Name
set

Sets the name of the annotation. With this name the annotation can be identified among all the annotations on a page (it has to be unique).

◆ Page

int iTextSharp.text.pdf.PdfAnnotation.Page
set

◆ PlaceInPage

int iTextSharp.text.pdf.PdfAnnotation.PlaceInPage
getset

Getter for property placeInPage.

Returns
Value of property placeInPage.

◆ Popup

PdfAnnotation iTextSharp.text.pdf.PdfAnnotation.Popup
set

◆ Rotate

int iTextSharp.text.pdf.PdfAnnotation.Rotate
set

◆ Templates

Hashtable iTextSharp.text.pdf.PdfAnnotation.Templates
get

◆ Title

string iTextSharp.text.pdf.PdfAnnotation.Title
set

The documentation for this class was generated from the following file: