Click or drag to resize

ChromiumWebBrowser Methods

Version 86.0.240

The ChromiumWebBrowser type exposes the following members.

Methods
  NameDescription
Public methodCreateBrowser
Create the underlying browser. The instance address, browser settings and request context will be used.
Public methodDispose
Releases all resources used by the ChromiumWebBrowser object
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources for the ChromiumWebBrowser
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Finalizes an instance of the ChromiumWebBrowser class.
(Overrides ObjectFinalize.)
Public methodGetBrowser
Returns the current CEF Browser Instance
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetScreenInfo
Gets the screen information (scale factor).
Protected methodGetScreenPoint
Called to retrieve the translation from view coordinates to actual screen coordinates.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodGetViewRect
Gets the view rect (width, height)
Public methodLoad
Loads the specified URL.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodScreenshotAsync
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.
Public methodScreenshotOrNull
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.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodAddWordToDictionary
Add the specified word to the spelling dictionary.
(Defined by WebBrowserExtensions.)
Public Extension MethodBack
Navigates back, must check CanGoBack before calling this method.
(Defined by WebBrowserExtensions.)
Public Extension MethodCloseDevTools
Explicitly close the developer tools window if one exists for this browser instance.
(Defined by WebBrowserExtensions.)
Public Extension MethodCopy
Execute Copy on the focused frame.
(Defined by WebBrowserExtensions.)
Public Extension MethodCut
Execute Cut on the focused frame.
(Defined by WebBrowserExtensions.)
Public Extension MethodDelete
Execute Delete on the focused frame.
(Defined by WebBrowserExtensions.)
Public Extension MethodCode exampleDestroyWindow
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.)
Public Extension MethodEnsureObjectBoundAsync
Make sure an object is bound in javascript. Executes against the main frame
(Defined by JavascriptBindingExtensions.)
Public Extension MethodEvaluateScriptAsPromiseAsync
Evaluate some Javascript code 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.
(Defined by WebBrowserExtensions.)
Public Extension MethodEvaluateScriptAsync(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.)
Public Extension MethodEvaluateScriptAsync(String, NullableTimeSpan, Boolean)Overloaded.
Evaluate some Javascript code 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
(Defined by WebBrowserExtensions.)
Public Extension MethodEvaluateScriptAsync(NullableTimeSpan, String, Object)Overloaded.
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).
(Defined by WebBrowserExtensions.)
Public Extension MethodExecuteDevToolsMethodAsync
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.)
Public Extension MethodExecuteScriptAsync(String)Overloaded.
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.
(Defined by WebBrowserExtensions.)
Public Extension MethodExecuteScriptAsync(String, Object)Overloaded.
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)
(Defined by WebBrowserExtensions.)
Public Extension MethodExecuteScriptAsyncWhenPageLoaded
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.
(Defined by WebBrowserExtensions.)
Public Extension MethodFind
Search for text within the current page.
(Defined by WebBrowserExtensions.)
Public Extension MethodForward
Navigates forward, must check CanGoForward before calling this method.
(Defined by WebBrowserExtensions.)
Public Extension MethodGetBrowserHost
Shortcut method to get the browser IBrowserHost.
(Defined by WebBrowserExtensions.)
Public Extension MethodGetCookieManager
Gets the default cookie manager associated with the IWebBrowser.
(Defined by WebBrowserExtensions.)
Public Extension MethodGetDevToolsClient
Gets a new Instance of the DevTools client for the chromiumWebBrowser instance.
(Defined by DevToolsExtensions.)
Public Extension MethodGetFocusedFrame
Returns the focused frame for the browser window.
(Defined by WebBrowserExtensions.)
Public Extension MethodGetMainFrame
Returns the main (top-level) frame for the browser window.
(Defined by WebBrowserExtensions.)
Public Extension MethodGetSourceAsync (Defined by WebBrowserExtensions.)
Public Extension MethodGetTextAsync (Defined by WebBrowserExtensions.)
Public Extension MethodGetZoomLevelAsync
Asynchronously gets the current Zoom Level.
(Defined by WebBrowserExtensions.)
Public Extension MethodLoadHtml(String, String)Overloaded.
Registers and loads a ResourceHandler that represents the HTML content.
(Defined by WebBrowserExtensions.)
Public Extension MethodLoadHtml(String, Boolean)Overloaded.
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.)
Public Extension MethodLoadHtml(String, String, Encoding, Boolean)Overloaded.
Registers and loads a ResourceHandler that represents the HTML content.
(Defined by WebBrowserExtensions.)
Public Extension MethodLoadUrlWithPostData
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.
(Defined by WebBrowserExtensions.)
Public Extension MethodPaste
Execute Paste on the focused frame.
(Defined by WebBrowserExtensions.)
Public Extension MethodPrint
Opens a Print Dialog which if used (can be user cancelled) will print the browser contents.
(Defined by WebBrowserExtensions.)
Public Extension MethodPrintToPdfAsync
Asynchronously prints the current browser contents to the PDF file specified. The caller is responsible for deleting the file when done.
(Defined by WebBrowserExtensions.)
Public Extension MethodRedo
Execute Redo on the focused frame.
(Defined by WebBrowserExtensions.)
Public Extension MethodRegisterAsyncJsObject

Asynchronously registers a Javascript object in this specific browser instance.

Only methods of the object will be availabe.

(Defined by WebBrowserExtensions.)
Public Extension MethodRegisterJsObject
Registers a Javascript object in this specific browser instance.
(Defined by WebBrowserExtensions.)
Public Extension MethodRegisterResourceHandler
Register a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of DefaultResourceHandlerFactory.
(Defined by WebBrowserExtensions.)
Public Extension MethodReloadOverloaded.
Reloads the page being displayed. This method will use data from the browser's cache, if available.
(Defined by WebBrowserExtensions.)
Public Extension MethodReload(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.)
Public Extension MethodReplaceMisspelling
If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word.
(Defined by WebBrowserExtensions.)
Public Extension MethodSelectAll
Execute SelectAll on the focused frame.
(Defined by WebBrowserExtensions.)
Public Extension MethodSendMouseWheelEvent
Send a mouse wheel event to the browser.
(Defined by WebBrowserExtensions.)
Public Extension MethodSetAsPopup (Defined by WebBrowserExtensions.)
Public Extension MethodSetZoomLevel
Change the ZoomLevel to the specified value. Can be set to 0.0 to clear the zoom level.
(Defined by WebBrowserExtensions.)
Public Extension MethodShowDevTools
Open developer tools in its own window.
(Defined by WebBrowserExtensions.)
Public Extension MethodStop
Stops loading the current page.
(Defined by WebBrowserExtensions.)
Public Extension MethodStopFinding
Cancel all searches that are currently going on.
(Defined by WebBrowserExtensions.)
Public Extension MethodUndo
Execute Undo on the focused frame.
(Defined by WebBrowserExtensions.)
Public Extension MethodUnRegisterResourceHandler
Unregister a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of DefaultResourceHandlerFactory.
(Defined by WebBrowserExtensions.)
Public Extension MethodViewSource
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.)
Top
See Also