officefileapi-devexpress-dot-pdf-0a768952.md
A signature form field in PDF Graphics API.
Namespace : DevExpress.Pdf
Assembly : DevExpress.Pdf.v25.2.Drawing.dll
NuGet Package : DevExpress.Pdf.Drawing
public class PdfGraphicsAcroFormSignatureField :
PdfGraphicsAcroFormCommonField
Public Class PdfGraphicsAcroFormSignatureField
Inherits PdfGraphicsAcroFormCommonField
The following members return PdfGraphicsAcroFormSignatureField objects:
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 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.
The following parameters are available:
| Parameter | API |
|---|---|
| Text displayed in the form field | Text |
| Image displayed in the form field | ContentDXImage |
| Form field name | Name |
| Tooltip text | ToolTip |
| Appearance settings (background and foreground color, font and border options) | Appearance |
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.25.2 assembly.
To draw an interactive field on a page, call one of the following methods:
The following code snippet uses PDF Graphics API to create a signature field and add it to a new PDF page.
using DevExpress.Pdf;
using DevExpress.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.CreateGraphicsPageSystem())
{
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.
DXImage image = DXImage.FromStream(new FileStream("..\\..\\Image.png", FileMode.OpenOrCreate, FileAccess.Read));
// Add the field to the document.
graphics.AddFormField(signature);
}
Imports DevExpress.Pdf
Imports DevExpress.Drawing
Shared Sub Main(ByVal args() As String)
Using processor As New PdfDocumentProcessor()
' Create an empty document.
processor.CreateEmptyDocument("..\..\Result.pdf")
' Create graphics and draw a signature field.
Using graphics As PdfGraphics = processor.CreateGraphicsPageSystem()
DrawSignatureField(graphics)
' Render a page with graphics.
processor.RenderNewPage(PdfPaperSize.Letter, graphics)
End Using
End Using
End Sub
Private Shared Sub DrawSignatureField(ByVal graphics As PdfGraphics)
' Create a signature field
Dim signature As New PdfGraphicsAcroFormSignatureField("signature", New RectangleF(0, 20, 120, 130))
' Specify a content image for the signature field.
Dim image As DXImage = DXImage.FromStream(New FileStream("..\\..\\Image.png", FileMode.OpenOrCreate, FileAccess.Read))
signature.ContentDXImage = image
' Add the field to the document.
graphics.AddFormField(signature)
End Sub
Object PdfGraphicsAcroFormField PdfGraphicsAcroFormCommonField PdfGraphicsAcroFormSignatureField
See Also