Text Tool Events

Canvas > Using Canvas Controls and Objects > Text Tool > Text Tool Events

Text Tool Events

Event icon The Text Tool supports the following scripting events. Click next to any event name in the Events pane to see a short description for the selected event.

See Accessing Screen Objects for more information about how to view control objects in script in the Canvas application.

When an event is enabled, the control will be automatically added to script and the Include in script property will be set to True.

Event

Description

Example

Click

The Click event is called when the user clicks once on the control with the left mouse button.

Objects.TextTool1.Click += new EventHandler(this.TextTool1_Click);

Close

The Close event is called when the screen is closed.

Initialize

The Initialize event is called when the screen is created in preview or run mode to allow further initialization of the control.

Loaded

The Loaded event is called when the control is rendered and ready for interaction.

Mouse Enter

The Mouse Enter event is called when the mouse pointer enters (moves over) a control.

Mouse Leave

The Mouse Leave event is called when the mouse pointer leaves (moves out of) a control.

Point Configuration Changed

The Point Configuration Changed event is called when a point's configuration changes.

Point Value Changed

The Point Value Changed event is called a point's value changes.

Tooltip Opening

The Tooltip Opening event is called right before the tooltip opens creating a custom tooltip, which can show any desired information, for example, a value from an affiliated point, an unrelated data point, or even a CygNet note. The Tooltip mode (TooltipMode) property must be set to Script. The Tooltip Opening event supports multi-line tooltips.

In the following example, a custom tooltip will be created that will retrieve and display three point values (Choke Position, SDV Valve Position, and Tubing Pressure) for the JOHNSON_WL facility on three separate lines.

Example

private void TextTool1_TooltipOpening(object sender, EventArgs args)

{

CygNet.Data.Core.DomainSiteService Site = new CygNet.Data.Core.DomainSiteService(5410, "MYSITE", "UIS");

CygNet.API.Points.RealtimeClient PointsClient = new CygNet.API.Points.RealtimeClient(Site);

CygNet.Data.Core.PointTag Choke = new CygNet.Data.Core.PointTag("MYSITE.UIS:JOHNSON_WL_POACTCHO");

CygNet.Data.Core.PointTag SDV = new CygNet.Data.Core.PointTag("MYSITE.UIS:JOHNSON_WL_POACTSDV");

CygNet.Data.Core.PointTag Tubing = new CygNet.Data.Core.PointTag("MYSITE.UIS:JOHNSON_WL_PRTUBXIN");

string TipValues = string.Concat("Choke Position: ", PointsClient.GetPointValueRecord(Choke).Value.ToString(), Environment.NewLine,

"SDV Valve Position: ", PointsClient.GetPointValueRecord(SDV).Value.ToString(), Environment.NewLine,

"Tubing Pressure: ", PointsClient.GetPointValueRecord(Tubing).Value.ToString());

Objects.TextTool1.TooltipText = TipValues;

}

See Order of Event Execution for information about the order in which events are executed on a screen.