Click or drag to resize

IBrowser Interface

Version 130.1.90
CefSharp interface for CefBrowser.

Namespace: CefSharp
Assembly: CefSharp (in CefSharp.dll) Version: 129.0.110.0 (129.0.110.0)
Syntax
public interface IBrowser : IDisposable

The IBrowser type exposes the following members.

Properties
 NameDescription
Public propertyCanGoBack Returns true if the browser can navigate backwards.
Public propertyCanGoForward Returns true if the browser can navigate forwards.
Public propertyFocusedFrame Returns the focused frame for the browser window or null.
Public propertyHasDocument Returns true if a document has been loaded in the browser.
Public propertyIdentifier Returns the globally unique identifier for this browser.
Public propertyIsDisposed Gets a value indicating whether the browser has been disposed of.
Public propertyIsLoading Returns true if the browser is currently loading.
Public propertyIsPopup Returns true if the window is a popup window.
Public propertyIsValid Returns True if this object is currently valid. This will return false after OnBeforeClose(IWebBrowser, IBrowser) is called.
Public propertyMainFrame Returns the main (top-level) frame for the browser window. Returns null if there is currently no MainFrame.
Top
Methods
 NameDescription
Public methodCloseBrowser Request that the browser close. The JavaScript 'onbeforeunload' event will be fired.
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
Public methodGetAllFrames Gets a collection of all the current frames.
Public methodGetFrameByIdentifier Returns the frame with the specified identifier, or NULL if not found.
Public methodGetFrameByName Returns the frame with the specified name, or NULL if not found.
Public methodGetFrameCount Returns the number of frames that currently exist.
Public methodGetFrameIdentifiers Returns the identifiers of all existing frames.
Public methodGetFrameNames Returns the names of all existing frames.
Public methodGetHost Returns the browser host object. This method can only be called in the browser process.
Public methodGoBack Navigate backwards.
Public methodGoForward Navigate forwards.
Public methodIsSame Returns true if this object is pointing to the same handle as that object.
Public methodReload Reload the current page.
Public methodStopLoad Stop loading the page.
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 MethodEvaluateScriptAsPromiseAsync 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.
(Defined by WebBrowserExtensions)
Public Extension MethodEvaluateScriptAsync 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 MethodEvaluateScriptAsyncT 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 WebBrowserExtensionsEx)
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 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.
(Defined by WebBrowserExtensions)
Public Extension MethodExecuteScriptAsync 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)
(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 MethodGetDevToolsClient Gets a new Instance of the DevTools client
(Defined by DevToolsExtensions)
Public Extension MethodGetSourceAsync Retrieve the main frame's HTML source using a TaskTResult.
(Defined by WebBrowserExtensions)
Public Extension MethodGetTextAsync Retrieve the main frame's display text using a TaskTResult.
(Defined by WebBrowserExtensions)
Public Extension MethodGetZoomLevelAsync Asynchronously gets the current Zoom Level.
(Defined by WebBrowserExtensions)
Public Extension MethodLoadUrlWithPostData Creates a new instance of IRequest with the specified Url and Method = POST and then calls LoadRequest(IRequest).
(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 MethodReload 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 MethodSetMainFrameDocumentContentAsync Set the Document Content for the Main Frame using DevTools Protocol.
(Defined by DevToolsExtensions)
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 MethodStartDownload Download the file at url using IDownloadHandler.
(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 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