ICImagingControl.OverlayUpdate Event

[VB.NET]
Public Event OverlayUpdate( ByVal sender As Object, ByVal e As ICImagingControl.OverlayUpdateEventArgs)

[C#]
public event System.EventHandler<ICImagingControl.OverlayUpdateEventArgs> OverlayUpdate;

The OverlayUpdate event is called after a new frame is available. In the OverlayUpdate event sub, text or graphical elements can be drawn in the new frame. Therefore, it is possible to insert individual information on each individual frame.

The sample time is the time that has been passed, since ICImagingControl.LiveStart has been called. The time resolution is seconds. The duration between SampleStartTime and SampleEndTime is equal to the current frame rate.

This event is called before the ICImagingControl.ImageAvailable event occurs.

Exceptions that occur in the OverlayUpdate event will get lost in the system. Therefore, bugs in the code that cause an exception cannot be recognized. To avoid this, all code in the event handler should be enclosed by a try ... catch block. If you need to display error messages, do not use a message box. Use a "debug trace" instead (e.g. System.Diagnostics.Trace.WriteLine(...) ). This is very important, because otherwise the system may run into a deadlock which will cause the application to hang.

This example demonstrates how to write a frame counter on the live video. FrameCount is a global declared variable in the form.

[VB.NET]
If IcImagingControl1.DeviceValid = True Then
    '  Check whether the overlay update event is enabled.
    If IcImagingControl1.OverlayUpdateEventEnable = False Then
        '  Enable the overlay update event.
        IcImagingControl1.OverlayUpdateEventEnable = True
    End If
End If

[C#]
if (ICImagingControl1.DeviceValid)
{
    //  Check whether the overlay update event is enabled.
    if ( !ICImagingControl1.OverlayUpdateEventEnable )
    {
        //  Enable the overlay update event.
        ICImagingControl1.OverlayUpdateEventEnable = true;
    }
}