iTextSharp.text.Annotation Class Reference

An Annotation is a little note that can be added to a page on a document. More...

Inheritance diagram for iTextSharp.text.Annotation:

Public Member Functions
	Annotation (Annotation an)
	Annotation (string title, string text)
	Constructs an Annotation with a certain title and some text. More...
	Annotation (string title, string text, float llx, float lly, float urx, float ury)
	Constructs an Annotation with a certain title and some text. More...
	Annotation (float llx, float lly, float urx, float ury, Uri url)
	Constructs an Annotation. More...
	Annotation (float llx, float lly, float urx, float ury, string url)
	Constructs an Annotation. More...
	Annotation (float llx, float lly, float urx, float ury, string file, string dest)
	Constructs an Annotation. More...
	Annotation (float llx, float lly, float urx, float ury, string moviePath, string mimeType, bool showOnDisplay)
	Creates a Screen anotation to embed media clips More...
	Annotation (float llx, float lly, float urx, float ury, string file, int page)
	Constructs an Annotation. More...
	Annotation (float llx, float lly, float urx, float ury, int named)
	Constructs an Annotation. More...
	Annotation (float llx, float lly, float urx, float ury, string application, string parameters, string operation, string defaultdir)
	Constructs an Annotation. More...
bool	Process (IElementListener listener)
	Processes the element by adding it (or the different parts) to an IElementListener. More...
void	SetDimensions (float llx, float lly, float urx, float ury)
	Sets the dimensions of this annotation. More...
float	GetLlx ()
	Returns the lower left x-value. More...
float	GetLly ()
	Returns the lower left y-value. More...
float	GetUrx ()
	Returns the uppper right x-value. More...
float	GetUry ()
	Returns the uppper right y-value. More...
float	GetLlx (float def)
	Returns the lower left x-value. More...
float	GetLly (float def)
	Returns the lower left y-value. More...
float	GetUrx (float def)
	Returns the upper right x-value. More...
float	GetUry (float def)
	Returns the upper right y-value. More...
bool	IsContent ()
bool	IsNestable ()
override string	ToString ()
	Gets the content of the text element. More...

Static Public Attributes
const int	TEXT = 0
	This is a possible annotation type. More...
const int	URL_NET = 1
	This is a possible annotation type. More...
const int	URL_AS_STRING = 2
	This is a possible annotation type. More...
const int	FILE_DEST = 3
	This is a possible annotation type. More...
const int	FILE_PAGE = 4
	This is a possible annotation type. More...
const int	NAMED_DEST = 5
	This is a possible annotation type. More...
const int	LAUNCH = 6
	This is a possible annotation type. More...
const int	SCREEN = 7
	This is a possible annotation type. More...
const string	TITLE = "title"
	This is a possible attribute. More...
const string	CONTENT = "content"
	This is a possible attribute. More...
const string	URL = "url"
	This is a possible attribute. More...
const string	FILE = "file"
	This is a possible attribute. More...
const string	DESTINATION = "destination"
	This is a possible attribute. More...
const string	PAGE = "page"
	This is a possible attribute. More...
const string	NAMED = "named"
	This is a possible attribute. More...
const string	APPLICATION = "application"
	This is a possible attribute. More...
const string	PARAMETERS = "parameters"
	This is a possible attribute. More...
const string	OPERATION = "operation"
	This is a possible attribute. More...
const string	DEFAULTDIR = "defaultdir"
	This is a possible attribute. More...
const string	LLX = "llx"
	This is a possible attribute. More...
const string	LLY = "lly"
	This is a possible attribute. More...
const string	URX = "urx"
	This is a possible attribute. More...
const string	URY = "ury"
	This is a possible attribute. More...
const string	MIMETYPE = "mime"
	This is a possible attribute. More...

Protected Attributes
int	annotationtype
	This is the type of annotation. More...
Hashtable	annotationAttributes = new Hashtable()
	This is the title of the Annotation. More...

Properties
int	Type [get]
	Gets the type of the text element More...
ArrayList	Chunks [get]
	Gets all the chunks in this element. More...
int	AnnotationType [get]
	Returns the type of this Annotation. More...
string	Title [get]
	Returns the title of this Annotation. More...
string	Content [get]
	Gets the content of this Annotation. More...
Hashtable	Attributes [get]
	Gets the content of this Annotation. More...
Properties inherited from iTextSharp.text.IElement
int	Type [get]
	Gets the type of the text element. More...
ArrayList	Chunks [get]
	Gets all the chunks in this element. More...

Detailed Description

An Annotation is a little note that can be added to a page on a document.

See also

T:iTextSharp.text.Element, T:iTextSharp.text.Anchor

Constructor & Destructor Documentation

Annotation() [1/10]

iTextSharp.text.Annotation.Annotation

(

Annotation

an

)

Annotation() [2/10]

iTextSharp.text.Annotation.Annotation	(	string	title,
		string	text
	)

Constructs an Annotation with a certain title and some text.

Parameters

title	the title of the annotation
text	the content of the annotation

Annotation() [3/10]

iTextSharp.text.Annotation.Annotation	(	string	title,
		string	text,
		float	llx,
		float	lly,
		float	urx,
		float	ury
	)

Constructs an Annotation with a certain title and some text.

Parameters

title	the title of the annotation
text	the content of the annotation
llx	the lower left x-value
lly	the lower left y-value
urx	the upper right x-value
ury	the upper right y-value

Annotation() [4/10]

iTextSharp.text.Annotation.Annotation	(	float	llx,
		float	lly,
		float	urx,
		float	ury,
		Uri	url
	)

Constructs an Annotation.

Parameters

llx	the lower left x-value
lly	the lower left y-value
urx	the upper right x-value
ury	the upper right y-value
url	the external reference

Annotation() [5/10]

iTextSharp.text.Annotation.Annotation	(	float	llx,
		float	lly,
		float	urx,
		float	ury,
		string	url
	)

Constructs an Annotation.

Parameters

llx	the lower left x-value
lly	the lower left y-value
urx	the upper right x-value
ury	the upper right y-value
url	the external reference

Annotation() [6/10]

iTextSharp.text.Annotation.Annotation	(	float	llx,
		float	lly,
		float	urx,
		float	ury,
		string	file,
		string	dest
	)

Constructs an Annotation.

Parameters

llx	the lower left x-value
lly	the lower left y-value
urx	the upper right x-value
ury	the upper right y-value
file	an external PDF file
dest	the destination in this file

Annotation() [7/10]

iTextSharp.text.Annotation.Annotation	(	float	llx,
		float	lly,
		float	urx,
		float	ury,
		string	moviePath,
		string	mimeType,
		bool	showOnDisplay
	)

Creates a Screen anotation to embed media clips

Parameters

llx	the lower left x-value
lly	the lower left y-value
urx	the upper right x-value
ury	the upper right y-value
moviePath	path to the media clip file
mimeType	mime type of the media
showOnDisplay	if true play on display of the page

Annotation() [8/10]

iTextSharp.text.Annotation.Annotation	(	float	llx,
		float	lly,
		float	urx,
		float	ury,
		string	file,
		int	page
	)

Constructs an Annotation.

Parameters

llx	the lower left x-value
lly	the lower left y-value
urx	the upper right x-value
ury	the upper right y-value
file	an external PDF file
page	a page number in this file

Annotation() [9/10]

iTextSharp.text.Annotation.Annotation	(	float	llx,
		float	lly,
		float	urx,
		float	ury,
		int	named
	)

Constructs an Annotation.

Parameters

llx	the lower left x-value
lly	the lower left y-value
urx	the upper right x-value
ury	the upper right y-value
named	a named destination in this file

<overloads> Has nine overloads. </overloads>

Annotation() [10/10]

iTextSharp.text.Annotation.Annotation	(	float	llx,
		float	lly,
		float	urx,
		float	ury,
		string	application,
		string	parameters,
		string	operation,
		string	defaultdir
	)

Constructs an Annotation.

Parameters

llx	the lower left x-value
lly	the lower left y-value
urx	the upper right x-value
ury	the upper right y-value
application	an external application
parameters	parameters to pass to this application
operation	the operation to pass to this application
defaultdir	the default directory to run this application in

Member Function Documentation

GetLlx() [1/2]

float iTextSharp.text.Annotation.GetLlx

(

)

Returns the lower left x-value.

Returns

a value

GetLlx() [2/2]

float iTextSharp.text.Annotation.GetLlx

(

float

def

)

Returns the lower left x-value.

Parameters

def	the default value

Returns

a value

GetLly() [1/2]

float iTextSharp.text.Annotation.GetLly

(

)

Returns the lower left y-value.

Returns

a value

GetLly() [2/2]

float iTextSharp.text.Annotation.GetLly

(

float

def

)

Returns the lower left y-value.

Parameters

def	the default value

Returns

a value

GetUrx() [1/2]

float iTextSharp.text.Annotation.GetUrx

(

)

Returns the uppper right x-value.

Returns

a value

GetUrx() [2/2]

float iTextSharp.text.Annotation.GetUrx

(

float

def

)

Returns the upper right x-value.

Parameters

def	the default value

Returns

a value

GetUry() [1/2]

float iTextSharp.text.Annotation.GetUry

(

)

Returns the uppper right y-value.

Returns

a value

GetUry() [2/2]

float iTextSharp.text.Annotation.GetUry

(

float

def

)

Returns the upper right y-value.

Parameters

def	the default value

Returns

a value

IsContent()

bool iTextSharp.text.Annotation.IsContent

(

)

See also

com.lowagie.text.Element::isContent()

Since

iText 2.0.8

Implements iTextSharp.text.IElement.

IsNestable()

bool iTextSharp.text.Annotation.IsNestable

(

)

See also

com.lowagie.text.Element::isNestable()

Since

iText 2.0.8

Implements iTextSharp.text.IElement.

Process()

bool iTextSharp.text.Annotation.Process

(

IElementListener

listener

)

Processes the element by adding it (or the different parts) to an IElementListener.

Parameters

listener

an IElementListener

Returns

true if the element was process successfully

Implements iTextSharp.text.IElement.

SetDimensions()

void iTextSharp.text.Annotation.SetDimensions	(	float	llx,
		float	lly,
		float	urx,
		float	ury
	)

Sets the dimensions of this annotation.

Parameters

llx	the lower left x-value
lly	the lower left y-value
urx	the upper right x-value
ury	the upper right y-value

ToString()

override string iTextSharp.text.Annotation.ToString

(

)

Gets the content of the text element.

Returns

the content of the text element

Implements iTextSharp.text.IElement.

Member Data Documentation

annotationAttributes

Hashtable iTextSharp.text.Annotation.annotationAttributes = new Hashtable()

protected

This is the title of the Annotation.

annotationtype

int iTextSharp.text.Annotation.annotationtype

protected

This is the type of annotation.

APPLICATION

const string iTextSharp.text.Annotation.APPLICATION = "application"

static

This is a possible attribute.

CONTENT

const string iTextSharp.text.Annotation.CONTENT = "content"

static

This is a possible attribute.

DEFAULTDIR

const string iTextSharp.text.Annotation.DEFAULTDIR = "defaultdir"

static

This is a possible attribute.

DESTINATION

const string iTextSharp.text.Annotation.DESTINATION = "destination"

static

This is a possible attribute.

FILE

const string iTextSharp.text.Annotation.FILE = "file"

static

This is a possible attribute.

FILE_DEST

const int iTextSharp.text.Annotation.FILE_DEST = 3

static

This is a possible annotation type.

FILE_PAGE

const int iTextSharp.text.Annotation.FILE_PAGE = 4

static

This is a possible annotation type.

LAUNCH

const int iTextSharp.text.Annotation.LAUNCH = 6

static

This is a possible annotation type.

LLX

const string iTextSharp.text.Annotation.LLX = "llx"

static

This is a possible attribute.

LLY

const string iTextSharp.text.Annotation.LLY = "lly"

static

This is a possible attribute.

MIMETYPE

const string iTextSharp.text.Annotation.MIMETYPE = "mime"

static

This is a possible attribute.

NAMED

const string iTextSharp.text.Annotation.NAMED = "named"

static

This is a possible attribute.

NAMED_DEST

const int iTextSharp.text.Annotation.NAMED_DEST = 5

static

This is a possible annotation type.

OPERATION

const string iTextSharp.text.Annotation.OPERATION = "operation"

static

This is a possible attribute.

PAGE

const string iTextSharp.text.Annotation.PAGE = "page"

static

This is a possible attribute.

PARAMETERS

const string iTextSharp.text.Annotation.PARAMETERS = "parameters"

static

This is a possible attribute.

SCREEN

const int iTextSharp.text.Annotation.SCREEN = 7

static

This is a possible annotation type.

TEXT

const int iTextSharp.text.Annotation.TEXT = 0

static

This is a possible annotation type.

TITLE

const string iTextSharp.text.Annotation.TITLE = "title"

static

This is a possible attribute.

URL

const string iTextSharp.text.Annotation.URL = "url"

static

This is a possible attribute.

URL_AS_STRING

const int iTextSharp.text.Annotation.URL_AS_STRING = 2

static

This is a possible annotation type.

URL_NET

const int iTextSharp.text.Annotation.URL_NET = 1

static

This is a possible annotation type.

URX

const string iTextSharp.text.Annotation.URX = "urx"

static

This is a possible attribute.

URY

const string iTextSharp.text.Annotation.URY = "ury"

static

This is a possible attribute.

Property Documentation

AnnotationType

int iTextSharp.text.Annotation.AnnotationType

get

Returns the type of this Annotation.

a type

Attributes

Hashtable iTextSharp.text.Annotation.Attributes

get

Gets the content of this Annotation.

a reference

Chunks

ArrayList iTextSharp.text.Annotation.Chunks

get

Gets all the chunks in this element.

an ArrayList

Content

string iTextSharp.text.Annotation.Content

get

Gets the content of this Annotation.

a reference

Title

string iTextSharp.text.Annotation.Title

get

Returns the title of this Annotation.

a name

Type

int iTextSharp.text.Annotation.Type

get

Gets the type of the text element

---

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

• src/core/iTextSharp/text/Annotation.cs