// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.

using System ;

using System . Collections . Specialized ;

using System . ComponentModel ;

using System . Globalization ;

using System . IO ;

using System . Text ;

using System . Threading . Tasks ;

using CefSharp . Internals ;

using CefSharp . Web ;

namespace CefSharp

/// <summary>

/// WebBrowser extensions - These methods make performing common tasks easier.

/// </summary>

public static class WebBrowserExtensions

public const string BrowserNullExceptionString = "IBrowser instance is null. Browser has likely not finished initializing or is in the process of disposing." ;

public const string BrowserHostNullExceptionString = "IBrowserHost instance is null. Browser has likely not finished initializing or is in the process of disposing." ;

public const string FrameNullExceptionString = "IFrame instance is null. Browser has likely not finished initializing or is in the process of disposing." ;

# region Legacy Javascript Binding

/// <summary>

/// Registers a Javascript object in this specific browser instance.

/// </summary>

/// <param name="webBrowser">The browser to perform the registering on.</param>

/// <param name="name">The name of the object. (e.g. "foo", if you want the object to be accessible as window.foo).</param>

/// <param name="objectToBind">The object to be made accessible to Javascript.</param>

/// <param name="options">(Optional) binding options - camelCaseJavascriptNames default to true.</param>

/// <exception cref="Exception">Browser is already initialized. RegisterJsObject must be +

/// called before the underlying CEF browser is created.</exception>

[ Obsolete ( "This method has been removed, see https://github.com/cefsharp/CefSharp/issues/2990 for details on migrating your code." ) ]

[ EditorBrowsable ( EditorBrowsableState . Never ) ]

public static void RegisterJsObject ( this IWebBrowser webBrowser , string name , object objectToBind , BindingOptions options = null )

throw new NotImplementedException ( "This method has been removed, see https://github.com/cefsharp/CefSharp/issues/2990 for details on migrating your code." ) ;

/// <summary>

/// <para>Asynchronously registers a Javascript object in this specific browser instance.</para>

/// <para>Only methods of the object will be availabe.</para>

/// </summary>

/// <param name="webBrowser">The browser to perform the registering on</param>

/// <param name="name">The name of the object. (e.g. "foo", if you want the object to be accessible as window.foo).</param>

/// <param name="objectToBind">The object to be made accessible to Javascript.</param>

/// <param name="options">binding options - camelCaseJavascriptNames default to true </param>

/// <exception cref="Exception">Browser is already initialized. RegisterJsObject must be +

/// called before the underlying CEF browser is created.</exception>

/// <remarks>The registered methods can only be called in an async way, they will all return immediately and the resulting

/// object will be a standard javascript Promise object which is usable to wait for completion or failure.</remarks>

[ Obsolete ( "This method has been removed, see https://github.com/cefsharp/CefSharp/issues/2990 for details on migrating your code." ) ]

[ EditorBrowsable ( EditorBrowsableState . Never ) ]

public static void RegisterAsyncJsObject ( this IWebBrowser webBrowser , string name , object objectToBind , BindingOptions options = null )

throw new NotImplementedException ( "This method has been removed, see https://github.com/cefsharp/CefSharp/issues/2990 for details on migrating your code." ) ;

# endregion

/// <summary>

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

/// </summary>

/// <param name="browser">the ChromiumWebBrowser instance.</param>

/// <returns> the main frame. </returns>

public static IFrame GetMainFrame ( this IChromiumWebBrowserBase browser )

var cefBrowser = browser . BrowserCore ;

cefBrowser . ThrowExceptionIfBrowserNull ( ) ;

return cefBrowser . MainFrame ;

/// <summary>

/// Returns the focused frame for the browser window.

/// </summary>

/// <param name="browser">the ChromiumWebBrowser instance.</param>

/// <returns>the focused frame.</returns>

public static IFrame GetFocusedFrame ( this IChromiumWebBrowserBase browser )

var cefBrowser = browser . BrowserCore ;

cefBrowser . ThrowExceptionIfBrowserNull ( ) ;

return cefBrowser . FocusedFrame ;

/// <summary>

/// Execute Undo on the focused frame.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

public static void Undo ( this IChromiumWebBrowserBase browser )

browser . BrowserCore . Undo ( ) ;

/// <summary>

/// Execute Undo on the focused frame.

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

public static void Undo ( this IBrowser browser )

browser . ThrowExceptionIfBrowserNull ( ) ;

using ( var frame = browser . FocusedFrame )

ThrowExceptionIfFrameNull ( frame ) ;

frame . Undo ( ) ;

/// <summary>

/// Execute Redo on the focused frame.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

public static void Redo ( this IChromiumWebBrowserBase browser )

browser . BrowserCore . Redo ( ) ;

/// <summary>

/// Execute Redo on the focused frame.

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

public static void Redo ( this IBrowser browser )

browser . ThrowExceptionIfBrowserNull ( ) ;

using ( var frame = browser . FocusedFrame )

ThrowExceptionIfFrameNull ( frame ) ;

frame . Redo ( ) ;

/// <summary>

/// Execute Cut on the focused frame.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

public static void Cut ( this IChromiumWebBrowserBase browser )

browser . BrowserCore . Cut ( ) ;

/// <summary>

/// Execute Cut on the focused frame.

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

public static void Cut ( this IBrowser browser )

browser . ThrowExceptionIfBrowserNull ( ) ;

using ( var frame = browser . FocusedFrame )

ThrowExceptionIfFrameNull ( frame ) ;

frame . Cut ( ) ;

/// <summary>

/// Execute Copy on the focused frame.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

public static void Copy ( this IChromiumWebBrowserBase browser )

browser . BrowserCore . Copy ( ) ;

/// <summary>

/// Execute Copy on the focused frame.

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

public static void Copy ( this IBrowser browser )

browser . ThrowExceptionIfBrowserNull ( ) ;

using ( var frame = browser . FocusedFrame )

ThrowExceptionIfFrameNull ( frame ) ;

frame . Copy ( ) ;

/// <summary>

/// Execute Paste on the focused frame.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

public static void Paste ( this IChromiumWebBrowserBase browser )

browser . BrowserCore . Paste ( ) ;

/// <summary>

/// Execute Paste on the focused frame.

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

public static void Paste ( this IBrowser browser )

browser . ThrowExceptionIfBrowserNull ( ) ;

using ( var frame = browser . FocusedFrame )

ThrowExceptionIfFrameNull ( frame ) ;

frame . Paste ( ) ;

/// <summary>

/// Execute Delete on the focused frame.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

public static void Delete ( this IChromiumWebBrowserBase browser )

browser . BrowserCore . Delete ( ) ;

/// <summary>

/// Execute Delete on the focused frame.

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

public static void Delete ( this IBrowser browser )

browser . ThrowExceptionIfBrowserNull ( ) ;

using ( var frame = browser . FocusedFrame )

ThrowExceptionIfFrameNull ( frame ) ;

frame . Delete ( ) ;

/// <summary>

/// Execute SelectAll on the focused frame.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

public static void SelectAll ( this IChromiumWebBrowserBase browser )

browser . BrowserCore . SelectAll ( ) ;

/// <summary>

/// Execute SelectAll on the focused frame.

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

public static void SelectAll ( this IBrowser browser )

browser . ThrowExceptionIfBrowserNull ( ) ;

using ( var frame = browser . FocusedFrame )

ThrowExceptionIfFrameNull ( frame ) ;

frame . SelectAll ( ) ;

/// <summary>

/// Opens up a new program window (using the default text editor) where the source code of the currently displayed web page is

/// shown.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

public static void ViewSource ( this IChromiumWebBrowserBase browser )

browser . BrowserCore . ViewSource ( ) ;

/// <summary>

/// Opens up a new program window (using the default text editor) where the source code of the currently displayed web page is

/// shown.

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

public static void ViewSource ( this IBrowser browser )

browser . ThrowExceptionIfBrowserNull ( ) ;

using ( var frame = browser . MainFrame )

ThrowExceptionIfFrameNull ( frame ) ;

frame . ViewSource ( ) ;

/// <summary>

/// Retrieve the main frame's HTML source using a <see cref="Task{String}"/>.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <returns>

/// <see cref="Task{String}"/> that when executed returns the main frame source as a string.

/// </returns>

public static Task < string > GetSourceAsync ( this IChromiumWebBrowserBase browser )

return browser . BrowserCore . GetSourceAsync ( ) ;

/// <summary>

/// Retrieve the main frame's HTML source using a <see cref="Task{String}"/>.

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

/// <returns>

/// <see cref="Task{String}"/> that when executed returns the main frame source as a string.

/// </returns>

public static Task < string > GetSourceAsync ( this IBrowser browser )

browser . ThrowExceptionIfBrowserNull ( ) ;

using ( var frame = browser . FocusedFrame )

ThrowExceptionIfFrameNull ( frame ) ;

return frame . GetSourceAsync ( ) ;

/// <summary>

/// Retrieve the main frame's display text using a <see cref="Task{String}"/>.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <returns>

/// <see cref="Task{String}"/> that when executed returns the main frame display text as a string.

/// </returns>

public static Task < string > GetTextAsync ( this IChromiumWebBrowserBase browser )

return browser . BrowserCore . GetTextAsync ( ) ;

/// <summary>

/// Retrieve the main frame's display text using a <see cref="Task{String}"/>.

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

/// <returns>

/// <see cref="Task{String}"/> that when executed returns the main frame display text as a string.

/// </returns>

public static Task < string > GetTextAsync ( this IBrowser browser )

browser . ThrowExceptionIfBrowserNull ( ) ;

using ( var frame = browser . FocusedFrame )

ThrowExceptionIfFrameNull ( frame ) ;

return frame . GetTextAsync ( ) ;

/// <summary>

/// Download the file at url using <see cref="IDownloadHandler"/>.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="url">url to download</param>

public static void StartDownload ( this IChromiumWebBrowserBase browser , string url )

browser . BrowserCore . StartDownload ( url ) ;

/// <summary>

/// Download the file at url using <see cref="IDownloadHandler"/>.

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

/// <param name="url">url to download</param>

public static void StartDownload ( this IBrowser browser , string url )

browser . ThrowExceptionIfBrowserNull ( ) ;

var host = browser . GetHost ( ) ;

ThrowExceptionIfBrowserHostNull ( host ) ;

host . StartDownload ( url ) ;

/// <summary>

/// See <see cref="IChromiumWebBrowserBase.LoadUrlAsync(string)"/> for details

/// </summary>

/// <param name="chromiumWebBrowser">ChromiumWebBrowser instance (cannot be null)</param>

/// <summary>

/// Load the <paramref name="url"/> in the main frame of the browser

/// </summary>

/// <param name="url">url to load</param>

/// <returns>See <see cref="IChromiumWebBrowserBase.LoadUrlAsync(string)"/> for details</returns>

public static Task < LoadUrlAsyncResponse > LoadUrlAsync ( IChromiumWebBrowserBase chromiumWebBrowser , string url )

if ( string . IsNullOrEmpty ( url ) )

throw new ArgumentNullException ( nameof ( url ) ) ;

var tcs = new TaskCompletionSource < LoadUrlAsyncResponse > ( ) ;

EventHandler < LoadErrorEventArgs > loadErrorHandler = null ;

EventHandler < LoadingStateChangedEventArgs > loadingStateChangeHandler = null ;

loadErrorHandler = ( sender , args ) = >

//Actions that trigger a download will raise an aborted error.

//Generally speaking Aborted is safe to ignore

if ( args . ErrorCode = = CefErrorCode . Aborted )

return ;

//If LoadError was called then we'll remove both our handlers

//as we won't need to capture LoadingStateChanged, we know there

//was an error

chromiumWebBrowser . LoadError - = loadErrorHandler ;

chromiumWebBrowser . LoadingStateChanged - = loadingStateChangeHandler ;

//Ensure our continuation is executed on the ThreadPool

//For the .Net Core implementation we could use

//TaskCreationOptions.RunContinuationsAsynchronously

tcs . TrySetResultAsync ( new LoadUrlAsyncResponse ( args . ErrorCode , - 1 ) ) ;

loadingStateChangeHandler = ( sender , args ) = >

//Wait for IsLoading = false

if ( ! args . IsLoading )

//If LoadingStateChanged was called then we'll remove both our handlers

//as LoadError won't be called, our site has loaded with a valid HttpStatusCode

//HttpStatusCodes can still be for example 404, this is considered a successful request,

//the server responded, it just didn't have the page you were after.

chromiumWebBrowser . LoadError - = loadErrorHandler ;

chromiumWebBrowser . LoadingStateChanged - = loadingStateChangeHandler ;

var host = args . Browser . GetHost ( ) ;

var navEntry = host ? . GetVisibleNavigationEntry ( ) ;

int statusCode = navEntry ? . HttpStatusCode ? ? - 1 ;

//By default 0 is some sort of error, we map that to -1

//so that it's clearer that something failed.

if ( statusCode = = 0 )

statusCode = - 1 ;

//Ensure our continuation is executed on the ThreadPool

//For the .Net Core implementation we could use

//TaskCreationOptions.RunContinuationsAsynchronously

tcs . TrySetResultAsync ( new LoadUrlAsyncResponse ( CefErrorCode . None , statusCode ) ) ;

chromiumWebBrowser . LoadError + = loadErrorHandler ;

chromiumWebBrowser . LoadingStateChanged + = loadingStateChangeHandler ;

chromiumWebBrowser . LoadUrl ( url ) ;

return tcs . Task ;

/// <summary>

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

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="methodName">The javascript method name to execute.</param>

/// <param name="args">the arguments to be passed as params to the method. Args are encoded using

/// <see cref="EncodeScriptParam"/>, you can provide a custom implementation if you require one.</param>

public static void ExecuteScriptAsync ( this IChromiumWebBrowserBase browser , string methodName , params object [ ] args )

browser . BrowserCore . ExecuteScriptAsync ( methodName , args ) ;

/// <summary>

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

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

/// <param name="methodName">The javascript method name to execute.</param>

/// <param name="args">the arguments to be passed as params to the method. Args are encoded using

/// <see cref="EncodeScriptParam"/>, you can provide a custom implementation if you require one.</param>

public static void ExecuteScriptAsync ( this IBrowser browser , string methodName , params object [ ] args )

var script = GetScriptForJavascriptMethodWithArgs ( methodName , args ) ;

browser . ExecuteScriptAsync ( script ) ;

/// <summary>

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

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="script">The Javascript code that should be executed.</param>

public static void ExecuteScriptAsync ( this IChromiumWebBrowserBase browser , string script )

using ( var frame = browser . GetMainFrame ( ) )

ThrowExceptionIfFrameNull ( frame ) ;

frame . ExecuteJavaScriptAsync ( script ) ;

/// <summary>

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

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

/// <param name="script">The Javascript code that should be executed.</param>

public static void ExecuteScriptAsync ( this IBrowser browser , string script )

browser . ThrowExceptionIfBrowserNull ( ) ;

using ( var frame = browser . MainFrame )

ThrowExceptionIfFrameNull ( frame ) ;

frame . ExecuteJavaScriptAsync ( script ) ;

/// <summary>

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

/// </summary>

/// <remarks>

/// Best effort is made to make sure the script is executed, there are likely a few edge cases where the script won't be executed,

/// if you suspect your script isn't being executed, then try executing in the LoadingStateChanged event handler to confirm that

/// it does indeed get executed.

/// </remarks>

/// <param name="webBrowser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="script">The Javascript code that should be executed.</param>

/// <param name="oneTime">(Optional) The script will only be executed on first page load, subsequent page loads will be ignored.</param>

public static void ExecuteScriptAsyncWhenPageLoaded ( this IChromiumWebBrowserBase webBrowser , string script , bool oneTime = true )

var useLoadingStateChangedEventHandler = webBrowser . IsBrowserInitialized = = false | | oneTime = = false ;

//Browser has been initialized, we check if there is a valid document and we're not loading

if ( webBrowser . IsBrowserInitialized )

//CefBrowser wrapper

var browser = webBrowser . BrowserCore ;

if ( browser . HasDocument & & browser . IsLoading = = false )

webBrowser . ExecuteScriptAsync ( script ) ;

useLoadingStateChangedEventHandler = true ;

//If the browser hasn't been initialized we can just wire up the LoadingStateChanged event

//If the script has already been executed and oneTime is false will be hooked up next page load.

if ( useLoadingStateChangedEventHandler )

EventHandler < LoadingStateChangedEventArgs > handler = null ;

handler = ( sender , args ) = >

//Wait for while page to finish loading not just the first frame

if ( ! args . IsLoading )

if ( oneTime )

webBrowser . LoadingStateChanged - = handler ;

webBrowser . ExecuteScriptAsync ( script ) ;

webBrowser . LoadingStateChanged + = handler ;

/// <summary>

/// Creates a new instance of IRequest with the specified Url and Method = POST and then calls

/// <see cref="IFrame.LoadRequest(IRequest)"/>.

/// </summary>

/// <param name="browser">browser this method extends</param>

/// <param name="url">url to load</param>

/// <param name="postDataBytes">post data as byte array</param>

/// <param name="contentType">(Optional) if set the Content-Type header will be set</param>

public static void LoadUrlWithPostData ( this IChromiumWebBrowserBase browser , string url , byte [ ] postDataBytes , string contentType = null )

browser . BrowserCore . LoadUrlWithPostData ( url , postDataBytes , contentType ) ;

/// <summary>

/// Creates a new instance of IRequest with the specified Url and Method = POST and then calls

/// <see cref="IFrame.LoadRequest(IRequest)"/>.

/// </summary>

/// <param name="browser">browser this method extends</param>

/// <param name="url">url to load</param>

/// <param name="postDataBytes">post data as byte array</param>

/// <param name="contentType">(Optional) if set the Content-Type header will be set</param>

public static void LoadUrlWithPostData ( this IBrowser browser , string url , byte [ ] postDataBytes , string contentType = null )

browser . ThrowExceptionIfBrowserNull ( ) ;

using ( var frame = browser . MainFrame )

ThrowExceptionIfFrameNull ( frame ) ;

//Initialize Request with PostData

var request = frame . CreateRequest ( initializePostData : true ) ;

request . Url = url ;

request . Method = "POST" ;

//Add AllowStoredCredentials as per suggestion linked in

//https://github.com/cefsharp/CefSharp/issues/2705#issuecomment-476819788

request . Flags = UrlRequestFlags . AllowStoredCredentials ;

request . PostData . AddData ( postDataBytes ) ;

if ( ! string . IsNullOrEmpty ( contentType ) )

var headers = new NameValueCollection ( ) ;

headers . Add ( "Content-Type" , contentType ) ;

request . Headers = headers ;

frame . LoadRequest ( request ) ;

/// <summary>

/// Registers and loads a <see cref="ResourceHandler"/> that represents the HTML content.

/// </summary>

/// <remarks>

/// `Cef` Native `LoadHtml` is unpredictable and only works sometimes, this method wraps the provided HTML in a

/// <see cref="ResourceHandler"/> and loads the provided url using the <see cref="IWebBrowser.Load"/> method. Defaults to using

/// <see cref="Encoding.UTF8"/> for character encoding The url must start with a valid schema, other uri's such as about:blank

/// are invalid A valid example looks like http://test/page.

/// </remarks>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="html">The HTML content.</param>

/// <param name="url">The URL that will be treated as the address of the content.</param>

/// <returns>

/// returns false if the Url was not successfully parsed into a Uri.

/// </returns>

public static bool LoadHtml ( this IWebBrowser browser , string html , string url )

return browser . LoadHtml ( html , url , Encoding . UTF8 ) ;

/// <summary>

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

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="html">Html to load as data uri.</param>

/// <param name="base64Encode">(Optional) if true the html string will be base64 encoded using UTF8 encoding.</param>

public static void LoadHtml ( this IChromiumWebBrowserBase browser , string html , bool base64Encode = false )

var htmlString = new HtmlString ( html , base64Encode ) ;

browser . LoadUrl ( htmlString . ToDataUriString ( ) ) ;

/// <summary>

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

/// </summary>

/// <param name="frame">The <seealso cref="IFrame"/> instance this method extends.</param>

/// <param name="html">Html to load as data uri.</param>

/// <param name="base64Encode">(Optional) if true the html string will be base64 encoded using UTF8 encoding.</param>

public static void LoadHtml ( this IFrame frame , string html , bool base64Encode = false )

var htmlString = new HtmlString ( html , base64Encode ) ;

frame . LoadUrl ( htmlString . ToDataUriString ( ) ) ;

/// <summary>

/// Registers and loads a <see cref="ResourceHandler"/> that represents the HTML content.

/// </summary>

/// <remarks>

/// `Cef` Native `LoadHtml` is unpredictable and only works sometimes, this method wraps the provided HTML in a

/// <see cref="ResourceHandler"/> and loads the provided url using the <see cref="IWebBrowser.Load"/> method.

/// </remarks>

/// <exception cref="Exception">Thrown when an exception error condition occurs.</exception>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="html">The HTML content.</param>

/// <param name="url">The URL that will be treated as the address of the content.</param>

/// <param name="encoding">Character Encoding.</param>

/// <param name="oneTimeUse">(Optional) Whether or not the handler should be used once (true) or until manually unregistered

/// (false)</param>

/// <returns>

/// returns false if the Url was not successfully parsed into a Uri.

/// </returns>

public static bool LoadHtml ( this IWebBrowser browser , string html , string url , Encoding encoding , bool oneTimeUse = false )

if ( browser . ResourceRequestHandlerFactory = = null )

browser . ResourceRequestHandlerFactory = new ResourceRequestHandlerFactory ( ) ;

var handler = browser . ResourceRequestHandlerFactory as ResourceRequestHandlerFactory ;

if ( handler = = null )

throw new Exception ( "LoadHtml can only be used with the default IResourceRequestHandlerFactory(DefaultResourceRequestHandlerFactory) implementation" ) ;

if ( handler . RegisterHandler ( url , ResourceHandler . GetByteArray ( html , encoding , true ) , ResourceHandler . DefaultMimeType , oneTimeUse ) )

browser . Load ( url ) ;

return true ;

return false ;

/// <summary>

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

/// DefaultResourceHandlerFactory.

/// </summary>

/// <exception cref="Exception">Thrown when an exception error condition occurs.</exception>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="url">the url of the resource to unregister.</param>

/// <param name="stream">Stream to be registered, the stream should not be shared with any other instances of

/// DefaultResourceHandlerFactory.</param>

/// <param name="mimeType">(Optional) the mimeType.</param>

/// <param name="oneTimeUse">(Optional) Whether or not the handler should be used once (true) or until manually unregistered

/// (false). If true the Stream will be Diposed of when finished.</param>

public static void RegisterResourceHandler ( this IWebBrowser browser , string url , Stream stream , string mimeType = ResourceHandler . DefaultMimeType ,

bool oneTimeUse = false )

if ( browser . ResourceRequestHandlerFactory = = null )

browser . ResourceRequestHandlerFactory = new ResourceRequestHandlerFactory ( ) ;

var handler = browser . ResourceRequestHandlerFactory as ResourceRequestHandlerFactory ;

if ( handler = = null )

throw new Exception ( "RegisterResourceHandler can only be used with the default IResourceRequestHandlerFactory(DefaultResourceRequestHandlerFactory) implementation" ) ;

using ( var ms = new MemoryStream ( ) )

stream . CopyTo ( ms ) ;

handler . RegisterHandler ( url , ms . ToArray ( ) , mimeType , oneTimeUse ) ;

/// <summary>

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

/// DefaultResourceHandlerFactory.

/// </summary>

/// <exception cref="Exception">Thrown when an exception error condition occurs.</exception>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="url">the url of the resource to unregister.</param>

public static void UnRegisterResourceHandler ( this IWebBrowser browser , string url )

var handler = browser . ResourceRequestHandlerFactory as ResourceRequestHandlerFactory ;

if ( handler = = null )

throw new Exception ( "UnRegisterResourceHandler can only be used with the default IResourceRequestHandlerFactory(DefaultResourceRequestHandlerFactory) implementation" ) ;

handler . UnregisterHandler ( url ) ;

/// <summary>

/// Stops loading the current page.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

public static void Stop ( this IChromiumWebBrowserBase browser )

browser . BrowserCore . Stop ( ) ;

/// <summary>

/// Stops loading the current page.

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

public static void Stop ( this IBrowser browser )

browser . ThrowExceptionIfBrowserNull ( ) ;

browser . StopLoad ( ) ;

/// <summary>

/// Navigates back, must check <see cref="IChromiumWebBrowserBase.CanGoBack"/> before calling this method.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

public static void Back ( this IChromiumWebBrowserBase browser )

browser . BrowserCore . Back ( ) ;

/// <summary>

/// Navigates back, must check <see cref="IBrowser.CanGoBack"/> before calling this method.

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

public static void Back ( this IBrowser browser )

browser . ThrowExceptionIfBrowserNull ( ) ;

browser . GoBack ( ) ;

/// <summary>

/// Navigates forward, must check <see cref="IChromiumWebBrowserBase.CanGoForward"/> before calling this method.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

public static void Forward ( this IChromiumWebBrowserBase browser )

browser . BrowserCore . Forward ( ) ;

/// <summary>

/// Navigates forward, must check <see cref="IBrowser.CanGoForward"/> before calling this method.

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

public static void Forward ( this IBrowser browser )

browser . ThrowExceptionIfBrowserNull ( ) ;

browser . GoForward ( ) ;

/// <summary>

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

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

public static void Reload ( this IChromiumWebBrowserBase browser )

browser . Reload ( false ) ;

/// <summary>

/// Reloads the page being displayed, optionally ignoring the cache (which means the whole page including all .css, .js etc.

/// resources will be re-fetched).

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="ignoreCache"><c>true</c> A reload is performed ignoring browser cache; <c>false</c> A reload is performed using

/// files from the browser cache, if available.</param>

public static void Reload ( this IChromiumWebBrowserBase browser , bool ignoreCache )

browser . BrowserCore . Reload ( ignoreCache ) ;

/// <summary>

/// Reloads the page being displayed, optionally ignoring the cache (which means the whole page including all .css, .js etc.

/// resources will be re-fetched).

/// </summary>

/// <param name="browser">The IBrowser instance this method extends.</param>

/// <param name="ignoreCache"><c>true</c> A reload is performed ignoring browser cache; <c>false</c> A reload is performed using

/// files from the browser cache, if available.</param>

public static void Reload ( this IBrowser browser , bool ignoreCache = false )

browser . ThrowExceptionIfBrowserNull ( ) ;

browser . Reload ( ignoreCache ) ;

/// <summary>

/// Gets the default cookie manager associated with the <see cref="IChromiumWebBrowserBase"/> instance.

/// </summary>

/// <exception cref="Exception">Thrown when an exception error condition occurs.</exception>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="callback">(Optional) If not null it will be executed asynchronously on the CEF IO thread after the manager's

/// storage has been initialized.</param>

/// <returns>

/// Cookie Manager.

/// </returns>

public static ICookieManager GetCookieManager ( this IChromiumWebBrowserBase browser , ICompletionCallback callback = null )

var host = browser . GetBrowserHost ( ) ;

ThrowExceptionIfBrowserHostNull ( host ) ;

var requestContext = host . RequestContext ;

if ( requestContext = = null )

throw new Exception ( "RequestContext is null, unable to obtain cookie manager" ) ;

return requestContext . GetCookieManager ( callback ) ;

/// <summary>

/// Asynchronously gets the current Zoom Level.

/// </summary>

/// <param name="cefBrowser">The ChromiumWebBrowser instance this method extends.</param>

/// <returns>

/// An asynchronous result that yields the zoom level.

/// </returns>

public static Task < double > GetZoomLevelAsync ( this IBrowser cefBrowser )

var host = cefBrowser . GetHost ( ) ;

ThrowExceptionIfBrowserHostNull ( host ) ;

return host . GetZoomLevelAsync ( ) ;

/// <summary>

/// Asynchronously gets the current Zoom Level.

/// </summary>

/// <param name="browser">the ChromiumWebBrowser instance.</param>

/// <returns>

/// An asynchronous result that yields the zoom level.

/// </returns>

public static Task < double > GetZoomLevelAsync ( this IChromiumWebBrowserBase browser )

return browser . BrowserCore . GetZoomLevelAsync ( ) ;

/// <summary>

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

/// </summary>

/// <remarks>

/// If called on the CEF UI thread the change will be applied immediately. Otherwise, the change will be applied asynchronously

/// on the CEF UI thread. The CEF UI thread is different to the WPF/WinForms UI Thread.

/// </remarks>

/// <param name="cefBrowser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="zoomLevel">zoom level.</param>

public static void SetZoomLevel ( this IBrowser cefBrowser , double zoomLevel )

cefBrowser . ThrowExceptionIfBrowserNull ( ) ;

var host = cefBrowser . GetHost ( ) ;

ThrowExceptionIfBrowserHostNull ( host ) ;

host . SetZoomLevel ( zoomLevel ) ;

/// <summary>

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

/// </summary>

/// <remarks>

/// If called on the CEF UI thread the change will be applied immediately. Otherwise, the change will be applied asynchronously

/// on the CEF UI thread. The CEF UI thread is different to the WPF/WinForms UI Thread.

/// </remarks>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="zoomLevel">zoom level.</param>

public static void SetZoomLevel ( this IChromiumWebBrowserBase browser , double zoomLevel )

browser . BrowserCore . SetZoomLevel ( zoomLevel ) ;

/// <summary>

/// Search for text within the current page.

/// </summary>

/// <param name="cefBrowser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="searchText">search text.</param>

/// <param name="forward">indicates whether to search forward or backward within the page.</param>

/// <param name="matchCase">indicates whether the search should be case-sensitive.</param>

/// <param name="findNext">indicates whether this is the first request or a follow-up.</param>

public static void Find ( this IBrowser cefBrowser , string searchText , bool forward , bool matchCase , bool findNext )

var host = cefBrowser . GetHost ( ) ;

ThrowExceptionIfBrowserHostNull ( host ) ;

host . Find ( searchText , forward , matchCase , findNext ) ;

/// <summary>

/// Search for text within the current page.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="searchText">search text.</param>

/// <param name="forward">indicates whether to search forward or backward within the page.</param>

/// <param name="matchCase">indicates whether the search should be case-sensitive.</param>

/// <param name="findNext">indicates whether this is the first request or a follow-up.</param>

public static void Find ( this IChromiumWebBrowserBase browser , string searchText , bool forward , bool matchCase , bool findNext )

var cefBrowser = browser . BrowserCore ;

cefBrowser . ThrowExceptionIfBrowserNull ( ) ;

cefBrowser . Find ( searchText , forward , matchCase , findNext ) ;

/// <summary>

/// Cancel all searches that are currently going on.

/// </summary>

/// <param name="cefBrowser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="clearSelection">clear the current search selection.</param>

public static void StopFinding ( this IBrowser cefBrowser , bool clearSelection )

cefBrowser . ThrowExceptionIfBrowserNull ( ) ;

var host = cefBrowser . GetHost ( ) ;

ThrowExceptionIfBrowserHostNull ( host ) ;

host . StopFinding ( clearSelection ) ;

/// <summary>

/// Cancel all searches that are currently going on.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="clearSelection">clear the current search selection.</param>

public static void StopFinding ( this IChromiumWebBrowserBase browser , bool clearSelection )

browser . BrowserCore . StopFinding ( clearSelection ) ;

/// <summary>

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

/// </summary>

/// <param name="cefBrowser">The ChromiumWebBrowser instance this method extends.</param>

public static void Print ( this IBrowser cefBrowser )

var host = cefBrowser . GetHost ( ) ;

ThrowExceptionIfBrowserHostNull ( host ) ;

host . Print ( ) ;

/// <summary>

/// Asynchronously prints the current browser contents to the PDF file specified. The caller is responsible for deleting the file

/// when done.

/// </summary>

/// <param name="cefBrowser">The <see cref="IBrowser"/> object this method extends.</param>

/// <param name="path">Output file location.</param>

/// <param name="settings">(Optional) Print Settings.</param>

/// <returns>

/// A task that represents the asynchronous print operation. The result is true on success or false on failure to generate the

/// Pdf.

/// </returns>

public static Task < bool > PrintToPdfAsync ( this IBrowser cefBrowser , string path , PdfPrintSettings settings = null )

var host = cefBrowser . GetHost ( ) ;

ThrowExceptionIfBrowserHostNull ( host ) ;

var callback = new TaskPrintToPdfCallback ( ) ;

host . PrintToPdf ( path , settings , callback ) ;

return callback . Task ;

/// <summary>

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

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

public static void Print ( this IChromiumWebBrowserBase browser )

var cefBrowser = browser . BrowserCore ;

cefBrowser . ThrowExceptionIfBrowserNull ( ) ;

cefBrowser . Print ( ) ;

/// <summary>

/// Asynchronously prints the current browser contents to the PDF file specified. The caller is responsible for deleting the file

/// when done.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="path">Output file location.</param>

/// <param name="settings">(Optional) Print Settings.</param>

/// <returns>

/// A task that represents the asynchronous print operation. The result is true on success or false on failure to generate the

/// Pdf.

/// </returns>

public static Task < bool > PrintToPdfAsync ( this IChromiumWebBrowserBase browser , string path , PdfPrintSettings settings = null )

return browser . BrowserCore . PrintToPdfAsync ( path , settings ) ;

/// <summary>

/// Open developer tools in its own window.

/// </summary>

/// <param name="cefBrowser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="windowInfo">(Optional) window info used for showing dev tools.</param>

/// <param name="inspectElementAtX">(Optional) x coordinate (used for inspectElement)</param>

/// <param name="inspectElementAtY">(Optional) y coordinate (used for inspectElement)</param>

public static void ShowDevTools ( this IBrowser cefBrowser , IWindowInfo windowInfo = null , int inspectElementAtX = 0 , int inspectElementAtY = 0 )

var host = cefBrowser . GetHost ( ) ;

ThrowExceptionIfBrowserHostNull ( host ) ;

host . ShowDevTools ( windowInfo , inspectElementAtX , inspectElementAtY ) ;

/// <summary>

/// Open developer tools in its own window.

/// </summary>

/// <param name="browser">The ChromiumWebBrowser instance this method extends.</param>

/// <param name="windowInfo">(Optional) window info used for showing dev tools.</param>

/// <param name="inspectElementAtX">(Optional) x coordinate (used for inspectElement)</param>

/// <param name="inspectElementAtY">(Optional) y coordinate (used for inspectElement)</param>

public static void ShowDevTools ( this IChromiumWebBrowserBase browser , IWindowInfo windowInfo = null , int inspe …