AdornmentOverlay¶

Namespace: ThinkGeo.Core

This class inherits from the Overlay abstract class. This specified overlay stores the AdornmentLayer used in the MapControl.

public class AdornmentOverlay : Overlay, System.IDisposable

Inheritance Object → Overlay → AdornmentOverlay
Implements IDisposable

Properties¶

Layers¶

This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay.

public GeoCollection<AdornmentLayer> Layers { get; }

Property Value¶

GeoCollection<AdornmentLayer>

        A collection of AdornmentLayers that are added to the
        AdornmentOverlay to be drawn.

IsEmpty¶

This property indicates whether this overlay is empty or not.

public bool IsEmpty { get; }

Property Value¶

Boolean

CanRefreshRegion¶

public bool CanRefreshRegion { get; protected set; }

Property Value¶

Boolean

IsBase¶

public bool IsBase { get; set; }

Property Value¶

Boolean

Name¶

Gets or sets the name of this overaly.

public string Name { get; set; }

Property Value¶

String

MapArguments¶

Gets or sets current map information which will be used for calculating mechanism.

public MapArguments MapArguments { get; set; }

Property Value¶

MapArguments

OverlayCanvas¶

Gets or sets the actual canvas which maintains all the visual elements on the overlay.

public Canvas OverlayCanvas { get; set; }

Property Value¶

Canvas

DrawingExceptionMode¶

This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.

public DrawingExceptionMode DrawingExceptionMode { get; set; }

Property Value¶

DrawingExceptionMode

IsVisible¶

Gets or sets if this overlay is visible.

public bool IsVisible { get; set; }

Property Value¶

Boolean

RefreshTypeOnResize¶

public OverlayRefreshType RefreshTypeOnResize { get; set; }

Property Value¶

OverlayRefreshType

Attribution¶

public string Attribution { get; set; }

Property Value¶

String

AutoRefreshInterval¶

public TimeSpan AutoRefreshInterval { get; set; }

Property Value¶

TimeSpan

Constructors¶

AdornmentOverlay()¶

Constructor of AdornmentOverlay class.

public AdornmentOverlay()

Methods¶

OpenAsyncCore()¶

protected Task OpenAsyncCore()

Returns¶

Task

OpenCore()¶

protected void OpenCore()

DrawCore(RectangleShape, OverlayRefreshType)¶

This method override the DrawCore logic of the Overlay class.

protected void DrawCore(RectangleShape targetExtent, OverlayRefreshType overlayRefreshType)

Parameters¶

targetExtent RectangleShape
This parameter specifies the extent for drawing this overlay.

overlayRefreshType OverlayRefreshType
This parameter specifies whether this overlay need to be clear and refresh or not.

DrawAsyncCore(RectangleShape, OverlayRefreshType, CancellationToken)¶

protected Task DrawAsyncCore(RectangleShape targetExtent, OverlayRefreshType overlayRefreshType, CancellationToken cancellationToken)

Parameters¶

targetExtent RectangleShape

overlayRefreshType OverlayRefreshType

cancellationToken CancellationToken

Returns¶

Task

SaveStateCore()¶

This method saves overlay state to a byte array.

protected Byte[] SaveStateCore()

Returns¶

Byte[]
A byte array indicates current overlay state.

LoadStateCore(Byte[])¶

This method restore the overlay state back from the specified state.

protected void LoadStateCore(Byte[] state)

Parameters¶

state Byte[]
This parameter indicates the state for restore the overlay.

Dispose(Boolean)¶

This method disposes the unmanaged resource used in this overlay.

protected void Dispose(bool disposing)

Parameters¶

disposing Boolean

OnDrawingExceptionModeChanged()¶

internal void OnDrawingExceptionModeChanged()

Events¶

Drawing¶

This event raises before the overlay is drawing.

public event EventHandler<DrawingOverlayEventArgs> Drawing;

Drawn¶

This event raises after the overlay is drawn.

public event EventHandler<DrawnOverlayEventArgs> Drawn;

DrawingAttribution¶

public event EventHandler<DrawingAttributionOverlayEventArgs> DrawingAttribution;

DrawnAttribution¶

public event EventHandler<DrawnAttributionOverlayEventArgs> DrawnAttribution;

ThrowingException¶

public event EventHandler<ThrowingExceptionOverlayEventArgs> ThrowingException;