Click or drag to resize

WebBrowserExtensionsEvaluateScriptAsPromiseAsync Method (IFrame, String, NullableTimeSpan, String)

Version 108.4.130
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.

Namespace:  CefSharp
Assembly:  CefSharp (in CefSharp.dll) Version: 108.4.130.0 (108.4.130.0)
Syntax
public static Task<JavascriptResponse> EvaluateScriptAsPromiseAsync(
	this IFrame frame,
	string script,
	TimeSpan? timeout = null,
	string javascriptBindingApiGlobalObjectName = null
)

Parameters

frame
Type: CefSharpIFrame
The instance this method extends.
script
Type: SystemString
The Javascript code that should be executed.
timeout (Optional)
Type: SystemNullableTimeSpan
(Optional) The timeout after which the Javascript code execution should be aborted.
javascriptBindingApiGlobalObjectName (Optional)
Type: SystemString
Only required if a custom value was specified for JavascriptBindingApiGlobalObjectName then this param must match that value. Otherwise exclude passing a value for this param or pass in null.

Return Value

Type: TaskJavascriptResponse
TaskTResult that can be awaited to perform the script execution.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IFrame. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionThrown when one or more arguments are outside the required range.
See Also