SignatureSettings Class

Represents the settings for creating a digital signature.

Inheritance

System.Object

SignatureSettings

Namespace: Syncfusion.Office

Assembly: Syncfusion.Compression.Base.dll

Syntax

public class SignatureSettings : Object

Constructors

SignatureSettings()

Declaration

public SignatureSettings()

Properties

ApplicationVersion

Gets or sets the application version.

Declaration

public string ApplicationVersion { get; set; }

Property Value

Type
System.String

Examples

//Open an existing Word document from a file
WordDocument document = new WordDocument(@"C:\Data\SampleDocument.docx");
//Load the signing certificate
OfficeDigitalSignatureCertificate certificate = new OfficeDigitalSignatureCertificate(@"C:\Data\signer.pfx", "password");
//Set the application version on signature settings
SignatureSettings settings = new SignatureSettings();
settings.ApplicationVersion = "16.0";
document.AddDigitalSignature(certificate, settings);
document.Save(@"C:\Data\SignedDocument.docx", FormatType.Docx);
document.Close();

ColorDepth

Gets or sets the color depth.

Declaration

public int ColorDepth { get; set; }

Property Value

Type
System.Int32

Examples

//Open an existing Word document from a file
WordDocument document = new WordDocument(@"C:\Data\SampleDocument.docx");
//Load the signing certificate
OfficeDigitalSignatureCertificate certificate = new OfficeDigitalSignatureCertificate(@"C:\Data\signer.pfx", "password");
//Set the color depth on signature settings
SignatureSettings settings = new SignatureSettings();
settings.ColorDepth = 32;
document.AddDigitalSignature(certificate, settings);
document.Save(@"C:\Data\SignedDocument.docx", FormatType.Docx);
document.Close();

Comments

Gets or sets the comments for the signature.

Declaration

public string Comments { get; set; }

Property Value

Type
System.String

Examples

//Open an existing Word document from a file
WordDocument document = new WordDocument(@"C:\Data\SampleDocument.docx");
//Load the signing certificate
OfficeDigitalSignatureCertificate certificate = new OfficeDigitalSignatureCertificate(@"C:\Data\signer.pfx", "password");
//Set the signing comments on signature settings
SignatureSettings settings = new SignatureSettings();
settings.Comments = "Approved";
document.AddDigitalSignature(certificate, settings);
document.Save(@"C:\Data\SignedDocument.docx", FormatType.Docx);
document.Close();

HorizontalResolution

Gets or sets the horizontal resolution.

Declaration

public float HorizontalResolution { get; set; }

Property Value

Type
System.Single

Examples

//Open an existing Word document from a file
WordDocument document = new WordDocument(@"C:\Data\SampleDocument.docx");
//Load the signing certificate
OfficeDigitalSignatureCertificate certificate = new OfficeDigitalSignatureCertificate(@"C:\Data\signer.pfx", "password");
//Set the horizontal resolution on signature settings
SignatureSettings settings = new SignatureSettings();
settings.HorizontalResolution = 1920f;
document.AddDigitalSignature(certificate, settings);
document.Save(@"C:\Data\SignedDocument.docx", FormatType.Docx);
document.Close();

OfficeVersion

Gets or sets the office version.

Declaration

public string OfficeVersion { get; set; }

Property Value

Type
System.String

Examples

//Open an existing Word document from a file
WordDocument document = new WordDocument(@"C:\Data\SampleDocument.docx");
//Load the signing certificate
OfficeDigitalSignatureCertificate certificate = new OfficeDigitalSignatureCertificate(@"C:\Data\signer.pfx", "password");
//Set the Office version on signature settings
SignatureSettings settings = new SignatureSettings();
settings.OfficeVersion = "16.0";
document.AddDigitalSignature(certificate, settings);
document.Save(@"C:\Data\SignedDocument.docx", FormatType.Docx);
document.Close();

ProviderId

Gets or sets the provider ID.

Declaration

public Guid ProviderId { get; set; }

Property Value

Type
System.Guid

Examples

//Open an existing Word document from a file
WordDocument document = new WordDocument(@"C:\Data\SampleDocument.docx");
//Load the signing certificate
OfficeDigitalSignatureCertificate certificate = new OfficeDigitalSignatureCertificate(@"C:\Data\signer.pfx", "password");
//Set the provider identifier on signature settings
SignatureSettings settings = new SignatureSettings();
settings.ProviderId = new Guid("00000000-0000-0000-0000-000000000000");
document.AddDigitalSignature(certificate, settings);
document.Save(@"C:\Data\SignedDocument.docx", FormatType.Docx);
document.Close();

SignatureLineId

Gets or sets the signature line ID.

Declaration

public Guid SignatureLineId { get; set; }

Property Value

Type
System.Guid

Examples

//Open a Word document with a signature line
WordDocument document = new WordDocument(@"C:\Data\SampleDocument.docx");
//Load the signing certificate
OfficeDigitalSignatureCertificate certificate = new OfficeDigitalSignatureCertificate(@"C:\Data\signer.pfx", "password");
//Bind the signature to an existing signature line by Id
SignatureSettings settings = new SignatureSettings();
settings.SignatureLineId = new Guid("1f2d3e4a-5b6c-7d8e-9f0a-1b2c3d4e5f6a");
document.AddDigitalSignature(certificate, settings);
document.Save(@"C:\Data\SignedDocument.docx", FormatType.Docx);
document.Close();

SignatureLineImage

Gets or sets the handwritten or typed signature image.

Declaration

public byte[] SignatureLineImage { get; set; }

Property Value

Type	Description
System.Byte[]	A byte array containing the image data used for the signature line.

Remarks

This property is used only when signing an OfficeSignatureLine. The image is written to the SignatureLineImage element in the resulting signature.

Examples

//Open a Word document from a file
WordDocument document = new WordDocument(@"C:\Data\SampleDocument.docx");

OfficeDigitalSignatureCertificate certificate =
    new OfficeDigitalSignatureCertificate(@"C:\Data\signer.pfx", "password");

IWSection section = document.AddSection();
IWParagraph paragraph = section.AddParagraph();

SignatureLineSettings lineSettings = new SignatureLineSettings()
{
    Signer = "John Doe",
    SignerTitle = "Manager",
    Email = "[email protected]",
    Instructions = "Please review and sign.",
    AllowComments = true,
    ShowDate = true
};

IWPicture picture = paragraph.AppendSignatureLine(lineSettings, 192, 96);
OfficeSignatureLine signatureLine = ((WPicture)picture).SignatureLine;

SignatureSettings settings = new SignatureSettings();
settings.SignatureLineId = signatureLine.Id;
settings.SignatureLineImage = File.ReadAllBytes(@"C:\Data\signature.png");
settings.Comments = "Approved";
settings.SignTime = DateTime.Now;
settings.ApplicationVersion = "16.0";
settings.OfficeVersion = "16.0";
settings.WindowsVersion = "10.0";
settings.HorizontalResolution = 1920;
settings.VerticalResolution = 1080;
settings.ColorDepth = 32;

document.AddDigitalSignature(certificate, settings);
document.Save(@"C:\Data\SignedDocument.docx", FormatType.Docx);
document.Close();

SignTime

Gets or sets the signing time.

Declaration

public DateTime SignTime { get; set; }

Property Value

Type
System.DateTime

Examples

//Open an existing Word document from a file
WordDocument document = new WordDocument(@"C:\Data\SampleDocument.docx");
//Load the signing certificate
OfficeDigitalSignatureCertificate certificate = new OfficeDigitalSignatureCertificate(@"C:\Data\signer.pfx", "password");
//Set the signing time on signature settings
SignatureSettings settings = new SignatureSettings();
settings.SignTime = DateTime.Now;
document.AddDigitalSignature(certificate, settings);
document.Save(@"C:\Data\SignedDocument.docx", FormatType.Docx);
document.Close();

VerticalResolution

Gets or sets the vertical resolution.

Declaration

public float VerticalResolution { get; set; }

Property Value

Type
System.Single

Examples

//Open an existing Word document from a file
WordDocument document = new WordDocument(@"C:\Data\SampleDocument.docx");
//Load the signing certificate
OfficeDigitalSignatureCertificate certificate = new OfficeDigitalSignatureCertificate(@"C:\Data\signer.pfx", "password");
//Set the vertical resolution on signature settings
SignatureSettings settings = new SignatureSettings();
settings.VerticalResolution = 1200f;
document.AddDigitalSignature(certificate, settings);
document.Save(@"C:\Data\SignedDocument.docx", FormatType.Docx);
document.Close();

WindowsVersion

Gets or sets the Windows version.

Declaration

public string WindowsVersion { get; set; }

Property Value

Type
System.String

Examples

//Open an existing Word document from a file
WordDocument document = new WordDocument(@"C:\Data\SampleDocument.docx");
//Load the signing certificate
OfficeDigitalSignatureCertificate certificate = new OfficeDigitalSignatureCertificate(@"C:\Data\signer.pfx", "password");
//Set the Windows version on signature settings
SignatureSettings settings = new SignatureSettings();
settings.WindowsVersion = "10.0";
document.AddDigitalSignature(certificate, settings);
document.Save(@"C:\Data\SignedDocument.docx", FormatType.Docx);
document.Close();

XmlDsigLevel

Gets or sets the XML DSig level.

Declaration

public XmlDsigLevel XmlDsigLevel { get; set; }

Property Value

Type
XmlDsigLevel

Examples

//Open an existing Word document from a file
WordDocument document = new WordDocument(@"C:\Data\SampleDocument.docx");
//Load the signing certificate
OfficeDigitalSignatureCertificate certificate = new OfficeDigitalSignatureCertificate(@"C:\Data\signer.pfx", "password");
//Select XAdES-EPES signing level
SignatureSettings settings = new SignatureSettings();
settings.XmlDsigLevel = XmlDsigLevel.XAdEsEpes;
document.AddDigitalSignature(certificate, settings);
document.Save(@"C:\Data\SignedDocument.docx", FormatType.Docx);
document.Close();