DitaMapTopicsetCompareDotNet.TopicCompareHeartbeat Event

DitaMapTopicsetCompareDotNet TopicCompareHeartbeat Event

DeltaXML DITA Compare .NET API Documentation

Report heartbeats 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.

Will be called at most once a second.
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.
This runs on the same thread as the comparison, so the code you add here will increase the comparison time.

Namespace: DeltaXML.DitaCompareApi
Assembly: DeltaXML.DitaCompareApi (in DeltaXML.DitaCompareApi.dll) Version: 9.1.1.1000 (9.1.1.1000)

Syntax

C++

Copy to Clipboard Print

public event DitaMapTopicsetCompareDotNet..::..ProgressTopicHrefHandler TopicCompareHeartbeat

public event DitaMapTopicsetCompareDotNet..::..ProgressTopicHrefHandler TopicCompareHeartbeat

Public Event TopicCompareHeartbeat As DitaMapTopicsetCompareDotNet..::..ProgressTopicHrefHandler

Public Event TopicCompareHeartbeat As DitaMapTopicsetCompareDotNet..::..ProgressTopicHrefHandler

public:
 event DitaMapTopicsetCompareDotNet..::..ProgressTopicHrefHandler^ TopicCompareHeartbeat {
	void add (DitaMapTopicsetCompareDotNet..::..ProgressTopicHrefHandler^ value);
	void remove (DitaMapTopicsetCompareDotNet..::..ProgressTopicHrefHandler^ value);
}

public:
 event DitaMapTopicsetCompareDotNet..::..ProgressTopicHrefHandler^ TopicCompareHeartbeat {
	void add (DitaMapTopicsetCompareDotNet..::..ProgressTopicHrefHandler^ value);
	void remove (DitaMapTopicsetCompareDotNet..::..ProgressTopicHrefHandler^ value);
}

member TopicCompareHeartbeat : IEvent<DitaMapTopicsetCompareDotNet..::..ProgressTopicHrefHandler,
    EventArgs>

member TopicCompareHeartbeat : IEvent<DitaMapTopicsetCompareDotNet..::..ProgressTopicHrefHandler,
    EventArgs>

Value

Type: DeltaXML.DitaCompareApi DitaMapTopicsetCompareDotNet ProgressTopicHrefHandler