Overlay &para;

Remarks:

Setting the property updates UIElement.Visibility. It will internally call Overlay.RefreshAsync(CancellationToken) if needed. In XAML, bind UIElement.Visibility instead: {Binding IsVisible} on an overlay resolves to the read-only UIElement.IsVisible, which says whether the overlay is rendered right now, not to this property.

Attribution¶

Gets the attribution text displayed for the overlay.

public string Attribution { get; protected set; }

Property Value¶

string

Remarks:

Set by derived overlays to describe the data source rendered on the map.

IsEmpty¶

Gets a value indicating whether the overlay has any content to draw.

public bool IsEmpty { get; }

Property Value¶

Remarks:

Derived overlays override this property so the draw pipeline can skip empty overlays and improve performance.

Background¶

public Brush Background { get; set; }

Property Value¶

Brush

Children¶

public UIElementCollection Children { get; }

Property Value¶

UIElementCollection

IsItemsHost¶

public bool IsItemsHost { get; set; }

Property Value¶

LogicalOrientationPublic¶

public Orientation LogicalOrientationPublic { get; }

Property Value¶

Orientation

HasLogicalOrientationPublic¶

public bool HasLogicalOrientationPublic { get; }

Property Value¶

Style¶

public Style Style { get; set; }

Property Value¶

Style

OverridesDefaultStyle¶

public bool OverridesDefaultStyle { get; set; }

Property Value¶

UseLayoutRounding¶

public bool UseLayoutRounding { get; set; }

Property Value¶

Triggers¶

public TriggerCollection Triggers { get; }

Property Value¶

TriggerCollection

TemplatedParent¶

public DependencyObject TemplatedParent { get; }

Property Value¶

DependencyObject

Resources¶

public ResourceDictionary Resources { get; set; }

Property Value¶

ResourceDictionary

DataContext¶

public object DataContext { get; set; }

Property Value¶

object

BindingGroup¶

public BindingGroup BindingGroup { get; set; }

Property Value¶

BindingGroup

Language¶

public XmlLanguage Language { get; set; }

Property Value¶

XmlLanguage

Tag¶

public object Tag { get; set; }

Property Value¶

object

InputScope¶

public InputScope InputScope { get; set; }

Property Value¶

InputScope

ActualWidth¶

public double ActualWidth { get; }

Property Value¶

ActualHeight¶

public double ActualHeight { get; }

Property Value¶

LayoutTransform¶

public Transform LayoutTransform { get; set; }

Property Value¶

Transform

Width¶

public double Width { get; set; }

Property Value¶

MinWidth¶

public double MinWidth { get; set; }

Property Value¶

MaxWidth¶

public double MaxWidth { get; set; }

Property Value¶

Height¶

public double Height { get; set; }

Property Value¶

MinHeight¶

public double MinHeight { get; set; }

Property Value¶

MaxHeight¶

public double MaxHeight { get; set; }

Property Value¶

FlowDirection¶

public FlowDirection FlowDirection { get; set; }

Property Value¶

FlowDirection

Margin¶

public Thickness Margin { get; set; }

Property Value¶

Thickness

HorizontalAlignment¶

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value¶

HorizontalAlignment

VerticalAlignment¶

public VerticalAlignment VerticalAlignment { get; set; }

Property Value¶

VerticalAlignment

FocusVisualStyle¶

public Style FocusVisualStyle { get; set; }

Property Value¶

Style

Cursor¶

public Cursor Cursor { get; set; }

Property Value¶

Cursor

ForceCursor¶

public bool ForceCursor { get; set; }

Property Value¶

IsInitialized¶

public bool IsInitialized { get; }

Property Value¶

IsLoaded¶

public bool IsLoaded { get; }

Property Value¶

public object ToolTip { get; set; }

Property Value¶

object

ContextMenu¶

public ContextMenu ContextMenu { get; set; }

Property Value¶

ContextMenu

Parent¶

public DependencyObject Parent { get; }

Property Value¶

DependencyObject

HasAnimatedProperties¶

public bool HasAnimatedProperties { get; }

Property Value¶

InputBindings¶

public InputBindingCollection InputBindings { get; }

Property Value¶

InputBindingCollection

CommandBindings¶

public CommandBindingCollection CommandBindings { get; }

Property Value¶

CommandBindingCollection

AllowDrop¶

public bool AllowDrop { get; set; }

Property Value¶

DesiredSize¶

public Size DesiredSize { get; }

Property Value¶

Size

IsMeasureValid¶

public bool IsMeasureValid { get; }

Property Value¶

IsArrangeValid¶

public bool IsArrangeValid { get; }

Property Value¶

RenderSize¶

public Size RenderSize { get; set; }

Property Value¶

Size

RenderTransform¶

public Transform RenderTransform { get; set; }

Property Value¶

Transform

RenderTransformOrigin¶

public Point RenderTransformOrigin { get; set; }

Property Value¶

Point

IsMouseDirectlyOver¶

public bool IsMouseDirectlyOver { get; }

Property Value¶

IsMouseOver¶

public bool IsMouseOver { get; }

Property Value¶

IsStylusOver¶

public bool IsStylusOver { get; }

Property Value¶

IsKeyboardFocusWithin¶

public bool IsKeyboardFocusWithin { get; }

Property Value¶

IsMouseCaptured¶

public bool IsMouseCaptured { get; }

Property Value¶

IsMouseCaptureWithin¶

public bool IsMouseCaptureWithin { get; }

Property Value¶

IsStylusDirectlyOver¶

public bool IsStylusDirectlyOver { get; }

Property Value¶

IsStylusCaptured¶

public bool IsStylusCaptured { get; }

Property Value¶

IsStylusCaptureWithin¶

public bool IsStylusCaptureWithin { get; }

Property Value¶

IsKeyboardFocused¶

public bool IsKeyboardFocused { get; }

Property Value¶

IsInputMethodEnabled¶

public bool IsInputMethodEnabled { get; }

Property Value¶

Opacity¶

public double Opacity { get; set; }

Property Value¶

OpacityMask¶

public Brush OpacityMask { get; set; }

Property Value¶

Brush

BitmapEffect¶

public BitmapEffect BitmapEffect { get; set; }

Property Value¶

BitmapEffect

Effect¶

public Effect Effect { get; set; }

Property Value¶

Effect

BitmapEffectInput¶

public BitmapEffectInput BitmapEffectInput { get; set; }

Property Value¶

BitmapEffectInput

CacheMode¶

public CacheMode CacheMode { get; set; }

Property Value¶

CacheMode

Uid¶

public string Uid { get; set; }

Property Value¶

string

Visibility¶

public Visibility Visibility { get; set; }

Property Value¶

Visibility

ClipToBounds¶

public bool ClipToBounds { get; set; }

Property Value¶

Clip¶

public Geometry Clip { get; set; }

Property Value¶

Geometry

SnapsToDevicePixels¶

public bool SnapsToDevicePixels { get; set; }

Property Value¶

IsFocused¶

public bool IsFocused { get; }

Property Value¶

IsEnabled¶

public bool IsEnabled { get; set; }

Property Value¶

IsHitTestVisible¶

public bool IsHitTestVisible { get; set; }

Property Value¶

Focusable¶

public bool Focusable { get; set; }

Property Value¶

PersistId¶

public int PersistId { get; }

Property Value¶

int

IsManipulationEnabled¶

public bool IsManipulationEnabled { get; set; }

Property Value¶

AreAnyTouchesOver¶

public bool AreAnyTouchesOver { get; }

Property Value¶

AreAnyTouchesDirectlyOver¶

public bool AreAnyTouchesDirectlyOver { get; }

Property Value¶

AreAnyTouchesCapturedWithin¶

public bool AreAnyTouchesCapturedWithin { get; }

Property Value¶

AreAnyTouchesCaptured¶

public bool AreAnyTouchesCaptured { get; }

Property Value¶

TouchesCaptured¶

public IEnumerable<TouchDevice> TouchesCaptured { get; }

Property Value¶

TouchesCapturedWithin¶

public IEnumerable<TouchDevice> TouchesCapturedWithin { get; }

Property Value¶

TouchesOver¶

public IEnumerable<TouchDevice> TouchesOver { get; }

Property Value¶

TouchesDirectlyOver¶

public IEnumerable<TouchDevice> TouchesDirectlyOver { get; }

Property Value¶

DependencyObjectType¶

public DependencyObjectType DependencyObjectType { get; }

Property Value¶

DependencyObjectType

IsSealed¶

public bool IsSealed { get; }

Property Value¶

Dispatcher¶

public Dispatcher Dispatcher { get; }

Property Value¶

Dispatcher

Methods¶

Initialize(IMapArguments)¶

Replaced: the map hands an overlay its Overlay.MapArguments itself, so there is nothing to call.

public void Initialize(IMapArguments mapArguments)

Parameters¶

mapArguments IMapArguments
The map arguments describing the current view and map dimensions.

Returns¶

InitializeCore(IMapArguments)¶

Replaced by for one-time setup and for work done before every draw. It is no longer virtual, so an override fails with CS0506 instead of compiling and never being called.

protected void InitializeCore(IMapArguments mapArguments)

Parameters¶

mapArguments IMapArguments
Map arguments describing the current map state.

Returns¶

A(IMapArguments)¶

internal void A(IMapArguments )

Parameters¶

`` IMapArguments

Returns¶

RefreshAsync(CancellationToken)¶

Refreshes the entire overlay.

public Task RefreshAsync(CancellationToken cancellationToken)

Parameters¶

cancellationToken CancellationToken
A token that can be used to cancel the refresh.

Returns¶

Task
A task that completes when the overlay finishes redrawing.

Remarks:

Redraws this overlay only. Unlike MapView.RefreshAsync(overlay), it does not touch the map-wide cancellation source, so it does not cancel draws of other overlays that are still in flight. Two parts of an application that each own an overlay can therefore redraw independently without coordinating with one another. Three things to know. The overlay has to belong to a map already; called on one the map has never initialized, this returns without doing anything. It always performs a full redraw, with no RedrawIfNotDrawn equivalent. And the map-level OverlayDrawn event is not raised for it; subscribe to this overlay's own Drawn event instead. Calls so derived overlays can customize redraw behavior.

RefreshAsyncCore(CancellationToken)¶

When overridden, refreshes the entire overlay.

protected Task RefreshAsyncCore(CancellationToken cancellationToken)

Parameters¶

cancellationToken CancellationToken
A token that can be used to cancel the refresh.

Returns¶

Task
A task that completes when drawing is finished.

CloseAsync()¶

Closes the overlay and releases any resources it holds.

public Task CloseAsync()

Returns¶

Task
A task that completes when the overlay is closed.

CloseAsync(CancellationToken)¶

Closes the overlay and releases any resources it holds.

public Task CloseAsync(CancellationToken cancellationToken)

Parameters¶

cancellationToken CancellationToken
A token that asks the teardown to stop doing optional work.

Returns¶

Task
A task that completes when the overlay is closed.

CloseAsyncCore()¶

Replaced by , and deliberately left here, not deleted, so the old signature still has a name to point at. It is no longer virtual: two overridable overloads cannot coexist, because an override of this one would keep compiling and would simply never be called again. Overriding it now fails with CS0506 rather than failing silently at run time - marking it obsolete is not enough on its own, since overriding an obsolete member is only a warning.

protected Task CloseAsyncCore()

Returns¶

Task
Never returns.

CloseAsyncCore(CancellationToken)¶

When overridden, performs the overlay-specific teardown during Overlay.CloseAsync(CancellationToken).

protected Task CloseAsyncCore(CancellationToken cancellationToken)

Parameters¶

cancellationToken CancellationToken

        A token that asks the teardown to stop doing optional work. It is advisory: a close still
        releases everything it holds, whatever the token says. Abandoning a teardown halfway would
        leave exactly the resources this signature exists to release.

Returns¶

Task
A task that completes when the overlay is closed.

OpenAsync()¶

Opens the overlay if it has not already been opened.

public Task OpenAsync()

Returns¶

Task
A task that completes when initialization is finished.

OpenAsync(CancellationToken)¶

Opens the overlay if it has not already been opened.

public Task OpenAsync(CancellationToken cancellationToken)

Parameters¶

cancellationToken CancellationToken
A token that cancels the open.

Returns¶

Task
A task that completes when initialization is finished.

A(IMapArguments, CancellationToken)¶

internal Task A(IMapArguments , CancellationToken )

Parameters¶

`` IMapArguments

`` CancellationToken

Returns¶

Task

OpenAsyncCore()¶

Replaced by , and deliberately left here, not deleted, so the old signature still has a name to point at. It is no longer virtual: two overridable overloads cannot coexist, because an override of this one would keep compiling and would simply never be called again. Overriding it now fails with CS0506 rather than failing silently at run time - marking it obsolete is not enough on its own, since overriding an obsolete member is only a warning.

protected Task OpenAsyncCore()

Returns¶

Task
Never returns.

OpenAsyncCore(CancellationToken)¶

When overridden, performs the overlay-specific work required to open the overlay.

protected Task OpenAsyncCore(CancellationToken cancellationToken)

Parameters¶

cancellationToken CancellationToken
A token that cancels the open.

Returns¶

Task
A task that completes when opening finishes.

Remarks:

Overlay.MapArguments is set here when the map opens the overlay. It is null when the overlay is opened with Overlay.OpenAsync(CancellationToken) before it is added to a map. It runs once per open: once, and again after each Overlay.CloseAsync(CancellationToken), so it opens what the close closed. Work that has to follow the map, such as its size, belongs in .

A(RectangleShape, OverlayRefreshType, CancellationToken)¶

internal Task A(RectangleShape , OverlayRefreshType , CancellationToken )

Parameters¶

`` RectangleShape

`` OverlayRefreshType

`` CancellationToken

Returns¶

Task

Transform(RectangleShape, ExtentChangedType)¶

Applies a transform to the overlay in response to a map extent change.

public void Transform(RectangleShape targetExtent, ExtentChangedType extentChangedType)

Parameters¶

targetExtent RectangleShape
The new world extent of the map.

extentChangedType ExtentChangedType
The type of extent change (for example, pan or zoom).

Returns¶

TransformCore(RectangleShape, ExtentChangedType)¶

When overridden, updates overlay visuals for the supplied extent change.

protected void TransformCore(RectangleShape targetExtent, ExtentChangedType extentChangedType)

Parameters¶

targetExtent RectangleShape
The new world extent of the map.

extentChangedType ExtentChangedType
The type of extent change (pan, zoom, resize, etc.).

Returns¶

DrawAsyncCore(RectangleShape, OverlayRefreshType, CancellationToken)¶

When implemented, draws the overlay for the specified extent and refresh type.

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

Parameters¶

targetExtent RectangleShape

        The world extent this draw is for. Draw this rather than MapArguments.CurrentExtent:
        during an animated zoom that draws while it animates, it is the extent the animation ends
        at, while CurrentExtent is still where the map is now.

overlayRefreshType OverlayRefreshType
Indicates whether the draw represents a pan, redraw, or cache refresh.

cancellationToken CancellationToken
A token that can be used to cancel the draw.

Returns¶

Task
A task that completes when drawing is finished.

DrawAttributionCore(GeoCanvas)¶

Draws overlay attribution information onto the supplied canvas.

protected void DrawAttributionCore(GeoCanvas canvas)

Parameters¶

canvas GeoCanvas
The canvas to receive the attribution rendering.

Returns¶

OnDrawingAttribution(DrawingAttributionOverlayEventArgs)¶

Raises the Overlay.DrawingAttribution event before attribution is rendered.

protected void OnDrawingAttribution(DrawingAttributionOverlayEventArgs args)

Parameters¶

args DrawingAttributionOverlayEventArgs
Event data that can cancel the default attribution rendering.

Returns¶

OnDrawnAttribution(DrawnAttributionOverlayEventArgs)¶

Raises the Overlay.DrawnAttribution event after attribution rendering completes.

protected void OnDrawnAttribution(DrawnAttributionOverlayEventArgs args)

Parameters¶

args DrawnAttributionOverlayEventArgs
Event data describing the completed attribution draw.

Returns¶

OnDrawing(DrawingOverlayEventArgs)¶

Raises the Overlay.Drawing event before drawing begins.

protected void OnDrawing(DrawingOverlayEventArgs e)

Parameters¶

e DrawingOverlayEventArgs
Event data describing the draw operation, including the target extent.

Returns¶

OnDrawn(DrawnOverlayEventArgs)¶

Raises the Overlay.Drawn event after drawing completes.

protected void OnDrawn(DrawnOverlayEventArgs e)

Parameters¶

e DrawnOverlayEventArgs
Event data describing the completed draw.

Returns¶

GetBoundingBox()¶

Gets the geographic extent that the overlay covers.

public RectangleShape GetBoundingBox()

Returns¶

RectangleShape
A bounding box describing the overlay's coverage.

Remarks:

Calls so derived overlays can define their own extents.

GetBoundingBoxCore()¶

When overridden, returns the geographic extent that the overlay covers.

protected RectangleShape GetBoundingBoxCore()

Returns¶

RectangleShape
A bounding box describing the overlay's coverage, or null if undetermined.

SaveState()¶

Serializes the overlay state to a byte array.

public Byte[] SaveState()

Returns¶

Byte[]
A byte array representing the overlay state, or null if the overlay does not support serialization.

SaveStateCore()¶

When overridden, serializes the overlay state to a byte array.

protected Byte[] SaveStateCore()

Returns¶

Byte[]
A byte array representing the overlay state, or null if serialization is not supported.

LoadState(Byte[])¶

Restores the overlay state from the provided byte array.

public void LoadState(Byte[] state)

Parameters¶

state Byte[]
The serialized state previously produced by .

Returns¶

LoadStateCore(Byte[])¶

When overridden, restores the overlay state from the provided byte array.

protected void LoadStateCore(Byte[] state)

Parameters¶

state Byte[]
The serialized state previously produced by .

Returns¶

Finalize()¶

Finalizer of this Overlay object.

protected void Finalize()

Returns¶

Dispose()¶

Releases the resources used by the overlay.

public void Dispose()

Returns¶

Dispose(bool)¶

When overridden, releases resources held by the overlay.

protected void Dispose(bool disposing)

Parameters¶

disposing bool
true to release managed resources as well as unmanaged resources; otherwise, false.

Returns¶

OnThrowingException(ThrowingExceptionOverlayEventArgs)¶

Raises the Overlay.ThrowingException event when an operation encounters an exception.

protected void OnThrowingException(ThrowingExceptionOverlayEventArgs e)

Parameters¶

e ThrowingExceptionOverlayEventArgs
Event data describing the exception and the originating member.

Returns¶