PdfDocumentProcessor.CreateEmptyDocument(Stream, PdfSaveOptions, PdfCreationOptions) Method

Creates an empty PDF document with no pages with specified save (encryption settings and a signature) and creation options, and writes it to a stream.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v23.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public void CreateEmptyDocument(
    Stream stream,
    PdfSaveOptions saveOptions,
    PdfCreationOptions creationOptions
)

VB.NET

Public Sub CreateEmptyDocument(
    stream As Stream,
    saveOptions As PdfSaveOptions,
    creationOptions As PdfCreationOptions
)

Parameters

Name	Type	Description
stream	Stream	A stream to which the PDF empty document should be written.
saveOptions	PdfSaveOptions	An object that contains settings to encrypt and sign an empty document.
creationOptions	PdfCreationOptions	An object that contains PDF compatibility and font embedding options.

Remarks

The PDF save options allow you to access the encryption options to protect an empty document with a password and permissions (the PdfSaveOptions.EncryptionOptions property). You can also sign a document using the PdfSaveOptions.Signature property.

Set the PdfCreationOptions.Compatibility property to one of the PdfCompatibility enumeration values to create an empty PDF document. The PdfCreationOptions.DisableEmbeddingAllFonts property allows you to disable embedding all fonts when the document is created. To disable embedding certain fonts, use the PdfCreationOptions.NotEmbeddedFontFamilies property.

Note

When all operations with a created document are completed, close the document either by the PdfDocumentProcessor.CloseDocument method call or dispose of the PdfDocumentProcessor instance.

The PDF specification does not describe empty documents. For this reason, most third-party PDF viewers cannot open such files. This does not apply to the DevExpress WinForms PDF Viewer and WPF PDF Viewer, which are less demanding concerning the validity of opened documents, and are capable of opening documents containing no pages.

This CreateEmptyDocument method overload writes generated document content into the stream specified as this method’s parameter. The SaveDocument method call rewrites this stream.

Example

This example shows how to use PDF Graphics API to create a document with graphics content.

View Example

Program.cs

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

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;

    DXFont font1 = new DXFont("Times New Roman", 32, DXFontStyle.Bold);
    graph.DrawString("PDF Document Processor", font1, black, 180, 150);

    DXFont font2 = new DXFont("Arial", 20);
    graph.DrawString("Display, Print and Export PDF Documents", font2, black, 168, 230);

    DXFont font3 = new DXFont("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);

}

Program.vb

Imports DevExpress.Pdf
Imports System
Imports System.Drawing
'...

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

Shared Sub DrawGraphics(ByVal graph As PdfGraphics)
    ' Draw text lines on the page.
    Dim black As SolidBrush = CType(Brushes.Black, SolidBrush)

    Dim font1 As New DXFont("Times New Roman", 32, DXFontStyle.Bold)
    graph.DrawString("PDF Document Processor", font1, black, 180, 150)

    Dim font2 As New DXFont("Arial", 20)
    graph.DrawString("Display, Print and Export PDF Documents", font2, black, 168, 230)

    Dim font3 As New DXFont("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 Sub