PdfCanvas Class


PdfCanvas Class

Base class for objects that can render pdf page elements.

Inheritance Hierarchy

SystemObject
  SelectPdf.UniversalPdfCanvas
    SelectPdf.UniversalPdfPage
    SelectPdf.UniversalPdfTemplate

Namespace: SelectPdf.Universal
Assembly: SelectPdf.Universal (in SelectPdf.Universal.dll) Version: 26.4

Syntax

Copy

public abstract class PdfCanvas

Public MustInherit Class PdfCanvas

The PdfCanvas type exposes the following members.

Constructors

	Name	Description
	PdfCanvas

Top

Properties

	Name	Description
	ClientRectangle	Gets the drawable area of the canvas. The page margins (and, for a page, the document header and footer) are excluded.

Top

Methods

	Name	Description
	Add	Adds a pdf page element to the canvas.
	AddAsync(PdfPageElement)	Adds a pdf page element to the canvas without waiting for it to be rendered.
	AddAsync(PdfPageElement, CancellationToken)	Adds a pdf page element to the canvas without waiting for it to be rendered, stopping when the specified token is cancelled.
	MeasureString	Measures the size of the specified string when rendered with the specified font.

Top

Remarks

PdfCanvas is the base class for PdfPage and PdfTemplate. Use PdfPage to add elements at a specific position on a single page; use PdfTemplate to add elements that repeat on more than one page.

Example

Copy

PdfDocument document = new PdfDocument();
PdfCanvas canvas = document.AddPage();
PdfFont font = PdfFont.CreateStandardFont(PdfStandardFont.Helvetica, 12f);
SizeF size = canvas.MeasureString("Hello", font);
RectangleF area = canvas.ClientRectangle;
document.Close();

Dim document As New PdfDocument()
Dim canvas As PdfCanvas = document.AddPage()
Dim font As PdfFont = PdfFont.CreateStandardFont(PdfStandardFont.Helvetica, 12.0F)
Dim size As SizeF = canvas.MeasureString("Hello", font)
Dim area As RectangleF = canvas.ClientRectangle
document.Close()

Reference

SelectPdf.Universal Namespace