| SignDocDocumentLoader Class |
Create SignDocDocument objects.
Unless you need differently configured SignDocDocumentLoader
objects, you should have only one SignDocDocumentLoader object per
process. Loading font configuration files can be expensive, in
particular if many fonts have to be scanned.
Inheritance HierarchyNamespace: de.softpro.signdocsdk
Assembly: SPSignDoc_4.3_DotNetLib (in SPSignDoc_4.3_DotNetLib.dll) Version: 1.0.6773.37566
SyntaxC#
public sealed class SignDocDocumentLoader : IDisposable
The SignDocDocumentLoader type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SignDocDocumentLoader | Constructor |
Methods| Name | Description | |
|---|---|---|
| createPDF | Create an empty PDF document.
The PDF document is invalid until you add at least one page.
SignDocDocument.addSignature() cannot be used until the document
has been saved.
|
| createPDFA | Create an empty PDF/A document.
The PDF document is invalid until you add at least one page.
SignDocDocument.addSignature() cannot be used until the document
has been saved.
|
| Dispose | Releases all resources used by the SignDocDocumentLoader |
| getFailedFontFiles | Get the pathnames of font files that failed to load for the most recent loadFontConfig*() or loadPdfFontConfig*() call.
This includes files that could not be found and files that could not be loaded.In the former case, the pathname may contain wildcard characters.
Note that loadFontConfig*() and loadPdfFontConfig() no longer fail if a specified font file cannot be found or loaded.
|
 | getInstallationCode | Get the installation code needed for creating a license file. |
| getLicenseText | Get license text |
| getLicenseTextCount | Get license text count |
| getRemainingDays | Get the number of days until the license will expire |
| getVersionNumber | Get the version number of SignDoc SDK. |
| initLicenseManager | Initialize license management.
License management must be initialized before the non - static methods of SignDocDocumentLoader can be used.
|
| initLogging | Initialize logging.
This function throws an exception if the log file cannot be opened.This function initializes logging for all threads of the current process. |
| loadFontConfigEnvironment | Load font configuration from files specified by an environment variable.
Suitable fonts are required for putting text containing characters that cannot be encoded using WinAnsiEncoding into text fields, FreeText annotations, DigSig appearances, watermarks, and pages of PDF documents.See section Font Configuration.
Under Windows, directories are separated by semicolons.Under Unix, directories are separated by colons.
The font configuration applies to all SignDocDocument objects created by this object. |
| loadFontConfigFile | Load font configuration from a file.
Suitable fonts are required for putting text containing characters that cannot be encoded using WinAnsiEncoding into text fields, FreeText annotations, DigSig appearances, watermarks, and pages of PDF documents. See section Font Configuration.
|
| loadFontConfigStream | Load font configuration from a stream.
Suitable fonts are required for putting text containing characters that cannot be encoded using WinAnsiEncoding into text fields, FreeText annotations, DigSig appearances, watermarks, and pages of PDF documents.See section Font Configuration.
The font configuration applies to all SignDocDocument objects created by this object.
|
| loadFromFile | Load a document from a file.
Signing the document will overwrite the document, but see integer parameter "Optimize" of SignDocSignatureParameters.
You can open FDF files that reference a PDF file; the referenced PDF file will be opened and the FDF file will be applied to the loaded copy (using SetFieldFlag::FontFail).If the pathname of the referenced PDF file is not an absolute pathname, it will be interpreted as being relative to the directory containing the FDF file.
|
| loadFromMemory | Load a document from memory. |
| loadPdfFontConfigEnvironment | Load font configuration for PDF documents from files specified by an environment variable.
Additional fonts may be required for rendering PDF documents.The font configuration for PDF documents contains mappings from font names to font files.See section Font Configuration.
The font configuration for PDF documents is global, ie, it affects all PDF documents, no matter by which SignDocDocumentLoader object they have been created.
Under Windows, directories are separated by semicolons.Under Unix, directories are separated by colons.
|
| loadPdfFontConfigFile | Load font configuration for PDF documents from a file.
Additional fonts may be required for rendering PDF documents.The font configuration for PDF documents contains mappings from font names to font files.See section Font Configuration.
The font configuration for PDF documents is global, ie, it affects all PDF documents, no matter by which SignDocDocumentLoader object they have been created.
|
| loadPdfFontConfigStream | Load font configuration for PDF documents from a stream.
Additional fonts may be required for rendering PDF documents.The font configuration for PDF documents contains mappings from font names to font files.See section Font Configuration.
The font configuration for PDF documents is global, ie, it affects all PDF documents, no matter by which SignDocDocumentLoader object they have been created. |
| loadTrustedCertificatesFromFile | Load trusted root CA certifcates from a file.
The loaded certificates are used for all SignDocDocument objects
created by this object. They are used for signature verification and
HTTPS connections.
For iOS, they replace the system's trusted anchors, for other
operating systems, they are used in addition to the operating
system's trusted root CA certificates.
The file must contain either a single DER-encoded X.509 certificate
or at least one PEM-encoded X.509 certificate.
Calls to loadTrustedCertificatesFromFile() and
loadTrustedCertificatesFromStream() are cumulative.
|
| loadTrustedCertificatesFromStream | Load trusted root CA certifcates from a stream.
The loaded certificates are used for all SignDocDocument objects
created by this object. They are used for signature verification and
HTTPS connections.
For iOS, they replace the system's trusted anchors, for other
operating systems, they are used in addition to the operating
system's trusted root CA certificates.
The stream must contain either a single DER-encoded X.509 certificate
or at least one PEM-encoded X.509 certificate.
|
| ping | Check if a document is supported by this handler.
|
| setFlags | Set flags modifying the behavior of this SignDocDocumentLoader
object and of the SignDocDocument objects created by it.
|
| setLicenseKey | Initialize license management.
License management must be initialized before the non - static methods of SignDocDocumentLoader can be used.
|
| setLicenseKey2 | Initialize license management.
License management must be initialized before the non - static methods of SignDocDocumentLoader can be used.
|
See Also