Click or drag to resize

OverlayClient Class

Version 94.4.20
This domain provides various functionality related to drawing atop the inspected page.
Inheritance Hierarchy

Namespace:  CefSharp.DevTools.Overlay
Assembly:  CefSharp (in CefSharp.dll) Version: (
public class OverlayClient : DevToolsDomainBase

The OverlayClient type exposes the following members.

Public methodOverlayClient
Public methodDisableAsync
Disables domain notifications.
Public methodEnableAsync
Enables domain notifications.
Protected methodEnumToString(Enum) (Inherited from DevToolsDomainBase.)
Protected methodEnumToString(ContentEncoding) (Inherited from DevToolsDomainBase.)
Protected methodEnumToString(CSPViolationType) (Inherited from DevToolsDomainBase.)
Protected methodEnumToString(DisabledImageType) (Inherited from DevToolsDomainBase.)
Protected methodEnumToString(PermissionType) (Inherited from DevToolsDomainBase.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetGridHighlightObjectsForTestAsync
For Persistent Grid testing.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetHighlightObjectForTestAsync
For testing.
Public methodGetSourceOrderHighlightObjectForTestAsync
For Source Order Viewer testing.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHideHighlightAsync
Hides any highlight.
Public methodHighlightNodeAsync
Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.
Public methodHighlightQuadAsync
Highlights given quad. Coordinates are absolute with respect to the main frame viewport.
Public methodHighlightRectAsync
Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.
Public methodHighlightSourceOrderAsync
Highlights the source order of the children of the DOM node with given id or with the given JavaScript object wrapper. Either nodeId or objectId must be specified.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetInspectModeAsync
Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. Backend then generates 'inspectNodeRequested' event upon element selection.
Public methodSetPausedInDebuggerMessageAsync
Public methodSetShowAdHighlightsAsync
Highlights owner element of all frames detected to be ads.
Public methodSetShowContainerQueryOverlaysAsync
Public methodSetShowDebugBordersAsync
Requests that backend shows debug borders on layers
Public methodSetShowFlexOverlaysAsync
Public methodSetShowFPSCounterAsync
Requests that backend shows the FPS counter
Public methodSetShowGridOverlaysAsync
Highlight multiple elements with the CSS Grid overlay.
Public methodSetShowHingeAsync
Add a dual screen device hinge
Public methodSetShowHitTestBordersAsync
Requests that backend shows hit-test borders on layers
Public methodSetShowLayoutShiftRegionsAsync
Requests that backend shows layout shift regions
Public methodSetShowPaintRectsAsync
Requests that backend shows paint rectangles
Public methodSetShowScrollBottleneckRectsAsync
Requests that backend shows scroll bottleneck rects
Public methodSetShowScrollSnapOverlaysAsync
Public methodSetShowViewportSizeOnResizeAsync
Paints viewport size upon main frame resize.
Public methodSetShowWebVitalsAsync
Request that backend shows an overlay with web vital metrics.
Protected methodToBase64String (Inherited from DevToolsDomainBase.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public eventInspectModeCanceled
Fired when user cancels the inspect mode.
Public eventInspectNodeRequested
Fired when the node should be inspected. This happens after call to `setInspectMode` or when user manually inspects an element.
Public eventNodeHighlightRequested
Fired when the node should be highlighted. This happens after call to `setInspectMode`.
Public eventScreenshotRequested
Fired when user asks to capture screenshot of some area on the page.
See Also