IPWorks EDI 2020 Kotlin Edition

Questions / Feedback?

Pdfxml Configuration

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

PDFXML Configuration Settings

AttachmentParams[index]:   Defines file parameters for PDF attachments.

This setting defines optional parameters for an embedded file such as last modified datetime and size. Multiple parameters can be specified in a comma separated list. For instance:

pdfxml.Config("AttachmentParams[0]=ModDate=D:20200311160001+08'00',Size=123456");
CloseInputStreamAfterProcessing:   Specifies whether or not the InputStream should be closed after processing.

Determines if the stream specified by SetInputStream is closed after Save or Load returns. By default this is True. Setting this to False keeps the stream open for further use.

CloseOutputStreamAfterProcessing:   Specifies whether or not the OutputStream should be closed after processing.

Determines if the stream specified by SetOutputStream is closed after Save returns. By default this is True. Setting this to False keeps the stream open for further use.

LogLevel:   Specifies the level of detail that is logged.

This setting controls the level of detail that is logged through the Status event. Possible values are:

0 (None)No events are logged.
1 (Info - default)Informational events are logged.
2 (Verbose)Detailed data is logged.
3 (Debug)Debug data is logged.

ZUGFeRDConformanceLevel:   Specifies the ZUGFeRD Conformance Level.

This setting specifies the conformance level to enforce for the ZUGFeRD document. Possible values are:

  • MINIMUM
  • BASIC WL
  • BASIC
  • EN 16931
  • EXTENDED

Note: ZUGFeRD conformance levels MINIMUM and EN 16931 are only supported in ZUGFeRD Version 2.0. The default value is BASIC.

This setting is only applicable when ZUGFeRDMode is set to True.

ZUGFeRDMode:   Specifies whether ZUGFeRDMode is enabled.

This setting specifies whether the document is treated as ZUGFeRD compliant. If True, the component will add the XMP Metadata of the PDF and verify there is an attachment named "ZUGFeRD-invoice.xml" or "zugferd-invoice.xml".

When set to False (default) no additional checks are performed.

ZUGFeRDVersion:   Specifies the ZUGFeRD version.

This setting specifies the ZUGFeRD version to use. Possible values are:

  • 1.0
  • 2.0 (default)

This setting is only applicable when ZUGFeRDMode is set to True.

Base Configuration Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Tells the component whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g. RuntimeLicense, License File).
  • License Type: The type of license installed (e.g. Royalty Free, Single Server).
UseDaemonThreads:   Whether threads created by the component are daemon threads.

If set to True (default), when the component creates a thread the thread's Daemon property will be explicitly set to True. When set to False the component will not set the Daemon property on the created thread. The default value is True.

UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

By default the component will use the system security libraries to perform cryptographic functions. Setting this to True tells the component to use the internal implementation instead of using the system's security API.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks EDI 2020 Kotlin Edition - Version 20.0 [Build 7941]