DeltaXML DITA Compare .NET API Documentation
This namespace contains IKVM
converted Java classes for the DITA Compare product. Some of these classes have been wrapped by .NET
specific variants, where this assists with their usage in a .NET context, such as by providing .NET versions
of the file, stream, and URL handling. Other classes are automatically wrapped by the .NET conversion
process, such as the primitive types and Exceptions. The remaining classes, such as the Java enumerations
are not wrapped, as they are already straight forward to use in their current form within the .NET context.
Only the unwrapped IKVMed classes that are officially part of the .NET API are documented here.
Please see the DeltaXML.DitaCompareApi namespace documentation for details of the .NET wrapped aspect of this API.
Classes
Class | Description | |
---|---|---|
AttributeWithValue |
Represents an XML Attribute name and value pair.
| |
ConfigProperties |
DeltaXML's configuration properties are used to control the behaviour of DeltaXML products.
| |
CPUCountException |
An exception indicating that the license used with the software does not support the number of runtime cores being used.
| |
CPULimitException |
An exception indicating that the license used with the software does not support the number of runtime cores being used.
| |
DeltaXMLDitaError |
Indicates an unrecoverable error condition in the DeltaXML DITA Comparator.
| |
DeltaXMLDitaException |
Specifies an exceptional condition in the DITA Comparator.
| |
DifferentRootElementException |
Indicates that the inputs have different root elements.
| |
DitaCompareVersion |
The product's version information.
| |
DitaIOException | ||
DitaMapCompareProgressListener DocumentSource | ||
DitaMapCompareProgressListener ProcessingMode | ||
DitaMapCompareProgressListenerAbstractImpl | ||
DitaMapfileCompare |
Compares the XML content of two Darwin Information Typing Architecture (DITA) maps and produces a result map marked to show
changes.
| |
DitaTopic4MapCompare |
Compares the XML content of two Darwin Information Typing Architecture (DITA) maps and produces a result topic that is ready
for DeltaXML's internal map processing.
| |
DitaTopicProcessingException | ||
FilterProcessingException |
Indicates an error in compiling, configuring or running a filter.
| |
FrameMakerTrackChangesTableChangeMode |
Enumeration representing the possible values for the framemaker-tcs-table-change-mode parameter.
| |
IndentOutput |
Enumeration representing the possible values for the indent output parameter.
| |
InputLoadException |
Indicates that an input could not be loaded.
| |
InvalidInputException |
Indicates that an input is not of the correct format for this pipeline.
| |
InvalidLicenseException |
An exception indicating that the wrong type of license was found at runtime.
| |
InvalidTableBehaviour |
An enum representing the action which should be taken when an invalid table is detected.
| |
LicenseConcurrencyLimitException |
An exception indicating that the server-controlled concurrency limit has been exceeded.
| |
LicenseContentException |
An exception indicating that the there was a problem with the license used with the software.
| |
LicenseException |
Indicates that the comparison could not be run due to licensing constraints.
| |
LicenseExpiredException |
An exception indicating that the license used with the software has expired.
| |
LicenseNotYetValidException |
An exception indicating that this license has not yet started
| |
LicenseSecurityException |
An exception indicating a problem with the licensing or other security related aspects of the DeltaXML software when the JVM is
using a Security Manager.
| |
MapCleanTemp |
Enumeration representing how the result map is constructed.
| |
MapCopyScope |
Enumeration representing a DITA map's copy scope.
| |
MapResultOrigin |
Enumeration representing which map input is being used to form the basis of the output.
| |
MapResultStructure |
Enumeration representing how the result map is constructed.
| |
MapTopicExceptionPropagationMode | ||
MapUncomparedTopicMarkup |
Enumeration representing what updates should be performed to uncompared/unaligned topics (in the context of a DITA map
comparison).
| |
MathMLGranularity |
Specifies the granularity at which the differences between the two MathML expressions will be represented from the
DocumentComparator.
| |
ModifiedAttributeMode |
Defined the modified attribute processing mode.
| |
NodeCapacityExceededException |
The size of the input data exceeds the capacity permitted by the license.
| |
NoLicenseInstalledException |
An exception indicating that the software cannot find an appropriate license.
| |
OutputFormat |
Enumeration representing the possible values for the output-format parameter.
| |
OutputImageRefForm |
The result document may reside in a different location to the inputs.
| |
OxygenTrackChangesDeletedSpaceMode |
Enumeration representing the possible values for the oxygen-tcs-deleted-space-mode parameter.
| |
ParserException |
Indicates a problem creating or configuring an XML Parser.
| |
PerformMarkupException | ||
PreservationMode |
An enum representing the different document preservation modes.
| |
SerializationException |
Indicates a problem with writing the comparison result.
| |
ShowNonPhraseChanges |
Enumeration representing how to show changes in elements where phrase would be invalid DITA.
| |
StepsConflictResolution |
Enumeration representing the possible values for the step conflict resolution parameter.
| |
UnmarkedChangeMode |
Choose the version of the item to extract for output.
| |
UnrepresentableTableRowChangeMode |
Enumeration representing the possible values for the xmetal-tcs-table-change-mode parameter.
| |
WarningReportMode |
An enum representing the warning report modes.
| |
WhitespaceProcessingMode |
Enumeration representing the possible values for the whitespace-processing-mode parameter.
| |
XmetalTrackChangesTableChangeMode |
Enumeration representing the possible values for the xmetal-tcs-table-change-mode parameter.
| |
XmlVersionDeclaration |
Represents the values for the version in the XML declaration.
|
Interfaces
Interface | Description | |
---|---|---|
DitaMapCompareProgressListener | ||
DitaMapfileCompareProgressListener |
A comparison progress listener.
| |
DitaTopic4MapCompareProgressListener |
A comparison progress listener.
| |
DitaTopicCompareProgressListener |
A comparison progress listener.
|