ExpertPdf Html to Pdf Converter Library
TextElement Class
NamespacesExpertPdf.HtmlToPdf.PdfDocumentTextElement
ExpertPdf Html to Pdf Converter Library
Represents a text element to be added to a PDF page or template.
Declaration Syntax
C#Visual BasicVisual C++
public class TextElement : PageGraphicElement
Public Class TextElement
	Inherits PageGraphicElement
public ref class TextElement : public PageGraphicElement
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
TextElement(Single, Single, String, PdfFont)
Contructs a paginable text element that will be rendered at the specified (x,y) position using the specified font. The height of the rendered text will be auto-determined. The width is the available width in page. The Unicode text is supported only for embedded true type fonts. A font can be embedded in the generated PDF document if the embedFont parameter of Document.Fonts.Add(System.Drawing.Font font, bool embedFont) is true. If the text pagination is not allowed ( Paginate property is false ), the text will be written on current page, the rendered text height being limited by the available height on page. The remaining text and the text bounds inside the current page are returned in the AddTextElementResult object when the element is added to a renderer. If the text pagination is allowed ( Paginate property is true ) and the text needs pagination (the auto-determined text height is bigger than the available space on page), all the text will be rendered using the necessary height. The text bounds inside the last page and the last page index are returned in the AddTextElementResult object when the element is added to a renderer.

TextElement(Single, Single, String, PdfFont, PdfColor)
Contructs a paginable text element that will be rendered at the specified (x,y) position using the specified font and colot. The height of the rendered text will be auto-determined. The width is the available width in page. The Unicode text is supported only for embedded true type fonts. A font can be embedded in the generated PDF document if the embedFont parameter of Document.Fonts.Add(System.Drawing.Font font, bool embedFont) is true. If the text pagination is not allowed ( Paginate property is false ), the text will be written on current page, the rendered text height being limited by the available height on page. The remaining text and the text bounds inside the current page are returned in the AddTextElementResult object when the element is added to a renderer. If the text pagination is allowed ( Paginate property is true ) and the text needs pagination (the auto-determined text height is bigger than the available space on page), all the text will be rendered using the necessary height. The text bounds inside the last page and the last page index are returned in the AddTextElementResult object when the element is added to a renderer.

TextElement(Single, Single, Single, String, PdfFont)
Contructs a paginable text element that will be rendered at the specified (x,y) position using the specified width and font. The height of the rendered text will be auto-determined. The Unicode text is supported only for embedded true type fonts. A font can be embedded in the generated PDF document if the embedFont parameter of Document.Fonts.Add(System.Drawing.Font font, bool embedFont) is true. If the text pagination is not allowed ( Paginate property is false ), the text will be written on current page, the rendered text height being limited by the available height on page. The remaining text and the text bounds inside the current page are returned in the AddTextElementResult object when the element is added to a renderer. If the text pagination is allowed ( Paginate property is true ) and the text needs pagination (the auto-determined text height is bigger than the available space on page), all the text will be rendered using the necessary height. The text bounds inside the last page and the last page index are returned in the AddTextElementResult object when the element is added to a renderer.

TextElement(Single, Single, Single, Single, String, PdfFont)
Contructs a paginable text element that will be rendered in the specified rectangle using the specified width, height and font. The Unicode text is supported only for embedded true type fonts. A font can be embedded in the generated PDF document if the embedFont parameter of Document.Fonts.Add(System.Drawing.Font font, bool embedFont) is true. If the text pagination is not allowed ( Paginate property is false ), the text will be written on current page, the rendered text height being given by the minimum between the specified height and the available height on page. The remaining text and the text bounds inside the current page are returned in the AddTextElementResult object when the element is added to a renderer. If the text pagination is allowed ( Paginate property is true ) and the text needs pagination (the specified height is bigger than the available space on page), the height parameter will be ignored and the text will be rendered to the end using the necessary height. The text bounds inside the last page and the last page index are returned in the AddTextElementResult object when the element is added to a renderer. If the text pagination is allowed but the text does not need pagination (the specified height is less than the available space on page), the rendered text will be truncated to fit the specified height. The text bounds inside the current page and the last page index are returned in the AddTextElementResult object when the element is added to a renderer.

TextElement(Single, Single, Single, String, PdfFont, PdfColor)
Contructs a paginable text element that will be rendered at the specified (x,y) position using the specified width, font and color. The height of the rendered text will be auto-determined. The Unicode text is supported only for embedded true type fonts. A font can be embedded in the generated PDF document if the embedFont parameter of Document.Fonts.Add(System.Drawing.Font font, bool embedFont) is true. If the text pagination is not allowed ( Paginate property is false ), the text will be written on current page, the rendered text height being limited by the available height on page. The remaining text and the text bounds inside the current page are returned in the AddTextElementResult object when the element is added to a renderer. If the text pagination is allowed ( Paginate property is true ) and the text needs pagination (the auto-determined text height is bigger than the available space on page), all the text will be rendered using the necessary height. The text bounds inside the last page and the last page index are returned in the AddTextElementResult object when the element is added to a renderer.

TextElement(Single, Single, Single, Single, String, PdfFont, PdfColor)
Contructs a paginable text element that will be rendered in the specified rectangle using the specified width, height, font and color. The Unicode text is supported only for embedded true type fonts. A font can be embedded in the generated PDF document if the embedFont parameter of Document.Fonts.Add(System.Drawing.Font font, bool embedFont) is true. If the text pagination is not allowed ( Paginate property is false ), the text will be written on current page, the rendered text height being given by the minimum between the specified height and the available height on page. The remaining text and the text bounds inside the current page are returned in the AddTextElementResult object when the element is added to a renderer. If the text pagination is allowed ( Paginate property is true ) and the text needs pagination (the specified height is bigger than the available space on page), the height parameter will be ignored and the text will be rendered to the end using the necessary height. The text bounds inside the last page and the last page index are returned in the AddTextElementResult object when the element is added to a renderer. If the text pagination is allowed but the text does not need pagination (the specified height is less than the available space on page), the rendered text will be truncated to fit the specified height. The text bounds inside the current page and the last page index are returned in the AddTextElementResult object when the element is added to a renderer.

BackColor
Gets or sets element background color.
(Inherited from PageGraphicElement.)
Blending
Gets or sets blending mode for transparent rendering mode of the element.
(Inherited from PageGraphicElement.)
CharacterSpacing
Gets or sets an additional spacing between characters.

ClipRectangle
A rectangle to be added to the current cliping path

ColorSpace
Gets or sets color space for element rendering.
(Inherited from PageGraphicElement.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
ForeColor
Gets or sets the element foreground color.
(Inherited from PageGraphicElement.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Gradient
The gradient used to fill a shape.
(Inherited from PageGraphicElement.)
Height
The height of the destination rectangle Is optional

IsPaginable
This property tells if the text element was constructed as a paginable text element or not.

LineSpacing
Gets or sets value that indicates the vertical distance between the baselines of adjacent lines of text.

LineStyle
Gets or sets the line style for elements rendering lines.
(Inherited from PageGraphicElement.)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Paginate
When true the text can be paginated

RightToLeftLanguage
Set this property true if the text is in a RTL language.

Rotate(Single)
Rotates the coordinate system axes clockwise by the specified angle before rendering the element. The coordinates of the element are relative to the rotated coordinates system.
(Inherited from PageGraphicElement.)
Rotated
A flag to indicate if this element was rotated.
(Inherited from PageGraphicElement.)
Scale(Single, Single)
Scales the coordinates so that 1 unit in the horizontal and vertical dimensions of the new coordinate system is the same size as sx and sy units, respectively, in the previous coordinate system.
(Inherited from PageGraphicElement.)
Scaled
A flag to indicate if this element was scaled.
(Inherited from PageGraphicElement.)
Skew(Single, Single)
Skews the x axis by an skewXAngle and the y axis by an skewYAngle before rendering the element.
(Inherited from PageGraphicElement.)
Skewed
A flag to indicate if this element was skewed.
(Inherited from PageGraphicElement.)
Text
The string to be written

TextAlign
Gets or sets the text alignment.

TextAngle
Gets or sets an angle to control text counter-clockwise direction. The default value is 0.

TextFont
The text font

TextRise
Gets or sets the distance to move the text baseline up or down from its default location. Adjustments to the baseline are useful for drawing superscripts or subscripts. Positive values of text rise move the baseline up and creates a superscript text. Negative values of text rise move the baseline down and creates a subscript text.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Translate(Single, Single)
Translates the coordinate system before rendering the element. The coordinates of the element are relative to the translated coordinate system.
(Inherited from PageGraphicElement.)
Translated
A flag to indicate if this element was translated.
(Inherited from PageGraphicElement.)
Transparency
Gets or sets element transparency. The transparency is expressed as a value between 0 and 100. 0 means completely transparent and 100 completely opaque.
(Inherited from PageGraphicElement.)
VerticalTextAlign
Gets or sets the vertical text alignment.

Width
The width of destination rectangle

WordSpacing
Gets or sets an aditional spacing between words. The words separator is consider the space character with code 32

X
The start x position

Y
The start y position

Inheritance Hierarchy

Assembly: ExpertPdf.HtmlToPdf (Module: ExpertPdf.HtmlToPdf.dll) Version: 9.2.0.25824 (9.2.0.0)