iText 5

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

Type

Name

Methods

PdfDictionary

MK

get

Methods

Public Static methods

Returns

Name

PdfAnnotation

CreateFileAttachment

(...)

PdfAnnotation

CreateFreeText

(

PdfWriter

writer,

Rectangle

rect, string contents,

PdfContentByte

defaultAppearance)

PdfAnnotation

CreateInk

(

PdfWriter

writer,

Rectangle

rect, string contents, float``[][] inkList)

PdfAnnotation

CreateLine

(

PdfWriter

writer,

Rectangle

rect, string contents, float x1, float y1, float x2, float y2)

PdfAnnotation

CreateLink

(...)

PdfAnnotation

CreateMarkup

(

PdfWriter

writer,

Rectangle

rect, string contents, int type, float``[] quadPoints)

PdfAnnotation

CreatePolygonPolyline

(

PdfWriter

writer,

Rectangle

rect, string contents, bool polygon,

PdfArray

vertices)

PdfAnnotation

CreatePopup

(

PdfWriter

writer,

Rectangle

rect, string contents, bool open)

PdfAnnotation

CreateScreen

(

PdfWriter

writer,

Rectangle

rect, string clipTitle,

PdfFileSpecification

fs, string mimeType, bool playOnDisplay)

PdfAnnotation

CreateSquareCircle

(

PdfWriter

writer,

Rectangle

rect, string contents, bool square)

PdfAnnotation

CreateStamp

(

PdfWriter

writer,

Rectangle

rect, string contents, string name)

PdfAnnotation

CreateText

(

PdfWriter

writer,

Rectangle

rect, string title, string contents, bool open, string icon)

PdfArray

GetMKColor

(

BaseColor

color)

PdfAnnotation

ShallowDuplicate

(

PdfAnnotation

annot)

Protected Static methods
Public methods

Returns

Name

void

ApplyCTM

(...)

PdfObject

GetAccessibleAttribute

(

PdfName

key)

Dictionary<

PdfName

,

PdfObject

>

GetAccessibleAttributes

()

HashSet2<

PdfTemplate

>

GetTemplates

()

bool

IsAnnotation

()

bool

IsForm

()

void

SetAccessibleAttribute

(

PdfName

key,

PdfObject

value)

void

SetAdditionalActions

(

PdfName

key,

PdfAction

action)

void

SetAppearance

(...)

void

SetHighlighting

(

PdfName

highlight)

void

SetMKIconFit

(

PdfName

scale,

PdfName

scalingType, float leftoverLeft, float leftoverBottom, bool fitInBounds)

void

SetPage

()

void

SetUsed

()

void

ToPdf

(

PdfWriter

writer, Stream os)

Internal methods

Returns

Name

bool

IsUsed

()

Details

Inheritance

Nested types

Classes
  • PdfImportedLink

Constructors

PdfAnnotation [1/3]

Source code

public PdfAnnotation(PdfWriter writer, Rectangle rect)

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

PdfAnnotation [2/3]

Source code

public PdfAnnotation(PdfWriter writer, float llx, float lly, float urx, float ury, PdfString title, PdfString content)

Arguments

Type

Name

Description

PdfWriter

writer

float

llx

float

lly

float

urx

float

ury

PdfString

title

PdfString

content

PdfAnnotation [3/3]

Source code

public PdfAnnotation(PdfWriter writer, float llx, float lly, float urx, float ury, PdfAction action)

Arguments

Type

Name

Description

PdfWriter

writer

float

llx

float

lly

float

urx

float

ury

PdfAction

action

Methods

CreateScreen

Source code

public static PdfAnnotation CreateScreen(PdfWriter writer, Rectangle rect, string clipTitle, PdfFileSpecification fs, string mimeType, bool playOnDisplay)

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

string

clipTitle

PdfFileSpecification

fs

string

mimeType

bool

playOnDisplay

CreateText

Source code

public static PdfAnnotation CreateText(PdfWriter writer, Rectangle rect, string title, string contents, bool open, string icon)

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

string

title

string

contents

bool

open

string

icon

Source code

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

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

PdfName

highlight

Source code

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

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

PdfName

highlight

PdfAction

action

Source code

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

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

PdfName

highlight

string

namedDestination

Source code

public static PdfAnnotation CreateLink(PdfWriter writer, Rectangle rect, PdfName highlight, int page, PdfDestination dest)

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

PdfName

highlight

int

page

PdfDestination

dest

CreateFreeText

Source code

public static PdfAnnotation CreateFreeText(PdfWriter writer, Rectangle rect, string contents, PdfContentByte defaultAppearance)

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

string

contents

PdfContentByte

defaultAppearance

CreateLine

Source code

public static PdfAnnotation CreateLine(PdfWriter writer, Rectangle rect, string contents, float x1, float y1, float x2, float y2)

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

string

contents

float

x1

float

y1

float

x2

float

y2

CreateSquareCircle

Source code

public static PdfAnnotation CreateSquareCircle(PdfWriter writer, Rectangle rect, string contents, bool square)

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

string

contents

bool

square

CreateMarkup

Source code

public static PdfAnnotation CreateMarkup(PdfWriter writer, Rectangle rect, string contents, int type, float[] quadPoints)

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

string

contents

int

type

float``[]

quadPoints

CreateStamp

Source code

public static PdfAnnotation CreateStamp(PdfWriter writer, Rectangle rect, string contents, string name)

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

string

contents

string

name

CreateInk

Source code

public static PdfAnnotation CreateInk(PdfWriter writer, Rectangle rect, string contents, float[][] inkList)

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

string

contents

float``[][]

inkList

CreateFileAttachment [1/2]

Source code

public static PdfAnnotation CreateFileAttachment(PdfWriter writer, Rectangle rect, string contents, byte[] fileStore, string file, string fileDisplay)

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

string

contents

byte``[]

fileStore

string

file

string

fileDisplay

CreateFileAttachment [2/2]

Source code

public static PdfAnnotation CreateFileAttachment(PdfWriter writer, Rectangle rect, string contents, PdfFileSpecification fs)

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

string

contents

PdfFileSpecification

fs

CreatePopup

Source code

public static PdfAnnotation CreatePopup(PdfWriter writer, Rectangle rect, string contents, bool open)

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

string

contents

bool

open

CreatePolygonPolyline

Source code

public static PdfAnnotation CreatePolygonPolyline(PdfWriter writer, Rectangle rect, string contents, bool polygon, PdfArray vertices)

Arguments

Type

Name

Description

PdfWriter

writer

Rectangle

rect

string

contents

bool

polygon

PdfArray

vertices

SetHighlighting

Source code

public virtual void SetHighlighting(PdfName highlight)

Arguments

Type

Name

Description

PdfName

highlight

SetAppearance [1/2]

Source code

public virtual void SetAppearance(PdfName ap, PdfTemplate template)

Arguments

Type

Name

Description

PdfName

ap

PdfTemplate

template

SetAppearance [2/2]

Source code

public virtual void SetAppearance(PdfName ap, string state, PdfTemplate template)

Arguments

Type

Name

Description

PdfName

ap

string

state

PdfTemplate

template

SetAdditionalActions

Source code

public virtual void SetAdditionalActions(PdfName key, PdfAction action)

Arguments

Type

Name

Description

PdfName

key

PdfAction

action

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

Type

Name

Description

PdfAnnotation

annot

GetMKColor

Source code

public static PdfArray GetMKColor(BaseColor color)

Arguments

Type

Name

Description

BaseColor

color

SetMKIconFit

Source code

public virtual void SetMKIconFit(PdfName scale, PdfName scalingType, float leftoverLeft, float leftoverBottom, bool fitInBounds)

Arguments

Type

Name

Description

PdfName

scale

PdfName

scalingType

float

leftoverLeft

float

leftoverBottom

bool

fitInBounds

ApplyCTM [1/2]

Source code

public virtual void ApplyCTM(AffineTransform ctm)

Arguments

Type

Name

Description

AffineTransform

ctm

ApplyCTM [2/2]

Source code

public void ApplyCTM(Matrix ctm)

Arguments

Type

Name

Description

Matrix

ctm

ToPdf

Source code

public override void ToPdf(PdfWriter writer, Stream os)

Arguments

Type

Name

Description

PdfWriter

writer

Stream

os

GetAccessibleAttribute

Source code

public virtual PdfObject GetAccessibleAttribute(PdfName key)

Arguments

Type

Name

Description

PdfName

key

SetAccessibleAttribute

Source code

public virtual void SetAccessibleAttribute(PdfName key, PdfObject value)

Arguments

Type

Name

Description

PdfName

key

PdfObject

value

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; }

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