OverlayClient Class |
This domain provides various functionality related to drawing atop the inspected page.
Inheritance HierarchyNamespace: CefSharp.DevTools.Overlay
Assembly: CefSharp (in CefSharp.dll) Version: 106.0.290.0 (106.0.290.0)
SyntaxThe OverlayClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | OverlayClient |
Overlay
|
Methods| Name | Description | |
|---|---|---|
| DisableAsync |
Disables domain notifications.
|
| EnableAsync |
Enables domain notifications.
|
 | EnumToString(Enum) | (Inherited from DevToolsDomainBase.) |
| EnumToString(ContentEncoding) | (Inherited from DevToolsDomainBase.) |
| EnumToString(CSPViolationType) | (Inherited from DevToolsDomainBase.) |
| EnumToString(DisabledImageType) | (Inherited from DevToolsDomainBase.) |
| EnumToString(PermissionType) | (Inherited from DevToolsDomainBase.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetGridHighlightObjectsForTestAsync |
For Persistent Grid testing.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetHighlightObjectForTestAsync |
For testing.
|
| GetSourceOrderHighlightObjectForTestAsync |
For Source Order Viewer testing.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HideHighlightAsync |
Hides any highlight.
|
| HighlightNodeAsync |
Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or
objectId must be specified.
|
| HighlightQuadAsync |
Highlights given quad. Coordinates are absolute with respect to the main frame viewport.
|
| HighlightRectAsync |
Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.
|
| HighlightSourceOrderAsync |
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.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetInspectModeAsync |
Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted.
Backend then generates 'inspectNodeRequested' event upon element selection.
|
| SetPausedInDebuggerMessageAsync |
SetPausedInDebuggerMessage
|
| SetShowAdHighlightsAsync |
Highlights owner element of all frames detected to be ads.
|
| SetShowContainerQueryOverlaysAsync |
SetShowContainerQueryOverlays
|
| SetShowDebugBordersAsync |
Requests that backend shows debug borders on layers
|
| SetShowFlexOverlaysAsync |
SetShowFlexOverlays
|
| SetShowFPSCounterAsync |
Requests that backend shows the FPS counter
|
| SetShowGridOverlaysAsync |
Highlight multiple elements with the CSS Grid overlay.
|
| SetShowHingeAsync |
Add a dual screen device hinge
|
| SetShowIsolatedElementsAsync |
Show elements in isolation mode with overlays.
|
| SetShowLayoutShiftRegionsAsync |
Requests that backend shows layout shift regions
|
| SetShowPaintRectsAsync |
Requests that backend shows paint rectangles
|
| SetShowScrollBottleneckRectsAsync |
Requests that backend shows scroll bottleneck rects
|
| SetShowScrollSnapOverlaysAsync |
SetShowScrollSnapOverlays
|
| SetShowViewportSizeOnResizeAsync |
Paints viewport size upon main frame resize.
|
| SetShowWebVitalsAsync |
Request that backend shows an overlay with web vital metrics.
|
| ToBase64String | (Inherited from DevToolsDomainBase.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | InspectModeCanceled |
Fired when user cancels the inspect mode.
|
| InspectNodeRequested |
Fired when the node should be inspected. This happens after call to `setInspectMode` or when
user manually inspects an element.
|
| NodeHighlightRequested |
Fired when the node should be highlighted. This happens after call to `setInspectMode`.
|
| ScreenshotRequested |
Fired when user asks to capture screenshot of some area on the page.
|
See Also