Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use PageExposeBindingOptions class of Microsoft.Playwright package

Best Playwright-dotnet code snippet using Microsoft.Playwright.PageExposeBindingOptions

IPage.cs

Source:IPage.cs

...744        /// <remarks><para>Functions installed via <see cref="IPage.ExposeBindingAsync"/> survive navigations.</para></remarks>745        /// <param name="name">Name of the function on the window object.</param>746        /// <param name="callback">Callback function that will be called in the Playwright's context.</param>747        /// <param name="options">Call options</param>748        Task ExposeBindingAsync(string name, Action callback, PageExposeBindingOptions? options = default);749        /// <summary>750        /// <para>751        /// The method adds a function called <paramref name="name"/> on the <c>window</c> object752        /// of every frame in the page. When called, the function executes <paramref name="callback"/>753        /// and returns a <see cref="Task"/> which resolves to the return value of <paramref754        /// name="callback"/>.755        /// </para>756        /// <para>If the <paramref name="callback"/> returns a <see cref="Task"/>, it will be awaited.</para>757        /// <para>See <see cref="IBrowserContext.ExposeFunctionAsync"/> for context-wide exposed function.</para>758        /// <para>An example of adding a <c>sha256</c> function to the page:</para>759        /// <code>760        /// using Microsoft.Playwright;<br/>761        /// using System;<br/>762        /// using System.Security.Cryptography;<br/>...

PageSynchronous.cs

Source:PageSynchronous.cs

...1589    /// <remarks><para>Functions installed via <see cref="IPage.ExposeBindingAsync"/> survive navigations.</para></remarks>1590    /// <param name="name">Name of the function on the window object.</param>1591    /// <param name="callback">Callback function that will be called in the Playwright's context.</param>1592    /// <param name="options">Call options</param>1593    public static IPage ExposeBinding(this IPage page, string name, Action callback, PageExposeBindingOptions? options = null)1594    {1595        page.ExposeBindingAsync(name, callback, options).GetAwaiter().GetResult();1596        return page;1597    }1598    /// <summary>1599    /// <para>1600    /// The method adds a function called <paramref name="name"/> on the <c>window</c> object1601    /// of every frame in the page. When called, the function executes <paramref name="callback"/>1602    /// and returns a <see cref="Task"/> which resolves to the return value of <paramref1603    /// name="callback"/>.1604    /// </para>1605    /// <para>If the <paramref name="callback"/> returns a <see cref="Task"/>, it will be awaited.</para>1606    /// <para>See <see cref="IBrowserContext.ExposeFunctionAsync"/> for context-wide exposed function.</para>1607    /// <para>An example of adding a <c>sha256</c> function to the page:</para>...

Page.cs

Source:Page.cs

...533        public async Task<IResponse> GoForwardAsync(PageGoForwardOptions options = default)534            => (await _channel.GoForwardAsync(options?.Timeout, options?.WaitUntil).ConfigureAwait(false))?.Object;535        public async Task<IResponse> ReloadAsync(PageReloadOptions options = default)536            => (await _channel.ReloadAsync(options?.Timeout, options?.WaitUntil).ConfigureAwait(false))?.Object;537        public Task ExposeBindingAsync(string name, Action callback, PageExposeBindingOptions options = default)538            => InnerExposeBindingAsync(name, (Delegate)callback, options?.Handle ?? false);539        public Task ExposeBindingAsync(string name, Action<BindingSource> callback)540            => InnerExposeBindingAsync(name, (Delegate)callback);541        public Task ExposeBindingAsync<T>(string name, Action<BindingSource, T> callback)542            => InnerExposeBindingAsync(name, (Delegate)callback);543        public Task ExposeBindingAsync<TResult>(string name, Func<BindingSource, TResult> callback)544            => InnerExposeBindingAsync(name, (Delegate)callback);545        public Task ExposeBindingAsync<TResult>(string name, Func<BindingSource, IJSHandle, TResult> callback)546            => InnerExposeBindingAsync(name, (Delegate)callback, true);547        public Task ExposeBindingAsync<T, TResult>(string name, Func<BindingSource, T, TResult> callback)548            => InnerExposeBindingAsync(name, (Delegate)callback);549        public Task ExposeBindingAsync<T1, T2, TResult>(string name, Func<BindingSource, T1, T2, TResult> callback)550            => InnerExposeBindingAsync(name, (Delegate)callback);551        public Task ExposeBindingAsync<T1, T2, T3, TResult>(string name, Func<BindingSource, T1, T2, T3, TResult> callback)...

PageModel.cs

Source:PageModel.cs

...314    protected virtual void ExposeBinding(string name, Action<BindingSource> callback)315    {316        this.Page.ExposeBinding(name, callback);317    }318    protected virtual void ExposeBinding(string name, Action callback, PageExposeBindingOptions? options = null)319    {320        this.Page.ExposeBinding(name, callback, options);321    }322    protected virtual void ExposeBinding<T>(string name, Action<BindingSource, T> callback)323    {324        this.Page.ExposeBinding<T>(name, callback);325    }326    protected virtual void ExposeBinding<TResult>(string name, Func<BindingSource, TResult> callback)327    {328        this.Page.ExposeBinding<TResult>(name, callback);329    }330    protected virtual void ExposeBinding<TResult>(string name, Func<BindingSource, IJSHandle, TResult> callback)331    {332        this.Page.ExposeBinding<TResult>(name, callback);...

PageExposeBindingOptions.cs

Source:PageExposeBindingOptions.cs

...35using System.Threading.Tasks;36#nullable enable37namespace Microsoft.Playwright38{39    public class PageExposeBindingOptions40    {41        public PageExposeBindingOptions() { }42        public PageExposeBindingOptions(PageExposeBindingOptions clone)43        {44            if (clone == null)45            {46                return;47            }48            Handle = clone.Handle;49        }50        /// <summary>51        /// <para>52        /// Whether to pass the argument as a handle, instead of passing by value. When passing53        /// a handle, only one argument is supported. When passing by value, multiple arguments54        /// are supported.55        /// </para>56        /// </summary>...

PageExposeBindingOptions

Using AI Code Generation

1using Microsoft.Playwright;2using System;3using System.Threading.Tasks;4{5    static async Task Main(string[] args)6    {7        using var playwright = await Playwright.CreateAsync();8        var browser = await playwright.Firefox.LaunchAsync(headless: false);9        var context = await browser.NewContextAsync();10        var page = await context.NewPageAsync();11        await page.ExposeBindingAsync("myFunction", (BindingSource source, object arg) =>12        {13            Console.WriteLine("myFunction called");14            return Task.CompletedTask;15        });16        await page.EvalOnSelectorAsync("body", "myFunction()");17        await page.WaitForTimeoutAsync(10000);18        await browser.CloseAsync();19    }20}21using Microsoft.Playwright;22using System;23using System.Threading.Tasks;24{25    static async Task Main(string[] args)26    {27        using var playwright = await Playwright.CreateAsync();28        var browser = await playwright.Firefox.LaunchAsync(headless: false);29        var context = await browser.NewContextAsync();30        var page = await context.NewPageAsync();31        await page.ExposeBindingAsync("myFunction", (BindingSource source, object arg) =>32        {33            Console.WriteLine("myFunction called");34            return Task.CompletedTask;35        });36        await page.EvalOnSelectorAsync("body", "myFunction()");37        await page.WaitForTimeoutAsync(10000);38        await browser.CloseAsync();39    }40}41using Microsoft.Playwright;42using System;43using System.Threading.Tasks;44{45    static async Task Main(string[] args)46    {47        using var playwright = await Playwright.CreateAsync();48        var browser = await playwright.Firefox.LaunchAsync(headless: false);49        var context = await browser.NewContextAsync();50        var page = await context.NewPageAsync();51        await page.ExposeBindingAsync("myFunction", (BindingSource source, object arg) =>52        {53            Console.WriteLine("myFunction called");54            return Task.CompletedTask;55        });

PageExposeBindingOptions

Using AI Code Generation

1using Microsoft.Playwright;2using System;3using System.Collections.Generic;4using System.Linq;5using System.Threading.Tasks;6{7    {8        static async Task Main(string[] args)9        {10            await using var playwright = await Playwright.CreateAsync();11            await using var browser = await playwright.Chromium.LaunchAsync(new BrowserTypeLaunchOptions12            {13            });14            var context = await browser.NewContextAsync(new BrowserNewContextOptions15            {16                UserAgent = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.149 Safari/537.36",17                {18                },19            });20            var page = await context.NewPageAsync();21            await page.ExposeBindingAsync("test", (BindingSource bindingSource, object[] args) =>22            {23                Console.WriteLine("test binding invoked");24                return Task.CompletedTask;25            });26            await page.ExposeBindingAsync("test2", (BindingSource bindingSource, object[] args) =>27            {28                Console.WriteLine("test2 binding invoked");29                return Task.CompletedTask;30            });31            await page.ExposeBindingAsync("test3", (BindingSource bindingSource, object[] args) =>32            {33                Console.WriteLine("test3 binding invoked");34                return Task.CompletedTask;35            });36            await page.ExposeBindingAsync("test4", (BindingSource bindingSource, object[] args) =>37            {38                Console.WriteLine("test4 binding invoked");39                return Task.CompletedTask;40            });41            await page.ExposeBindingAsync("test5", (BindingSource bindingSource, object[] args) =>42            {43                Console.WriteLine("test5 binding invoked");44                return Task.CompletedTask;45            });46            await page.ExposeBindingAsync("test6", (BindingSource bindingSource, object[] args) =>47            {48                Console.WriteLine("test6 binding invoked");49                return Task.CompletedTask;50            });51            await page.ExposeBindingAsync("test7", (BindingSource bindingSource, object[]

PageExposeBindingOptions

Using AI Code Generation

1using Microsoft.Playwright;2using System.Threading.Tasks;3using System;4using System.Threading;5{6    static async Task Main(string[] args)7    {8        using var playwright = await Playwright.CreateAsync();9        var browser = await playwright.Chromium.LaunchAsync(new LaunchOptions { Headless = false });10        var page = await browser.NewPageAsync();11        await page.ExposeBindingAsync("myBinding", (BindingSource source, string arg1) => {12            Console.WriteLine("myBinding called with " + arg1);13            return Task.FromResult<object>(null);14        });15        await page.EvaluateAsync("() => myBinding('hello')");16        await page.CloseAsync();17        await browser.CloseAsync();18    }19}20using Microsoft.Playwright;21using System.Threading.Tasks;22using System;23using System.Threading;24{25    static async Task Main(string[] args)26    {27        using var playwright = await Playwright.CreateAsync();28        var browser = await playwright.Chromium.LaunchAsync(new LaunchOptions { Headless = false });29        var page = await browser.NewPageAsync();30        await page.ExposeBindingAsync("myBinding", (BindingSource source, string arg1) => {31            Console.WriteLine("myBinding called with " + arg1);32            return Task.FromResult<object>(null);33        }, new PageExposeBindingOptions { Handle = true });34        await page.EvaluateAsync("() => myBinding('hello')");35        await page.CloseAsync();36        await browser.CloseAsync();37    }38}39using Microsoft.Playwright;40using System.Threading.Tasks;41using System;42using System.Threading;43{44    static async Task Main(string[] args)45    {46        using var playwright = await Playwright.CreateAsync();47        var browser = await playwright.Chromium.LaunchAsync(new LaunchOptions { Headless = false });48        var page = await browser.NewPageAsync();49        await page.ExposeBindingAsync("myBinding", (BindingSource source, string arg1) => {50            Console.WriteLine("myBinding called with " + arg1);

PageExposeBindingOptions

Using AI Code Generation

1using Microsoft.Playwright;2using System.Threading.Tasks;3{4    {5        static async Task Main(string[] args)6        {7            using var playwright = await Playwright.CreateAsync();8            await using var browser = await playwright.Chromium.LaunchAsync(new BrowserTypeLaunchOptions9            {10            });11            var page = await browser.NewPageAsync();12            await page.ExposeBindingAsync("add", (BindingSource source, int a, int b) =>13            {14                return Task.FromResult(a + b);15            }, new PageExposeBindingOptions16            {17            });18            var result = await page.EvaluateAsync<int>("async () => add(5, 6)");19        }20    }21}

PageExposeBindingOptions

Using AI Code Generation

1using Microsoft.Playwright;2await PageExposeBindingOptions pageExposeBindingOptions = new PageExposeBindingOptions();3pageExposeBindingOptions.Handle = (IJSHandle arg) =>4{5    return arg.As<string>() + "World";6};7await page.ExposeBindingAsync("myFunction", pageExposeBindingOptions);8await page.EvaluateAsync("() => myFunction('Hello')");9using Microsoft.Playwright;10await PageExposeBindingOptions pageExposeBindingOptions = new PageExposeBindingOptions();11pageExposeBindingOptions.Handle = (IJSHandle arg) =>12{13    return arg.As<string>() + "World";14};15await page.ExposeBindingAsync("myFunction", pageExposeBindingOptions);16await page.EvaluateAsync("() => myFunction('Hello')");17using Microsoft.Playwright;18await PageExposeBindingOptions pageExposeBindingOptions = new PageExposeBindingOptions();19pageExposeBindingOptions.Handle = (IJSHandle arg) =>20{21    return arg.As<string>() + "World";22};23await page.ExposeBindingAsync("myFunction", pageExposeBindingOptions);24await page.EvaluateAsync("() => myFunction('Hello')");25using Microsoft.Playwright;26await PageExposeBindingOptions pageExposeBindingOptions = new PageExposeBindingOptions();27pageExposeBindingOptions.Handle = (IJSHandle arg) =>28{29    return arg.As<string>() + "World";30};31await page.ExposeBindingAsync("myFunction", pageExposeBindingOptions);32await page.EvaluateAsync("() => myFunction('Hello')");33using Microsoft.Playwright;34await PageExposeBindingOptions pageExposeBindingOptions = new PageExposeBindingOptions();35pageExposeBindingOptions.Handle = (IJSHandle arg) =>36{37    return arg.As<string>() + "World";38};39await page.ExposeBindingAsync("myFunction", pageExposeBindingOptions);40await page.EvaluateAsync("() => myFunction('Hello')");

PageExposeBindingOptions

Using AI Code Generation

1using Microsoft.Playwright;2using System;3using System.Threading.Tasks;4{5    {6        static void Main(string[] args)7        {8            MainAsync().GetAwaiter().GetResult();9        }10        static async Task MainAsync()11        {12            using var playwright = await Playwright.CreateAsync();13            await using var browser = await playwright.Chromium.LaunchAsync(new LaunchOptions14            {15            });16            var page = await browser.NewPageAsync(new PageOptions17            {18                {19                },20            });21            await page.ExposeBindingAsync("myFunction", (string arg1, int arg2) =>22            {23                Console.WriteLine($"myFunction was called with {arg1} and {arg2}");24                return Task.CompletedTask;25            }, new PageExposeBindingOptions26            {27            });28            await page.ClickAsync("text=Run myFunction");29        }30    }31}32using Microsoft.Playwright;33using System;34using System.Threading.Tasks;35{36    {37        static void Main(string[] args)38        {39            MainAsync().GetAwaiter().GetResult();40        }41        static async Task MainAsync()42        {43            using var playwright = await Playwright.CreateAsync();44            await using var browser = await playwright.Chromium.LaunchAsync(new LaunchOptions45            {46            });47            var page = await browser.NewPageAsync(new PageOptions48            {49                {50                },51            });

PageExposeBindingOptions

Using AI Code Generation

1using Microsoft.Playwright;2using Microsoft.Playwright.NUnit;3using NUnit.Framework;4{5    {6        [PlaywrightTest("page-expose-binding-options.spec.ts", "should be able to pass an elementHandle")]7        [Test, Timeout(TestConstants.DefaultTestTimeout)]8        public async Task ShouldBeAbleToPassAnElementHandle()9        {10            await Page.SetContentAsync("<div>hello</div>");11            var div = await Page.QuerySelectorAsync("div");12            await Page.ExposeBindingAsync("div", (BindingSource source, ElementHandle element) =>13            {14                Assert.AreEqual(div, element);15                return Task.CompletedTask;16            });17            await Page.EvaluateAsync("div => div.textContent", div);18        }19        [PlaywrightTest("page-expose-binding-options.spec.ts", "should work when page is navigated")]20        [Test, Timeout(TestConstants.DefaultTestTimeout)]21        public async Task ShouldWorkWhenPageIsNavigated()22        {23            await Page.ExposeBindingAsync("foo", (BindingSource source, string arg) => { return Task.CompletedTask; });24            await Page.GotoAsync(TestConstants.EmptyPage);25            await Page.EvaluateAsync("() => window.foo('test')");26        }27        [PlaywrightTest("page-expose-binding-options.spec.ts", "should survive cross-process navigation")]28        [Test, Timeout(TestConstants.DefaultTestTimeout)]29        public async Task ShouldSurviveCrossProcessNavigation()30        {31            await Page.ExposeBindingAsync("foo", (BindingSource source, string arg) => { return Task.CompletedTask; });32            await Page.GotoAsync(TestConstants.EmptyPage);33            await Page.GotoAsync(TestConstants.CrossProcessHttpPrefix + "/empty.html");34            await Page.EvaluateAsync("() => window.foo('test')");35        }36        [PlaywrightTest("page-expose-binding-options.spec.ts", "should work when subframe issues window.stop")]37        [Test, Timeout(TestConstants.DefaultTestTimeout)]38        public async Task ShouldWorkWhenSubframeIssuesWindowStop()39        {40            await Page.GotoAsync(TestConstants.EmptyPage);41            await Page.ExposeBindingAsync("log", (BindingSource source, string arg) => { return Task.CompletedTask; });42            await Page.EvaluateAsync(@"async () => {43                const frame = document.createElement('iframe');

Playwright tutorial

LambdaTest’s Playwright tutorial will give you a broader idea about the Playwright automation framework, its unique features, and use cases with examples to exceed your understanding of Playwright testing. This tutorial will give A to Z guidance, from installing the Playwright framework to some best practices and advanced concepts.

Chapters:

What is Playwright : Playwright is comparatively new but has gained good popularity. Get to know some history of the Playwright with some interesting facts connected with it.
How To Install Playwright : Learn in detail about what basic configuration and dependencies are required for installing Playwright and run a test. Get a step-by-step direction for installing the Playwright automation framework.
Playwright Futuristic Features: Launched in 2020, Playwright gained huge popularity quickly because of some obliging features such as Playwright Test Generator and Inspector, Playwright Reporter, Playwright auto-waiting mechanism and etc. Read up on those features to master Playwright testing.
What is Component Testing: Component testing in Playwright is a unique feature that allows a tester to test a single component of a web application without integrating them with other elements. Learn how to perform Component testing on the Playwright automation framework.
Inputs And Buttons In Playwright: Every website has Input boxes and buttons; learn about testing inputs and buttons with different scenarios and examples.
Functions and Selectors in Playwright: Learn how to launch the Chromium browser with Playwright. Also, gain a better understanding of some important functions like “BrowserContext,” which allows you to run multiple browser sessions, and “newPage” which interacts with a page.
Handling Alerts and Dropdowns in Playwright : Playwright interact with different types of alerts and pop-ups, such as simple, confirmation, and prompt, and different types of dropdowns, such as single selector and multi-selector get your hands-on with handling alerts and dropdown in Playright testing.
Playwright vs Puppeteer: Get to know about the difference between two testing frameworks and how they are different than one another, which browsers they support, and what features they provide.
Run Playwright Tests on LambdaTest: Playwright testing with LambdaTest leverages test performance to the utmost. You can run multiple Playwright tests in Parallel with the LammbdaTest test cloud. Get a step-by-step guide to run your Playwright test on the LambdaTest platform.
Playwright Python Tutorial: Playwright automation framework support all major languages such as Python, JavaScript, TypeScript, .NET and etc. However, there are various advantages to Python end-to-end testing with Playwright because of its versatile utility. Get the hang of Playwright python testing with this chapter.
Playwright End To End Testing Tutorial: Get your hands on with Playwright end-to-end testing and learn to use some exciting features such as TraceViewer, Debugging, Networking, Component testing, Visual testing, and many more.
Playwright Video Tutorial: Watch the video tutorials on Playwright testing from experts and get a consecutive in-depth explanation of Playwright automation testing.