XMLReference Type
Represents an XML reference element.
Remarks
XMLReference specifies the digest algorithm and digest value, and, optionally: an identifier of the object being signed, the type of the object, and/or a list of transforms to be applied prior to digesting.
Fields
|
AutoGenerateElementId Boolean |
Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing. Used when the referenced element doesn't have an ID and CustomElementId and URI properties are empty. | ||||||||||||||||||||||||||||||||||||
|
CanonicalizationMethod TsbxXMLCanonicalizationMethods |
Use this property to specify the canonicalization method for the transform of the reference. Use cxcmNone value to not to include canonicalization transform in transform chain. See XML-Signature Syntax and Processing specification for details.
| ||||||||||||||||||||||||||||||||||||
|
CustomElementId String |
Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing. Used when the referenced element doesn't have an ID and URI property is empty. | ||||||||||||||||||||||||||||||||||||
|
DigestValue TBytes |
Use this property to get or set the value of the digest calculated over the referenced data. This property is optional and should be set only if you don't provide the actual data via TargetData or URI. If the data is set, then you don't need to set DigestValue since it will be calculated automatically. | ||||||||||||||||||||||||||||||||||||
|
Handle Int64 |
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); | ||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Specifies the hash algorithm to be used. Supported values:
| ||||||||||||||||||||||||||||||||||||
|
HasURI Boolean |
Specifies whether the URI is set (even when it is empty). | ||||||||||||||||||||||||||||||||||||
|
ID String |
A user-defined identifier (ID) attribute of this Reference element. | ||||||||||||||||||||||||||||||||||||
|
InclusiveNamespacesPrefixList String |
Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. See XML-Signature Syntax and Processing specification for details. | ||||||||||||||||||||||||||||||||||||
|
ReferenceType String |
The Reference's type attribute as defined in XMLDSIG specification. | ||||||||||||||||||||||||||||||||||||
|
TargetData TBytes |
Contains the referenced external data when the digest value is not explicitly specified. This property is optional and should only be set if you reference the external data via URI, and you don't provide the digest value explicitly via DigestValue. | ||||||||||||||||||||||||||||||||||||
|
TargetXMLElement String |
This property specifies the referenced XML element. Used when the URI property is not set. In this case, the URI value is generated based on the ID of the referenced (target) XML element. If the URI property is set, this property is ignored until the ResolveReference event. Supported values are:
| ||||||||||||||||||||||||||||||||||||
|
URI String |
Use this property to get or set the URL which references the data. If the data is external, the application must set either TargetData or DigestValue. If TargetData is set, the digest is calculated automatically unless it is explicitly set by the application via DigestValue. | ||||||||||||||||||||||||||||||||||||
|
UseBase64Transform Boolean |
Specifies whether Base64 transform is included in transform chain. | ||||||||||||||||||||||||||||||||||||
|
UseEnvelopedSignatureTransform Boolean |
Specifies whether enveloped signature transform is included in transform chain. | ||||||||||||||||||||||||||||||||||||
|
UseXPathFilter2Transform Boolean |
Specifies whether XPath Filter 2.0 transform is included in transform chain. | ||||||||||||||||||||||||||||||||||||
|
UseXPathTransform Boolean |
Specifies whether XPath transform is included in transform chain. | ||||||||||||||||||||||||||||||||||||
|
XPathExpression String |
Use this property to specify XPath expression for XPath transform of the reference. | ||||||||||||||||||||||||||||||||||||
|
XPathFilter2Expressions String |
Use this property to specify XPointer expression(s) for XPath Filter 2.0 transform of the reference. TBD | ||||||||||||||||||||||||||||||||||||
|
XPathFilter2Filters String |
Use this property to specify XPointer filter(s) for XPath Filter 2.0 transform of the reference. The prefix list is comma-separated. Supported values:
| ||||||||||||||||||||||||||||||||||||
|
XPathFilter2PrefixList String |
Use this property to specify a prefix list for XPath Filter 2.0 transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property. | ||||||||||||||||||||||||||||||||||||
|
XPathPrefixList String |
Use this property to specify a prefix list for XPath transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property. |
Constructors
constructor Create();
Creates a new XML reference element.
constructor Create(valID: String);
Creates a new XML reference element from its ID .
constructor Create(valID: String; valURI: String);
Creates a new XML reference element from its ID and URI reference to the external data.