C# Class iTextSharp.text.Annotation

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

Inheritance: IElement

Show file Open project: mapo80/iTextSharp-Monotouch Class Usage Examples

Protected Properties

Property	Type	Description
annotationAttributes	object>.Dictionary
annotationtype	int

Public Methods

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

Private Methods

Method	Description
Annotation ( float llx, float lly, float urx, float ury ) : System	Constructs an Annotation with a certain title and some text.

Method Details

Annotation() public method

public Annotation ( Annotation an ) : System
an	Annotation
return	System

Annotation() public method

Constructs an Annotation.

public Annotation ( float llx, float lly, float urx, float ury, Uri url ) : System
llx	float	the lower left x-value
lly	float	the lower left y-value
urx	float	the upper right x-value
ury	float	the upper right y-value
url	System.Uri	the external reference
return	System

Annotation() public method

Constructs an Annotation.

public Annotation ( float llx, float lly, float urx, float ury, int named ) : System
llx	float	the lower left x-value
lly	float	the lower left y-value
urx	float	the upper right x-value
ury	float	the upper right y-value
named	int	a named destination in this file
return	System

Annotation() public method

Constructs an Annotation.

public Annotation ( float llx, float lly, float urx, float ury, string url ) : System
llx	float	the lower left x-value
lly	float	the lower left y-value
urx	float	the upper right x-value
ury	float	the upper right y-value
url	string	the external reference
return	System

Annotation() public method

Constructs an Annotation.

public Annotation ( float llx, float lly, float urx, float ury, string file, int page ) : System
llx	float	the lower left x-value
lly	float	the lower left y-value
urx	float	the upper right x-value
ury	float	the upper right y-value
file	string	an external PDF file
page	int	a page number in this file
return	System

Annotation() public method

Constructs an Annotation.

public Annotation ( float llx, float lly, float urx, float ury, string file, string dest ) : System
llx	float	the lower left x-value
lly	float	the lower left y-value
urx	float	the upper right x-value
ury	float	the upper right y-value
file	string	an external PDF file
dest	string	the destination in this file
return	System

Annotation() public method

Creates a Screen anotation to embed media clips

public Annotation ( float llx, float lly, float urx, float ury, string moviePath, string mimeType, bool showOnDisplay ) : System
llx	float	the lower left x-value
lly	float	the lower left y-value
urx	float	the upper right x-value
ury	float	the upper right y-value
moviePath	string	path to the media clip file
mimeType	string	mime type of the media
showOnDisplay	bool	if true play on display of the page
return	System

Annotation() public method

Constructs an Annotation.

public Annotation ( float llx, float lly, float urx, float ury, string application, string parameters, string operation, string defaultdir ) : System
llx	float	the lower left x-value
lly	float	the lower left y-value
urx	float	the upper right x-value
ury	float	the upper right y-value
application	string	an external application
parameters	string	parameters to pass to this application
operation	string	the operation to pass to this application
defaultdir	string	the default directory to run this application in
return	System

Annotation() public method

Constructs an Annotation with a certain title and some text.

public Annotation ( string title, string text ) : System
title	string	the title of the annotation
text	string	the content of the annotation
return	System

Annotation() public method

Constructs an Annotation with a certain title and some text.

public Annotation ( string title, string text, float llx, float lly, float urx, float ury ) : System
title	string	the title of the annotation
text	string	the content of the annotation
llx	float	the lower left x-value
lly	float	the lower left y-value
urx	float	the upper right x-value
ury	float	the upper right y-value
return	System

GetLlx() public method

Returns the lower left x-value.

public GetLlx ( ) : float
return	float

GetLlx() public method

Returns the lower left x-value.

public GetLlx ( float def ) : float
def	float	the default value
return	float

GetLly() public method

Returns the lower left y-value.

public GetLly ( ) : float
return	float

GetLly() public method

Returns the lower left y-value.

public GetLly ( float def ) : float
def	float	the default value
return	float

GetUrx() public method

Returns the uppper right x-value.

public GetUrx ( ) : float
return	float

GetUrx() public method

Returns the upper right x-value.

public GetUrx ( float def ) : float
def	float	the default value
return	float

GetUry() public method

Returns the uppper right y-value.

public GetUry ( ) : float
return	float

GetUry() public method

Returns the upper right y-value.

public GetUry ( float def ) : float
def	float	the default value
return	float

IsContent() public method

public IsContent ( ) : bool
return	bool

IsNestable() public method

public IsNestable ( ) : bool
return	bool

Process() public method

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

public Process ( IElementListener listener ) : bool
listener	IElementListener	an IElementListener
return	bool

SetDimensions() public method

Sets the dimensions of this annotation.

public SetDimensions ( float llx, float lly, float urx, float ury ) : void
llx	float	the lower left x-value
lly	float	the lower left y-value
urx	float	the upper right x-value
ury	float	the upper right y-value
return	void

ToString() public method

public ToString ( ) : string
return	string

Property Details

annotationAttributes protected property

This is the title of the Annotation.

protected Dictionary annotationAttributes
return	object>.Dictionary

annotationtype protected property

This is the type of annotation.

protected int annotationtype
return	int