Implement custom serialization with QR-Code signatures

GroupDocs.Signature provides ability to embed into QR-code signature custom objects. This feature is implemented over object serialization to string and further encryption. There is ability to provide custom encryption. This procedure requires implementation of interface IDataEncryption with two methods to encrypt and decrypt data.

Here are the steps to embed into QR-code text with custom encryption with GroupDocs.Signature:

  • Define custom data encryption class that implements IDataEncryption interface. By default GroupDocs.Signature has several encryption implementation you can use but allows user to customize it.
  • Implement class with properties and specify if needed class attributes (like custom serialization attribute, custom encryption attribute), specify attributes for properties like FormatAttribute attribute to specify serialization name and display format, same as SkipSerializationAttribute to mark property of class as not serialize
  • Create new instance of Signature class and pass source document path as a constructor parameter.
  • Create one or several objects of QrCodeSignOptions object with Data value
  • Instantiate the QrCodeSignOptions object according to your requirements and custom object to Data property.
  • Call Sign method of  Signature  class instance and pass QrCodeSignOptions to it.

This example shows how to specify custom serialization class. This class could be implemented also as Attribute (optional) to specify as class attribute.

class CustomSerializationAttribute : Attribute, IDataSerializer
    public T Deserialize<T>(string source) where T : class
        return JsonConvert.DeserializeObject<T>(source);
    public string Serialize(object data)
        var serializerSettings = new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore };
        return JsonConvert.SerializeObject(data, serializerSettings);

Definition of class

This example shows how to define custom class with serialization and encryption properties and setup Format attributes for properties.

// setup CustomSerialization Attribute to setup customer serialization(see example above)
public class DocumentSignatureData
    public string ID { get; set; }
    public string Author { get; set; }
    [Format("SDate", "yyyy-MM-dd")]
    public DateTime Signed { get; set; }
    [Format("SDFact", "N2")]
    public decimal DataFactor { get; set; }
    public string Comments { get; set; }

Sign documents with custom encrypted objects and values into QR-code signatures

This example shows how to add custom object into metadata signature to Image document.

using (Signature signature = new Signature("sample.pdf"))
    // create data encryption
    IDataEncryption encryption = new CustomXOREncryption();
    // create custom object
    DocumentSignatureData documentSignatureData = new DocumentSignatureData()
        ID = Guid.NewGuid().ToString(),
        Author = Environment.UserName,
        Signed = DateTime.Now,
        DataFactor = 11.22M
    // setup QR-Code options
    QrCodeSignOptions options = new QrCodeSignOptions()
        // set custom object to serialize to QR Code
        Data = documentSignatureData,
        // QR-code type
        EncodeType = QrCodeTypes.QR,
        // specify serialization encryption
        DataEncryption = encryption,
        // locate and aligh signature
        Height = 100,
        Width = 100,
        VerticalAlignment = VerticalAlignment.Bottom,
        HorizontalAlignment = HorizontalAlignment.Right,
        Margin = new Padding() { Right = 10, Bottom = 10 }
    // sign document to file
    signature.Sign("QRCodeCustomSerialization.pdf", options);

More resources

GitHub Examples

You may easily run the code above and see the feature in action in our GitHub examples:

Free Online App

Along with full-featured .NET library we provide simple, but powerful free Apps.

You are welcome to eSign PDF, Word, Excel, PowerPoint documents with free to use online GroupDocs Signature App.

© Aspose Pty Ltd 2001-2022. All Rights Reserved.