Share via

SignatureCollection Class

  • Article

Contains a Signature object for each digital signature applied to a form or to a set of signable data represented by a SignedDataBlock object.

Namespace: Microsoft.Office.InfoPath
Assembly: Microsoft.Office.InfoPath (in microsoft.office.infopath.dll)

Syntax

'Declaration
'Usage

Remarks

The SignatureCollection object for a form or a set of signable data is accessed through the Signatures property of the SignedDataBlock object that represents that set of signable data.

If the form template is configured to enable digital signatures for the entire form, there is only one SignedDataBlock object for all the data in the form, and the SignatureCollection object contains all digital signatures applied to the entire form.

If the form template is configured to enable digital signatures for specific data in the form, there is a SignedDataBlock object for each set of signable data configured in the form template. In this case, each SignedDataBlock object contains the digital signatures applied to the set of signable data that is associated with the SignedDataBlock object.

The SignatureCollection class provides the CreateSignature method, which creates a Signature object (getting a snapshot of the view plus additional signature information) without adding it to the form. To add this signature to the form, call the Sign method of the Signature class. You can only call the CreateSignature method from the event handler for the Sign event, which only a fully trusted form template can execute.

The SignatureCollection class also provides the Item and Count properties to access and count the Signature objects in the collection.

Example

The following example returns the SignatureCollection object that represents the signatures on the first set of signable data, or, if signing is enabled for the entire form, will return the SignatureCollection object for signatures on the entire form.

SignatureCollection block1Signatures = 
   this.SignedDataBlocks[0].Signatures;

Dim block1Signatures As SignatureCollection = 
   Me.SignedDataBlocks(0).Signatures

Inheritance Hierarchy

System.Object
  Microsoft.Office.InfoPath.SignatureCollection

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

SignatureCollection Members
Microsoft.Office.InfoPath Namespace