Text |
The TextElement type exposes the following members.
| Name | Description | |
|---|---|---|
| TextElement(Single, Single, String, PdfFont) | 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 added with Document.AddFont from an installed font or a font file is embedded in the generated PDF document. 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) | 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 added with Document.AddFont from an installed font or a font file is embedded in the generated PDF document. 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) | 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 added with Document.AddFont from an installed font or a font file is embedded in the generated PDF document. 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) | 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 added with Document.AddFont from an installed font or a font file is embedded in the generated PDF document. 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) | 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 added with Document.AddFont from an installed font or a font file is embedded in the generated PDF document. 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) | 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 added with Document.AddFont from an installed font or a font file is embedded in the generated PDF document. 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. |
| Name | Description | |
|---|---|---|
| ActualText |
Gets or sets the exact text this element stands for in a tagged document, when its content does not
spell it (text drawn as an image or with an unusual font, for example). The default value is null.
(Inherited from PageElement) | |
| AlternateText |
Gets or sets the alternate description of this element in a tagged document, read by assistive
technology instead of the content - the description of a figure, for example. PDF/UA requires it
for figures. The default value is null.
(Inherited from PageElement) | |
| Artifact |
Gets or sets whether this element is decorative in a tagged document: it is marked as an artifact
(a background, a rule, a running header) and left out of the logical structure. The default value
is false.
(Inherited from PageElement) | |
| BackColor |
Gets or sets the element background color.
(Inherited from PageGraphicElement) | |
| Blending |
Gets or sets the blending mode for the transparent rendering 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 the color space the element colors are written in: RGB (the default), CMYK or
grayscale.
(Inherited from PageGraphicElement) | |
| ForeColor |
Gets or sets the element foreground color.
(Inherited from PageGraphicElement) | |
| Gradient |
Gets or sets 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 of the elements that render lines.
(Inherited from PageGraphicElement) | |
| Paginate | When true the text can be paginated | |
| RightToLeftLanguage | Set this property true if the text is in a RTL language. | |
| Rotated |
Gets whether the element is rotated (Rotate was called with a non-zero angle).
(Inherited from PageGraphicElement) | |
| Scaled |
Gets whether the element is scaled (Scale was called with a factor other than 1).
(Inherited from PageGraphicElement) | |
| Skewed |
Gets whether the element is skewed (Skew was called with a non-zero angle).
(Inherited from PageGraphicElement) | |
| TagType |
Gets or sets the structure type of this element in a tagged document (a heading, a paragraph, a figure
and so on). Every element added to a tagged document must have a tag type or be an
Artifact. Ignored in a document that is not tagged. The default value is null.
(Inherited from PageElement) | |
| 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. | |
| Translated |
Gets whether the element is translated (Translate was called with a non-zero offset).
(Inherited from PageGraphicElement) | |
| Transparency |
Gets or sets the element transparency, as a value between 0 and 100: 0 means completely
transparent and 100 completely opaque. The default value is 100.
(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 |
| Name | Description | |
|---|---|---|
| Rotate |
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) | |
| Scale |
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) | |
| Skew |
Skews the x axis by an skewXAngle and the y axis by an skewYAngle
before rendering the element.
(Inherited from PageGraphicElement) | |
| Translate |
Translates the coordinate system before rendering the element.
The coordinates of the element are relative to the translated coordinate system.
(Inherited from PageGraphicElement) |