SignatureProvider.GenerateSignatureLineImage Method

Gets a signature line image.

Namespace:  Microsoft.Office.Core
Assembly:  office (in office.dll)

Syntax

'Declaration
Function GenerateSignatureLineImage ( _
    siglnimg As SignatureLineImage, _
    psigsetup As SignatureSetup, _
    psiginfo As SignatureInfo, _
    XmlDsigStream As Object _
) As IPictureDisp
'Usage
Dim instance As SignatureProvider
Dim siglnimg As SignatureLineImage
Dim psigsetup As SignatureSetup
Dim psiginfo As SignatureInfo
Dim XmlDsigStream As Object
Dim returnValue As IPictureDisp

returnValue = instance.GenerateSignatureLineImage(siglnimg, _
    psigsetup, psiginfo, XmlDsigStream)

IPictureDisp GenerateSignatureLineImage(
    SignatureLineImage siglnimg,
    SignatureSetup psigsetup,
    SignatureInfo psiginfo,
    Object XmlDsigStream
)

Parameters

• siglnimg
  Type: Microsoft.Office.Core.SignatureLineImage

  Contains the name if the signature line graphic.

• psigsetup
  Type: Microsoft.Office.Core.SignatureSetup

  Specifies initial settings of the signature provider add-in.

• psiginfo
  Type: Microsoft.Office.Core.SignatureInfo

  Specifies information about the signature provider add-in.

• XmlDsigStream
  Type: System.Object

Return Value

Type: IPictureDisp
IPictureDisp

Remarks

The SignatureProvider object is used exclusively in custom signature provider add-ins. This method is called for each of the images that is displayed in the document's content. The method can be called asynchronously. For example, the method may be called for the "Unsigned" image and the "No-software" image directly after signature setup. The method may then be called after signing for the "Signed" image. The four images used are:

• siglnimgSoftwareRequired: This image is displayed to the user if the signature provider add-in is not installed on the user's computer. If the user tries to sign or view a signature line, they are redirected to a provider-supplied hyperlink specified in the GetProviderDetail(SignatureProviderDetail) method.

• siglnimgUnsigned: This image is displayed for an unsigned signature image. Basically, when a document loads with an unsigned signature line, the signature provider prompts for an up-to-date signature image and shows this image.

• siglnimgSignedValid: This is the image that is displayed when a signature line is signed and valid (or, to be more specific, signed and the signature does not register as invalid). When the document opens, it is assumed that all signed signatures are valid until the verification process is complete, at which point a "Signed/invalid" image is displayed for the invalid signatures. Because signature verification is time-intensive, the signature verification runs in parallel with Office on a background thread. Because your add-in implements signature verification, your code runs parallel with Office and should not attempt to display UI during signing or verifying.

• siglnimgSignedInvalid: This is the image we show when a signature line is signed but there is a problem with the signature, such as the document was modified or the user's certificate is revoked. Because your add-in implements signature verification, you can decide how and when a signature is invalid.

See Also

Reference

SignatureProvider Interface

SignatureProvider Members

Microsoft.Office.Core Namespace