HiraokaHyperTools.iTextSharp-LGPL  0.2.5
iTextSharp.text.rtf.RtfAddableElement Class Referenceabstract
Inheritance diagram for iTextSharp.text.rtf.RtfAddableElement:
iTextSharp.text.Chunk iTextSharp.text.rtf.IRtfBasicElement iTextSharp.text.IElement iTextSharp.text.IRtfElementInterface iTextSharp.text.rtf.direct.RtfDirectContent iTextSharp.text.rtf.graphic.RtfShape iTextSharp.text.rtf.graphic.RtfShapePosition iTextSharp.text.rtf.graphic.RtfShapeProperty iTextSharp.text.rtf.text.RtfTab iTextSharp.text.rtf.text.RtfTabGroup

Public Member Functions

 RtfAddableElement ()
 
abstract void WriteContent (Stream outp)
 
void SetRtfDocument (RtfDocument doc)
 
void SetInTable (bool inTable)
 
void SetInHeader (bool inHeader)
 
byte[] IntToByteArray (int i)
 
override bool IsEmpty ()
 
- Public Member Functions inherited from iTextSharp.text.Chunk
 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...
 
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 ()
 

Protected Attributes

RtfDocument doc = null
 
bool inTable = false
 
bool inHeader = false
 
- Protected Attributes inherited from iTextSharp.text.Chunk
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
 

Additional Inherited Members

- Static Public Member Functions inherited from iTextSharp.text.Chunk
static bool IsTag (string tag)
 Checks if a given tag corresponds with this object. More...
 
- Static Public Attributes inherited from iTextSharp.text.Chunk
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"
 
- Properties inherited from iTextSharp.text.Chunk
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...
 

Detailed Description

The RtfAddableElement is the superclass for all rtf specific elements that need to be added to an iText document. It is an extension of Chunk and it also implements RtfBasicElement. It is an abstract class thus it cannot be instantiated itself and has to be subclassed to be used.

Version
Revision
1.6
Author
Mark Hall (Mark..nosp@m.Hall.nosp@m.@mail.nosp@m..roo.nosp@m.m3b.e.nosp@m.u)

Constructor & Destructor Documentation

◆ RtfAddableElement()

iTextSharp.text.rtf.RtfAddableElement.RtfAddableElement ( )

Constructs a new RtfAddableElement. The Chunk content is set to an empty string and the font to the default Font().

Member Function Documentation

◆ IntToByteArray()

byte [] iTextSharp.text.rtf.RtfAddableElement.IntToByteArray ( int  i)

Transforms an integer into its String representation and then returns the bytes of that string.

Parameters
iThe integer to convert
Returns
A byte array representing the integer

◆ IsEmpty()

override bool iTextSharp.text.rtf.RtfAddableElement.IsEmpty ( )
virtual

RtfAddableElement subclasses are never assumed to be empty.

Reimplemented from iTextSharp.text.Chunk.

◆ SetInHeader()

void iTextSharp.text.rtf.RtfAddableElement.SetInHeader ( bool  inHeader)

Sets whether this RtfAddableElement is contained in a header/footer.

Implements iTextSharp.text.rtf.IRtfBasicElement.

◆ SetInTable()

void iTextSharp.text.rtf.RtfAddableElement.SetInTable ( bool  inTable)

Sets whether this RtfAddableElement is contained in a table.

Implements iTextSharp.text.rtf.IRtfBasicElement.

◆ SetRtfDocument()

void iTextSharp.text.rtf.RtfAddableElement.SetRtfDocument ( RtfDocument  doc)

Sets the RtfDocument this RtfAddableElement belongs to.

Implements iTextSharp.text.rtf.IRtfBasicElement.

◆ WriteContent()

abstract void iTextSharp.text.rtf.RtfAddableElement.WriteContent ( Stream  outp)
pure virtual

Member Data Documentation

◆ doc

RtfDocument iTextSharp.text.rtf.RtfAddableElement.doc = null
protected

The RtfDocument this RtfAddableElement belongs to.

◆ inHeader

bool iTextSharp.text.rtf.RtfAddableElement.inHeader = false
protected

Whether this RtfAddableElement is contained in a header.

◆ inTable

bool iTextSharp.text.rtf.RtfAddableElement.inTable = false
protected

Whether this RtfAddableElement is contained in a table.


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