Click or drag to resize
IWinFormsWebBrowser Interface
Version 57.0.0
WinForms specific implementation, has events the ChromiumWebBrowser implementation exposes.

Namespace: CefSharp.WinForms
Assembly: CefSharp.WinForms (in CefSharp.WinForms.dll) Version: 57.0.0.0 (57.0.0.0)
Syntax
public interface IWinFormsWebBrowser : IWebBrowser, 
	IDisposable

The IWinFormsWebBrowser type exposes the following members.

Properties
  NameDescription
Public propertyAddress
The address (URL) which the browser control is currently displaying. Will automatically be updated as the user navigates to another page (e.g. by clicking on a link).
(Inherited from IWebBrowser.)
Public propertyCanExecuteJavascriptInMainFrame
A flag that indicates if you can execute javascript in the main frame. Flag is set to true in IRenderProcessMessageHandler.OnContextCreated. and false in IRenderProcessMessageHandler.OnContextReleased
(Inherited from IWebBrowser.)
Public propertyCanGoBack
A flag that indicates whether the state of the control current supports the GoBack action (true) or not (false).
(Inherited from IWebBrowser.)
Public propertyCanGoForward
A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false).
(Inherited from IWebBrowser.)
Public propertyDialogHandler
Implement IDialogHandler and assign to handle dialog events.
(Inherited from IWebBrowser.)
Public propertyDisplayHandler
Implement IDisplayHandler and assign to handle events related to browser display state.
(Inherited from IWebBrowser.)
Public propertyDownloadHandler
Implement IDownloadHandler and assign to handle events related to downloading files.
(Inherited from IWebBrowser.)
Public propertyDragHandler
Implement IDragHandler and assign to handle events related to dragging.
(Inherited from IWebBrowser.)
Public propertyFindHandler
Implement IFindHandler to handle events related to find results.
(Inherited from IWebBrowser.)
Public propertyFocusHandler
Implement IFocusHandler and assign to handle events related to the browser component's focus
(Inherited from IWebBrowser.)
Public propertyGeolocationHandler
Implement IGeolocationHandler and assign to handle requests for permission to use geolocation.
(Inherited from IWebBrowser.)
Public propertyIsBrowserInitialized
A flag that indicates whether the WebBrowser is initialized (true) or not (false).
(Inherited from IWebBrowser.)
Public propertyIsLoading
A flag that indicates whether the control is currently loading one or more web pages (true) or not (false).
(Inherited from IWebBrowser.)
Public propertyJsDialogHandler
Implement IJsDialogHandler and assign to handle events related to JavaScript Dialogs.
(Inherited from IWebBrowser.)
Public propertyKeyboardHandler
Implement IKeyboardHandler and assign to handle events related to key press.
(Inherited from IWebBrowser.)
Public propertyLifeSpanHandler
Implement ILifeSpanHandler and assign to handle events related to popups.
(Inherited from IWebBrowser.)
Public propertyLoadHandler
Implement ILoadHandler and assign to handle events related to browser load status.
(Inherited from IWebBrowser.)
Public propertyMenuHandler
Implement IContextMenuHandler and assign to handle events related to the browser context menu
(Inherited from IWebBrowser.)
Public propertyRenderProcessMessageHandler
Implement IRenderProcessMessageHandler and assign to handle messages from the render process.
(Inherited from IWebBrowser.)
Public propertyRequestHandler
Implement IRequestHandler and assign to handle events related to browser requests.
(Inherited from IWebBrowser.)
Public propertyResourceHandlerFactory
Implement IResourceHandlerFactory and control the loading of resources
(Inherited from IWebBrowser.)
Public propertyTooltipText
The text that will be displayed as a ToolTip
(Inherited from IWebBrowser.)
Top
Methods
  NameDescription
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodFocus
Attempts to give focus to the IWebBrowser control.
(Inherited from IWebBrowser.)
Public methodGetBrowser
Returns the current CEF Browser Instance
(Inherited from IWebBrowser.)
Public methodLoad
Loads the specified URL.
(Inherited from IWebBrowser.)
Public methodRegisterAsyncJsObject

Asynchronously registers a Javascript object in this specific browser instance.

Only methods of the object will be available.

(Inherited from IWebBrowser.)
Public methodRegisterJsObject
Registers a Javascript object in this specific browser instance.
(Inherited from IWebBrowser.)
Top
Events
  NameDescription
Public eventAddressChanged
Occurs when the browser address changed. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
Public eventConsoleMessage
Event handler for receiving Javascript console messages being sent from web pages. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread. (The exception to this is when your running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
(Inherited from IWebBrowser.)
Public eventFrameLoadEnd
Event handler that will get called when the browser is done loading a frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This method will always be called for all frames irrespective of whether the request completes successfully. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
(Inherited from IWebBrowser.)
Public eventFrameLoadStart
Event handler that will get called when the browser begins loading a frame. Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended. This method may not be called for a particular frame if the load request for that frame fails. For notification of overall browser load status use OnLoadingStateChange instead. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
(Inherited from IWebBrowser.)
Public eventLoadError
Event handler that will get called when the resource load for a navigation fails or is canceled. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
(Inherited from IWebBrowser.)
Public eventLoadingStateChanged
Event handler that will get called when the Loading state has changed. This event will be fired twice. Once when loading is initiated either programmatically or by user action, and once when loading is terminated due to completion, cancellation of failure. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
(Inherited from IWebBrowser.)
Public eventStatusMessage
Event handler for changes to the status message. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread. (The exception to this is when your running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
(Inherited from IWebBrowser.)
Public eventTitleChanged
Occurs when the browser title changed. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
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 MethodEvaluateScriptAsync(String, NullableTimeSpan)Overloaded. (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(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 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 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 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)Overloaded.
Registers and loads a ResourceHandler that represents the HTML content.
(Defined by WebBrowserExtensions.)
Public Extension MethodLoadString
Load the string contents with the specified dummy url. Web security restrictions may not behave as expected.
(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 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 (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 MethodThrowExceptionIfBrowserNotInitialized (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