Edit

Share via

SignatureSet object (Office)

  • Article

A collection of Signature objects that correspond to the digital signature attached to a document.

Remarks

Use the Signatures property of the Document object to return a SignatureSet collection; for example:

Set sigs = ActiveDocument.Signatures

You can add a Signature object to a SignatureSet collection by using the Add method, and you can return an existing member by using the Item method.

The AddSignatureLine method also adds a Signature object to the collection. Also see the Subset property, which acts as a filter for whether certain Signature objects appear in the collection.

To remove a Signature from a SignatureSet collection, use the Delete method of the Signature object.

Example

The following example prompts the user to select a digital signature with which to sign the active document in Microsoft Word. To use this example, open a document in Word and pass this function the name of a certificate issuer and the name of a certificate signer that match the Issued By and Issued To fields of a digital certificate in the Digital Certificates dialog box. This example will test to make sure that the digital signature that the user selects meets certain criteria, such as not having expired, before the new signature is committed to the disk.

Function AddSignature(ByVal strIssuer As String, _ 
 strSigner As String) As Boolean 
 
 Dim sig As Signature 
 
 'Display the dialog box that lets the 
 'user select a digital signature. 
 'If the user selects a signature, then 
 'it is added to the Signatures 
 'collection. If the user doesn't, then 
 'an error is returned. 
 Set sig = ActiveDocument.Signatures.Add 
 
 'Test several properties before committing the Signature object to disk. 
 If sig.Issuer = strIssuer And _ 
 sig.Signer = strSigner And _ 
 sig.IsCertificateExpired = False And _ 
 sig.IsCertificateRevoked = False And _ 
 sig.IsValid = True Then 
 
 MsgBox "Signed" 
 AddSignature = True 
 'Otherwise, remove the Signature object from the SignatureSet collection. 
 Else 
 sig.Delete 
 MsgBox "Not signed" 
 AddSignature = False 
 End If 
 
End Function

See also

Support and feedback

Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.