WebBrowserExtensions Class |
WebBrowser extensions - These methods make performing common tasks easier.
Inheritance HierarchyNamespace: CefSharp
Assembly: CefSharp (in CefSharp.dll) Version: 91.1.160.0 (91.1.160.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, NullableTimeSpan, 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(IWebBrowser, String) |
Add the specified word to the spelling dictionary.
|
| Back |
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(IWebBrowser) |
Explicitly close the developer tools window if one exists for this browser instance.
|
| Copy |
Execute Copy on the focused frame.
|
| Cut |
Execute Cut on the focused frame.
|
| Delete |
Execute Delete on the focused frame.
|
| EvaluateScriptAsPromiseAsync(IFrame, String, NullableTimeSpan) |
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. 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 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. 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(IWebBrowser, 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(IWebBrowser, NullableTimeSpan, String, Object) |
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).
|
| EvaluateScriptAsync(IWebBrowser, 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
|
| ExecuteScriptAsync(IWebBrowser, String) |
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.
|
| ExecuteScriptAsync(IWebBrowser, String, Object) |
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)
|
| ExecuteScriptAsyncWhenPageLoaded |
Execute Javascript code in the context of this WebBrowser. 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, Int32, String, Boolean, Boolean, Boolean) |
Search for text within the current page.
|
| Find(IWebBrowser, Int32, String, Boolean, Boolean, Boolean) |
Search for text within the current page.
|
| Forward |
Navigates forward, must check CanGoForward before calling this method.
|
| GetBrowserHost |
Shortcut method to get the browser IBrowserHost.
|
| GetCookieManager |
Gets the default cookie manager associated with the IWebBrowser.
|
| GetFocusedFrame |
Returns the focused frame for the browser window.
|
| GetMainFrame |
Returns the main (top-level) frame for the browser window.
|
| GetScriptForJavascriptMethodWithArgs |
Transforms the methodName and arguments into valid Javascript code. Will encapsulate params in single quotes (unless int,
uint, etc)
|
| GetSourceAsync |
Retrieve the main frame's HTML source using a TaskTResult.
|
| GetTextAsync |
Retrieve the main frame's display text using a TaskTResult.
|
| GetZoomLevelAsync(IBrowser) |
Asynchronously gets the current Zoom Level.
|
| GetZoomLevelAsync(IWebBrowser) |
Asynchronously gets the current Zoom Level.
|
| 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, 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, SynchronizationContext) for details
|
| LoadUrlWithPostData |
Creates a new instance of IRequest with the specified Url and Method = POST and then calls
LoadRequest(IRequest).
LoadRequest(IRequest) can only be used if a renderer process already exists.
In newer versions initially loading about:blank no longer creates a renderer process. You can load a Data Uri initially then
call this method. https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs.
|
| Paste |
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(IWebBrowser) |
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(IWebBrowser, String, PdfPrintSettings) |
Asynchronously prints the current browser contents to the PDF file specified. The caller is responsible for deleting the file
when done.
|
| Redo |
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(IWebBrowser) |
Reloads the page being displayed. This method will use data from the browser's cache, if available.
|
| Reload(IWebBrowser, 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(IWebBrowser, String) |
If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word.
|
| SelectAll |
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(IWebBrowser, 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(IWebBrowser, 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(IWebBrowser, IWindowInfo, Int32, Int32) |
Open developer tools in its own window.
|
| StartDownload |
Download the file at url using IDownloadHandler.
|
| Stop |
Stops loading the current page.
|
| StopFinding(IBrowser, Boolean) |
Cancel all searches that are currently going on.
|
| StopFinding(IWebBrowser, Boolean) |
Cancel all searches that are currently going on.
|
| Undo |
Execute Undo on the focused frame.
|
| UnRegisterResourceHandler |
Unregister a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of
DefaultResourceHandlerFactory.
|
| ViewSource |
Opens up a new program window (using the default text editor) where the source code of the currently displayed web page is
shown.
|
See Also