.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

PdfGraphicsAcroFormSignatureField Class

A signature form field in PDF Graphics API.

Namespace: DevExpress.Pdf

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

Declaration

public class PdfGraphicsAcroFormSignatureField :
    PdfGraphicsAcroFormCommonField

Remarks

Tip

Use the PdfSignatureBuilder class to create a signature field and sign a PDF file. Refer to the following article for more information: Sign PDF Documents.

Create a Form Field

Create a new PdfGraphicsAcroFormSignatureField object, and pass the field name and location as constructor parameters. The field location is calculated in the world coordinate system.

You can also call the PdfGraphicsAcroFormField.CreateSignature method to create a new PdfGraphicsAcroFormSignatureField object.

Specify Form Field Parameters

The following parameters are available:

Parameter API
Text displayed in the form field Text
Image displayed in the form field ContentImage
Form field name Name
Tooltip text ToolTip
Appearance settings (background and foreground color, font and border options) Appearance

Add a Form Field as a Graphics Content

To add a text signature field as graphics content, pass a PdfGraphicsAcroFormSignatureField instance as a parameter to the PdfGraphics.AddFormField method.

To access the PdfGraphics class, reference the DevExpress.Pdf.Drawing.v.21.2 assembly.

Draw a Form Field on a Page

To draw an interactive field on a page, call one of the following methods:

Example

This example shows how to use PDF Graphics API to create a signature field and add it to a new PDF page.

using DevExpress.Pdf;
using System.Drawing;

//...

static void Main(string[] args)
{
    using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
    {
        // Create an empty document. 
        processor.CreateEmptyDocument("..\\..\\Result.pdf");

        // Create graphics and draw a signature field.
        using (PdfGraphics graphics = processor.CreateGraphics())
        {
            DrawSignatureField(graphics);

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

static void DrawSignatureField(PdfGraphics graphics)
{
    // Create a signature field
    PdfGraphicsAcroFormSignatureField signature = new PdfGraphicsAcroFormSignatureField("signature", new RectangleF(0, 20, 120, 130));

    // Specify a content image for the signature field.
    Image image = Image.FromFile("..\\..\\Image.png");
    signature.ContentImage = image;            

    // Add the field to the document.
    graphics.AddFormField(signature);
}

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PdfGraphicsAcroFormSignatureField class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

Inheritance

See Also