DrawingLayerOverlayEventArgs¶

Namespace: ThinkGeo.UI.WebApi

Provides data for the LayerOverlay.DrawingLayer event, exposing the target canvas, layer, and cancellation flag.

public class DrawingLayerOverlayEventArgs : System.EventArgs

Inheritance Object → EventArgs → DrawingLayerOverlayEventArgs

Properties¶

Cancel¶

Gets or sets a value indicating whether the current layer draw should be skipped.

public bool Cancel { get; set; }

Property Value¶

Boolean
true to cancel the operation; otherwise, false.

GeoCanvas¶

Gets or sets the canvas that the layer will render onto. Assigning null throws an ArgumentNullException.

public GeoCanvas GeoCanvas { get; set; }

Property Value¶

GeoCanvas
The non-null canvas associated with the event.

DrawingLayer¶

Gets or sets the layer that is about to be drawn. This may be null when the event is raised without a concrete layer.

public Layer DrawingLayer { get; set; }

Property Value¶

Layer
The layer associated with the event, or null if not specified.

Constructors¶

DrawingLayerOverlayEventArgs()¶

Creates an event argument instance with no pre-assigned canvas or layer.

public DrawingLayerOverlayEventArgs()

DrawingLayerOverlayEventArgs(GeoCanvas, Layer)¶

Creates an event argument instance that targets the supplied canvas and layer, defaulting cancellation to false.

public DrawingLayerOverlayEventArgs(GeoCanvas geoCanvas, Layer drawingLayer)

Parameters¶

geoCanvas GeoCanvas
Canvas that will be used for drawing.

drawingLayer Layer
Layer that is about to be drawn.

DrawingLayerOverlayEventArgs(GeoCanvas, Layer, Boolean)¶

Creates an event argument instance that targets the supplied canvas and layer and specifies whether drawing should continue.

public DrawingLayerOverlayEventArgs(GeoCanvas geoCanvas, Layer drawingLayer, bool cancel)

Parameters¶

geoCanvas GeoCanvas
Canvas that will be used for drawing.

drawingLayer Layer
Layer that is about to be drawn.

cancel Boolean
true to cancel the draw operation; otherwise, false.