Click or drag to resize

WebBrowserExtensions Methods

Version 130.1.90

The WebBrowserExtensions type exposes the following members.

Methods
 NameDescription
Public Extension MethodAddWordToDictionary(IBrowser, String) Add the specified word to the spelling dictionary.
Public Extension MethodAddWordToDictionary(IChromiumWebBrowserBase, String) Add the specified word to the spelling dictionary.
Public Extension MethodBack(IBrowser) Navigates back, must check CanGoBack before calling this method.
Public Extension MethodBack(IChromiumWebBrowserBase) Navigates back, must check CanGoBack before calling this method.
Public Extension MethodCloseDevTools(IBrowser) Explicitly close the developer tools window if one exists for this browser instance.
Public Extension MethodCloseDevTools(IChromiumWebBrowserBase) Explicitly close the developer tools window if one exists for this browser instance.
Public Extension MethodCopy(IBrowser) Execute Copy on the focused frame.
Public Extension MethodCopy(IChromiumWebBrowserBase) Execute Copy on the focused frame.
Public Extension MethodCut(IBrowser) Execute Cut on the focused frame.
Public Extension MethodCut(IChromiumWebBrowserBase) Execute Cut on the focused frame.
Public Extension MethodDelete(IBrowser) Execute Delete on the focused frame.
Public Extension MethodDelete(IChromiumWebBrowserBase) Execute Delete on the focused frame.
Public Extension MethodDisposeDevToolsContext Dispose of the DevToolsContext (if any). Used in conjunction with CefSharp.Dom
Public Extension MethodEvaluateScriptAsPromiseAsync(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.
Public Extension MethodEvaluateScriptAsPromiseAsync(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.
Public Extension MethodEvaluateScriptAsPromiseAsync(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.
Public Extension MethodEvaluateScriptAsync(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)
Public Extension MethodEvaluateScriptAsync(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
Public Extension MethodEvaluateScriptAsync(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).
Public Extension MethodEvaluateScriptAsync(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
Public Extension MethodExecuteScriptAsync(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.
Public Extension MethodExecuteScriptAsync(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.
Public Extension MethodExecuteScriptAsync(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)
Public Extension MethodExecuteScriptAsync(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)
Public Extension MethodExecuteScriptAsyncWhenPageLoaded 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.
Public Extension MethodFind(IBrowser, String, Boolean, Boolean, Boolean) Search for text within the current page.
Public Extension MethodFind(IChromiumWebBrowserBase, String, Boolean, Boolean, Boolean) Search for text within the current page.
Public Extension MethodForward(IBrowser) Navigates forward, must check CanGoForward before calling this method.
Public Extension MethodForward(IChromiumWebBrowserBase) Navigates forward, must check CanGoForward before calling this method.
Public Extension MethodFreeDevToolsContext Set the DevToolsContext property to null. Used in conjunction with CefSharp.Dom
Public Extension MethodGetBrowserHost Shortcut method to get the browser IBrowserHost.
Public Extension MethodGetCookieManager Gets the default cookie manager associated with the IChromiumWebBrowserBase instance.
Public Extension MethodGetFocusedFrame Returns the focused frame for the browser window.
Public Extension MethodGetMainFrame Returns the main (top-level) frame for the browser window.
Public Extension MethodGetRequestContext Gets the RequestContext associated with the IChromiumWebBrowserBase instance.
Public methodStatic memberGetScriptForJavascriptMethodWithArgs Transforms the methodName and arguments into valid Javascript code. Will encapsulate params in single quotes (unless int, uint, etc)
Public Extension MethodGetSourceAsync(IBrowser) Retrieve the main frame's HTML source using a TaskTResult.
Public Extension MethodGetSourceAsync(IChromiumWebBrowserBase) Retrieve the main frame's HTML source using a TaskTResult.
Public Extension MethodGetTextAsync(IBrowser) Retrieve the main frame's display text using a TaskTResult.
Public Extension MethodGetTextAsync(IChromiumWebBrowserBase) Retrieve the main frame's display text using a TaskTResult.
Public Extension MethodGetZoomLevelAsync(IBrowser) Asynchronously gets the current Zoom Level.
Public Extension MethodGetZoomLevelAsync(IChromiumWebBrowserBase) Asynchronously gets the current Zoom Level.
Public Extension MethodLoadHtml(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.
Public Extension MethodLoadHtml(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.
Public Extension MethodLoadHtml(IWebBrowser, String, String) Registers and loads a ResourceHandler that represents the HTML content.
Public Extension MethodLoadHtml(IWebBrowser, String, String, Encoding, Boolean) Registers and loads a ResourceHandler that represents the HTML content.
Public methodStatic memberLoadUrlAsync See LoadUrlAsync(String) for details
Public Extension MethodLoadUrlWithPostData(IBrowser, String, Byte, String) Creates a new instance of IRequest with the specified Url and Method = POST and then calls LoadRequest(IRequest).
Public Extension MethodLoadUrlWithPostData(IChromiumWebBrowserBase, String, Byte, String) Creates a new instance of IRequest with the specified Url and Method = POST and then calls LoadRequest(IRequest).
Public Extension MethodPaste(IBrowser) Execute Paste on the focused frame.
Public Extension MethodPaste(IChromiumWebBrowserBase) Execute Paste on the focused frame.
Public Extension MethodPrint(IBrowser) Opens a Print Dialog which if used (can be user cancelled) will print the browser contents.
Public Extension MethodPrint(IChromiumWebBrowserBase) Opens a Print Dialog which if used (can be user cancelled) will print the browser contents.
Public Extension MethodPrintToPdfAsync(IBrowser, String, PdfPrintSettings) Asynchronously prints the current browser contents to the PDF file specified. The caller is responsible for deleting the file when done.
Public Extension MethodPrintToPdfAsync(IChromiumWebBrowserBase, String, PdfPrintSettings) Asynchronously prints the current browser contents to the PDF file specified. The caller is responsible for deleting the file when done.
Public Extension MethodRedo(IBrowser) Execute Redo on the focused frame.
Public Extension MethodRedo(IChromiumWebBrowserBase) Execute Redo on the focused frame.
Public Extension MethodRegisterAsyncJsObjectObsolete.

Asynchronously registers a Javascript object in this specific browser instance.

Only methods of the object will be availabe.

Public Extension MethodRegisterJsObjectObsolete.
Registers a Javascript object in this specific browser instance.
Public Extension MethodRegisterResourceHandler Register a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of DefaultResourceHandlerFactory.
Public Extension MethodReload(IChromiumWebBrowserBase) Reloads the page being displayed. This method will use data from the browser's cache, if available.
Public Extension MethodReload(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).
Public Extension MethodReload(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).
Public Extension MethodReplaceMisspelling(IBrowser, String) If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word.
Public Extension MethodReplaceMisspelling(IChromiumWebBrowserBase, String) If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word.
Public Extension MethodSelectAll(IBrowser) Execute SelectAll on the focused frame.
Public Extension MethodSelectAll(IChromiumWebBrowserBase) Execute SelectAll on the focused frame.
Public Extension MethodSendMouseClickEvent Send a mouse click event to the browser.
Public Extension MethodSendMouseMoveEvent Send a mouse move event to the browser.
Public Extension MethodSendMouseWheelEvent(IBrowser, Int32, Int32, Int32, Int32, CefEventFlags) Send a mouse wheel event to the browser.
Public Extension MethodSendMouseWheelEvent(IBrowserHost, Int32, Int32, Int32, Int32, CefEventFlags) Send a mouse wheel event to the browser.
Public Extension MethodSendMouseWheelEvent(IChromiumWebBrowserBase, Int32, Int32, Int32, Int32, CefEventFlags) Send a mouse wheel event to the browser.
Public Extension MethodSetAsPopup 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)
Public Extension MethodSetZoomLevel(IBrowser, Double) Change the ZoomLevel to the specified value. Can be set to 0.0 to clear the zoom level.
Public Extension MethodSetZoomLevel(IChromiumWebBrowserBase, Double) Change the ZoomLevel to the specified value. Can be set to 0.0 to clear the zoom level.
Public Extension MethodShowDevTools(IBrowser, IWindowInfo, Int32, Int32) Open developer tools in its own window.
Public Extension MethodShowDevTools(IChromiumWebBrowserBase, IWindowInfo, Int32, Int32) Open developer tools in its own window.
Public Extension MethodStartDownload(IBrowser, String) Download the file at url using IDownloadHandler.
Public Extension MethodStartDownload(IChromiumWebBrowserBase, String) Download the file at url using IDownloadHandler.
Public Extension MethodStop(IBrowser) Stops loading the current page.
Public Extension MethodStop(IChromiumWebBrowserBase) Stops loading the current page.
Public Extension MethodStopFinding(IBrowser, Boolean) Cancel all searches that are currently going on.
Public Extension MethodStopFinding(IChromiumWebBrowserBase, Boolean) Cancel all searches that are currently going on.
Public methodStatic memberThrowExceptionIfBrowserHostNull Throw exception if browser host null.
Public methodStatic memberThrowExceptionIfBrowserNull An IBrowser extension method that throw exception if browser null.
Public methodStatic memberThrowExceptionIfCanExecuteJavascriptInMainFrameFalse Throw exception if can execute javascript in main frame false.
Public methodStatic memberThrowExceptionIfChromiumWebBrowserDisposed 
Public methodStatic memberThrowExceptionIfFrameNull Throw exception if frame null.
Public Extension MethodUndo(IBrowser) Execute Undo on the focused frame.
Public Extension MethodUndo(IChromiumWebBrowserBase) Execute Undo on the focused frame.
Public Extension MethodUnRegisterResourceHandler Unregister a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of DefaultResourceHandlerFactory.
Public Extension MethodViewSource(IBrowser) Opens up a new program window (using the default text editor) where the source code of the currently displayed web page is shown.
Public Extension MethodViewSource(IChromiumWebBrowserBase) Opens up a new program window (using the default text editor) where the source code of the currently displayed web page is shown.
Public methodStatic memberCode exampleWaitForNavigationAsync 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.
Public Extension MethodCode exampleWaitForSelectorAsync 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.
Top
See Also