OfficeSigner Component
Properties Methods Events Configuration Settings Errors
The OfficeSigner component signs Office documents.
Syntax
TsbxOfficeSigner
Remarks
OfficeSigner provides digital signing capabilities of Office documents, and provides support for extended facilities, such as timestamps and advanced (XAdES) signatures.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| BlockedCertificates | The certificates that must be rejected as trust anchors. |
| ChainValidationDetails | The details of a certificate chain validation outcome. |
| ChainValidationResult | The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result. |
| ClaimedSigningTime | The signing time from the signer's computer. |
| DocumentFormat | Defines the format of the Office document. |
| EnableXAdES | Specifies if an advanced signature (XAdES) will be produced. |
| ExternalCrypto | Provides access to external signing and DC parameters. |
| HashAlgorithm | Specifies the hash algorithm to be used. |
| IgnoreChainValidationErrors | Makes the component tolerant to chain validation errors. |
| InputBytes | Use this property to pass the input to component in the byte array form. |
| InputFile | The file to be signed. |
| KnownCertificates | Additional certificates for chain validation. |
| KnownCRLs | Additional CRLs for chain validation. |
| KnownOCSPs | Additional OCSP responses for chain validation. |
| OfflineMode | Switches the component to the offline mode. |
| OutputBytes | Use this property to read the output the component object has produced. |
| OutputFile | Defines where to save the signed document. |
| Profile | Specifies a pre-defined profile to apply when creating the signature. |
| Proxy | The proxy server settings. |
| RevocationCheck | Specifies the kind(s) of revocation check to perform. |
| SignatureIndex | The index of the signature to update. |
| SignatureType | Specifies the type of the signature to be made. |
| SignCoreProperties | Whether to sign the core properties of the document. |
| SignDocument | Whether to sign the document itself. |
| SigningCertificate | The certificate to be used for signing. |
| SigningChain | The signing certificate chain. |
| SignSignatureOrigin | Whether to sign the signature origin. |
| SocketSettings | Manages network connection settings. |
| TimestampServer | The address of the timestamping server. |
| TLSClientChain | The TLS client certificate chain. |
| TLSServerChain | The TLS server's certificate chain. |
| TLSSettings | Manages TLS layer settings. |
| TrustedCertificates | A list of trusted certificates for chain validation. |
| ValidationLog | Contains the complete log of the certificate validation routine. |
| XAdESForm | Specifies which form of XAdES should be produced. |
| XAdESVersion | Specifies XAdES version. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| ExtractAsyncData | Extracts user data from the DC signing service response. |
| Sign | Calculates the signature value. |
| SignAsyncBegin | Initiates the asynchronous signing operation. |
| SignAsyncEnd | Completes the asynchronous signing operation. |
| SignExternal | Signs the document using an external signing facility. |
| Timestamp | Use this method to add timestamp. |
| Upgrade | Upgrades existing XAdES signature to a new form. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Error | Information about errors during signing. |
| ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
| Notification | This event notifies the application about an underlying control flow event. |
| StoreCertificate | This event is fired when a certificate should be stored along with a signature. |
| StoreCRL | This event is fired when a CRL should be stored along with a signature. |
| StoreOCSPResponse | This event is fired when a OCSP Response should be stored along with a signature. |
| TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| ClaimedRoleText | The text of the claimed role. |
| ClaimedRoleXML | The XML content of the claimed roles. |
| CommitmentTypeIndicationAllSignedDataObjects[Index] | Specifies the CommitmentTypeIndication's AllSignedDataObjects. |
| CommitmentTypeIndicationCount | The number of the CommitmentTypeIndication elements. |
| CommitmentTypeIndicationIdentifier[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier. |
| CommitmentTypeIndicationIdentifierDescription[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's Description. |
| CommitmentTypeIndicationIdentifierDocumentationReferences[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences. |
| CommitmentTypeIndicationIdentifierQualifier[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier. |
| CommitmentTypeIndicationObjectReference[Index] | Specifies the CommitmentTypeIndication's ObjectReference. |
| CommitmentTypeIndicationQualifiersXML[Index] | The XML content of the CommitmentTypeIndication's Qualifiers. |
| ExpireTime | Signature expiration time in UTC. |
| ForceCompleteChainValidation | Whether to check the CA certificates when the signing certificate is invalid. |
| ForceCompleteChainValidationForTrusted | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
| GracePeriod | Specifies a grace period to apply during revocation information checks. |
| IgnoreOCSPNoCheckExtension | Whether OCSP NoCheck extension should be ignored. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| IgnoreTimestampFailure | Whether to ignore time-stamping failure during signing. |
| ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
| IncludeKnownRevocationInfoToSignature | Whether to include custom revocation info to the signature. |
| ProductionPlace | Identifies the place of the signature production. |
| PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
| RefsTimestampType | Specifies references timestamp type to include to the signature. |
| SignatureInfoAddress1 | Specifies the location at which the signature was created. |
| SignatureInfoAddress2 | Specifies the location at which the signature was created. |
| SignatureInfoComments | Comments to the signature info text. |
| SignatureInfoDelegateSuggestedSigner | Specifies the name of a person. |
| SignatureInfoDelegateSuggestedSigner2 | Specifies the title of a person. |
| SignatureInfoDelegateSuggestedSignerEmail | Specifies the e-mail address of a person. |
| SignatureInfoImage | Specifies an image for the digital signature. |
| SignatureInfoIncluded | Whether to include the signature info. |
| SignatureInfoInvalidLnImage | Specifies the image of an invalid signature. |
| SignatureInfoSignatureType | Specifies the type of the digital signature. |
| SignatureInfoText | The text to be displayed as the signature info. |
| SignatureInfoValidLnImage | Specifies the image of a valid signature. |
| SignatureLineAdditionalSignatureInfo[Index] | Contains additional signature information. |
| SignatureLineAllowComments[Index] | Indicates if comments are allowed. |
| SignatureLineCount | The number of signature lines. |
| SignatureLineId[Index] | Contains signature unique ID. |
| SignatureLineImageData[Index] | Contains signature image. |
| SignatureLineIndex | Specifies the index of the signature line to sign. |
| SignatureLineShowSignDate[Index] | Indicates if signing date should be shown. |
| SignatureLineSignatureIndex[Index] | The index of the signature that signs signature line. |
| SignatureLineSignatureProviderId[Index] | Contains signature provider ID. |
| SignatureLineSignatureProviderUrl[Index] | Contains signature provider URL. |
| SignatureLineSigned[Index] | Indicates if signature line is signed. |
| SignatureLineSigningInstructions[Index] | Contains signing instructions. |
| SignatureLineSuggestedSigner2[Index] | Suggested signer line two. |
| SignatureLineSuggestedSigner[Index] | Suggested signer line one. |
| SignatureLineSuggestedSignerEmail[Index] | Suggested signer email address. |
| SignTime | Specifies the signing time in UTC. |
| SigPolicyDescription | signature policy description. |
| SigPolicyExplicitText | The explicit text of the user notice. |
| SigPolicyHash | The hash value of the signature policy. |
| SigPolicyHashAlgorithm | Specifies the hash algorithm used to compute the signature policy hash. |
| SigPolicyID | Identifies the signature policy. |
| SigPolicyNoticeNumbers | Contains user notice numbers. |
| SigPolicyNoticeOrganization | The organization part of the NoticeReference qualifier. |
| SigPolicyURI | Signature policy URI. |
| TempPath | Location where the temporary files are stored. |
| TimestampCanonicalizationMethod | Specifies canonicalization method used in timestamp. |
| TimestampValidationDataDetails | Specifies timestamp validation data details to include to the signature. |
| TLSChainValidationDetails | Contains the advanced details of the TLS server certificate validation. |
| TLSChainValidationResult | Contains the result of the TLS server certificate validation. |
| TLSClientAuthRequested | Indicates whether the TLS server requests client authentication. |
| TLSValidationLog | Contains the log of the TLS server certificate validation. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| TspHashAlgorithm | Sets a specific hash algorithm for use with the timestamping service. |
| UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
| ValidationDataRefsDetails | Specifies validation data references details to include to the signature. |
| ValidationDataValuesDetails | Specifies validation data values details to include to the signature. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |