IWebBrowser Interface (original) (raw)

Name

Description

Public Extension Method

AddWordToDictionary

Add the specified word to the spelling dictionary.

(Defined by WebBrowserExtensions.)

Public Extension Method

Back

Navigates back, must check CanGoBack before calling this method.

(Defined by WebBrowserExtensions.)

Public Extension Method

CloseDevTools

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

(Defined by WebBrowserExtensions.)

Public Extension Method

Copy

Execute Copy on the focused frame.

(Defined by WebBrowserExtensions.)

Public Extension Method

Cut

Execute Cut on the focused frame.

(Defined by WebBrowserExtensions.)

Public Extension Method

Delete

Execute Delete on the focused frame.

(Defined by WebBrowserExtensions.)

Public Extension MethodCode example

DestroyWindow

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 Method

EnsureObjectBoundAsync

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

(Defined by JavascriptBindingExtensions.)

Public Extension Method

EvaluateScriptAsPromiseAsync

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.

(Defined by WebBrowserExtensions.)

Public Extension Method

EvaluateScriptAsync(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 Method

EvaluateScriptAsync(NullableTimeSpan, String, Object)

Overloaded.

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

(Defined by WebBrowserExtensions.)

Public Extension Method

EvaluateScriptAsync(String, NullableTimeSpan, Boolean)

Overloaded.

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

(Defined by WebBrowserExtensions.)

Public Extension Method

EvaluateScriptAsyncT(String, NullableTimeSpan)

Overloaded.

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

(Defined by WebBrowserExtensionsEx.)

Public Extension Method

ExecuteDevToolsMethodAsync

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 Method

ExecuteScriptAsync(String)

Overloaded.

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.

(Defined by WebBrowserExtensions.)

Public Extension Method

ExecuteScriptAsync(String, Object)

Overloaded.

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)

(Defined by WebBrowserExtensions.)

Public Extension Method

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.

(Defined by WebBrowserExtensions.)

Public Extension Method

Find

Search for text within the current page.

(Defined by WebBrowserExtensions.)

Public Extension Method

Forward

Navigates forward, must check CanGoForward before calling this method.

(Defined by WebBrowserExtensions.)

Public Extension Method

GetBrowserHost

Shortcut method to get the browser IBrowserHost.

(Defined by WebBrowserExtensions.)

Public Extension Method

GetCookieManager

(Defined by WebBrowserExtensions.)

Public Extension Method

GetDevToolsClient

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

(Defined by DevToolsExtensions.)

Public Extension Method

GetFocusedFrame

Returns the focused frame for the browser window.

(Defined by WebBrowserExtensions.)

Public Extension Method

GetMainFrame

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

(Defined by WebBrowserExtensions.)

Public Extension Method

GetRequestContext

(Defined by WebBrowserExtensions.)

Public Extension Method

GetSourceAsync

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

(Defined by WebBrowserExtensions.)

Public Extension Method

GetTextAsync

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

(Defined by WebBrowserExtensions.)

Public Extension Method

GetVisibleNavigationEntryAsync

(Defined by WebBrowserExtensionsEx.)

Public Extension Method

GetZoomLevelAsync

Asynchronously gets the current Zoom Level.

(Defined by WebBrowserExtensions.)

Public Extension Method

LoadHtml(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 Method

LoadHtml(String, String)

Overloaded.

Registers and loads a ResourceHandler that represents the HTML content.

(Defined by WebBrowserExtensions.)

Public Extension Method

LoadHtml(String, String, Encoding, Boolean)

Overloaded.

Registers and loads a ResourceHandler that represents the HTML content.

(Defined by WebBrowserExtensions.)

Public Extension Method

LoadUrlWithPostData

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

(Defined by WebBrowserExtensions.)

Public Extension Method

Paste

Execute Paste on the focused frame.

(Defined by WebBrowserExtensions.)

Public Extension Method

Print

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

(Defined by WebBrowserExtensions.)

Public Extension Method

PrintToPdfAsync

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 Method

Redo

Execute Redo on the focused frame.

(Defined by WebBrowserExtensions.)

Public Extension Method

RegisterAsyncJsObject

Asynchronously registers a Javascript object in this specific browser instance.

Only methods of the object will be availabe.

(Defined by WebBrowserExtensions.)

Public Extension Method

RegisterJsObject

Registers a Javascript object in this specific browser instance.

(Defined by WebBrowserExtensions.)

Public Extension Method

RegisterResourceHandler

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

(Defined by WebBrowserExtensions.)

Public Extension Method

Reload

Overloaded.

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

(Defined by WebBrowserExtensions.)

Public Extension Method

Reload(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 Method

ReplaceMisspelling

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 Method

SelectAll

Execute SelectAll on the focused frame.

(Defined by WebBrowserExtensions.)

Public Extension Method

SendMouseWheelEvent

Send a mouse wheel event to the browser.

(Defined by WebBrowserExtensions.)

Public Extension Method

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)

(Defined by WebBrowserExtensions.)

Public Extension Method

SetMainFrameDocumentContentAsync

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

(Defined by DevToolsExtensions.)

Public Extension Method

SetZoomLevel

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

(Defined by WebBrowserExtensions.)

Public Extension Method

ShowDevTools

Open developer tools in its own window.

(Defined by WebBrowserExtensions.)

Public Extension Method

ShowDevToolsDocked(ActionChromiumHostControl, String, DockStyle, Int32, Int32)

Overloaded.

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)

(Defined by WebBrowserExtensions.)

Public Extension Method

ShowDevToolsDocked(Control, String, DockStyle, Int32, Int32)

Overloaded.

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)

(Defined by WebBrowserExtensions.)

Public Extension Method

StartDownload

(Defined by WebBrowserExtensions.)

Public Extension Method

Stop

Stops loading the current page.

(Defined by WebBrowserExtensions.)

Public Extension Method

StopFinding

Cancel all searches that are currently going on.

(Defined by WebBrowserExtensions.)

Public Extension Method

ToggleAudioMute

Toggles audio mute for the current browser. If the browser is null or has been disposed then this command will be a no-op.

(Defined by WebBrowserExtensionsEx.)

Public Extension Method

Undo

Execute Undo on the focused frame.

(Defined by WebBrowserExtensions.)

Public Extension Method

UnRegisterResourceHandler

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

(Defined by WebBrowserExtensions.)

Public Extension Method

ViewSource

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

Public Extension MethodCode example

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.

(Defined by WebBrowserExtensions.)