DrawingOverlayEventArgs¶

Namespace: ThinkGeo.UI.WebApi

Provides data for the Overlay.Drawing event, including the target canvas and cancellation state.

public class DrawingOverlayEventArgs : System.EventArgs

Inheritance Object → EventArgs → DrawingOverlayEventArgs

Properties¶

Cancel¶

Gets or sets a value indicating whether the overlay draw should be canceled by the event subscriber.

public bool Cancel { get; set; }

Property Value¶

Boolean
true to stop the draw workflow; otherwise, false.

GeoCanvas¶

Gets or sets the canvas that the overlay is about to draw onto. Assigning null throws an ArgumentNullException.

public GeoCanvas GeoCanvas { get; set; }

Property Value¶

GeoCanvas
The non-null canvas that supplies drawing capabilities.

Constructors¶

DrawingOverlayEventArgs()¶

Creates an event argument instance with no canvas assigned so it can be populated later.

public DrawingOverlayEventArgs()

DrawingOverlayEventArgs(GeoCanvas)¶

Creates an event argument instance for the specified canvas, defaulting the cancellation flag to false.

public DrawingOverlayEventArgs(GeoCanvas geoCanvas)

Parameters¶

geoCanvas GeoCanvas
Canvas that will receive the overlay output.

DrawingOverlayEventArgs(GeoCanvas, Boolean)¶

Creates an event argument instance for the specified canvas and explicit cancellation flag.

public DrawingOverlayEventArgs(GeoCanvas geoCanvas, bool cancel)

Parameters¶

geoCanvas GeoCanvas
Canvas that will receive the overlay output.

cancel Boolean
true to request that the draw operation be aborted; otherwise, false.