IVisualDiagnosticsOverlay Interface

Definition

Namespace:

Microsoft.Maui

Assembly:

Microsoft.Maui.dll

Source:

IVisualDiagnosticsOverlay.cs

public interface class IVisualDiagnosticsOverlay : Microsoft::Maui::Graphics::IDrawable, Microsoft::Maui::IWindowOverlay

public interface IVisualDiagnosticsOverlay : Microsoft.Maui.Graphics.IDrawable, Microsoft.Maui.IWindowOverlay

type IVisualDiagnosticsOverlay = interface
    interface IWindowOverlay
    interface IDrawable

Public Interface IVisualDiagnosticsOverlay
Implements IDrawable, IWindowOverlay

Derived

Microsoft.Maui.VisualDiagnosticsOverlay

Implements

IDrawable IWindowOverlay

Properties

Density	Gets the Density for the layer. Can be used to pass through Density settings to underlying drawables. (Inherited from IWindowOverlay)
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. (Inherited from IWindowOverlay)
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. (Inherited from IWindowOverlay)
EnableElementSelector	Gets or sets a value indicating whether to enable the element selector on the diagnostics overlay. If enabled, this will also enable 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. (Inherited from IWindowOverlay)
IsVisible	Gets or sets a value indicating whether to draw the window overlay. (Inherited from IWindowOverlay)
Offset	Gets the offset point used to adjust the platform drawing bounds for a given Adorner. Used when the underlying operating system may not give exact placement for where elements are. Ex. Android and the Status Bar.
ScrollToElement	Gets or sets a value indicating whether to automatically scroll to an element when adding an adorner, if available.
ScrollViews	Gets the Scroll Views in a given window, to be handled by the layer for when they scroll to update the underlying adorners.
Window	Gets the containing IWindow. (Inherited from IWindowOverlay)
WindowElements	Gets the current collection of drawable elements on the overlay. (Inherited from IWindowOverlay)

Methods

AddAdorner(IAdorner, Boolean)	Adds a new adorner to the Visual Diagnostics Overlay.
AddAdorner(IVisualTreeElement, Boolean)	Adds a new adorner to the Visual Diagnostics Overlay. Uses the default Adorner for drawing.
AddScrollableElementHandler(IScrollView)	Adds scrollable element handle attached to IScrollView. Used for tracking when a user has scrolled, in order to update the layer to redraw.
AddScrollableElementHandlers()	Adds scrollable element handles attached to IScrollView. Used for tracking when a user has scrolled, in order to update the layer to redraw.
AddWindowElement(IWindowOverlayElement)	Adds a new drawable element to the overlay. (Inherited from IWindowOverlay)
Deinitialize()	Deinitialize the overlay. (Inherited from IWindowOverlay)
Draw(ICanvas, RectF)	(Inherited from IDrawable)
HandleUIChange()	Handles updating the drawing layer when a UI layout change happens. (Inherited from IWindowOverlay)
Initialize()	Initialize the overlay. (Inherited from IWindowOverlay)
Invalidate()	Invalidates the layer. Call to force the layer to redraw. (Inherited from IWindowOverlay)
RemoveAdorner(IAdorner)	Removes adorner from Visual Diagnostics Overlay.
RemoveAdorners()	Removes all adorners from the Visual Diagnostics Overlay.
RemoveAdorners(IVisualTreeElement)	Removes all adorners containing the inner IVisualTreeElement.
RemoveScrollableElementHandler()	Removes any existing scrollable element handles attached to IScrollView.
RemoveWindowElement(IWindowOverlayElement)	Removes a drawable element from the overlay. (Inherited from IWindowOverlay)
RemoveWindowElements()	Removes all drawable elements from the overlay. (Inherited from IWindowOverlay)
ScrollToView(IVisualTreeElement)	Automatically scroll to a given element within the view, if available.

Events

Tapped

Event Handler for touch events on the Overlay. Called when a user touched the Overlay. (Inherited from IWindowOverlay)