SignatureLine Class
Digital Signature Line.When the object is serialized out as xml, its qualified name is o:signatureline.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Vml.Office.SignatureLine
Namespace: DocumentFormat.OpenXml.Vml.Office
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class SignatureLine _
Inherits OpenXmlLeafElement
'Usage
Dim instance As SignatureLine
public class SignatureLine : OpenXmlLeafElement
Remarks
[ISO/IEC 29500-1 1st Edition]
14.2.2.30 signatureline (Digital Signature Line)
This element specifies a signature line in a document. A signature line provides a visual representation of a signature in a document that is digitally signed. The signature line element indicates that the VML shape in which it appears acts as that visual representation. Typically, the VML shape is an image.
[Example:
<v:shape … >
<v:imagedata … />
<o:signatureline v:ext="edit" id="{11979195-DE54-414B-ABD6-5F63607C648B}"
provid="{00000000-0000-0000-0000-000000000000}" o:suggestedsigner="John Doe"
o:suggestedsigner2="Manager" o:suggestedsigneremail=johndoe@example.com
allowcomments="t" issignatureline="t"/>
</v:shape>
The signature line in the document might look like this:
.png "DocumentFormat.OpenXml.Vml.Office.SignatureLine-im")
end example]
Parent Elements |
|---|
arc (§14.1.2.1); background (Part 1, §17.2.1); curve (§14.1.2.3); group (§14.1.2.7); hdrShapeDefaults (§9.7.2.1); image (§14.1.2.10); line (§14.1.2.12); object (Part 1, §17.3.3.19); oval (§14.1.2.13); pict (§9.2.2.2); pict (§9.5.1); polyline (§14.1.2.15); rect (§14.1.2.16); roundrect (§14.1.2.17); shape (§14.1.2.19); shapeDefaults (§9.7.2.2); shapetype (§14.1.2.20) |
Attributes |
Description |
|---|---|
addlxml (Additional Signature Information) |
Specifies an optional string that is used to store additional information about the digital signature. Default is no value. [Rationale: Some digital signature software stores, for example, server and region information with the signature. end rationale] [Example: <o:signatureline … o:addlxml="…"> </o:signatureline> end example] The possible values for this attribute are defined by the W3C XML Schema string datatype. |
allowcomments (User-specified Comments Flag) |
Specifies whether the user can attach comments to the signature line at signing time. Default is false. [Example: <o:signatureline … allowcomments="true"> </o:signatureline> end example] The possible values for this attribute are defined by the ST_TrueFalse simple type (§15.1.2.5). |
ext (VML Extension Handling Behavior) Namespace: urn:schemas-microsoft-com:vml |
Specifies an optional value that indicates how applications that implement VML should interpret extensions not defined as part of the original specification of core VML. [Rationale: This part of the original VML specification is included to assist applications that leverage existing VML support in implementing the Office Open XML Format. end rationale] The possible values for this attribute are defined by the ST_Ext simple type (§14.1.3.2). |
id (Unique ID) |
Specifies a unique ID for the signature line. Default is no value. [Example: <o:signatureline …
id="{11979195-DE54-414B-ABD6-5F63607C648B}">
</o:signatureline>
end example] The possible values for this attribute are defined by the ST_Guid simple type (Part 1, §22.9.2.4). |
issignatureline (Signature Line Flag) |
Specifies whether the image is a signature line. Default is true. [Example: <o:signatureline … issignatureline="true"> </o:signatureline> end example] The possible values for this attribute are defined by the ST_TrueFalse simple type (§15.1.2.5). |
provid (Signature Provider ID) |
Specifies a unique ID identifying which signature provider created the signature line. Default is no value. [Guidance The GUID is typically the CLSID of the provider COM add-in. end guidance] [Example: <o:signatureline …
provid="{00000000-0000-0000-0000-000000000000}">
</o:signatureline>
end example] The possible values for this attribute are defined by the ST_Guid simple type (Part 1, §22.9.2.4). |
showsigndate (Show Signed Date Flag) |
Specifies whether the signed signature line image generated should include the date of signing. Default is true. [Example: <o:signatureline … showsigndate="false"> </o:signatureline> end example] The possible values for this attribute are defined by the ST_TrueFalse simple type (§15.1.2.5). |
signinginstructions (Instructions for Signing) |
Specifies text shown to the user at signing time. Default is no value. [Example: <o:signatureline … o:signinginstructions="Sign here"> </o:signatureline> end example] The possible values for this attribute are defined by the W3C XML Schema string datatype. |
signinginstructionsset (Use Signing Instructions Flag) |
Specifies whether there is data set in the signinginstructions attribute. Default is false. [Example: <o:signatureline … signinginstructionsset="true"> </o:signatureline> end example] The possible values for this attribute are defined by the ST_TrueFalse simple type (§15.1.2.5). |
sigprovurl (Signature Provider Download URL) |
Specifies the URL for downloading the signature provider. Default is no value. [Example: <o:signatureline … o:sigprovurl="http://www.example.com"> </o:signatureline> end example] The possible values for this attribute are defined by the W3C XML Schema string datatype. |
suggestedsigner (Suggested Signer Line 1) |
Specifies the first line of information of who should sign the signature line. Default is no value. [Example: <o:signatureline … o:suggestedsigner="John Doe"> </o:signatureline> end example] The possible values for this attribute are defined by the W3C XML Schema string datatype. |
suggestedsigner2 (Suggested Signer Line 2) |
Specifies the second line of information of who should sign the signature line. Default is no value. [Example: <o:signatureline … o:suggestedsigner2="Title"> </o:signatureline> end example] The possible values for this attribute are defined by the W3C XML Schema string datatype. |
suggestedsigneremail (Suggested Signer E-mail Address) |
Specifies the e-mail address of who should sign the signature line. Default is no value. [Example: <o:signatureline … o:suggestedsigneremail="johndoe@example.com"> </o:signatureline> end example] The possible values for this attribute are defined by the W3C XML Schema string datatype. |
[Note: The W3C XML Schema definition of this element’s content model (CT_SignatureLine) is located in §A.6.2. end note]
© ISO/IEC29500: 2008.
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.