AlarmZoneAtCoord Method

In This Topic

Retrieves a reference to the foremost AlarmZone that lies under the specified client coordinates.

Syntax

Visual Basic
C#

'Declaration
 
Public Function AlarmZoneAtCoord( _
   ByVal XCoord As System.Integer, _
   ByVal YCoord As System.Integer _
) As AlarmZone

public AlarmZone AlarmZoneAtCoord( 
   System.int XCoord,
   System.int YCoord
)

Parameters

XCoord: The X client coordinate to test.
YCoord: The Y client coordinate to test.

Return Value

A reference to the AlarmZone that is foremost at the specified client coordinate.

Remarks

AlarmZones can overlap the same space in the plot area. If multiple AlarmZones lie under the specified point, this method returns a reference to the foremost AlarmZone (i.e. - on top). To obtain a list of all AlarmZones that lie under the specified coordinate, enumerate all AlarmZones in the collection and test each one using the AlarmZone.IsInsideZone method.

Reference

AlarmZonesCollection Class
AlarmZonesCollection Members