DitaCompareDotNet.TC_Heartbeat Event

DitaCompareDotNet TC_Heartbeat Event

DeltaXML DITA Compare .NET API Documentation

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:

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 DitaTopicCompareDotNet..::..ProgressHeartbeatHandler TC_Heartbeat

public event DitaTopicCompareDotNet..::..ProgressHeartbeatHandler TC_Heartbeat

Public Event TC_Heartbeat As DitaTopicCompareDotNet..::..ProgressHeartbeatHandler

Public Event TC_Heartbeat As DitaTopicCompareDotNet..::..ProgressHeartbeatHandler

public:
 event DitaTopicCompareDotNet..::..ProgressHeartbeatHandler^ TC_Heartbeat {
	void add (DitaTopicCompareDotNet..::..ProgressHeartbeatHandler^ value);
	void remove (DitaTopicCompareDotNet..::..ProgressHeartbeatHandler^ value);
}

public:
 event DitaTopicCompareDotNet..::..ProgressHeartbeatHandler^ TC_Heartbeat {
	void add (DitaTopicCompareDotNet..::..ProgressHeartbeatHandler^ value);
	void remove (DitaTopicCompareDotNet..::..ProgressHeartbeatHandler^ value);
}

member TC_Heartbeat : IEvent<DitaTopicCompareDotNet..::..ProgressHeartbeatHandler,
    EventArgs>

member TC_Heartbeat : IEvent<DitaTopicCompareDotNet..::..ProgressHeartbeatHandler,
    EventArgs>

Value

Type: DeltaXML.DitaCompareApi DitaTopicCompareDotNet ProgressHeartbeatHandler