TextElement Class

Constructs 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.

Constructs 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.

Constructs 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.

Constructs 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.

Constructs 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.

Constructs 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.

Gets or sets element background color.

Gets or sets blending mode for transparent rendering mode of the element.

Gets or sets an additional spacing between characters.

A rectangle to be added to the current cliping path

Gets or sets color space for element rendering.

Gets or sets the element foreground color.

The gradient used to fill a shape.

The height of the destination rectangle Is optional

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

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

Gets or sets the line style for elements rendering lines.

When true the text can be paginated

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

A flag to indicate if this element was rotated.

A flag to indicate if this element was scaled.

A flag to indicate if this element was skewed.

The string to be written

Gets or sets the text alignment.

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

The text font

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.

A flag to indicate if this element was translated.

Gets or sets element transparency. The transparency is expressed as a value between 0 and 100. 0 means completely transparent and 100 completely opaque.

Gets or sets the vertical text alignment.

The width of destination rectangle

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

The start x position

The start y position

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.

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.

Skews the x axis by an skewXAngle and the y axis by an skewYAngle before rendering the element.

Translates the coordinate system before rendering the element. The coordinates of the element are relative to the translated coordinate system.