ChromiumWebBrowser Class

Create a new OffScreen Chromium Browser. If you use LegacyBindingEnabled = true then you must set automaticallyCreateBrowser to false and call CreateBrowser(IWindowInfo, IBrowserSettings) after the objects are registered. The underlying Chromium Embedded Framework(CEF) Browser is created asynchronouly, to subscribe to the BrowserInitialized event it is recommended that you set automaticallyCreateBrowser to false, subscribe to the event and then call CreateBrowser(IWindowInfo, IBrowserSettings) to ensure you are subscribe to the event before it's fired (Issue https://github.com/cefsharp/CefSharp/issues/3552).

Create a new OffScreen Chromium Browser. If you use LegacyBindingEnabled = true then you must set automaticallyCreateBrowser to false and call CreateBrowser(IWindowInfo, IBrowserSettings) after the objects are registered. The underlying Chromium Embedded Framework(CEF) Browser is created asynchronouly, to subscribe to the BrowserInitialized event it is recommended that you set automaticallyCreateBrowser to false, subscribe to the event and then call CreateBrowser(IWindowInfo, IBrowserSettings) to ensure you are subscribe to the event before it's fired (Issue https://github.com/cefsharp/CefSharp/issues/3552).

Implement IAccessibilityHandler to handle events related to accessibility.

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).

Implement IAudioHandler to handle audio events.

Get access to the core IBrowser instance. Maybe null if the underlying CEF Browser has not yet been created or if this control has been disposed. Check IsDisposed before accessing.

A flag that indicates if you can execute javascript in the main frame. Flag is set to true in IRenderProcessMessageHandler.OnContextCreated. and false in IRenderProcessMessageHandler.OnContextReleased

A flag that indicates whether the state of the control current supports the GoBack action (true) or not (false).

A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false).

Device scale factor. Specifies the ratio between physical and logical pixels.

Implement IDialogHandler and assign to handle dialog events.

Implement IDisplayHandler and assign to handle events related to browser display state.

Implement IDownloadHandler and assign to handle events related to downloading files.

Implement IDragHandler and assign to handle events related to dragging.

Implement IFindHandler to handle events related to find results.

The IFocusHandler for this ChromiumWebBrowser.

Implement IFrameHandler to handle frame events.

A flag that indicates whether the WebBrowser is initialized (true) or not (false).

Gets a value indicating whether this instance is disposed.

A flag that indicates whether the control is currently loading one or more web pages (true) or not (false).

The javascript object repository, one repository per ChromiumWebBrowser instance.

Implement IJsDialogHandler and assign to handle events related to JavaScript Dialogs.

Implement IKeyboardHandler and assign to handle events related to key press.

Implement ILifeSpanHandler and assign to handle events related to popups.

Implement ILoadHandler and assign to handle events related to browser load status.

Implement IContextMenuHandler and assign to handle events related to the browser context menu

Implement IRenderHandler and assign to handle events related to browser rendering.

Implement IRenderProcessMessageHandler and assign to handle messages from the render process.

Gets the request context.

Implement IRequestHandler and assign to handle events related to browser requests.

Implement IResourceRequestHandlerFactory and control the loading of resources

Get/set the size of the Chromium viewport, in pixels. This also changes the size of the next rendered bitmap.

The text that will be displayed as a ToolTip

Capture page screenshot.

Create the underlying browser. The instance address, browser settings and request context will be used.

Create the underlying CEF browser. The address and request context passed into the constructor will be used. If a ActionT delegate was passed into the constructor it will not be called as this method overrides that value internally.

Releases all resources used by the ChromiumWebBrowser object

Releases unmanaged and - optionally - managed resources for the ChromiumWebBrowser

Determines whether the specified object is equal to the current object.

Finalizes an instance of the ChromiumWebBrowser class.

Returns the current CEF Browser Instance

Size of scrollable area in CSS pixels

Serves as the default hash function.

Gets the screen information (scale factor).

Called to retrieve the translation from view coordinates to actual screen coordinates.

Gets the Type of the current instance.

Gets the view rect (width, height)

Loads the specified url in the Main Frame. If [!:IsDisposed] is true then the method call will be ignored. Same as calling [!:LoadUrl(string)]

Loads the specified url in the Main Frame. Same as calling [!:Load(string)]

Load the url in the main frame of the browser

Creates a shallow copy of the current Object.

Resize the browser

Starts a task that waits for the next rendering from Chrome. Chrome also renders the page loading, so if you want to see a complete rendering, only start this task once your page is loaded (which you can detect via FrameLoadEnd or your own heuristics based on evaluating JavaScript). It is your responsibility to dispose the returned Bitmap. The bitmap size is determined by the Size property set earlier.

Immediately returns a copy of the last rendering from Chrome, or null if no rendering has occurred yet. Chrome also renders the page loading, so if you want to see a complete rendering, only start this task once your page is loaded (which you can detect via FrameLoadEnd or your own heuristics based on evaluating JavaScript). It is your responsibility to dispose the returned Bitmap. The bitmap size is determined by the Size property set earlier.

Returns a string that represents the current object.

Try and get a reference to the IBrowser instance that matches the browserId. Primarily used for geting a reference to the IBrowser used by popups.

Wait for the Browser to finish loading the initial web page.

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.

Occurs when the browser address changed. 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).

Event called after the underlying CEF browser instance has been created. 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).

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).

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.

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.

Event handler that will get called when the message that originates from CefSharp.PostMessage

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.

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.

Fired on the CEF UI thread, which by default is not the same as your application main thread. Called when an element should be painted. Pixel values passed to this method are scaled relative to view coordinates based on the value of ScreenInfo.DeviceScaleFactor returned from GetScreenInfo.

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).

Occurs when [title changed]. 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).

Add the specified word to the spelling dictionary.

Navigates back, must check CanGoBack before calling this method.

Explicitly close the developer tools window if one exists for this browser instance.

Execute Copy on the focused frame.

Execute Cut on the focused frame.

Execute Delete on the focused frame.

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.

Make sure an object is bound in javascript. Executes against the main frame

Evaluate Javascript in the context of the MainFrame of the ChromiumWebBrowser. The script will be executed asynchronously and the method returns a Task encapsulating the response from the Javascript. The result of the script execution in javascript is Promise.resolve so even no promise values will be treated as a promise. Your javascript should return a value. The javascript will be wrapped in an Immediately Invoked Function Expression. When the promise either trigger then/catch this returned Task will be completed.

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)

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

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).

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.

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.

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)

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.

Search for text within the current page.

Navigates forward, must check CanGoForward before calling this method.

Shortcut method to get the browser IBrowserHost.

Gets the default cookie manager associated with the IChromiumWebBrowserBase instance.

Gets a new Instance of the DevTools client for the chromiumWebBrowser instance.

Returns the focused frame for the browser window.

Returns the main (top-level) frame for the browser window.

Gets the RequestContext associated with the IChromiumWebBrowserBase instance.

Retrieve the main frame's HTML source using a TaskTResult.

Retrieve the main frame's display text using a TaskTResult.

Retrieve the current NavigationEntry. Contains information like HttpStatusCode and SslStatus

Asynchronously gets the current Zoom Level.

Registers and loads a ResourceHandler that represents the HTML content.

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.

Registers and loads a ResourceHandler that represents the HTML content.

Creates a new instance of IRequest with the specified Url and Method = POST and then calls LoadRequest(IRequest).

Execute Paste on the focused frame.

Opens a Print Dialog which if used (can be user cancelled) will print the browser contents.

Asynchronously prints the current browser contents to the PDF file specified. The caller is responsible for deleting the file when done.

Execute Redo on the focused frame.

Registers a Javascript object in this specific browser instance.

Register a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of DefaultResourceHandlerFactory.

Reloads the page being displayed. This method will use data from the browser's cache, if available.

Reloads the page being displayed, optionally ignoring the cache (which means the whole page including all .css, .js etc. resources will be re-fetched).

If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word.

Execute SelectAll on the focused frame.

Send a mouse wheel event to the browser.

An IWebBrowser extension method that sets the HasParent property used when passing a ChromiumWebBrowser instance to OnBeforePopup(IWebBrowser, IBrowser, IFrame, String, String, WindowOpenDisposition, Boolean, IPopupFeatures, IWindowInfo, IBrowserSettings, Boolean, IWebBrowser)

Set the Document Content for the Main Frame using DevTools Protocol.

Change the ZoomLevel to the specified value. Can be set to 0.0 to clear the zoom level.

Open developer tools in its own window.

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)

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)

Download the file at url using IDownloadHandler.

Stops loading the current page.

Cancel all searches that are currently going on.

Execute Undo on the focused frame.

Unregister a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of DefaultResourceHandlerFactory.

Opens up a new program window (using the default text editor) where the source code of the currently displayed web page is shown.