DitaCompareDotNet EventsDeltaXML DITA Compare .NET API Documentation
DeltaXML DITA Compare .NET API DocumentationThe DitaCompareDotNet type exposes the following members.
Events

  NameDescription
Public eventMC_MapCopyCompleted
Map comparator event raised when the input map copy is completed.
Public eventMC_MapCopyStarted
Map comparator event raised when the input map copy starts.
Public eventMC_MapLevelOutputProcessingCompleted
Map comparator event raised when the updates to the final result map(s) have completed.
Public eventMC_MapLevelOutputProcessingStarted
Map comparator event raised when the updates to the final result map(s) have started.
Public eventMC_MapScanCompleted
Map comparator event raised when the scan for the topics referenced (directly or indirectly) from the input map has completed.
Public eventMC_MapScanStarted
Map comparator event raised when the scan for the topics referenced (directly or indirectly) from the input map has started.
Public eventMC_TopicAlignmentCompleted
Raised when topic alignment process completed.

Provides alignment information on referenced topics, giving an indication of the number of comparisons to be performed - the size of the alignedTopics Dictionary.

Public eventMC_TopicAlignmentStarted
Map comparator event raised when topic alignment process started.
Public eventMC_TopicCompareCompleted
Map comparator event raised when each topic comparison stage has been completed.
Public eventMC_TopicCompareHeartbeat
Map comparator heartbeat event raised when inside the compare stage. Progress on the 'Main comparator' stage is monitored by a heartbeat. This callback event is best used to report when the comparator was last known to be alive.

  1. Will be called at most once a second.
  2. Not receiving this event should not be interpreted as the comparison stopping or being broken, but usually a sign that the comparison is busy processing.
  3. This runs on the same thread as the comparison, so the code you add here will increase the comparison time.

Public eventMC_TopicCompareStarted
Map comparator event raised when each topic comparison stage has been started.
Public eventMC_TopicProcessingCompleted
Map comparator event raised when the processing of a topic has completed.
Public eventMC_TopicProcessingFailed
Map comparator event raised when a failure happens during the processing of a topic.
Public eventMC_TopicProcessingStarted
Map comparator event raised when the processing of a topic has started.
Public eventMC_TopicStageCountComputed
Map comparator event raised before a topic compare to return the total number of topic comparison stages that are involved
Public eventTC_Completed
Topic comparator event raised when each stage completes.
Public eventTC_Heartbeat
Topic comparator heartbeat event raised 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:

  1. Will be called at most once a second.
  2. Not receiving this event should not be interpreted as the comparison stopping or being broken, but usually a sign that the comparison is busy processing.
  3. This runs on the same thread as the comparison, so the code you add here will increase the comparison time.

Public eventTC_StageCountComputed
Topic comparator event raised on computing the total for the number of stages required for the comparison.
Public eventTC_Started
Topic comparator event raised when each stage starts.
Back to Top
See Also