Web |
WebBrowser extensions - These methods make performing common tasks easier.
Inheritance HierarchyNamespace: CefSharp
Assembly: CefSharp (in CefSharp.dll) Version: 129.0.110.0 (129.0.110.0)
SyntaxThe WebBrowserExtensions type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | EncodeScriptParam | Function used to encode the params passed to [!:ExecuteScriptAsync(IWebBrowser, string, object[])], [!:EvaluateScriptAsync(IWebBrowser, string, object[])] and [!:EvaluateScriptAsync(IWebBrowser, TimeSpan?, string, object[])] Provide your own custom function to perform custom encoding. You can use your choice of JSON encoder here if you should so choose. |
Methods| Name | Description | |
|---|---|---|
 | AddWordToDictionary(IBrowser, String) | Add the specified word to the spelling dictionary. |
| AddWordToDictionary(IChromiumWebBrowserBase, String) | Add the specified word to the spelling dictionary. |
| Back(IBrowser) | Navigates back, must check CanGoBack before calling this method. |
| Back(IChromiumWebBrowserBase) | Navigates back, must check CanGoBack before calling this method. |
| CloseDevTools(IBrowser) | Explicitly close the developer tools window if one exists for this browser instance. |
| CloseDevTools(IChromiumWebBrowserBase) | Explicitly close the developer tools window if one exists for this browser instance. |
| Copy(IBrowser) | Execute Copy on the focused frame. |
| Copy(IChromiumWebBrowserBase) | Execute Copy on the focused frame. |
| Cut(IBrowser) | Execute Cut on the focused frame. |
| Cut(IChromiumWebBrowserBase) | Execute Cut on the focused frame. |
| Delete(IBrowser) | Execute Delete on the focused frame. |
| Delete(IChromiumWebBrowserBase) | Execute Delete on the focused frame. |
| DisposeDevToolsContext | Dispose of the DevToolsContext (if any). Used in conjunction with CefSharp.Dom |
| EvaluateScriptAsPromiseAsync(IBrowser, String, NullableTimeSpan) | 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. 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. |
| EvaluateScriptAsPromiseAsync(IWebBrowser, String, NullableTimeSpan) | 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. |
| EvaluateScriptAsPromiseAsync(IFrame, String, NullableTimeSpan, String) | 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. 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. |
| EvaluateScriptAsync(IChromiumWebBrowserBase, String, Object) | 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) |
| EvaluateScriptAsync(IBrowser, String, NullableTimeSpan, Boolean) | 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 |
| EvaluateScriptAsync(IChromiumWebBrowserBase, NullableTimeSpan, String, Object) | 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). |
| EvaluateScriptAsync(IChromiumWebBrowserBase, String, NullableTimeSpan, Boolean) | 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 |
| ExecuteScriptAsync(IBrowser, String) | Execute Javascript in the context of this Browser 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. |
| ExecuteScriptAsync(IChromiumWebBrowserBase, String) | 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. |
| ExecuteScriptAsync(IBrowser, String, Object) | Execute 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) |
| ExecuteScriptAsync(IChromiumWebBrowserBase, String, Object) | 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) |
| 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. |
| Find(IBrowser, String, Boolean, Boolean, Boolean) | Search for text within the current page. |
| Find(IChromiumWebBrowserBase, String, Boolean, Boolean, Boolean) | Search for text within the current page. |
| Forward(IBrowser) | Navigates forward, must check CanGoForward before calling this method. |
| Forward(IChromiumWebBrowserBase) | Navigates forward, must check CanGoForward before calling this method. |
| FreeDevToolsContext | Set the DevToolsContext property to null. Used in conjunction with CefSharp.Dom |
| GetBrowserHost | Shortcut method to get the browser IBrowserHost. |
| GetCookieManager | Gets the default cookie manager associated with the IChromiumWebBrowserBase instance. |
| GetFocusedFrame | Returns the focused frame for the browser window. |
| GetMainFrame | Returns the main (top-level) frame for the browser window. |
| GetRequestContext | Gets the RequestContext associated with the IChromiumWebBrowserBase instance. |
 | GetScriptForJavascriptMethodWithArgs | Transforms the methodName and arguments into valid Javascript code. Will encapsulate params in single quotes (unless int, uint, etc) |
| GetSourceAsync(IBrowser) | Retrieve the main frame's HTML source using a TaskTResult. |
| GetSourceAsync(IChromiumWebBrowserBase) | Retrieve the main frame's HTML source using a TaskTResult. |
| GetTextAsync(IBrowser) | Retrieve the main frame's display text using a TaskTResult. |
| GetTextAsync(IChromiumWebBrowserBase) | Retrieve the main frame's display text using a TaskTResult. |
| GetZoomLevelAsync(IBrowser) | Asynchronously gets the current Zoom Level. |
| GetZoomLevelAsync(IChromiumWebBrowserBase) | Asynchronously gets the current Zoom Level. |
| LoadHtml(IChromiumWebBrowserBase, String, Boolean) | 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. |
| LoadHtml(IFrame, String, Boolean) | 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. |
| LoadHtml(IWebBrowser, String, String) | Registers and loads a ResourceHandler that represents the HTML content. |
| LoadHtml(IWebBrowser, String, String, Encoding, Boolean) | Registers and loads a ResourceHandler that represents the HTML content. |
| LoadUrlAsync | See LoadUrlAsync(String) for details |
| LoadUrlWithPostData(IBrowser, String, Byte, String) | Creates a new instance of IRequest with the specified Url and Method = POST and then calls LoadRequest(IRequest). |
| LoadUrlWithPostData(IChromiumWebBrowserBase, String, Byte, String) | Creates a new instance of IRequest with the specified Url and Method = POST and then calls LoadRequest(IRequest). |
| Paste(IBrowser) | Execute Paste on the focused frame. |
| Paste(IChromiumWebBrowserBase) | Execute Paste on the focused frame. |
| Print(IBrowser) | Opens a Print Dialog which if used (can be user cancelled) will print the browser contents. |
| Print(IChromiumWebBrowserBase) | Opens a Print Dialog which if used (can be user cancelled) will print the browser contents. |
| PrintToPdfAsync(IBrowser, String, PdfPrintSettings) | Asynchronously prints the current browser contents to the PDF file specified. The caller is responsible for deleting the file when done. |
| PrintToPdfAsync(IChromiumWebBrowserBase, String, PdfPrintSettings) | Asynchronously prints the current browser contents to the PDF file specified. The caller is responsible for deleting the file when done. |
| Redo(IBrowser) | Execute Redo on the focused frame. |
| Redo(IChromiumWebBrowserBase) | Execute Redo on the focused frame. |
| RegisterAsyncJsObject | Obsolete. Asynchronously registers a Javascript object in this specific browser instance. Only methods of the object will be availabe. |
| RegisterJsObject | Obsolete. Registers a Javascript object in this specific browser instance. |
| RegisterResourceHandler | Register a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of DefaultResourceHandlerFactory. |
| Reload(IChromiumWebBrowserBase) | Reloads the page being displayed. This method will use data from the browser's cache, if available. |
| Reload(IBrowser, Boolean) | Reloads the page being displayed, optionally ignoring the cache (which means the whole page including all .css, .js etc. resources will be re-fetched). |
| Reload(IChromiumWebBrowserBase, Boolean) | Reloads the page being displayed, optionally ignoring the cache (which means the whole page including all .css, .js etc. resources will be re-fetched). |
| ReplaceMisspelling(IBrowser, String) | If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word. |
| ReplaceMisspelling(IChromiumWebBrowserBase, String) | If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word. |
| SelectAll(IBrowser) | Execute SelectAll on the focused frame. |
| SelectAll(IChromiumWebBrowserBase) | Execute SelectAll on the focused frame. |
| SendMouseClickEvent | Send a mouse click event to the browser. |
| SendMouseMoveEvent | Send a mouse move event to the browser. |
| SendMouseWheelEvent(IBrowser, Int32, Int32, Int32, Int32, CefEventFlags) | Send a mouse wheel event to the browser. |
| SendMouseWheelEvent(IBrowserHost, Int32, Int32, Int32, Int32, CefEventFlags) | Send a mouse wheel event to the browser. |
| SendMouseWheelEvent(IChromiumWebBrowserBase, Int32, Int32, Int32, Int32, CefEventFlags) | Send a mouse wheel event to the browser. |
| SetAsPopup | 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) |
| SetZoomLevel(IBrowser, Double) | Change the ZoomLevel to the specified value. Can be set to 0.0 to clear the zoom level. |
| SetZoomLevel(IChromiumWebBrowserBase, Double) | Change the ZoomLevel to the specified value. Can be set to 0.0 to clear the zoom level. |
| ShowDevTools(IBrowser, IWindowInfo, Int32, Int32) | Open developer tools in its own window. |
| ShowDevTools(IChromiumWebBrowserBase, IWindowInfo, Int32, Int32) | Open developer tools in its own window. |
| StartDownload(IBrowser, String) | Download the file at url using IDownloadHandler. |
| StartDownload(IChromiumWebBrowserBase, String) | Download the file at url using IDownloadHandler. |
| Stop(IBrowser) | Stops loading the current page. |
| Stop(IChromiumWebBrowserBase) | Stops loading the current page. |
| StopFinding(IBrowser, Boolean) | Cancel all searches that are currently going on. |
| StopFinding(IChromiumWebBrowserBase, Boolean) | Cancel all searches that are currently going on. |
| ThrowExceptionIfBrowserHostNull | Throw exception if browser host null. |
| ThrowExceptionIfBrowserNull | An IBrowser extension method that throw exception if browser null. |
| ThrowExceptionIfCanExecuteJavascriptInMainFrameFalse | Throw exception if can execute javascript in main frame false. |
| ThrowExceptionIfChromiumWebBrowserDisposed | |
| ThrowExceptionIfFrameNull | Throw exception if frame null. |
| Undo(IBrowser) | Execute Undo on the focused frame. |
| Undo(IChromiumWebBrowserBase) | Execute Undo on the focused frame. |
| UnRegisterResourceHandler | Unregister a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of DefaultResourceHandlerFactory. |
| ViewSource(IBrowser) | Opens up a new program window (using the default text editor) where the source code of the currently displayed web page is shown. |
| ViewSource(IChromiumWebBrowserBase) | Opens up a new program window (using the default text editor) where the source code of the currently displayed web page is shown. |
 | 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. |
| WaitForSelectorAsync | Waits for a DOM element specified by the selector string to be added to or removed from the DOM. A simplified version of Puppeteer WaitForSelector. Uses a MutationObserver to wait for the element to become added or removed. |
Fields| Name | Description | |
|---|---|---|
 | BrowserHostNullExceptionString | |
| BrowserNullExceptionString | |
| FrameNullExceptionString |
See Also