DeltaXML DITA Compare .NET API DocumentationThe DitaTopicCompareDotNet type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
| DitaTopicCompareDotNet |
Constructs a new DitaTopicCompare instance.
|
Methods
| Name | Description | |
|---|---|---|
| compare(FileInfo, FileInfo, FileInfo) |
Compares two File inputs to produce a File result.
| |
| compare(String, Uri, String, Uri) |
Compares two XML string inputs to produce an XML string result.
| |
| compare(Stream, Uri, Stream, Uri, Stream) |
Compare two input Streams to produce an output Stream result.
| |
| compare(TextReader, Uri, TextReader, Uri, TextWriter) |
Compare two input readers (character streams) to produce an output writer result.
| |
| getEntityResolver |
Get the previously set entity resolver.
| |
| setEntityResolver |
Set the entity resolver to use.
| |
| setLicenseFile |
Sets the license file for use with Flexera licensing.
| |
| setLicenseServer(String) |
Sets a license server for use with concurrent licensing.
| |
| setLicenseServer(String, Int32) |
Sets a license server and port for use with concurrent licensing.
|
Properties
| Name | Description | |
|---|---|---|
| AddOutputclassAtts |
Specifies whether to include an outputclass attribute for marking changes.
| |
| AddRevisionAtts |
Specifies whether the result should use 'rev' attributes to mark change.
| |
| AddStatusAtts |
Specifies whether the result should use 'status' attributes to mark change.
| |
| CalsTableProcessing |
Specifies whether to apply CALS table processing.
| |
| DitaTopicCompareIkvmJava |
Get the underpinning IKVM translation of the Java DitaTopicCompare object
| |
| EnableProgressEventHandling |
Controls whether raising of progress handling events is enabled.
| |
| ForceSpecialization |
Specifies whether or not to force result specialization when the input types are different.
| |
| FramemakerTcsTableChangeMode |
Specifies how changes in tables should be tracked.
| |
| Grouping |
Specifies whether adjacent changes (insertions or deletions) should be grouped into
a single insertion and/or deletion block.
| |
| HtmlTableProcessing |
Specifies whether to apply html table or DITA simpletable processing.
| |
| ImageCompare |
Specifies whether to enable or disable image comparison.
| |
| IncludeDeleted |
Specifies whether to include deleted content in the result.
| |
| IndentOutput |
Sets whether the result should be indented.
| |
| InvalidTableBehaviour |
In order to ensure that only valid CALS tables are passed to our specialized CALS table processing,
each input table is marked either valid or invalid.
| |
| MapContextHref |
When set to the non-empty string, this parameter provides a reference to a file that stores the map
context information.
| |
| MathMLGranularity |
Specifies type of MathML processing.
| |
| MathMLProcessing |
Specifies whether to apply MathML processing.
| |
| ModifiedAttributeMode |
Specifies how modified attributes should be included in the output.
| |
| NewOutputclass |
Specifies the string value to use for the outputclass attribute of added content.
| |
| NewRevision |
Specifies the string value to use for the rev attribute of added content.
| |
| NewVersionAtts |
Specifies attributes to place on to added elements in the result.
| |
| OldOutputclass |
Specifies the string value to use for the outputclass attribute of deleted content.
| |
| OldRevision |
Specifies the string value to use for the rev attribute of deleted content.
| |
| OldVersionAtts |
Specifies attributes to place on deleted elements in the result.
| |
| OutputEncodingDeclaration |
Sets the character encoding output to use in the XML declaration.
| |
| OutputFormat |
Specifies what type of output is produced.
| |
| OxygenTcsDeletedSpaceMode |
Specifies how deleted spaces should be handled.
| |
| OxygenTcsVersion |
Specifies the version of oXygen editor used to display, accept and reject the tracked changes.
| |
| PhraseContainerExclusions |
Specifies any specializations where phrases have been removed from the content model.
| |
| PhraseElementName |
Specifies the element name to use in place of <ph> in the result.
| |
| PreservationMode |
Sets the mode to use for preserving original data.
| |
| ProductVersion |
Get the product's version
| |
| RedistributionLicense |
Sets a redistribution license for use with subsequent compare operations.
| |
| RemoveRevAttributeRegex |
'rev' attributes in the input could be confused with those used to represent change
in the output.
| |
| ShowNonPhraseChanges |
Specifies how to textually mark changes to text where <ph> elements are not allowed.
| |
| StepsConflictResolution |
Specifies how to resolve conflicts between a task body's mutually exclusive steps and steps-unordered
elements.
| |
| StrictTaskModel |
Specifies whether inputs use the strict task model.
| |
| TopicPublicId |
Specifies the publicId to use for a Topic doctype.
| |
| TopicSystemId |
Specifies the systemId to use for a Topic doctype.
| |
| TrackedChangesAuthor |
Specifies the author name that is embedded into the generated insertion and deletion processing
instruction.
| |
| TrackedChangesDate |
Specifies the time-stamp that is embedded into the generated insertion and deletion processing
instruction.
| |
| UnmarkedChangeMode |
Specifies how to handle data that cannot contain difference markup.
| |
| UseIdsAsKeys |
Specifies whether to use id attribute value as keys in order to provide identity during comparison.
| |
| ValidateInputs |
Specifies whether to validate input documents.
| |
| WarningReportMode |
Sets the mode to use for reporting recoverable errors and warnings.
| |
| WhitespaceProcessingMode |
Specifies how to handle whitespace changes.
| |
| WordByWord |
Specifies whether to perform detailed text comparison or not.
| |
| XmetalTcsTableChangeMode |
Specifies how changes in tables should be tracked.
| |
| XmlVersionDeclaration |
Sets the version to use in the XML declaration.
|
Events
| Name | Description | |
|---|---|---|
| Completed |
Raised when each stage completes.
| |
| Heartbeat |
Raised for each heartbeat event when inside the compare stage.
Progress on the 'Main comparator' stage is monitored by a heartbeat.
This event is best used to report when the comparator was last known
to be alive.
Notes:
| |
| StageCountComputed |
Raised on computing the total for the number of stages required for the comparison.
| |
| Started |
Raised when each stage starts.
|
See Also