Share via


IWindowOverlay Interface

Definition

public interface class IWindowOverlay : Microsoft::Maui::Graphics::IDrawable
public interface IWindowOverlay : Microsoft.Maui.Graphics.IDrawable
type IWindowOverlay = interface
    interface IDrawable
Public Interface IWindowOverlay
Implements IDrawable
Derived
Implements

Properties

Density

Gets the Density for the layer. Can be used to pass through Density settings to underlying drawables.

DisableUITouchEventPassthrough

Gets or sets a value indicating whether to disable UI Touch Event Passthrough. Enable this when you want to enable hit testing the current overlay without interfacing with the underlaying UI.

EnableDrawableTouchHandling

Gets or sets a value indicating whether to enable handling touch events when selecting any drawable element on the overlay. This setting is overridden by DisableUITouchEventPassthrough.

IsPlatformViewInitialized

Gets a value indicating whether the platform touch and drawing layer has been initialized. If it has not, you will be unable to draw or use hit testing on the Overlay.

IsVisible

Gets or sets a value indicating whether to draw the window overlay.

Window

Gets the containing IWindow.

WindowElements

Gets the current collection of drawable elements on the overlay.

Methods

AddWindowElement(IWindowOverlayElement)

Adds a new drawable element to the overlay.

Deinitialize()

Deinitialize the overlay.

Draw(ICanvas, RectF) (Inherited from IDrawable)
HandleUIChange()

Handles updating the drawing layer when a UI layout change happens.

Initialize()

Initialize the overlay.

Invalidate()

Invalidates the layer. Call to force the layer to redraw.

RemoveWindowElement(IWindowOverlayElement)

Removes a drawable element from the overlay.

RemoveWindowElements()

Removes all drawable elements from the overlay.

Events

Tapped

Event Handler for touch events on the Overlay. Called when a user touched the Overlay.

Applies to