Winnovative PDF Next Library for .NET Documentation
Pdf
Represents a block of text to be rendered in a PDF document.
Supports positioning, styling and multi-page continuation
Definition
Namespace: Winnovative.Pdf.Next
Assembly: Winnovative.Pdf.Next (in Winnovative.Pdf.Next.dll) Version: 21.0.3
Assembly: Winnovative.Pdf.Next (in Winnovative.Pdf.Next.dll) Version: 21.0.3
C#
public class PdfTextElement- Inheritance
- Object PdfTextElement
Constructors
| PdfTextElement | Initializes a new instance of the PdfTextElement class with the specified text and font. Use PdfFontManager to create the font |
Properties
| Accessibility | Accessibility metadata used when the host PdfDocument is tagged. The default structure type for a text block is Paragraph; set StructureType to Heading1..Heading6 for headings, or to Artifact for decorative fragments |
| Alignment | The horizontal alignment of the text |
| BackgroundColor | Optional background color drawn behind the text on each page where the text is rendered. The background covers the area available to the text on the page and follows the rotation of the element. When null, the default, no background is drawn |
| BackgroundOpacity | The opacity of the background color in the range 0..1. The default value is 1 which produces a fully opaque background |
| ContinuationBottomMargin | In a PdfEditor, the distance in points from the bottom of the pages to the lowest point the text can reach on each page, starting with the page where it starts. Has no effect in a PdfDocument, where the bottom margin of the document applies. The default value is 0 |
| ContinuationTopMargin | In a PdfEditor, the distance in points from the top of the pages where the text continues to the top of the continued text. Has no effect in a PdfDocument, where the top margin of the document applies. The default value is 0 |
| ContinueOnNextPage | When true, text that does not fit on the page continues on the next pages. In a PdfDocument the next pages are new pages and the margins of the document apply. In a PdfEditor the next pages are the following pages of the document, or pages inserted after the current one when InsertContinuationPages is true, and the ContinuationTopMargin and ContinuationBottomMargin properties give the area of the pages the text can use. The default value is false |
| Direction | The direction in which the text is rendered (LTR or RTL) Default is LeftToRight. |
| Font | The font used to render the text content created by PdfFontManager |
| Height | The height of the text block. If zero or negative, the available page height is used |
| InsertContinuationPages | In a PdfEditor, when true, the pages where the text continues are inserted after the page where it starts, so the following pages of the document keep their content. When false, the default, the text continues on the following pages of the document and new pages are added only at its end. Has no effect in a PdfDocument |
| Leading | The line spacing multiplier used when rendering text. This value is multiplied by the font size to determine the space between lines. If zero, a default value of 1.2 is used |
| OnAfterPageRender | Optional callback called after the text was rendered on each page, with the PdfTextPageRenderInfo of that page: the rectangle of the rendered text, its four corners when the text is rotated, its visible part, the size of the page and the part of the text drawn on the page |
| OnBeforePageRender | Optional callback called before the text is drawn on each page, with the PdfTextPageRenderInfo of that page: the rectangle the text is about to use and the part of the text drawn on the page. The content drawn on the page from the callback, like a background or a decoration, appears under the text |
| OnPageRendered | Optional callback called after the text was rendered on each page, with the page number and the rectangle of the rendered text. The rectangle is relative to the content area of the page in a document, to the top left corner of the page in an edited document and to the template when the text was added to a template |
| Opacity | Opacity of the rendered text (0..1). Default is 1 (fully opaque) |
| PageNumberOffset | An optional offset (positive or negative) applied to the current page number when replacing the {page_number} placeholder. The default value is 0 |
| RotationDegrees | Rotation angle in degrees applied to the entire text block. Positive values rotate counter-clockwise. Default is 0 (no rotation) |
| RotationPivot | Gets or sets the pivot point used when rotating this element. The pivot determines which point of the element's bounding box remains fixed during rotation. The default value is TopLeft. |
| Text | The text content to be rendered. Supports placeholder variables such as {page_number} and {total_pages} which are replaced with their actual values in the rendered PDF. Placeholders also work when the text is added inside a PdfTemplate that is repeated across PDF pages. |
| TotalPagesOffset | An optional offset (positive or negative) applied to the total number of pages when replacing the {total_pages} placeholder. The default value is 0 |
| Width | The width of the text block. If zero or negative, the available page width is used |
| X | The X position of the text block, in points and relative to the top left corner of the content area of the page in a document, of the page in an edited document or of the template |
| Y | The Y position of the text block, in points and relative to the top left corner of the content area of the page in a document, of the page in an edited document or of the template |
Methods
| Equals | (Inherited from Object) |
| Finalize | (Inherited from Object) |
| GetHashCode | (Inherited from Object) |
| GetType | (Inherited from Object) |
| MemberwiseClone | (Inherited from Object) |
| ToString | (Inherited from Object) |