ChromiumWebBrowser Class

Create a new OffScreen Chromium Browser. If you use LegacyJavascriptBindingEnabled = true then you must set automaticallyCreateBrowser to false and call CreateBrowser(IWindowInfo, BrowserSettings) after the objects are registered.

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

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

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.

Implement IFocusHandler and assign to handle events related to the browser component's focus

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

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 IResourceHandlerFactory 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

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

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Releases unmanaged and - optionally - managed resources.

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

Finalizes an instance of the ChromiumWebBrowser class.

Returns the current CEF Browser Instance

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.

Creates a shallow copy of the current Object.

Registers a Javascript object in this specific browser instance.

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.

Occurs when [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 your 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 your 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 your 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 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 your 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 your 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

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

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 some 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 some Javascript code in the context of this WebBrowser. As the method name implies, the script will be executed asynchronously, and the method therefore returns before the script has actually been executed.

Execute some Javascript code in the context of this WebBrowser. 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 WebBrowser. 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 IWebBrowser

Returns the focused frame for the browser window.

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

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

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

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.

Load the string contents with the specified dummy url. Web security restrictions may not behave as expected.

Creates a new instance of IRequest with the specified Url and Method = POST and then calls LoadRequest(IRequest). LoadRequest(IRequest) can only be used if a renderer process already exists. In newer versions initially loading about:blank no longer creates a renderer process. You can load a Data Uri initially then call this method. https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs

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

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

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.

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.