UIMessageEvent Event

TestStand 2017 Help

Edition Date: November 2017

Part Number: 370052W-01

»View Product Info

Download Help (Windows Only)

	NI TestStand 2014 Help
	NI TestStand 2014 SP1 Help
	TestStand 2016 Help
	TestStand 2016 SP1 Help
	TestStand 2017 Help

Syntax

ControlName_UIMessageEvent ( uiMsg, cancel)

Applies To

ApplicationMgr

Purpose

Forwards TestStand Engine events before the manager controls process them.

Remarks

Use this event to handle messages before the manager controls handle them.

The Application Manager control automatically calls the UIMessage.Acknowledge method when this event completes. Therefore, you do not have to directly call the UIMessage.Acknowledge method from within this event.

Parameters

uiMsg As UIMessage

[In] Specifies a TestStand User Interface message.

cancel As Boolean

[In/Out] Set this parameter to True when you do not want the manager controls to handle this event. Setting this parameter to True can improve performance in some cases by preventing TestStand from storing user interface message data in the internal cache.

Note  National Instruments recommends using this parameter only when performance is a concern. Preventing the manager controls from receiving messages needed to track the state of the TestStand Engine can produce unpredictable behavior in the application.

See Also

ApplicationMgr.AfterUIMessageEvent

ApplicationMgr.UserMessage

UIMessage

UIMessage.Acknowledge