IChromiumWebBrowserBase Interface |
Interface for common events/methods/properties for ChromiumWebBrowser and popup host implementations.
Namespace: CefSharp
Assembly: CefSharp (in CefSharp.dll) Version: 118.6.80.0 (118.6.80.0)
SyntaxThe IChromiumWebBrowserBase type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Address |
The address (URL) which the browser control is currently displaying.
Will automatically be updated as the user navigates to another page (e.g. by clicking on a link).
|
| BrowserCore |
Returns the current IBrowser Instance or null.
IBrowser is the the underlying CefBrowser
instance and provides access to frames/browserhost etc.
|
| CanGoBack |
A flag that indicates whether the state of the control current supports the GoBack action (true) or not (false).
|
| CanGoForward |
A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false).
|
| IsBrowserInitialized |
A flag that indicates whether the WebBrowser is initialized (true) or not (false).
|
| IsDisposed |
A flag that indicates whether the WebBrowser has been disposed () or not ()
|
| IsLoading |
A flag that indicates whether the control is currently loading one or more web pages (true) or not (false).
|
Methods| Name | Description | |
|---|---|---|
 | Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| Focus |
Attempts to give focus to the IWebBrowser control.
|
| LoadUrl |
Loads the specified url in the Main Frame.
Same as calling Load(String) |
| LoadUrlAsync |
Load the url in the main frame of the browser
|
 | WaitForNavigationAsync |
This resolves when the browser navigates to a new URL or reloads.
It is useful for when you run code which will indirectly cause the browser to navigate.
A common use case would be when executing javascript that results in a navigation. e.g. clicks a link
This must be called before executing the action that navigates the browser. It may not resolve correctly
if called after.
|
Events| Name | Description | |
|---|---|---|
 | ConsoleMessage |
Event handler for receiving Javascript console messages being sent from web pages.
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
(The exception to this is when you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
|
| FrameLoadEnd |
Event handler that will get called when the browser is done loading a frame. Multiple frames may be loading at the same
time. Sub-frames may start or continue loading after the main frame load has ended. This method will always be called
for all frames irrespective of whether the request completes successfully.
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
|
| FrameLoadStart |
Event handler that will get called when the browser begins loading a frame. Multiple frames may be loading at the same
time. Sub-frames may start or continue loading after the main frame load has ended. This method may not be called for a
particular frame if the load request for that frame fails. For notification of overall browser load status use
OnLoadingStateChange instead.
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
|
| LoadError |
Event handler that will get called when the resource load for a navigation fails or is canceled.
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
|
| LoadingStateChanged |
Event handler that will get called when the Loading state has changed.
This event will be fired twice. Once when loading is initiated either programmatically or
by user action, and once when loading is terminated due to completion, cancellation of failure.
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
|
| StatusMessage |
Event handler for changes to the status message.
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
(The exception to this is when you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
|
Extension Methods| Name | Description | |
|---|---|---|
 | AddWordToDictionary |
Add the specified word to the spelling dictionary.
(Defined by WebBrowserExtensions.) |
| Back |
Navigates back, must check CanGoBack before calling this method.
(Defined by WebBrowserExtensions.) |
| CloseDevTools |
Explicitly close the developer tools window if one exists for this browser instance.
(Defined by WebBrowserExtensions.) |
| Copy |
Execute Copy on the focused frame.
(Defined by WebBrowserExtensions.) |
| Cut |
Execute Cut on the focused frame.
(Defined by WebBrowserExtensions.) |
| Delete |
Execute Delete on the focused frame.
(Defined by WebBrowserExtensions.) |
| DestroyWindow |
Manually call https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-destroywindow
passing in the handle returned from GetWindowHandle.
This method can be used to manually close the underlying CefBrowser instance.
This will avoid the WM_Close message that CEF sends by default to the top level window.
(Which closes your application). This method should generally only be used in the WinForms version.
(Defined by WebBrowserExtensions.) |
| EvaluateScriptAsync(String, Object) | Overloaded.
Evaluate some Javascript code in the context of this WebBrowser. The script will be executed asynchronously and the method
returns a Task encapsulating the response from the Javascript This simple helper extension will encapsulate params in single
quotes (unless int, uint, etc)
(Defined by WebBrowserExtensions.) |
| EvaluateScriptAsync(NullableTimeSpan, String, Object) | Overloaded.
Evaluate Javascript code in the context of this WebBrowser using the specified timeout. The script will be executed
asynchronously and the method returns a Task encapsulating the response from the Javascript This simple helper extension will
encapsulate params in single quotes (unless int, uint, etc).
(Defined by WebBrowserExtensions.) |
| EvaluateScriptAsync(String, NullableTimeSpan, Boolean) | Overloaded.
Evaluate Javascript in the context of this Browsers Main Frame. The script will be executed
asynchronously and the method returns a Task encapsulating the response from the Javascript
(Defined by WebBrowserExtensions.) |
| EvaluateScriptAsyncT(String, NullableTimeSpan) | Overloaded.
Evaluate Javascript in the context of this Browsers Main Frame. The script will be executed
asynchronously and the method returns a Task encapsulating the response from the Javascript
(Defined by WebBrowserExtensionsEx.) |
| ExecuteDevToolsMethodAsync |
Execute a method call over the DevTools protocol. This is a more structured
version of SendDevToolsMessage. ExecuteDevToolsMethod(IBrowserHost, Int32, String, JsonString) can only be called on the
CEF UI Thread, this method can be called on any thread.
See the DevTools protocol documentation at https://chromedevtools.github.io/devtools-protocol/ for details
of supported methods and the expected parameters dictionary contents.
See the SendDevToolsMessage documentation for additional usage information.
(Defined by DevToolsExtensions.) |
| ExecuteScriptAsync(String) | Overloaded.
Execute Javascript in the context of this Browsers Main Frame. As the method name implies, the script will be executed
asynchronously, and the method therefore returns before the script has actually been executed.
(Defined by WebBrowserExtensions.) |
| ExecuteScriptAsync(String, Object) | Overloaded.
Execute Javascript code in the context of this Browser. As the method name implies, the script will be executed
asynchronously, and the method therefore returns before the script has actually been executed. This simple helper extension
will encapsulate params in single quotes (unless int, uint, etc)
(Defined by WebBrowserExtensions.) |
| ExecuteScriptAsyncWhenPageLoaded |
Execute Javascript code in the context of this Browsers Main Frame. This extension method uses the LoadingStateChanged event. As the
method name implies, the script will be executed asynchronously, and the method therefore returns before the script has
actually been executed.
(Defined by WebBrowserExtensions.) |
| Find |
Search for text within the current page.
(Defined by WebBrowserExtensions.) |
| Forward |
Navigates forward, must check CanGoForward before calling this method.
(Defined by WebBrowserExtensions.) |
| GetBrowserHost |
Shortcut method to get the browser IBrowserHost.
(Defined by WebBrowserExtensions.) |
| GetCookieManager |
Gets the default cookie manager associated with the IChromiumWebBrowserBase instance.
(Defined by WebBrowserExtensions.) |
| GetDevToolsClient |
Gets a new Instance of the DevTools client for the chromiumWebBrowser
instance.
(Defined by DevToolsExtensions.) |
| GetFocusedFrame |
Returns the focused frame for the browser window.
(Defined by WebBrowserExtensions.) |
| GetMainFrame |
Returns the main (top-level) frame for the browser window.
(Defined by WebBrowserExtensions.) |
| GetRequestContext |
Gets the RequestContext associated with the IChromiumWebBrowserBase instance.
(Defined by WebBrowserExtensions.) |
| GetSourceAsync |
Retrieve the main frame's HTML source using a TaskTResult.
(Defined by WebBrowserExtensions.) |
| GetTextAsync |
Retrieve the main frame's display text using a TaskTResult.
(Defined by WebBrowserExtensions.) |
| GetVisibleNavigationEntryAsync | (Defined by WebBrowserExtensionsEx.) |
| GetZoomLevelAsync |
Asynchronously gets the current Zoom Level.
(Defined by WebBrowserExtensions.) |
| LoadHtml |
Loads html as Data Uri See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs for details If
base64Encode is false then html will be Uri encoded.
(Defined by WebBrowserExtensions.) |
| LoadUrlWithPostData |
Creates a new instance of IRequest with the specified Url and Method = POST and then calls
LoadRequest(IRequest).
(Defined by WebBrowserExtensions.) |
| Paste |
Execute Paste on the focused frame.
(Defined by WebBrowserExtensions.) |
|
Opens a Print Dialog which if used (can be user cancelled) will print the browser contents.
(Defined by WebBrowserExtensions.) | |
| PrintToPdfAsync |
Asynchronously prints the current browser contents to the PDF file specified. The caller is responsible for deleting the file
when done.
(Defined by WebBrowserExtensions.) |
| Redo |
Execute Redo on the focused frame.
(Defined by WebBrowserExtensions.) |
| Reload | Overloaded.
Reloads the page being displayed. This method will use data from the browser's cache, if available.
(Defined by WebBrowserExtensions.) |
| Reload(Boolean) | Overloaded.
Reloads the page being displayed, optionally ignoring the cache (which means the whole page including all .css, .js etc.
resources will be re-fetched).
(Defined by WebBrowserExtensions.) |
| ReplaceMisspelling |
If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word.
(Defined by WebBrowserExtensions.) |
| SelectAll |
Execute SelectAll on the focused frame.
(Defined by WebBrowserExtensions.) |
| SendMouseWheelEvent |
Send a mouse wheel event to the browser.
(Defined by WebBrowserExtensions.) |
| SetMainFrameDocumentContentAsync |
Set the Document Content for the Main Frame using DevTools Protocol.
(Defined by DevToolsExtensions.) |
| SetZoomLevel |
Change the ZoomLevel to the specified value. Can be set to 0.0 to clear the zoom level.
(Defined by WebBrowserExtensions.) |
| ShowDevTools |
Open developer tools in its own window.
(Defined by WebBrowserExtensions.) |
| ShowDevToolsDocked(ActionChromiumHostControl, String, DockStyle, Int32, Int32) | Overloaded.
Open DevTools using your own Control as the parent. If inspectElementAtX and/or inspectElementAtY are specified then
the element at the specified (x,y) location will be inspected.
For resize/moving to work correctly you will need to use the LifeSpanHandler implementation.
(Set LifeSpanHandler to an instance of LifeSpanHandler)
(Defined by WebBrowserExtensions.) |
| ShowDevToolsDocked(Control, String, DockStyle, Int32, Int32) | Overloaded.
Open DevTools using parentControl as the parent control. If inspectElementAtX and/or inspectElementAtY are specified then
the element at the specified (x,y) location will be inspected.
For resize/moving to work correctly you will need to use the LifeSpanHandler implementation.
(Set LifeSpanHandler to an instance of LifeSpanHandler)
(Defined by WebBrowserExtensions.) |
| StartDownload |
Download the file at url using IDownloadHandler.
(Defined by WebBrowserExtensions.) |
| Stop |
Stops loading the current page.
(Defined by WebBrowserExtensions.) |
| StopFinding |
Cancel all searches that are currently going on.
(Defined by WebBrowserExtensions.) |
| ToggleAudioMute |
Toggles audio mute for the current browser.
If the browser is null or has been disposed
then this command will be a no-op.
(Defined by WebBrowserExtensionsEx.) |
| Undo |
Execute Undo on the focused frame.
(Defined by WebBrowserExtensions.) |
| ViewSource |
Opens up a new program window (using the default text editor) where the source code of the currently displayed web page is
shown.
(Defined by WebBrowserExtensions.) |
See Also