|
HiraokaHyperTools.iTextSharp-LGPL
0.3.0
|
This is the smallest significant part of text that can be added to a document. More...
Public Member Functions | |
| Chunk () | |
| Empty constructor. More... | |
| Chunk (Chunk ck) | |
| Chunk (string content, Font font) | |
| Constructs a chunk of text with a certain content and a certain Font. More... | |
| Chunk (string content) | |
| Constructs a chunk of text with a certain content, without specifying a Font. More... | |
| Chunk (char c, Font font) | |
| Chunk (char c) | |
| Chunk (Image image, float offsetX, float offsetY) | |
| Constructs a chunk containing an Image. More... | |
| Chunk (IDrawInterface separator) | |
| Chunk (IDrawInterface separator, bool vertical) | |
| Chunk (IDrawInterface separator, float tabPosition) | |
| Chunk (IDrawInterface separator, float tabPosition, bool newline) | |
| Chunk (Image image, float offsetX, float offsetY, bool changeLeading) | |
| Constructs a chunk containing an Image. More... | |
| bool | Process (IElementListener listener) |
| Processes the element by adding it (or the different parts) to an IElementListener. More... | |
| StringBuilder | Append (string str) |
| appends some text to this Chunk. More... | |
| override string | ToString () |
| Gets the content of the text element. More... | |
| virtual bool | IsEmpty () |
| Checks is this Chunk is empty. More... | |
| float | GetWidthPoint () |
| bool | HasAttributes () |
| Checks the attributes of this Chunk. More... | |
| Chunk | SetHorizontalScaling (float scale) |
| Chunk | SetUnderline (float thickness, float yPosition) |
| Chunk | SetUnderline (Color color, float thickness, float thicknessMul, float yPosition, float yPositionMul, int cap) |
| summary> Key for sub/basescript. More... | |
| Chunk | SetTextRise (float rise) |
| Sets the text displacement relative to the baseline. Positive values rise the text, negative values lower the text. More... | |
| float | GetTextRise () |
| summary> Key for text skewing. More... | |
| Chunk | SetSkew (float alpha, float beta) |
| summary> Key for background. More... | |
| Chunk | SetBackground (Color color) |
| Sets the color of the background Chunk. More... | |
| Chunk | SetBackground (Color color, float extraLeft, float extraBottom, float extraRight, float extraTop) |
| summary> Key for text rendering mode. More... | |
| Chunk | SetTextRenderMode (int mode, float strokeWidth, Color strokeColor) |
| summary> Key for split character. More... | |
| Chunk | SetSplitCharacter (ISplitCharacter splitCharacter) |
| Sets the split characters. More... | |
| Chunk | SetHyphenation (IHyphenationEvent hyphenation) |
| sets the hyphenation engine to this Chunk. More... | |
| Chunk | SetRemoteGoto (string filename, string name) |
| Sets a goto for a remote destination for this Chunk. More... | |
| Chunk | SetRemoteGoto (string filename, int page) |
| Sets a goto for a remote destination for this Chunk. More... | |
| Chunk | SetLocalGoto (string name) |
| Sets a local goto for this Chunk. More... | |
| Chunk | SetLocalDestination (string name) |
| Sets a local destination for this Chunk. More... | |
| Chunk | SetGenericTag (string text) |
| Sets the generic tag Chunk. More... | |
| Image | GetImage () |
| Returns the image. More... | |
| Chunk | SetAction (PdfAction action) |
| Sets an action for this Chunk. More... | |
| Chunk | SetAnchor (Uri url) |
| Sets an anchor for this Chunk. More... | |
| Chunk | SetAnchor (string url) |
| Sets an anchor for this Chunk. More... | |
| Chunk | SetNewPage () |
| Sets a new page tag. More... | |
| Chunk | SetAnnotation (PdfAnnotation annotation) |
| Sets a generic annotation to this Chunk. More... | |
| bool | IsContent () |
| bool | IsNestable () |
| IHyphenationEvent | GetHyphenation () |
Static Public Member Functions | |
| static bool | IsTag (string tag) |
| Checks if a given tag corresponds with this object. More... | |
Static Public Attributes | |
| const string | OBJECT_REPLACEMENT_CHARACTER = "\ufffc" |
| summary> This is a Chunk containing a newline. More... | |
| static readonly Chunk | NEWLINE = new Chunk("\n") |
| static readonly Chunk | NEXTPAGE = new Chunk("") |
| const String | SEPARATOR = "SEPARATOR" |
| const String | TAB = "TAB" |
| const string | HSCALE = "HSCALE" |
| const string | UNDERLINE = "UNDERLINE" |
| const string | SUBSUPSCRIPT = "SUBSUPSCRIPT" |
| const string | SKEW = "SKEW" |
| const string | BACKGROUND = "BACKGROUND" |
| const string | TEXTRENDERMODE = "TEXTRENDERMODE" |
| const string | SPLITCHARACTER = "SPLITCHARACTER" |
| const string | HYPHENATION = "HYPHENATION" |
| const string | REMOTEGOTO = "REMOTEGOTO" |
| const string | LOCALGOTO = "LOCALGOTO" |
| const string | LOCALDESTINATION = "LOCALDESTINATION" |
| const string | GENERICTAG = "GENERICTAG" |
| const string | IMAGE = "IMAGE" |
| const string | ACTION = "ACTION" |
| const string | NEWPAGE = "NEWPAGE" |
| const string | PDFANNOTATION = "PDFANNOTATION" |
| const string | COLOR = "COLOR" |
| Key for color. More... | |
| const string | ENCODING = "ENCODING" |
Protected Attributes | |
| StringBuilder | content = null |
| This is the content of this chunk of text. More... | |
| Font | font = null |
| summary> Contains some of the attributes for this Chunk. More... | |
| Hashtable | attributes = null |
Properties | |
| int | Type [get] |
| Gets the type of the text element. More... | |
| ArrayList | Chunks [get] |
| Gets all the chunks in this element. More... | |
| virtual Font | Font [get, set] |
| Get/set the font of this Chunk. More... | |
| virtual string | Content [get] |
| Returns the content of this Chunk. More... | |
| Hashtable | Attributes [get, set] |
| Gets the attributes for this Chunk. More... | |
| float | HorizontalScaling [get] |
| summary> Key for underline. 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... | |
This is the smallest significant part of text that can be added to a document.
Most elements can be divided in one or more Chunks. A chunk is a string with a certain Font. all other layoutparameters should be defined in the object to which this chunk of text is added.
| iTextSharp.text.Chunk.Chunk | ( | ) |
Empty constructor.
<overloads> Has six overloads. </overloads>
| iTextSharp.text.Chunk.Chunk | ( | Chunk | ck | ) |
| iTextSharp.text.Chunk.Chunk | ( | string | content, |
| Font | font | ||
| ) |
Constructs a chunk of text with a certain content and a certain Font.
| content | the content |
| font | the font |
| iTextSharp.text.Chunk.Chunk | ( | string | content | ) |
Constructs a chunk of text with a certain content, without specifying a Font.
| content | the content |
| iTextSharp.text.Chunk.Chunk | ( | char | c, |
| Font | font | ||
| ) |
Constructs a chunk of text with a char and a certain Font.
| c | the content |
| font | the font |
| iTextSharp.text.Chunk.Chunk | ( | char | c | ) |
Constructs a chunk of text with a char, without specifying a Font.
| c | the content |
| iTextSharp.text.Chunk.Chunk | ( | Image | image, |
| float | offsetX, | ||
| float | offsetY | ||
| ) |
Constructs a chunk containing an Image.
| image | the image |
| offsetX | the image offset in the x direction |
| offsetY | the image offset in the y direction |
| iTextSharp.text.Chunk.Chunk | ( | IDrawInterface | separator | ) |
Creates a separator Chunk. Note that separator chunks can't be used in combination with tab chunks!
| separator | the drawInterface to use to draw the separator. |
| iTextSharp.text.Chunk.Chunk | ( | IDrawInterface | separator, |
| bool | vertical | ||
| ) |
Creates a separator Chunk. Note that separator chunks can't be used in combination with tab chunks!
| separator | the drawInterface to use to draw the separator. |
| vertical | true if this is a vertical separator |
| iTextSharp.text.Chunk.Chunk | ( | IDrawInterface | separator, |
| float | tabPosition | ||
| ) |
| iTextSharp.text.Chunk.Chunk | ( | IDrawInterface | separator, |
| float | tabPosition, | ||
| bool | newline | ||
| ) |
Creates a tab Chunk. Note that separator chunks can't be used in combination with tab chunks!
| separator | the drawInterface to use to draw the tab. |
| tabPosition | an X coordinate that will be used as start position for the next Chunk. |
| newline | if true, a newline will be added if the tabPosition has already been reached. |
| iTextSharp.text.Chunk.Chunk | ( | Image | image, |
| float | offsetX, | ||
| float | offsetY, | ||
| bool | changeLeading | ||
| ) |
Constructs a chunk containing an Image.
| image | the image |
| offsetX | the image offset in the x direction |
| offsetY | the image offset in the y direction |
| changeLeading | true if the leading has to be adapted to the image |
| StringBuilder iTextSharp.text.Chunk.Append | ( | string | str | ) |
| IHyphenationEvent iTextSharp.text.Chunk.GetHyphenation | ( | ) |
Returns the hyphenation (if present).
| hyphenation | a HyphenationEvent instance |
| float iTextSharp.text.Chunk.GetTextRise | ( | ) |
summary> Key for text skewing.
| float iTextSharp.text.Chunk.GetWidthPoint | ( | ) |
Gets the width of the Chunk in points.
| bool iTextSharp.text.Chunk.HasAttributes | ( | ) |
Checks the attributes of this Chunk.
| bool iTextSharp.text.Chunk.IsContent | ( | ) |
|
virtual |
Checks is this Chunk is empty.
Reimplemented in iTextSharp.text.rtf.RtfAddableElement, and iTextSharp.text.rtf.field.RtfField.
| bool iTextSharp.text.Chunk.IsNestable | ( | ) |
Implements iTextSharp.text.IElement.
|
static |
Checks if a given tag corresponds with this object.
| tag | the given tag |
summary> Key for Action.
| bool iTextSharp.text.Chunk.Process | ( | IElementListener | listener | ) |
Processes the element by adding it (or the different parts) to an IElementListener.
| listener | an IElementListener |
Implements iTextSharp.text.IElement.
| Chunk iTextSharp.text.Chunk.SetAnchor | ( | string | url | ) |
| Chunk iTextSharp.text.Chunk.SetAnchor | ( | Uri | url | ) |
| Chunk iTextSharp.text.Chunk.SetAnnotation | ( | PdfAnnotation | annotation | ) |
| Chunk iTextSharp.text.Chunk.SetBackground | ( | Color | color, |
| float | extraLeft, | ||
| float | extraBottom, | ||
| float | extraRight, | ||
| float | extraTop | ||
| ) |
summary> Key for text rendering mode.
Sets the color and the size of the background Chunk.
| color | the color of the background |
| extraLeft | increase the size of the rectangle in the left |
| extraBottom | increase the size of the rectangle in the bottom |
| extraRight | increase the size of the rectangle in the right |
| extraTop | increase the size of the rectangle in the top |
Chunk | Chunk iTextSharp.text.Chunk.SetGenericTag | ( | string | text | ) |
| Chunk iTextSharp.text.Chunk.SetHorizontalScaling | ( | float | scale | ) |
Sets the text horizontal scaling. A value of 1 is normal and a value of 0.5f shrinks the text to half it's width.
| scale | the horizontal scaling factor |
Chunk | Chunk iTextSharp.text.Chunk.SetHyphenation | ( | IHyphenationEvent | hyphenation | ) |
| Chunk iTextSharp.text.Chunk.SetLocalDestination | ( | string | name | ) |
| Chunk iTextSharp.text.Chunk.SetLocalGoto | ( | string | name | ) |
| Chunk iTextSharp.text.Chunk.SetNewPage | ( | ) |
| Chunk iTextSharp.text.Chunk.SetRemoteGoto | ( | string | filename, |
| int | page | ||
| ) |
| Chunk iTextSharp.text.Chunk.SetRemoteGoto | ( | string | filename, |
| string | name | ||
| ) |
| Chunk iTextSharp.text.Chunk.SetSkew | ( | float | alpha, |
| float | beta | ||
| ) |
summary> Key for background.
Skews the text to simulate italic and other effects. Try alpha=0 and beta=12.
| alpha | the first angle in degrees |
| beta | the second angle in degrees |
Chunk | Chunk iTextSharp.text.Chunk.SetSplitCharacter | ( | ISplitCharacter | splitCharacter | ) |
Sets the split characters.
| splitCharacter | the SplitCharacter interface |
summary> Key for hyphenation.
summary> Key for split character.
Sets the text rendering mode. It can outline text, simulate bold and make text invisible.
| mode | the text rendering mode. It can be PdfContentByte.TEXT_RENDER_MODE_FILL, PdfContentByte.TEXT_RENDER_MODE_STROKE, PdfContentByte.TEXT_RENDER_MODE_FILL_STROKE and PdfContentByte.TEXT_RENDER_MODE_INVISIBLE. |
| strokeWidth | the stroke line width for the modes PdfContentByte.TEXT_RENDER_MODE_STROKE and PdfContentByte.TEXT_RENDER_MODE_FILL_STROKE. |
| strokeColor | the stroke color or null to follow the text color |
Chunk | Chunk iTextSharp.text.Chunk.SetTextRise | ( | float | rise | ) |
Sets the text displacement relative to the baseline. Positive values rise the text, negative values lower the text.
It can be used to implement sub/basescript.
| rise | the displacement in points |
| Chunk iTextSharp.text.Chunk.SetUnderline | ( | Color | color, |
| float | thickness, | ||
| float | thicknessMul, | ||
| float | yPosition, | ||
| float | yPositionMul, | ||
| int | cap | ||
| ) |
summary> Key for sub/basescript.
Sets an horizontal line that can be an underline or a strikethrough. Actually, the line can be anywhere vertically and has always the Chunk width. Multiple call to this method will produce multiple lines.
| color | the color of the line or null to follow the text color |
| thickness | the absolute thickness of the line |
| thicknessMul | the thickness multiplication factor with the font size |
| yPosition | the absolute y position relative to the baseline |
| yPositionMul | the position multiplication factor with the font size |
| cap | the end line cap. Allowed values are PdfContentByte.LINE_CAP_BUTT, PdfContentByte.LINE_CAP_ROUND and PdfContentByte.LINE_CAP_PROJECTING_SQUARE |
Chunk | Chunk iTextSharp.text.Chunk.SetUnderline | ( | float | thickness, |
| float | yPosition | ||
| ) |
Sets an horizontal line that can be an underline or a strikethrough. Actually, the line can be anywhere vertically and has always the Chunk width. Multiple call to this method will produce multiple lines.
| thickness | the absolute thickness of the line |
| yPosition | the absolute y position relative to the baseline |
Chunk | override string iTextSharp.text.Chunk.ToString | ( | ) |
Gets the content of the text element.
Implements iTextSharp.text.IElement.
|
static |
|
protected |
|
static |
|
static |
Key for color.
summary> Key for encoding.
|
protected |
This is the content of this chunk of text.
summary> This is the Font of this chunk of text.
|
static |
|
protected |
summary> Contains some of the attributes for this Chunk.
|
static |
|
static |
Key for text horizontal scaling.
|
static |
|
static |
|
static |
|
static |
|
static |
This is a Chunk containing a newpage.
|
static |
summary> This is a Chunk containing a newline.
The character stand in for an image or a separator.
|
static |
|
static |
|
static |
Key for drawInterface of the Separator.
|
static |
|
static |
|
static |
|
static |
Key for drawInterface of the tab.
|
static |
|
static |
|
getset |
|
get |
Gets all the chunks in this element.
an ArrayList
|
get |
Returns the content of this Chunk.
a string
|
get |
summary> Key for underline.
Gets the horizontal scaling.
|
get |
Gets the type of the text element.
a type