Click or drag to resize
IBrowserHost Interface
Version 51.0.0
Interface used to represent the browser process aspects of a browser window. They may be called on any thread in that process unless otherwise indicated in the comments.

Namespace: CefSharp
Assembly: CefSharp (in CefSharp.dll) Version: 51.0.0.0 (51.0.0.0)
Syntax
public interface IBrowserHost : IDisposable

The IBrowserHost type exposes the following members.

Properties
  NameDescription
Public propertyIsDisposed
Gets a value indicating whether the browserHost has been disposed of.
Public propertyMouseCursorChangeDisabled
Get/Set Mouse cursor change disabled
Public propertyRequestContext
Returns the request context for this browser.
Public propertyWindowlessFrameRate
Gets/sets the maximum rate in frames per second (fps) that CefRenderHandler:: OnPaint will be called for a windowless browser. The actual fps may be lower if the browser cannot generate frames at the requested rate. The minimum value is 1 and the maximum value is 60 (default 30). This method can only be called on the UI thread. Can also be set at browser creation via BrowserSettings.WindowlessFrameRate.
Public propertyWindowRenderingDisabled
Returns true if window rendering is disabled.
Top
Methods
  NameDescription
Public methodAddWordToDictionary
Add the specified word to the spelling dictionary.
Public methodCloseBrowser
Request that the browser close. The JavaScript 'onbeforeunload' event will be fired.
Public methodCloseDevTools
Explicitly close the developer tools window if one exists for this browser instance.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodDragSourceEndedAt
Call this method when the drag operation started by a [!:IRenderWebBrowser.StartDragging] call has ended either in a drop or by being cancelled. If the web view is both the drag source and the drag target then all DragTarget* methods should be called before DragSource* methods. This method is only used when window rendering is disabled.
Public methodDragSourceSystemDragEnded
Call this method when the drag operation started by a [!:IRenderWebBrowser.StartDragging] call has completed. This method may be called immediately without first calling DragSourceEndedAt to cancel a drag operation. If the web view is both the drag source and the drag target then all DragTarget* methods should be called before DragSource* mthods. This method is only used when window rendering is disabled.
Public methodDragTargetDragDrop
Call this method when the user completes the drag operation by dropping the object onto the web view (after calling DragTargetDragEnter(IDragData, MouseEvent, DragOperationsMask)). The object being dropped is IDragData, given as an argument to the previous DragTargetDragEnter(IDragData, MouseEvent, DragOperationsMask) call. This method is only used when window rendering is disabled.
Public methodDragTargetDragEnter
Public methodDragTargetDragLeave
Call this method when the user drags the mouse out of the web view (after calling DragTargetDragEnter(IDragData, MouseEvent, DragOperationsMask)). This method is only used when window rendering is disabled.
Public methodDragTargetDragOver
Call this method each time the mouse is moved across the web view during a drag operation (after calling DragTargetDragEnter(IDragData, MouseEvent, DragOperationsMask) and before calling DragTargetDragLeave/DragTargetDragDrop(MouseEvent)). This method is only used when window rendering is disabled.
Public methodFind
Search for text
Public methodGetNavigationEntries
Retrieve a snapshot of current navigation entries as values sent to the specified visitor.
Public methodGetOpenerWindowHandle
Retrieve the window handle of the browser that opened this browser.
Public methodGetWindowHandle
Retrieve the window handle for this browser.
Public methodGetZoomLevelAsync
Get the current zoom level. The default zoom level is 0.0. This method can only be called on the CEF UI thread.
Public methodInvalidate
Invalidate the view. The browser will call CefRenderHandler::OnPaint asynchronously. This method is only used when window rendering is disabled (OSR).
Public methodNotifyMoveOrResizeStarted
Notify the browser that the window hosting it is about to be moved or resized.
Public methodNotifyScreenInfoChanged
Send a notification to the browser that the screen info has changed. The browser will then call CefRenderHandler::GetScreenInfo to update the screen information with the new values. This simulates moving the webview window from one display to another, or changing the properties of the current display. This method is only used when window rendering is disabled.
Public methodPrint
Print the current browser contents.
Public methodPrintToPdf
Asynchronously prints the current browser contents to the Pdf file specified. The caller is responsible for deleting the file when done.
Public methodPrintToPdfAsync
Asynchronously prints the current browser contents to the Pdf file specified. The caller is responsible for deleting the file when done.
Public methodReplaceMisspelling
If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word.
Public methodSendCaptureLostEvent
Send a capture lost event to the browser.
Public methodSendFocusEvent
Send a focus event to the browser. . (Used for OSR Rendering e.g. WPF or OffScreen)
Public methodSendKeyEvent(KeyEvent)
Send a key event to the browser.
Public methodSendKeyEvent(Int32, Int32, Int32)
Send key event to browser based on operating system message
Public methodSendMouseClickEvent
Send a mouse click event to the browser.
Public methodSendMouseMoveEvent
Send a mouse move event to the browser
Public methodSendMouseWheelEvent
Send a mouse wheel event to the browser.
Public methodSetFocus
Set whether the browser is focused. (Used for Normal Rendering e.g. WinForms)
Public methodSetZoomLevel
Change the zoom level to the specified value. Specify 0.0 to reset the zoom level. If called on the CEF UI thread the change will be applied immediately. Otherwise, the change will be applied asynchronously on the UI thread.
Public methodShowDevTools
Open developer tools in its own window. If inspectElementAtX and/or inspectElementAtY are specified then the element at the specified (x,y) location will be inspected.
Public methodStartDownload
Download the file at url using IDownloadHandler.
Public methodStopFinding
Cancel all searches that are currently going on.
Public methodWasHidden
Notify the browser that it has been hidden or shown. Layouting and rendering notification will stop when the browser is hidden. This method is only used when window rendering is disabled (WPF/OffScreen).
Public methodWasResized
Notify the browser that the widget has been resized. The browser will first call CefRenderHandler::GetViewRect to get the new size and then call CefRenderHandler::OnPaint asynchronously with the updated regions. This method is only used when window rendering is disabled.
Top
See Also