PdfSignatureOptions.DefaultHashAlgorithm Property

Specifies the default hash algorithm to be used in PDF documents generated within the application.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v23.2.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public static PdfHashAlgorithm DefaultHashAlgorithm { get; set; }

VB.NET

Public Shared Property DefaultHashAlgorithm As PdfHashAlgorithm

Property Value

Type	Description
PdfHashAlgorithm	The default hash algorithm to be used in PDF documents generated within the application.

Available values:

Name	Description
SHA1	Obsolete. This field is obsolete (do not use this value due to security reasons).
SHA256
SHA384
SHA512

Property Paths

You can access this nested property as listed below:

Object Type	Path to DefaultHashAlgorithm
PdfExportOptions	.SignatureOptions .DefaultHashAlgorithm

Remarks

Important

For security reasons, do not set this property to SHA-1.

The code sample below shows how to specify the default hash algorithm for PDF export files to SHA-512.

C#

// Specifies the default hash algorithm.
DevExpress.XtraPrinting.PdfSignatureOptions.DefaultHashAlgorithm = PdfHashAlgorithm.SHA512;
// Creates a simple report.
XtraReport report = new XtraReport()
{
    Name = "SimpleReport",
    Bands = {
        new DetailBand() {
            Controls = {
                new XRLabel() {
                    Text = "Simple Report"
                }
            }
        }
    }
};
// Exports the report to the user's Downloads folder.
report.ExportToPdf(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile)
    + @"\Downloads\" + report.Name + ".pdf");

VB.NET

Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraPrinting
' ...
' Specifies the default hash algorithm.
DevExpress.XtraPrinting.PdfSignatureOptions.DefaultHashAlgorithm = PdfHashAlgorithm.SHA512
' Creates a simple report.
Dim report = New XtraReport()
Dim band = New DetailBand()
Dim control1 = New XRLabel() With {
    .Name = "Label1",
    .Text = "Simple Report"
}
band.Controls.AddRange(New XRControl() {control1})
report.Bands.Add(band)
' Exports the report to the Downloads folder.
report.ExportToPdf(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile) _
    & "\Downloads\" & report.Name & ".pdf")