Annotation
Annotation Public class
Description
An Annotation is a little note that can be added to a page on a document.
Diagram
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph iTextSharp.text
iTextSharp.text.Annotation[[Annotation]]
iTextSharp.text.IElement[[IElement]]
class iTextSharp.text.IElement interfaceStyle;
end
iTextSharp.text.IElement --> iTextSharp.text.Annotation
Members
Properties
Public properties
| Type | Name | Methods |
|---|---|---|
int | AnnotationTypeReturns the type of this Annotation. | get |
Dictionary<string, object> | AttributesGets the content of this Annotation. | get |
IList<Chunk> | ChunksGets all the chunks in this element. | get |
string | ContentGets the content of this Annotation. | get |
string | TitleReturns the title of this Annotation. | get |
int | TypeGets the type of the text element | get |
Methods
Public methods
| Returns | Name |
|---|---|
float | GetLlx(...)Returns the lower left x-value. |
float | GetLly(...)Returns the lower left y-value. |
float | GetUrx(...)Returns the uppper right x-value. |
float | GetUry(...)Returns the uppper right y-value. |
bool | IsContent() |
bool | IsNestable() |
bool | Process(IElementListener listener)Processes the element by adding it (or the different parts) to an IElementListener. |
void | SetDimensions(float llx, float lly, float urx, float ury)Sets the dimensions of this annotation. |
string | ToString() |
Details
Summary
An Annotation is a little note that can be added to a page on a document.
Inheritance
Constructors
Annotation [1/10]
public Annotation(Annotation an)
Arguments
| Type | Name | Description |
|---|---|---|
Annotation | an |
Annotation [2/10]
public Annotation(string title, string text)
Arguments
| Type | Name | Description |
|---|---|---|
string | title | the title of the annotation |
string | text | the content of the annotation |
Summary
Constructs an Annotation with a certain title and some text.
Annotation [3/10]
public Annotation(string title, string text, float llx, float lly, float urx, float ury)
Arguments
| Type | Name | Description |
|---|---|---|
string | title | the title of the annotation |
string | text | the content of the annotation |
float | llx | the lower left x-value |
float | lly | the lower left y-value |
float | urx | the upper right x-value |
float | ury | the upper right y-value |
Summary
Constructs an Annotation with a certain title and some text.
Annotation [4/10]
public Annotation(float llx, float lly, float urx, float ury, Uri url)
Arguments
| Type | Name | Description |
|---|---|---|
float | llx | the lower left x-value |
float | lly | the lower left y-value |
float | urx | the upper right x-value |
float | ury | the upper right y-value |
Uri | url | the external reference |
Summary
Constructs an Annotation.
Annotation [5/10]
public Annotation(float llx, float lly, float urx, float ury, string url)
Arguments
| Type | Name | Description |
|---|---|---|
float | llx | the lower left x-value |
float | lly | the lower left y-value |
float | urx | the upper right x-value |
float | ury | the upper right y-value |
string | url | the external reference |
Summary
Constructs an Annotation.
Annotation [6/10]
public Annotation(float llx, float lly, float urx, float ury, string file, string dest)
Arguments
| Type | Name | Description |
|---|---|---|
float | llx | the lower left x-value |
float | lly | the lower left y-value |
float | urx | the upper right x-value |
float | ury | the upper right y-value |
string | file | an external PDF file |
string | dest | the destination in this file |
Summary
Constructs an Annotation.
Annotation [7/10]
public Annotation(float llx, float lly, float urx, float ury, string moviePath, string mimeType, bool showOnDisplay)
Arguments
| Type | Name | Description |
|---|---|---|
float | llx | the lower left x-value |
float | lly | the lower left y-value |
float | urx | the upper right x-value |
float | ury | the upper right y-value |
string | moviePath | path to the media clip file |
string | mimeType | mime type of the media |
bool | showOnDisplay | if true play on display of the page |
Summary
Creates a Screen anotation to embed media clips
Annotation [8/10]
public Annotation(float llx, float lly, float urx, float ury, string file, int page)
Arguments
| Type | Name | Description |
|---|---|---|
float | llx | the lower left x-value |
float | lly | the lower left y-value |
float | urx | the upper right x-value |
float | ury | the upper right y-value |
string | file | an external PDF file |
int | page | a page number in this file |
Summary
Constructs an Annotation.
Annotation [9/10]
public Annotation(float llx, float lly, float urx, float ury, int named)
Arguments
| Type | Name | Description |
|---|---|---|
float | llx | the lower left x-value |
float | lly | the lower left y-value |
float | urx | the upper right x-value |
float | ury | the upper right y-value |
int | named | a named destination in this file |
Summary
Constructs an Annotation.
Annotation [10/10]
public Annotation(float llx, float lly, float urx, float ury, string application, string parameters, string operation, string defaultdir)
Arguments
| Type | Name | Description |
|---|---|---|
float | llx | the lower left x-value |
float | lly | the lower left y-value |
float | urx | the upper right x-value |
float | ury | the upper right y-value |
string | application | an external application |
string | parameters | parameters to pass to this application |
string | operation | the operation to pass to this application |
string | defaultdir | the default directory to run this application in |
Summary
Constructs an Annotation.
Methods
Process
public virtual bool Process(IElementListener listener)
Arguments
| Type | Name | Description |
|---|---|---|
IElementListener | listener | an IElementListener |
Summary
Processes the element by adding it (or the different parts) to an IElementListener.
Returns
true if the element was process successfully
SetDimensions
public virtual void SetDimensions(float llx, float lly, float urx, float ury)
Arguments
| Type | Name | Description |
|---|---|---|
float | llx | the lower left x-value |
float | lly | the lower left y-value |
float | urx | the upper right x-value |
float | ury | the upper right y-value |
Summary
Sets the dimensions of this annotation.
GetLlx [1/2]
public virtual float GetLlx()
Summary
Returns the lower left x-value.
Returns
a value
GetLly [1/2]
public virtual float GetLly()
Summary
Returns the lower left y-value.
Returns
a value
GetUrx [1/2]
public virtual float GetUrx()
Summary
Returns the uppper right x-value.
Returns
a value
GetUry [1/2]
public virtual float GetUry()
Summary
Returns the uppper right y-value.
Returns
a value
GetLlx [2/2]
public virtual float GetLlx(float def)
Arguments
| Type | Name | Description |
|---|---|---|
float | def | the default value |
Summary
Returns the lower left x-value.
Returns
a value
GetLly [2/2]
public virtual float GetLly(float def)
Arguments
| Type | Name | Description |
|---|---|---|
float | def | the default value |
Summary
Returns the lower left y-value.
Returns
a value
GetUrx [2/2]
public virtual float GetUrx(float def)
Arguments
| Type | Name | Description |
|---|---|---|
float | def | the default value |
Summary
Returns the upper right x-value.
Returns
a value
GetUry [2/2]
public virtual float GetUry(float def)
Arguments
| Type | Name | Description |
|---|---|---|
float | def | the default value |
Summary
Returns the upper right y-value.
Returns
a value
IsContent
public virtual bool IsContent()
IsNestable
public virtual bool IsNestable()
ToString
public override string ToString()
Properties
Type
public virtual int Type { get; }
Summary
Gets the type of the text element
Chunks
public virtual IList<Chunk> Chunks { get; }
Summary
Gets all the chunks in this element.
Value
an ArrayList
AnnotationType
public virtual int AnnotationType { get; }
Summary
Returns the type of this Annotation.
Value
a type
Title
public virtual string Title { get; }
Summary
Returns the title of this Annotation.
Value
a name
Content
public virtual string Content { get; }
Summary
Gets the content of this Annotation.
Value
a reference
Attributes
public virtual Dictionary<string, object> Attributes { get; }
Summary
Gets the content of this Annotation.
Value
a reference
Generated with ModularDoc