PdfGraphics Class

Implements drawing on a PDF page.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v18.2.Drawing.dll

Declaration

C#

public class PdfGraphics :
    PdfDisposableObject

VB.NET

Public Class PdfGraphics
    Inherits PdfDisposableObject

Related API Members

The following members return PdfGraphics objects:

• PdfDocumentProcessor.CreateGraphics()

Remarks

The PdfGraphics class uses the world coordinate system. See the Coordinate Systems topic to learn more.

The PdfGraphics class contains all graphics content that allows an application to draw on the document. In addition to the properties (e.g., PdfGraphics.TextOrigin and PdfGraphics.JpegImageQuality), this class declares the methods used to create an image (PdfGraphics.DrawImage), text (PdfGraphics.DrawString) and graphic elements on a document.

For more details, see the PDF Graphics section.

Example

The PDF Document Processor allows you to draw graphic primitives on the PDF page, such as lines, Bezier curves, polygons, ellipses, paths, an image and a string.

This example shows how to draw a business card in the document foreground. To accomplish this task, do the following:

• Create a PDF document processor and add an empty document to it by calling the PdfDocumentProcessor.CreateEmptyDocument method.
• Create PDF graphics represented by an instance of the PdfGraphics class by calling the PdfDocumentProcessor.CreateGraphics method. To access PdfGraphics, you need to reference the DevExpress.Pdf.Drawing assembly.
• To draw an image on the PDF page, call the PdfGraphics.DrawImage method for the specified image at the specified location with the specified size.
• To draw text, call the PdfGraphics.DrawString method at the specified location with the specified Brush and Font objects.
• Render a page with created graphics by calling the PdfDocumentProcessor.RenderNewPage method.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-generate-a-document-layout-from-scratch-t244516

Program.vb

Imports DevExpress.Pdf
Imports System
Imports System.Drawing

Namespace DocumentCreationAPI
    Friend Class Program

        Shared Sub Main(ByVal args() As String)

            Using processor As New PdfDocumentProcessor()

                ' Create an empty document.
                processor.CreateEmptyDocument("..\..\Result.pdf")

                ' Create and draw PDF graphics.
                Using graph As PdfGraphics = processor.CreateGraphics()
                    DrawGraphics(graph)

                    ' Render a page with graphics.
                    processor.RenderNewPage(PdfPaperSize.Letter, graph)
                End Using
            End Using
        End Sub

        Private Shared Sub DrawGraphics(ByVal graph As PdfGraphics)

            ' Draw text lines on the page. 
            Dim black As SolidBrush = CType(Brushes.Black, SolidBrush)
            Using font1 As New Font("Times New Roman", 32, FontStyle.Bold)
                graph.DrawString("PDF Document Processor", font1, black, 180, 150)
            End Using
            Using font2 As New Font("Arial", 20)
                graph.DrawString("Display, Print and Export PDF Documents", font2, black, 168, 230)
            End Using
            Using font3 As New Font("Arial", 10)
                graph.DrawString("The PDF Document Processor is a non-visual component " & "that provides the application programming interface of the PDF Viewer.", font3, black, 16, 300)
            End Using
        End Sub
    End Class
End Namespace

Program.cs

using DevExpress.Pdf;
using System;
using System.Drawing;

namespace DocumentCreationAPI {
    class Program {

        static void Main(string[] args) {

            using (PdfDocumentProcessor processor = new PdfDocumentProcessor()) {

                // Create an empty document.
                processor.CreateEmptyDocument("..\\..\\Result.pdf");

                // Create and draw PDF graphics.
                using (PdfGraphics graph = processor.CreateGraphics()) {
                    DrawGraphics(graph);

                    // Render a page with graphics.
                    processor.RenderNewPage(PdfPaperSize.Letter, graph);
                }
            }
        }

        static void DrawGraphics(PdfGraphics graph) {

            // Draw text lines on the page. 
            SolidBrush black = (SolidBrush)Brushes.Black;
            using (Font font1 = new Font("Times New Roman", 32, FontStyle.Bold)) {
                graph.DrawString("PDF Document Processor", font1, black, 180, 150);
            }
            using (Font font2 = new Font("Arial", 20)) {
                graph.DrawString("Display, Print and Export PDF Documents", font2, black, 168, 230);
            }
            using (Font font3 = new Font("Arial", 10)) {
                graph.DrawString("The PDF Document Processor is a non-visual component " +
                                  "that provides the application programming interface of the PDF Viewer.", font3, black, 16, 300);
            }
        }
    }
}

Inheritance

Object

DevExpress.Pdf.Native.PdfDisposableObject

PdfGraphics