PdfSignatureOptions.ImageSource Property

Gets or sets an image to display in the visual signature field of a digitally signed PDF document.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v26.1.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

[DefaultValue(null)]
public ImageSource ImageSource { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property ImageSource As ImageSource

Property Value

Type	Default	Description
ImageSource	null	An image displayed in the visual signature field.

Property Paths

You can access this nested property as listed below:

Object Type	Path to ImageSource
PdfExportOptions	.SignatureOptions .ImageSource

Remarks

Use the ImageSource property to specify a visual representation (for example, a scanned handwritten signature or logo) for the digital signature that is displayed on the PDF page. The image is embedded into the signature field and does not affect the cryptographic validity of the signature.

The XRPdfSignature control uses the ImageSource property to render the document signature in reports exported to PDF.

The following example applies a digital signature when a report is exported to PDF.

void Export() {
    // Create a report.
    XtraReport1 report = new XtraReport1();

    // Create a new X509Certificate2 object.
    X509Certificate2 certificate = new X509Certificate2();

    // Initialize and configure a local certificate storage.
    X509Store store = new X509Store(StoreName.My, StoreLocation.CurrentUser);
    store.Open(OpenFlags.ReadOnly | OpenFlags.OpenExistingOnly);

    // Initialize a certificate collection.
    X509Certificate2Collection collection = (X509Certificate2Collection)store.Certificates;
    X509Certificate2Collection fcollection =
        (X509Certificate2Collection)collection.Find(X509FindType.FindByTimeValid, DateTime.Now, true);
    X509Certificate2Collection scollection =
        X509Certificate2UI.SelectFromCollection(fcollection, "Select a Certificate",
            "Select a certificate to view its details.",
            X509SelectionFlag.SingleSelection);
    if (scollection.Count > 0)
        certificate = scollection[0];

    // Specify PDF signature options.
    report.ExportOptions.Pdf.SignatureOptions.Reason = "Approved";
    report.ExportOptions.Pdf.SignatureOptions.Location = "USA";
    report.ExportOptions.Pdf.SignatureOptions.Certificate = certificate;
    // svgImageCollection stores SVG images.
    // In this example, it was created and populated at design time.
    report.ExportOptions.Pdf.SignatureOptions.ImageSource = new ImageSource(svgImageCollection1["approved"]);

    // Export the report to PDF.
    report.ExportToPdf("test.pdf");

    System.Diagnostics.Process.Start("test.pdf");
}

View Example: Apply a Digital Signature

See the following help topic for more information: Create a Report with a Visual PDF Signature in the Visual Studio Report Designer.

Related GitHub Examples

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

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.

C#

reporting-winforms-export-pdf-digital-signature/CS/pdf-signature-sample/Form1.cs#L42

// In this example, it was created and populated at design time.
report.ExportOptions.Pdf.SignatureOptions.ImageSource = new ImageSource(
    svgImageCollection1["approved"]