Page
页面提供了与 浏览器 中的单个标签页或 Chromium 中的 扩展后台页面 进行交互的方法。一个 浏览器 实例可以有多个 页面 实例。
此示例创建一个页面，导航到 URL，然后保存屏幕截图
using Microsoft.Playwright;
using System.Threading.Tasks;
class PageExamples
{
public static async Task Run()
{
using var playwright = await Playwright.CreateAsync();
await using var browser = await playwright.Webkit.LaunchAsync();
var page = await browser.NewPageAsync();
await page.GotoAsync("https://www.theverge.com");
await page.ScreenshotAsync(new() { Path = "theverge.png" });
}
}
Page 类会发出各种事件（如下所述），可以使用 Node 的任何原生 EventEmitter 方法（例如 on、once 或 removeListener）进行处理。
此示例记录单个页面 load 事件的消息
page.Load += (_, _) => Console.WriteLine("Page loaded!");
要取消订阅事件，请使用 removeListener 方法
void PageLoadHandler(object _, IPage p) {
Console.WriteLine("Page loaded!");
};
page.Load += PageLoadHandler;
// Do some work...
page.Load -= PageLoadHandler;
方法
AddInitScriptAsync
v1.9 之前添加添加一个脚本，该脚本将在以下情况之一中进行评估：
- 每当页面导航时。
- 每当子框架附加或导航时。在这种情况下，脚本在新附加框架的上下文中进行评估。
脚本在文档创建后但在任何脚本运行之前进行评估。这对于修改 JavaScript 环境非常有用，例如，为 Math.random 设置种子。
用法
在页面加载之前覆盖 Math.random 的示例
// preload.js
Math.random = () => 42;
await Page.AddInitScriptAsync(scriptPath: "./preload.js");
通过 BrowserContext.AddInitScriptAsync() 和 Page.AddInitScriptAsync() 安装的多个脚本的求值顺序未定义。
参数
返回
AddLocatorHandlerAsync
新增于: v1.42在测试网页时，有时会出现意外的叠加层，例如“注册”对话框，并阻止您想要自动化的操作，例如单击按钮。这些叠加层并不总是以相同的方式或在相同的时间出现，这使得它们在自动化测试中难以处理。
此方法允许您设置一个特殊函数，称为处理程序，当它检测到覆盖层可见时激活。处理程序的任务是删除覆盖层，让您的测试继续，就像覆盖层不存在一样。
要记住的事情
- 当叠加层可预测地显示时，我们建议在测试中明确等待它，并将其作为正常测试流程的一部分将其关闭，而不是使用 Page.AddLocatorHandlerAsync()。
- Playwright 在执行或重试需要可操作性检查的操作之前，或在执行自动等待断言检查之前，每次都会检查叠加层。当叠加层可见时，Playwright 首先调用处理程序，然后继续执行操作/断言。请注意，处理程序仅在您执行操作/断言时调用——如果叠加层变得可见但您不执行任何操作，则不会触发处理程序。
- 执行处理程序后，Playwright 将确保触发处理程序的叠加层不再可见。您可以使用 NoWaitAfter 选择退出此行为。
- 处理程序的执行时间计入执行处理程序的操作/断言的超时。如果您的处理程序花费时间过长，可能会导致超时。
- 您可以注册多个处理程序。但是，一次只能运行一个处理程序。请确保处理程序内的操作不依赖于另一个处理程序。
运行处理程序将改变您的页面状态中途测试。例如，它将改变当前聚焦的元素并移动鼠标。请确保在处理程序之后运行的操作是自包含的，并且不依赖于焦点和鼠标状态保持不变。
例如，考虑一个调用 Locator.FocusAsync() 后跟 Keyboard.PressAsync() 的测试。如果您的处理程序在这两个操作之间单击了一个按钮，那么聚焦的元素很可能是不正确的，并且按键将在意外的元素上发生。请改用 Locator.PressAsync() 以避免此问题。
另一个例子是一系列鼠标操作，其中 Mouse.MoveAsync() 后跟 Mouse.DownAsync()。同样，当处理程序在这两个操作之间运行时，鼠标在按下鼠标时位置将不正确。请选择自包含的操作，例如 Locator.ClickAsync()，它们不依赖于处理程序不会改变状态。
用法
一个在“注册新闻通讯”对话框出现时关闭它的示例
// Setup the handler.
await page.AddLocatorHandlerAsync(page.GetByText("Sign up to the newsletter"), async () => {
await page.GetByRole(AriaRole.Button, new() { Name = "No thanks" }).ClickAsync();
});
// Write the test as usual.
await page.GotoAsync("https://example.com");
await page.GetByRole("button", new() { Name = "Start here" }).ClickAsync();
一个在显示“确认您的安全详细信息”页面时跳过它的示例
// Setup the handler.
await page.AddLocatorHandlerAsync(page.GetByText("Confirm your security details"), async () => {
await page.GetByRole(AriaRole.Button, new() { Name = "Remind me later" }).ClickAsync();
});
// Write the test as usual.
await page.GotoAsync("https://example.com");
await page.GetByRole("button", new() { Name = "Start here" }).ClickAsync();
一个在每次可操作性检查时使用自定义回调的示例。它使用一个始终可见的 `
` 定位器，因此在每次可操作性检查之前都会调用处理程序。指定 NoWaitAfter 很重要，因为处理程序不会隐藏 `` 元素。// Setup the handler.
await page.AddLocatorHandlerAsync(page.Locator("body"), async () => {
await page.EvaluateAsync("window.removeObstructionsForTestIfNeeded()");
}, new() { NoWaitAfter = true });
// Write the test as usual.
await page.GotoAsync("https://example.com");
await page.GetByRole("button", new() { Name = "Start here" }).ClickAsync();
处理程序将原始定位器作为参数。您还可以通过设置 Times 在多次调用后自动删除处理程序
await page.AddLocatorHandlerAsync(page.GetByText("Sign up to the newsletter"), async locator => {
await locator.ClickAsync();
}, new() { Times = 1 });
参数
-
触发处理程序的定位器。
-
当 定位器 出现时应运行的函数。此函数应删除阻止点击等操作的元素。
-
optionsPageAddLocatorHandlerOptions?(可选)
返回
AddScriptTagAsync
v1.9 之前添加将带有所需 URL 或内容的 <script> 标签添加到页面中。当脚本的 onload 事件触发或脚本内容注入到框架中时，返回添加的标签。
用法
await Page.AddScriptTagAsync(options);
参数
optionsPageAddScriptTagOptions?(可选)
返回
AddStyleTagAsync
v1.9 之前添加在页面中添加带有所需 URL 的 `<link rel="stylesheet">` 标签或带有内容的 `<style type="text/css">` 标签。当样式表加载完成或 CSS 内容注入到框架中时，返回添加的标签。
用法
await Page.AddStyleTagAsync(options);
参数
optionsPageAddStyleTagOptions?(可选)
返回
BringToFrontAsync
v1.9 之前添加将页面带到前面（激活标签页）。
用法
await Page.BringToFrontAsync();
返回
CloseAsync
v1.9 之前添加如果 RunBeforeUnload 为 false，则不运行任何卸载处理程序并等待页面关闭。如果 RunBeforeUnload 为 true，该方法将运行卸载处理程序，但**不会**等待页面关闭。
默认情况下，page.close() 不 运行 beforeunload 处理程序。
如果 RunBeforeUnload 设置为 true，则可能会弹出 beforeunload 对话框，应通过 Page.Dialog 事件手动处理。
用法
await Page.CloseAsync(options);
参数
optionsPageCloseOptions?(可选)-
要报告给因页面关闭而中断的操作的原因。
-
默认为
false。是否运行 before unload 页面处理程序。
-
返回
ContentAsync
v1.9 之前添加获取页面的完整 HTML 内容，包括 doctype。
用法
await Page.ContentAsync();
返回
Context
v1.9 之前添加获取页面所属的浏览器上下文。
用法
Page.Context
返回
DragAndDropAsync
添加于：v1.13此方法将源元素拖动到目标元素。它将首先移动到源元素，执行 mousedown，然后移动到目标元素并执行 mouseup。
用法
await Page.DragAndDropAsync("#source", "#target");
// or specify exact positions relative to the top-left corners of the elements:
await Page.DragAndDropAsync("#source", "#target", new()
{
SourcePosition = new() { X = 34, Y = 7 },
TargetPosition = new() { X = 10, Y = 20 },
});
参数
-
用于搜索要拖动的元素的选择器。如果有多个元素满足选择器，将使用第一个。
-
用于搜索要拖放到的元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageDragAndDropOptions?(可选)-
是否绕过可操作性检查。默认为
false。 -
已弃用
此选项无效。
此选项无效。
-
SourcePositionSourcePosition? (可选)新增于：v1.14#-
X[float] -
Y[float]
在此点（相对于元素内边距框的左上角）点击源元素。如果未指定，则使用元素的某个可见点。
-
-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
TargetPositionTargetPosition? (可选)新增于：v1.14#-
X[float] -
Y[float]
在此点（相对于元素内边距框的左上角）拖放到目标元素。如果未指定，则使用元素的某个可见点。
-
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。 -
设置后，此方法仅执行可操作性检查并跳过操作。默认为
false。在不执行操作的情况下等待元素准备好进行操作很有用。
-
返回
EmulateMediaAsync
v1.9 之前添加此方法通过 media 参数更改 CSS 媒体类型，并通过 colorScheme 参数更改 'prefers-colors-scheme' 媒体功能。
用法
await page.EvaluateAsync("() => matchMedia('screen').matches");
// → true
await page.EvaluateAsync("() => matchMedia('print').matches");
// → false
await page.EmulateMediaAsync(new() { Media = Media.Print });
await page.EvaluateAsync("() => matchMedia('screen').matches");
// → false
await page.EvaluateAsync("() => matchMedia('print').matches");
// → true
await page.EmulateMediaAsync(new() { Media = Media.Screen });
await page.EvaluateAsync("() => matchMedia('screen').matches");
// → true
await page.EvaluateAsync("() => matchMedia('print').matches");
// → false
await page.EmulateMediaAsync(new() { ColorScheme = ColorScheme.Dark });
await page.EvaluateAsync("matchMedia('(prefers-color-scheme: dark)').matches");
// → true
await page.EvaluateAsync("matchMedia('(prefers-color-scheme: light)').matches");
// → false
参数
optionsPageEmulateMediaOptions?(可选)-
ColorSchemeenum ColorScheme { Light, Dark, NoPreference, Null }?(可选)添加于：v1.9#模拟 prefers-colors-scheme 媒体特性，支持的值为
'light'和'dark'。传入'Null'会禁用配色方案模拟。'no-preference'已弃用。 -
Contrastenum Contrast { NoPreference, More, Null }?(可选)添加于: v1.51# -
ForcedColorsenum ForcedColors { Active, None, Null }?(可选)新增于: v1.15# -
Mediaenum Media { Screen, Print, Null }?(可选)添加于：v1.9#更改页面的 CSS 媒体类型。唯一允许的值是
'Screen'、'Print'和'Null'。传入'Null'会禁用 CSS 媒体模拟。 -
ReducedMotionenum ReducedMotion { Reduce, NoPreference, Null }?(可选)添加于：v1.12#模拟
'prefers-reduced-motion'媒体功能，支持的值为'reduce'、'no-preference'。传递null会禁用减速运动模拟。
-
返回
EvaluateAsync
v1.9 之前添加返回表达式调用的值。
如果传递给 Page.EvaluateAsync() 的函数返回一个 Promise，那么 Page.EvaluateAsync() 将等待 Promise 解决并返回其值。
如果传递给 Page.EvaluateAsync() 的函数返回一个不可序列化的值，那么 Page.EvaluateAsync() 解析为 undefined。Playwright 还支持传输一些 JSON 不可序列化的额外值：-0、NaN、Infinity、-Infinity。
用法
向表达式传递参数
var result = await page.EvaluateAsync<int>("([x, y]) => Promise.resolve(x * y)", new[] { 7, 8 });
Console.WriteLine(result);
也可以传递字符串而不是函数
Console.WriteLine(await page.EvaluateAsync<int>("1 + 2")); // prints "3"
ElementHandle 实例可以作为参数传递给 Page.EvaluateAsync()
var bodyHandle = await page.EvaluateAsync("document.body");
var html = await page.EvaluateAsync<string>("([body, suffix]) => body.innerHTML + suffix", new object [] { bodyHandle, "hello" });
await bodyHandle.DisposeAsync();
参数
-
要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
-
argEvaluationArgument? (可选)#要传递给表达式的可选参数。
返回
- [object]#
EvaluateHandleAsync
v1.9 之前添加以 JSHandle 形式返回 expression 调用的值。
Page.EvaluateAsync() 和 Page.EvaluateHandleAsync() 之间唯一的区别是 Page.EvaluateHandleAsync() 返回 JSHandle。
如果传递给 Page.EvaluateHandleAsync() 的函数返回一个 Promise，那么 Page.EvaluateHandleAsync() 将等待 Promise 解决并返回其值。
用法
// Handle for the window object.
var aWindowHandle = await page.EvaluateHandleAsync("() => Promise.resolve(window)");
也可以传递字符串而不是函数
var docHandle = await page.EvaluateHandleAsync("document"); // Handle for the `document`
JSHandle 实例可以作为参数传递给 Page.EvaluateHandleAsync()
var handle = await page.EvaluateHandleAsync("() => document.body");
var resultHandle = await page.EvaluateHandleAsync("([body, suffix]) => body.innerHTML + suffix", new object[] { handle, "hello" });
Console.WriteLine(await resultHandle.JsonValueAsync<string>());
await resultHandle.DisposeAsync();
参数
-
要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
-
argEvaluationArgument? (可选)#要传递给 表达式 的可选参数。
返回
ExposeBindingAsync
v1.9 之前添加该方法在页面中每个框架的 window 对象上添加一个名为 name 的函数。调用时，该函数执行 callback 并返回一个 Promise，该 Promise 解析为 callback 的返回值。如果 callback 返回一个 Promise，它将被等待。
回调函数的第一个参数包含有关调用者的信息：{ browserContext: BrowserContext, page: Page, frame: Frame }。
有关上下文范围的版本，请参阅 BrowserContext.ExposeBindingAsync()。
通过 Page.ExposeBindingAsync() 安装的函数在导航后仍然存在。
用法
将页面 URL 暴露给页面中所有框架的示例
using Microsoft.Playwright;
using System.Threading.Tasks;
class PageExamples
{
public static async Task Main()
{
using var playwright = await Playwright.CreateAsync();
await using var browser = await playwright.Webkit.LaunchAsync(new()
{
Headless = false,
});
var page = await browser.NewPageAsync();
await page.ExposeBindingAsync("pageUrl", (source) => source.Page.Url);
await page.SetContentAsync("<script>\n" +
" async function onClick() {\n" +
" document.querySelector('div').textContent = await window.pageURL();\n" +
" }\n" +
"</script>\n" +
"<button onclick=\"onClick()\">Click me</button>\n" +
"<div></div>");
await page.ClickAsync("button");
}
}
参数
-
窗口对象上函数的名称。
-
callbackAction<BindingSource, T, [TResult]>#将在 Playwright 上下文中调用的回调函数。
-
optionsPageExposeBindingOptions?(可选)
返回
ExposeFunctionAsync
v1.9 之前添加该方法在页面中每个框架的 window 对象上添加一个名为 name 的函数。调用时，该函数执行 callback 并返回一个 Promise，该 Promise 解析为 callback 的返回值。
有关上下文范围的暴露函数，请参阅 BrowserContext.ExposeFunctionAsync()。
通过 Page.ExposeFunctionAsync() 安装的函数在导航后仍然存在。
用法
向页面添加 sha256 函数的示例
using Microsoft.Playwright;
using System;
using System.Security.Cryptography;
using System.Threading.Tasks;
class PageExamples
{
public static async Task Main()
{
using var playwright = await Playwright.CreateAsync();
await using var browser = await playwright.Webkit.LaunchAsync(new()
{
Headless = false
});
var page = await browser.NewPageAsync();
await page.ExposeFunctionAsync("sha256", (string input) =>
{
return Convert.ToBase64String(
SHA256.Create().ComputeHash(System.Text.Encoding.UTF8.GetBytes(input)));
});
await page.SetContentAsync("<script>\n" +
" async function onClick() {\n" +
" document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');\n" +
" }\n" +
"</script>\n" +
"<button onclick=\"onClick()\">Click me</button>\n" +
"<div></div>");
await page.ClickAsync("button");
Console.WriteLine(await page.TextContentAsync("div"));
}
}
参数
返回
Frame
v1.9 之前添加返回符合指定条件的帧。必须指定 name 或 url。
用法
var frame = page.Frame("frame-name");
var frame = page.FrameByUrl(".*domain.*");
参数
返回
FrameByUrl
添加于：v1.9返回具有匹配 URL 的框架。
用法
Page.FrameByUrl(url);
参数
返回
FrameLocator
新增于: v1.17使用 iframe 时，您可以创建一个框架定位器，它将进入 iframe 并允许选择 iframe 中的元素。
用法
以下代码片段在 id 为 my-frame 的 iframe 中查找文本为“提交”的元素，例如 <iframe id="my-frame">
var locator = page.FrameLocator("#my-iframe").GetByText("Submit");
await locator.ClickAsync();
参数
返回
Frames
v1.9 之前添加附加到页面的所有帧的数组。
用法
Page.Frames
返回
GetByAltText
新增于：v1.27允许根据元素的 alt 文本定位元素。
用法
例如，此方法将通过 alt 文本“Playwright logo”找到图像
<img alt='Playwright logo'>
await page.GetByAltText("Playwright logo").ClickAsync();
参数
-
用于定位元素的文本。
-
optionsPageGetByAltTextOptions?(可选)
返回
GetByLabel
新增于：v1.27允许通过关联的 <label> 或 aria-labelledby 元素的文本或 aria-label 属性来定位输入元素。
用法
例如，此方法将在以下 DOM 中通过标签“用户名”和“密码”找到输入
<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">
await page.GetByLabel("Username").FillAsync("john");
await page.GetByLabel("Password").FillAsync("secret");
参数
-
用于定位元素的文本。
-
optionsPageGetByLabelOptions?(可选)
返回
GetByPlaceholder
新增于：v1.27允许通过占位符文本定位输入元素。
用法
例如，考虑以下 DOM 结构。
<input type="email" placeholder="name@example.com" />
您可以按占位符文本定位输入框后填充它
await page
.GetByPlaceholder("name@example.com")
.FillAsync("playwright@microsoft.com");
参数
-
用于定位元素的文本。
-
optionsPageGetByPlaceholderOptions?(可选)
返回
GetByRole
新增于：v1.27允许通过元素的 ARIA 角色、ARIA 属性和可访问名称来定位元素。
用法
考虑以下 DOM 结构。
<h3>Sign up</h3>
<label>
<input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>
您可以通过其隐式角色定位每个元素
await Expect(Page
.GetByRole(AriaRole.Heading, new() { Name = "Sign up" }))
.ToBeVisibleAsync();
await page
.GetByRole(AriaRole.Checkbox, new() { Name = "Subscribe" })
.CheckAsync();
await page
.GetByRole(AriaRole.Button, new() {
NameRegex = new Regex("submit", RegexOptions.IgnoreCase)
})
.ClickAsync();
参数
-
roleenum AriaRole { Alert, Alertdialog, Application, Article, Banner, Blockquote, Button, Caption, Cell, Checkbox, Code, Columnheader, Combobox, Complementary, Contentinfo, Definition, Deletion, Dialog, Directory, Document, Emphasis, Feed, Figure, Form, Generic, Grid, Gridcell, Group, Heading, Img, Insertion, Link, List, Listbox, Listitem, Log, Main, Marquee, Math, Meter, Menu, Menubar, Menuitem, Menuitemcheckbox, Menuitemradio, Navigation, None, Note, Option, Paragraph, Presentation, Progressbar, Radio, Radiogroup, Region, Row, Rowgroup, Rowheader, Scrollbar, Search, Searchbox, Separator, Slider, Spinbutton, Status, Strong, Subscript, Superscript, Switch, Tab, Table, Tablist, Tabpanel, Term, Textbox, Time, Timer, Toolbar, Tooltip, Tree, Treegrid, Treeitem }#所需的 aria 角色。
-
optionsPageGetByRoleOptions?(可选)-
通常由
aria-checked或原生<input type=checkbox>控件设置的属性。了解更多关于
aria-checked的信息。 -
通常由
aria-disabled或disabled设置的属性。注意与大多数其他属性不同，
disabled在 DOM 层次结构中是继承的。了解更多关于aria-disabled的信息。 -
名称|NameRegex 是否完全匹配：区分大小写和整个字符串。默认为 false。当 名称|NameRegex 是正则表达式时忽略。请注意，精确匹配仍会修剪空白。
-
通常由
aria-expanded设置的属性。了解更多关于
aria-expanded的信息。 -
控制是否匹配隐藏元素的选项。默认情况下，只有非隐藏元素（由 ARIA 定义）由角色选择器匹配。
了解更多关于
aria-hidden的信息。 -
通常用于角色
heading、listitem、row、treeitem的数字属性，<h1>-<h6>元素具有默认值。了解更多关于
aria-level的信息。 -
Name|NameRegexstring? | Regex? (可选)#匹配可访问名称的选项。默认情况下，匹配不区分大小写并搜索子字符串，使用 Exact 来控制此行为。
了解更多关于 可访问名称 的信息。
-
通常由
aria-pressed设置的属性。了解更多关于
aria-pressed的信息。 -
通常由
aria-selected设置的属性。了解更多关于
aria-selected的信息。
-
返回
详情
角色选择器 不替代 可访问性审计和合规性测试，而是提供有关 ARIA 指南的早期反馈。
许多 html 元素具有隐式定义的角色，该角色被角色选择器识别。您可以在此处找到所有支持的角色。ARIA 指南**不建议**通过将 role 和/或 aria-* 属性设置为默认值来复制隐式角色和属性。
GetByTestId
新增于：v1.27按测试 ID 定位元素。
用法
考虑以下 DOM 结构。
<button data-testid="directions">Itinéraire</button>
您可以通过其测试 ID 定位元素
await page.GetByTestId("directions").ClickAsync();
参数
返回
详情
默认情况下，data-testid 属性用作测试 ID。如有必要，使用 Selectors.SetTestIdAttribute() 配置不同的测试 ID 属性。
GetByText
新增于：v1.27允许定位包含给定文本的元素。
另请参阅 Locator.Filter()，它允许通过其他条件（如可访问角色）进行匹配，然后按文本内容进行过滤。
用法
考虑以下 DOM 结构
<div>Hello <span>world</span></div>
<div>Hello</div>
您可以通过文本子字符串、精确字符串或正则表达式进行定位
// Matches <span>
page.GetByText("world");
// Matches first <div>
page.GetByText("Hello world");
// Matches second <div>
page.GetByText("Hello", new() { Exact = true });
// Matches both <div>s
page.GetByText(new Regex("Hello"));
// Matches second <div>
page.GetByText(new Regex("^hello$", RegexOptions.IgnoreCase));
参数
-
用于定位元素的文本。
-
optionsPageGetByTextOptions?(可选)
返回
详情
按文本匹配始终会规范化空格，即使是精确匹配也是如此。例如，它会将多个空格转换为一个空格，将换行符转换为空格，并忽略前导和尾随空格。
类型为 button 和 submit 的输入元素通过其 value 而不是文本内容进行匹配。例如，通过文本 "登录" 定位匹配 <input type=button value="登录">。
GetByTitle
新增于：v1.27允许通过元素的 title 属性定位元素。
用法
考虑以下 DOM 结构。
<span title='Issues count'>25 issues</span>
您可以通过 title 文本定位它后检查问题数量
await Expect(Page.GetByTitle("Issues count")).toHaveText("25 issues");
参数
-
用于定位元素的文本。
-
optionsPageGetByTitleOptions?(可选)
返回
GoBackAsync
v1.9 之前添加返回主资源响应。如果存在多次重定向，导航将解析为最后一次重定向的响应。如果无法返回，则返回 null。
导航到历史记录中的上一页。
用法
await Page.GoBackAsync(options);
参数
optionsPageGoBackOptions?(可选)-
Timeout[float]? (可选)#最大操作时间（毫秒），默认为 30 秒，传入
0以禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。 -
WaitUntilenum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?(可选)#何时认为操作成功，默认为
load。事件可以是以下之一'domcontentloaded'- 当DOMContentLoaded事件触发时，认为操作完成。'load'- 当load事件触发时，认为操作完成。'networkidle'- 不建议 当至少500毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。'commit'- 当收到网络响应且文档开始加载时，认为操作完成。
-
返回
GoForwardAsync
v1.9 之前添加返回主资源响应。如果存在多次重定向，导航将解析为最后一次重定向的响应。如果无法前进，则返回 null。
导航到历史记录中的下一页。
用法
await Page.GoForwardAsync(options);
参数
optionsPageGoForwardOptions?(可选)-
Timeout[float]? (可选)#最大操作时间（毫秒），默认为 30 秒，传入
0以禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。 -
WaitUntilenum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?(可选)#何时认为操作成功，默认为
load。事件可以是以下之一'domcontentloaded'- 当DOMContentLoaded事件触发时，认为操作完成。'load'- 当load事件触发时，认为操作完成。'networkidle'- 不建议 当至少500毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。'commit'- 当收到网络响应且文档开始加载时，认为操作完成。
-
返回
GotoAsync
v1.9 之前添加返回主资源响应。如果存在多次重定向，导航将解析为第一个非重定向响应。
此方法将在以下情况下抛出错误
- 存在 SSL 错误（例如自签名证书）。
- 目标 URL 无效。
- 在导航期间超过超时。
- 远程服务器无响应或无法访问。
- 主资源加载失败。
当远程服务器返回任何有效的 HTTP 状态码时，该方法不会抛出错误，包括 404“未找到”和 500“内部服务器错误”。可以通过调用 Response.Status 检索此类响应的状态码。
该方法要么抛出错误，要么返回主资源响应。唯一的例外是导航到 about:blank 或导航到具有不同哈希的相同 URL，这将成功并返回 null。
无头模式不支持导航到 PDF 文档。请参阅 上游问题。
用法
await Page.GotoAsync(url, options);
参数
-
要导航到的页面 URL。URL 应包含方案，例如
https://。如果通过上下文选项提供了 BaseURL，并且传入的 URL 是一个不带路径的字符串，则会通过new URL()构造函数进行合并。 -
optionsPageGotoOptions?(可选)-
Referer 头值。如果提供，它将优先于通过 Page.SetExtraHTTPHeadersAsync() 设置的 referer 头值。
-
Timeout[float]? (可选)#最大操作时间（毫秒），默认为 30 秒，传入
0以禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。 -
WaitUntilenum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?(可选)#何时认为操作成功，默认为
load。事件可以是以下之一'domcontentloaded'- 当DOMContentLoaded事件触发时，认为操作完成。'load'- 当load事件触发时，认为操作完成。'networkidle'- 不建议 当至少500毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。'commit'- 当收到网络响应且文档开始加载时，认为操作完成。
-
返回
IsClosed
v1.9 之前添加指示页面已关闭。
用法
Page.IsClosed
返回
Locator
新增于：v1.14该方法返回一个元素定位器，可用于在此页面/框架上执行操作。定位器在执行操作之前立即解析为元素，因此在同一定位器上执行一系列操作实际上可以在不同的 DOM 元素上执行。如果这些操作之间的 DOM 结构已更改，则会发生这种情况。
用法
Page.Locator(selector, options);
参数
-
用于解析 DOM 元素的选取器。
-
optionsPageLocatorOptions?(可选)-
将方法的结果缩小到包含与此相对定位器匹配的元素的那些结果。例如，具有
text=Playwright的article匹配<article><div>Playwright</div></article>。内部定位器**必须相对于**外部定位器，并且从外部定位器匹配开始查询，而不是文档根。例如，您可以在
<article><content><div>Playwright</div></content></article>中找到具有div的content。但是，查找具有article div的content将失败，因为内部定位器必须是相对的，并且不应使用content之外的任何元素。请注意，外部和内部定位器必须属于同一个框架。内部定位器不能包含 FrameLocator。
-
匹配不包含与内部定位器匹配的元素的元素。内部定位器根据外部定位器进行查询。例如，不包含
div的article匹配<article><span>Playwright</span></article>。请注意，外部和内部定位器必须属于同一个框架。内部定位器不能包含 FrameLocator。
-
HasNotText|HasNotTextRegexstring? | Regex? (可选)新增于：v1.33#匹配不包含指定文本的元素，可能在子元素或后代元素中。当传入 string 时，匹配不区分大小写并搜索子字符串。
-
HasText|HasTextRegexstring? | Regex? (可选)#匹配包含指定文本的元素，可能在子元素或后代元素中。当传入 string 时，匹配不区分大小写并搜索子字符串。例如，
"Playwright"匹配<article><div>Playwright</div></article>。
-
返回
MainFrame
v1.9 之前添加页面的主框架。页面保证有一个在导航期间持久存在的主框架。
用法
Page.MainFrame
返回
OpenerAsync
v1.9 之前添加对于弹出页面返回打开者，对于其他页面返回 null。如果打开者已经关闭，则返回 null。
用法
await Page.OpenerAsync();
返回
PauseAsync
添加于：v1.9暂停脚本执行。Playwright 将停止执行脚本，并等待用户点击页面覆盖中的“恢复”按钮，或者在 DevTools 控制台中调用 playwright.resume()。
用户可以在暂停时检查选择器或执行手动步骤。恢复将从暂停的位置继续运行原始脚本。
此方法要求 Playwright 以有头模式启动，使用虚假 Headless 选项。
用法
await Page.PauseAsync();
返回
PdfAsync
v1.9 之前添加返回 PDF 缓冲区。
page.pdf() 使用 print css 媒体生成页面的 pdf。要使用 screen 媒体生成 pdf，请在调用 page.pdf() 之前调用 Page.EmulateMediaAsync()
默认情况下，page.pdf() 会生成带有修改颜色的 PDF 以进行打印。使用 -webkit-print-color-adjust 属性强制渲染精确的颜色。
用法
// Generates a PDF with 'screen' media type
await page.EmulateMediaAsync(new() { Media = Media.Screen });
await page.PdfAsync(new() { Path = "page.pdf" });
宽度、高度 和 边距 选项接受带有单位的值。未标记的值被视为像素。
一些示例
page.pdf({width: 100})- 打印宽度设置为 100 像素page.pdf({width: '100px'})- 打印宽度设置为 100 像素page.pdf({width: '10cm'})- 打印宽度设置为 10 厘米。
所有可能的单位是
px- 像素in- 英寸cm- 厘米mm- 毫米
格式选项为
信纸: 8.5 英寸 x 11 英寸法律: 8.5 英寸 x 14 英寸Tabloid: 11 英寸 x 17 英寸账本: 17 英寸 x 11 英寸A0: 33.1 英寸 x 46.8 英寸A1: 23.4 英寸 x 33.1 英寸A2: 16.54 英寸 x 23.4 英寸A3: 11.7 英寸 x 16.54 英寸A4: 8.27 英寸 x 11.7 英寸A5: 5.83 英寸 x 8.27 英寸A6: 4.13 英寸 x 5.83 英寸
参数
optionsPagePdfOptions?(可选)-
DisplayHeaderFooterbool? (可选)#显示页眉和页脚。默认为
false。 -
打印页脚的 HTML 模板。应使用与 HeaderTemplate 相同的格式。
-
打印页眉的 HTML 模板。应为有效 HTML 标记，其中以下类用于注入打印值
'date'格式化的打印日期'title'文档标题'url'文档位置'pageNumber'当前页码'totalPages'文档总页数
-
纸张高度，接受带单位的值。
-
纸张方向。默认为
false。 -
MarginMargin? (可选)#-
Topstring? (可选)上边距，接受带单位的值。默认为
0。 -
Rightstring? (可选)右边距，接受带单位的值。默认为
0。 -
Bottomstring? (可选)下边距，接受带单位的值。默认为
0。 -
Leftstring? (可选)左边距，接受带单位的值。默认为
0。
纸张边距，默认为无。
-
-
是否将文档大纲嵌入 PDF。默认为
false。 -
要打印的页面范围，例如 '1-5, 8, 11-13'。默认为空字符串，表示打印所有页面。
-
保存 PDF 的文件路径。如果 Path 是相对路径，则它会相对于当前工作目录解析。如果未提供路径，则 PDF 不会保存到磁盘。
-
优先使用页面中声明的任何 CSS
@page大小，而不是 宽度 和 高度 或 格式 选项中声明的大小。默认为false，这将缩放内容以适应纸张大小。 -
打印背景图形。默认为
false。 -
Scale[float]? (可选)#网页渲染的比例。默认为
1。比例值必须在 0.1 到 2 之间。 -
是否生成带标签（可访问）的 PDF。默认为
false。 -
纸张宽度，接受带单位的值。
-
返回
ReloadAsync
v1.9 之前添加此方法重新加载当前页面，就像用户触发了浏览器刷新一样。返回主资源响应。在多次重定向的情况下，导航将解析为最后一次重定向的响应。
用法
await Page.ReloadAsync(options);
参数
optionsPageReloadOptions?(可选)-
Timeout[float]? (可选)#最大操作时间（毫秒），默认为 30 秒，传入
0以禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。 -
WaitUntilenum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?(可选)#何时认为操作成功，默认为
load。事件可以是以下之一'domcontentloaded'- 当DOMContentLoaded事件触发时，认为操作完成。'load'- 当load事件触发时，认为操作完成。'networkidle'- 不建议 当至少500毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。'commit'- 当收到网络响应且文档开始加载时，认为操作完成。
-
返回
RemoveLocatorHandlerAsync
新增于：v1.44删除通过 Page.AddLocatorHandlerAsync() 添加的特定定位器的所有定位器处理程序。
用法
await Page.RemoveLocatorHandlerAsync(locator);
参数
-
传递给 Page.AddLocatorHandlerAsync() 的定位器。
返回
RequestGCAsync
新增于: v1.48请求页面执行垃圾回收。请注意，不能保证所有不可达对象都会被收集。
这有助于检测内存泄漏。例如，如果您的页面有一个可能泄漏的大对象 'suspect'，您可以使用 WeakRef 来检查它是否没有泄漏。
// 1. In your page, save a WeakRef for the "suspect".
await Page.EvaluateAsync("globalThis.suspectWeakRef = new WeakRef(suspect)");
// 2. Request garbage collection.
await Page.RequestGCAsync();
// 3. Check that weak ref does not deref to the original object.
Assert.True(await Page.EvaluateAsync("!globalThis.suspectWeakRef.deref()"));
用法
await Page.RequestGCAsync();
返回
RouteAsync
v1.9 之前添加路由提供了修改页面发出的网络请求的能力。
一旦启用路由，每个匹配 URL 模式的请求都将暂停，除非它被继续、完成或中止。
如果响应是重定向，则处理程序将只针对第一个 URL 调用。
Page.RouteAsync() 不会拦截 Service Worker 拦截的请求。请参阅 此 问题。我们建议通过将 ServiceWorkers 设置为 'block' 来禁用 Service Worker 以进行请求拦截。
Page.RouteAsync() 不会拦截弹出页面的第一个请求。请改用 BrowserContext.RouteAsync()。
用法
一个简单地中止所有图片请求的处理程序示例
var page = await browser.NewPageAsync();
await page.RouteAsync("**/*.{png,jpg,jpeg}", async r => await r.AbortAsync());
await page.GotoAsync("https://www.microsoft.com");
或者使用正则表达式模式的相同片段
var page = await browser.NewPageAsync();
await page.RouteAsync(new Regex("(\\.png$)|(\\.jpg$)"), async r => await r.AbortAsync());
await page.GotoAsync("https://www.microsoft.com");
可以检查请求以决定路由操作。例如，模拟所有包含某些 POST 数据的请求，并保留所有其他请求不变
await page.RouteAsync("/api/**", async r =>
{
if (r.Request.PostData.Contains("my-string"))
await r.FulfillAsync(new() { Body = "mocked-data" });
else
await r.ContinueAsync();
});
当请求匹配两个处理程序时，页面路由优先于浏览器上下文路由（通过 BrowserContext.RouteAsync() 设置）。
要使用其处理程序删除路由，您可以使用 Page.UnrouteAsync()。
启用路由会禁用 HTTP 缓存。
参数
-
urlstring | Regex | Func<string, bool>#一个 glob 模式、正则表达式模式或谓词，它接收一个 URL 以在路由期间进行匹配。如果在上下文选项中设置了 BaseURL，并且提供的 URL 是一个不以
*开头的字符串，它将使用new URL()构造函数进行解析。 -
用于路由请求的处理函数。
-
optionsPageRouteOptions?(可选)
返回
RouteFromHARAsync
添加于：v1.23如果指定，页面中的网络请求将从 HAR 文件提供。阅读更多关于 从 HAR 重放 的信息。
Playwright 不会从 HAR 文件中提供 Service Worker 拦截的请求。请参阅 此 问题。我们建议通过将 ServiceWorkers 设置为 'block' 来禁用 Service Worker 以进行请求拦截。
用法
await Page.RouteFromHARAsync(har, options);
参数
-
带有预录网络数据的 HAR 文件路径。如果
path是相对路径，则它相对于当前工作目录解析。 -
optionsPageRouteFromHAROptions?(可选)-
NotFoundenum HarNotFound { Abort, Fallback }?(可选)#- 如果设置为 'abort'，则 HAR 文件中未找到的任何请求都将被中止。
- 如果设置为 'fallback'，则缺失的请求将被发送到网络。
默认为中止。
-
如果指定，将使用实际网络信息更新给定的 HAR，而不是从文件提供。当调用 BrowserContext.CloseAsync() 时，文件将写入磁盘。
-
UpdateContentenum RouteFromHarUpdateContentPolicy { Embed, Attach }?(可选)新增于: v1.32#可选设置以控制资源内容管理。如果指定
attach，资源将作为单独的文件或 ZIP 档案中的条目持久化。如果指定embed，内容将内联存储在 HAR 文件中。 -
UpdateModeenum HarMode { Full, Minimal }?(可选)新增于: v1.32#当设置为
minimal时，仅记录从 HAR 路由所需的信息。这会省略 HAR 信息中不用于从 HAR 重放的大小、时间、页面、cookie、安全性和其他类型的信息。默认为minimal。 -
Url|UrlRegexstring? | Regex? (可选)#一个 glob 模式、正则表达式或谓词，用于匹配请求 URL。只有 URL 匹配模式的请求将从 HAR 文件中提供。如果未指定，所有请求都将从 HAR 文件中提供。
-
返回
RouteWebSocketAsync
新增于: v1.48此方法允许修改页面建立的 websocket 连接。
请注意，只有在此方法调用后创建的 WebSocket 才会进行路由。建议在导航页面之前调用此方法。
用法
下面是一个响应单个消息的简单模拟示例。有关更多详细信息和示例，请参阅 WebSocketRoute。
await page.RouteWebSocketAsync("/ws", ws => {
ws.OnMessage(frame => {
if (frame.Text == "request")
ws.Send("response");
});
});
参数
-
urlstring | Regex | Func<string, bool>#只有 URL 与此模式匹配的 WebSocket 才会路由。字符串模式可以相对于 BaseURL 上下文选项。
-
handlerAction<WebSocketRoute>#用于路由 WebSocket 的处理函数。
返回
RunAndWaitForConsoleMessageAsync
添加于：v1.9执行操作并等待页面中记录的 ConsoleMessage。如果提供了谓词，它将 ConsoleMessage 值传递给 predicate 函数并等待 predicate(message) 返回真值。如果在触发 Page.Console 事件之前页面关闭，则会抛出错误。
用法
await Page.RunAndWaitForConsoleMessageAsync(action, options);
参数
-
触发事件的操作。
-
optionsPageRunAndWaitForConsoleMessageOptions?(可选)-
PredicateFunc<ConsoleMessage?, bool> (可选)#接收 ConsoleMessage 对象，并在等待应解决时解析为真值。
-
Timeout[float]? (可选)#最长等待时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 更改。
-
返回
WaitForConsoleMessageAsync
添加于：v1.9执行操作并等待页面中记录的 ConsoleMessage。如果提供了谓词，它将 ConsoleMessage 值传递给 predicate 函数并等待 predicate(message) 返回真值。如果在触发 Page.Console 事件之前页面关闭，则会抛出错误。
用法
await Page.WaitForConsoleMessageAsync(action, options);
参数
optionsPageRunAndWaitForConsoleMessageOptions?(可选)-
PredicateFunc<ConsoleMessage?, bool> (可选)#接收 ConsoleMessage 对象，并在等待应解决时解析为真值。
-
Timeout[float]? (可选)#最长等待时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 更改。
-
返回
RunAndWaitForDownloadAsync
添加于：v1.9执行操作并等待新的 下载。如果提供了谓词，它将 下载 值传递给 predicate 函数并等待 predicate(download) 返回真值。如果在触发下载事件之前页面关闭，则会抛出错误。
用法
await Page.RunAndWaitForDownloadAsync(action, options);
参数
-
触发事件的操作。
-
optionsPageRunAndWaitForDownloadOptions?(可选)
返回
WaitForDownloadAsync
添加于：v1.9执行操作并等待新的 下载。如果提供了谓词，它将 下载 值传递给 predicate 函数并等待 predicate(download) 返回真值。如果在触发下载事件之前页面关闭，则会抛出错误。
用法
await Page.WaitForDownloadAsync(action, options);
参数
optionsPageRunAndWaitForDownloadOptions?(可选)
返回
RunAndWaitForFileChooserAsync
添加于：v1.9执行操作并等待新的 FileChooser 创建。如果提供了谓词，它将 FileChooser 值传递给 predicate 函数，并等待 predicate(fileChooser) 返回真值。如果在文件选择器打开之前页面关闭，则会抛出错误。
用法
await Page.RunAndWaitForFileChooserAsync(action, options);
参数
-
触发事件的操作。
-
optionsPageRunAndWaitForFileChooserOptions?(可选)-
PredicateFunc<文件选择器?, bool> (可选)#接收 FileChooser 对象，并在等待应解决时解析为真值。
-
Timeout[float]? (可选)#最长等待时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 更改。
-
返回
WaitForFileChooserAsync
添加于：v1.9执行操作并等待新的 FileChooser 创建。如果提供了谓词，它将 FileChooser 值传递给 predicate 函数，并等待 predicate(fileChooser) 返回真值。如果在文件选择器打开之前页面关闭，则会抛出错误。
用法
await Page.WaitForFileChooserAsync(action, options);
参数
optionsPageRunAndWaitForFileChooserOptions?(可选)-
PredicateFunc<文件选择器?, bool> (可选)#接收 FileChooser 对象，并在等待应解决时解析为真值。
-
Timeout[float]? (可选)#最长等待时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。默认值可以通过 BrowserContext.SetDefaultTimeout() 更改。
-
返回
RunAndWaitForPopupAsync
添加于：v1.9执行操作并等待弹出窗口 Page。如果提供了 predicate，它会将 [Popup] 值传递给 predicate 函数，并等待 predicate(page) 返回一个真值。如果页面在弹出事件触发之前关闭，将抛出错误。
用法
await Page.RunAndWaitForPopupAsync(action, options);
参数
-
触发事件的操作。
-
optionsPageRunAndWaitForPopupOptions?(可选)
返回
WaitForPopupAsync
添加于：v1.9执行操作并等待弹出窗口 Page。如果提供了 predicate，它会将 [Popup] 值传递给 predicate 函数，并等待 predicate(page) 返回一个真值。如果页面在弹出事件触发之前关闭，将抛出错误。
用法
await Page.WaitForPopupAsync(action, options);
参数
optionsPageRunAndWaitForPopupOptions?(可选)
返回
RunAndWaitForRequestAsync
v1.9 之前添加等待匹配的请求并返回它。有关事件的更多详细信息，请参阅 等待事件。
用法
// Waits for the next request with the specified url.
await page.RunAndWaitForRequestAsync(async () =>
{
await page.GetByText("trigger request").ClickAsync();
}, "http://example.com/resource");
// Alternative way with a predicate.
await page.RunAndWaitForRequestAsync(async () =>
{
await page.GetByText("trigger request").ClickAsync();
}, request => request.Url == "https://example.com" && request.Method == "GET");
参数
-
触发事件的操作。
-
urlOrPredicatestring | Regex | Func<Request, bool>#请求 URL 字符串、正则表达式或接收 Request 对象的谓词。如果通过上下文选项提供了 BaseURL，并且传入的 URL 是一个路径，它将通过
new URL()构造函数进行合并。 -
optionsPageRunAndWaitForRequestOptions?(可选)-
Timeout[float]? (可选)#最大等待时间（毫秒），默认为 30 秒，传递
0禁用超时。默认值可以通过使用 Page.SetDefaultTimeout() 方法更改。
-
返回
WaitForRequestAsync
v1.9 之前添加等待匹配的请求并返回它。有关事件的更多详细信息，请参阅 等待事件。
用法
// Waits for the next request with the specified url.
await page.RunAndWaitForRequestAsync(async () =>
{
await page.GetByText("trigger request").ClickAsync();
}, "http://example.com/resource");
// Alternative way with a predicate.
await page.RunAndWaitForRequestAsync(async () =>
{
await page.GetByText("trigger request").ClickAsync();
}, request => request.Url == "https://example.com" && request.Method == "GET");
参数
-
urlOrPredicatestring | Regex | Func<Request, bool>#请求 URL 字符串、正则表达式或接收 Request 对象的谓词。如果通过上下文选项提供了 BaseURL，并且传入的 URL 是一个路径，它将通过
new URL()构造函数进行合并。 -
optionsPageRunAndWaitForRequestOptions?(可选)-
Timeout[float]? (可选)#最大等待时间（毫秒），默认为 30 秒，传递
0禁用超时。默认值可以通过使用 Page.SetDefaultTimeout() 方法更改。
-
返回
RunAndWaitForRequestFinishedAsync
添加于：v1.12执行操作并等待 Request 完成加载。如果提供了 predicate，它会将 Request 值传递给 predicate 函数，并等待 predicate(request) 返回一个真值。如果页面在 Page.RequestFinished 事件触发之前关闭，将抛出错误。
用法
await Page.RunAndWaitForRequestFinishedAsync(action, options);
参数
-
触发事件的操作。
-
optionsPageRunAndWaitForRequestFinishedOptions?(可选)
返回
WaitForRequestFinishedAsync
添加于：v1.12执行操作并等待 Request 完成加载。如果提供了 predicate，它会将 Request 值传递给 predicate 函数，并等待 predicate(request) 返回一个真值。如果页面在 Page.RequestFinished 事件触发之前关闭，将抛出错误。
用法
await Page.WaitForRequestFinishedAsync(action, options);
参数
optionsPageRunAndWaitForRequestFinishedOptions?(可选)
返回
RunAndWaitForResponseAsync
v1.9 之前添加返回匹配的响应。有关事件的更多详细信息，请参阅 等待事件。
用法
// Waits for the next response with the specified url.
await page.RunAndWaitForResponseAsync(async () =>
{
await page.GetByText("trigger response").ClickAsync();
}, "http://example.com/resource");
// Alternative way with a predicate.
await page.RunAndWaitForResponseAsync(async () =>
{
await page.GetByText("trigger response").ClickAsync();
}, response => response.Url == "https://example.com" && response.Status == 200 && response.Request.Method == "GET");
参数
-
触发事件的操作。
-
urlOrPredicatestring | Regex | Func<Response, bool>#请求 URL 字符串、正则表达式或接收 Response 对象的谓词。如果通过上下文选项提供了 BaseURL，并且传入的 URL 是一个路径，它将通过
new URL()构造函数进行合并。 -
optionsPageRunAndWaitForResponseOptions?(可选)-
Timeout[float]? (可选)#最大等待时间（毫秒），默认为 30 秒，传递
0禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
-
返回
WaitForResponseAsync
v1.9 之前添加返回匹配的响应。有关事件的更多详细信息，请参阅 等待事件。
用法
// Waits for the next response with the specified url.
await page.RunAndWaitForResponseAsync(async () =>
{
await page.GetByText("trigger response").ClickAsync();
}, "http://example.com/resource");
// Alternative way with a predicate.
await page.RunAndWaitForResponseAsync(async () =>
{
await page.GetByText("trigger response").ClickAsync();
}, response => response.Url == "https://example.com" && response.Status == 200 && response.Request.Method == "GET");
参数
-
urlOrPredicatestring | Regex | Func<Response, bool>#请求 URL 字符串、正则表达式或接收 Response 对象的谓词。如果通过上下文选项提供了 BaseURL，并且传入的 URL 是一个路径，它将通过
new URL()构造函数进行合并。 -
optionsPageRunAndWaitForResponseOptions?(可选)-
Timeout[float]? (可选)#最大等待时间（毫秒），默认为 30 秒，传递
0禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
-
返回
RunAndWaitForWebSocketAsync
添加于：v1.9执行操作并等待新的 WebSocket。如果提供了 predicate，它会将 WebSocket 值传递给 predicate 函数，并等待 predicate(webSocket) 返回一个真值。如果页面在 WebSocket 事件触发之前关闭，将抛出错误。
用法
await Page.RunAndWaitForWebSocketAsync(action, options);
参数
-
触发事件的操作。
-
optionsPageRunAndWaitForWebSocketOptions?(可选)
返回
WaitForWebSocketAsync
添加于：v1.9执行操作并等待新的 WebSocket。如果提供了 predicate，它会将 WebSocket 值传递给 predicate 函数，并等待 predicate(webSocket) 返回一个真值。如果页面在 WebSocket 事件触发之前关闭，将抛出错误。
用法
await Page.WaitForWebSocketAsync(action, options);
参数
optionsPageRunAndWaitForWebSocketOptions?(可选)
返回
RunAndWaitForWorkerAsync
添加于：v1.9执行操作并等待新的 Worker。如果提供了 predicate，它会将 Worker 值传递给 predicate 函数，并等待 predicate(worker) 返回一个真值。如果页面在 worker 事件触发之前关闭，将抛出错误。
用法
await Page.RunAndWaitForWorkerAsync(action, options);
参数
-
触发事件的操作。
-
optionsPageRunAndWaitForWorkerOptions?(可选)
返回
WaitForWorkerAsync
添加于：v1.9执行操作并等待新的 Worker。如果提供了 predicate，它会将 Worker 值传递给 predicate 函数，并等待 predicate(worker) 返回一个真值。如果页面在 worker 事件触发之前关闭，将抛出错误。
用法
await Page.WaitForWorkerAsync(action, options);
参数
optionsPageRunAndWaitForWorkerOptions?(可选)
返回
ScreenshotAsync
v1.9 之前添加返回包含捕获的屏幕截图的缓冲区。
用法
await Page.ScreenshotAsync(options);
参数
optionsPageScreenshotOptions?(可选)-
Animationsenum ScreenshotAnimations { Disabled, Allow }?(可选)#设置为
"disabled"时，停止 CSS 动画、CSS 过渡和 Web 动画。动画的处理方式因其持续时间而异- 有限动画会快进到完成，因此它们会触发
transitionend事件。 - 无限动画会取消到初始状态，然后在截图后重新播放。
默认为
"allow"，保持动画不变。 - 有限动画会快进到完成，因此它们会触发
-
Caretenum ScreenshotCaret { Hide, Initial }?(可选)#设置为
"hide"时，截图将隐藏文本插入符号。设置为"initial"时，文本插入符号行为不会更改。默认为"hide"。 -
ClipClip? (可选)#-
X[float]裁剪区域左上角的 x 坐标
-
Y[float]裁剪区域左上角的 y 坐标
-
Width[float]裁剪区域的宽度
-
Height[float]裁剪区域的高度
一个指定结果图像裁剪的对象。
-
-
当为 true 时，截取整个可滚动页面的截图，而不是当前可见的视口。默认为
false。 -
MaskIEnumerable?<Locator> (可选)#指定截图时应遮盖的定位器。被遮盖的元素将覆盖一个粉红色方框
#FF00FF（由 MaskColor 自定义），完全覆盖其边界框。遮罩也适用于不可见元素，请参阅 仅匹配可见元素 以禁用此功能。 -
MaskColorstring? (可选)添加于：v1.35#指定遮盖元素的覆盖框颜色，采用 CSS 颜色格式。默认颜色为粉红色
#FF00FF。 -
隐藏默认的白色背景并允许捕获透明截图。不适用于
jpeg图像。默认为false。 -
保存图片的文件夹路径。截图类型将从文件扩展名推断。如果 Path 是相对路径，则它将相对于当前工作目录解析。如果未提供路径，则图像将不会保存到磁盘。
-
图像质量，介于 0-100 之间。不适用于
png图像。 -
Scaleenum ScreenshotScale { Css, Device }?(可选)#当设置为
"css"时，截图的每个 CSS 像素对应一个物理像素。对于高 DPI 设备，这将使截图保持较小。使用"device"选项将为每个设备像素生成一个物理像素，因此高 DPI 设备的截图将是两倍甚至更大。默认为
"device"。 -
在截图时应用的样式表文本。您可以在这里隐藏动态元素，使元素不可见或更改其属性，以帮助您创建可重复的截图。此样式表穿透 Shadow DOM 并应用于内部帧。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。 -
Typeenum ScreenshotType { Png, Jpeg }?(可选)#指定截图类型，默认为
png。
-
返回
SetContentAsync
v1.9 之前添加此方法内部调用 document.write()，继承其所有特定特征和行为。
用法
await Page.SetContentAsync(html, options);
参数
-
要分配给页面的 HTML 标记。
-
optionsPageSetContentOptions?(可选)-
Timeout[float]? (可选)#最大操作时间（毫秒），默认为 30 秒，传入
0以禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。 -
WaitUntilenum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?(可选)#何时认为操作成功，默认为
load。事件可以是以下之一'domcontentloaded'- 当DOMContentLoaded事件触发时，认为操作完成。'load'- 当load事件触发时，认为操作完成。'networkidle'- 不建议 当至少500毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。'commit'- 当收到网络响应且文档开始加载时，认为操作完成。
-
返回
SetDefaultNavigationTimeout
v1.9 之前添加此设置将更改以下方法和相关快捷方式的默认最大导航时间
- Page.GoBackAsync()
- Page.GoForwardAsync()
- Page.GotoAsync()
- Page.ReloadAsync()
- Page.SetContentAsync()
- Page.RunAndWaitForNavigationAsync()
- Page.WaitForURLAsync()
用法
Page.SetDefaultNavigationTimeout(timeout);
参数
-
timeout[float]#最大导航时间（毫秒）
SetDefaultTimeout
v1.9 之前添加此设置将更改所有接受 timeout 选项的方法的默认最大时间。
用法
Page.SetDefaultTimeout(timeout);
参数
-
timeout[float]#最大时间（毫秒）。传入
0禁用超时。
SetExtraHTTPHeadersAsync
v1.9 之前添加额外的 HTTP 头将随页面发起的每个请求一起发送。
Page.SetExtraHTTPHeadersAsync() 不保证传出请求中 headers 的顺序。
用法
await Page.SetExtraHTTPHeadersAsync(headers);
参数
-
headersIDictionary<string, string>#一个包含要随每个请求发送的额外 HTTP 标头的对象。所有标头值必须是字符串。
返回
SetViewportSizeAsync
v1.9 之前添加在一个浏览器中的多个页面，每个页面可以有自己的视口大小。但是，Browser.NewContextAsync() 允许一次性为上下文中所有页面设置视口大小（以及更多）。
Page.SetViewportSizeAsync() 将调整页面大小。许多网站不期望手机改变大小，因此您应该在导航到页面之前设置视口大小。Page.SetViewportSizeAsync() 还会重置 screen 大小，如果您需要更好地控制这些属性，请使用带 screen 和 viewport 参数的 Browser.NewContextAsync()。
用法
var page = await browser.NewPageAsync();
await page.SetViewportSizeAsync(640, 480);
await page.GotoAsync("https://www.microsoft.com");
参数
返回
TitleAsync
v1.9 之前添加返回页面的标题。
用法
await Page.TitleAsync();
返回
UnrouteAsync
v1.9 之前添加删除使用 Page.RouteAsync() 创建的路由。当未指定 handler 时，删除 url 的所有路由。
用法
await Page.UnrouteAsync(url, handler);
参数
返回
UnrouteAllAsync
新增于: v1.41删除所有使用 Page.RouteAsync() 和 Page.RouteFromHARAsync() 创建的路由。
用法
await Page.UnrouteAllAsync(options);
参数
optionsPageUnrouteAllOptions?(可选)-
Behaviorenum UnrouteBehavior { Wait, IgnoreErrors, Default }?(可选)#指定是否等待已运行的处理程序以及如果它们抛出错误该怎么做
'default'- 不等待当前处理程序调用 (如果有) 完成，如果未路由的处理程序抛出错误，可能会导致未处理的错误'wait'- 等待当前处理程序调用 (如果有) 完成'ignoreErrors'- 不等待当前处理程序调用 (如果有) 完成，取消路由后处理程序抛出的所有错误都将被静默捕获
-
返回
Url
v1.9 之前添加用法
Page.Url
返回
Video
v1.9 之前添加与此页面关联的视频对象。
用法
Page.Video
返回
ViewportSize
v1.9 之前添加用法
Page.ViewportSize
返回
WaitForFunctionAsync
v1.9 之前添加当 expression 返回一个真值时返回。它解析为真值的 JSHandle。
用法
Page.WaitForFunctionAsync() 可用于观察视口大小变化。
using Microsoft.Playwright;
using System.Threading.Tasks;
class FrameExamples
{
public static async Task WaitForFunction()
{
using var playwright = await Playwright.CreateAsync();
await using var browser = await playwright.Webkit.LaunchAsync();
var page = await browser.NewPageAsync();
await page.SetViewportSizeAsync(50, 50);
await page.MainFrame.WaitForFunctionAsync("window.innerWidth < 100");
}
}
将参数传递给 Page.WaitForFunctionAsync() 函数的谓词
var selector = ".foo";
await page.WaitForFunctionAsync("selector => !!document.querySelector(selector)", selector);
参数
-
要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
-
argEvaluationArgument? (可选)#要传递给 expression 的可选参数。
-
optionsPageWaitForFunctionOptions?(可选)-
PollingInterval[float]? (可选)#如果指定，则将其视为函数执行的间隔（毫秒）。默认情况下，如果未指定此选项，expression 将在
requestAnimationFrame回调中执行。 -
Timeout[float]? (可选)#最大等待时间（毫秒）。默认为
30000（30 秒）。传递0禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改。
-
返回
WaitForLoadStateAsync
v1.9 之前添加当达到所需加载状态时返回。
当页面达到所需加载状态（默认为 load）时解析。调用此方法时导航必须已提交。如果当前文档已达到所需状态，则立即解析。
大多数情况下，不需要此方法，因为 Playwright 在每次操作前自动等待。
用法
await page.GetByRole(AriaRole.Button).ClickAsync(); // Click triggers navigation.
await page.WaitForLoadStateAsync(); // The promise resolves after 'load' event.
var popup = await page.RunAndWaitForPopupAsync(async () =>
{
await page.GetByRole(AriaRole.Button).ClickAsync(); // click triggers the popup
});
// Wait for the "DOMContentLoaded" event.
await popup.WaitForLoadStateAsync(LoadState.DOMContentLoaded);
Console.WriteLine(await popup.TitleAsync()); // popup is ready to use.
参数
-
stateenum LoadState { Load, DOMContentLoaded, NetworkIdle }?(可选)#要等待的可选加载状态，默认为
load。如果当前文档加载期间已达到该状态，则该方法会立即解析。可以是以下之一'load'- 等待load事件触发。'domcontentloaded'- 等待DOMContentLoaded事件触发。'networkidle'- **不推荐** 等待至少500毫秒内没有网络连接。不要将此方法用于测试，而是依赖 Web 断言来评估准备情况。
-
optionsPageWaitForLoadStateOptions?(可选)-
Timeout[float]? (可选)#最大操作时间（毫秒），默认为 30 秒，传入
0以禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。
-
返回
WaitForURLAsync
添加于：v1.11等待主框架导航到给定 URL。
用法
await page.ClickAsync("a.delayed-navigation"); // clicking the link will indirectly cause a navigation
await page.WaitForURLAsync("**/target.html");
参数
-
urlstring | Regex | Func<string, bool>#用于在等待导航时匹配的 glob 模式、正则表达式模式或接收 URL 的谓词。请注意，如果参数是没有通配符的字符串，该方法将等待导航到与该字符串完全相同的 URL。
-
optionsPageWaitForURLOptions?(可选)-
Timeout[float]? (可选)#最大操作时间（毫秒），默认为 30 秒，传入
0以禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。 -
WaitUntilenum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?(可选)#何时认为操作成功，默认为
load。事件可以是以下之一'domcontentloaded'- 当DOMContentLoaded事件触发时，认为操作完成。'load'- 当load事件触发时，认为操作完成。'networkidle'- 不建议 当至少500毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。'commit'- 当收到网络响应且文档开始加载时，认为操作完成。
-
返回
Workers
v1.9 之前添加此方法返回与页面关联的所有专用 WebWorkers。
这不包含 ServiceWorkers
用法
Page.Workers
返回
属性
APIRequest
添加于：v1.16与此页面关联的 API 测试帮助程序。此方法返回与页面上下文中的 BrowserContext.APIRequest 相同的实例。有关更多详细信息，请参阅 BrowserContext.APIRequest。
用法
Page.APIRequest
类型
Clock
新增于: v1.45Playwright 能够模拟时钟和时间流逝。
用法
Page.Clock
类型
Keyboard
v1.9 之前添加用法
Page.Keyboard
类型
Mouse
v1.9 之前添加用法
Page.Mouse
类型
Touchscreen
v1.9 之前添加用法
Page.Touchscreen
类型
事件
event Close
v1.9 之前添加当页面关闭时发出。
用法
Page.Close += async (_, page) => {};
事件数据
event Console
v1.9 之前添加当页面中的 JavaScript 调用其中一个 console API 方法（例如 console.log 或 console.dir）时触发。
传递到 console.log 的参数可在 ConsoleMessage 事件处理程序参数上获得。
用法
page.Console += async (_, msg) =>
{
foreach (var arg in msg.Args)
Console.WriteLine(await arg.JsonValueAsync<object>());
};
await page.EvaluateAsync("console.log('hello', 5, { foo: 'bar' })");
事件数据
event Crash
v1.9 之前添加当页面崩溃时发出。如果浏览器页面尝试分配过多内存，可能会崩溃。当页面崩溃时，正在进行和后续操作将抛出异常。
处理崩溃最常见的方法是捕获异常
try {
// Crash might happen during a click.
await page.ClickAsync("button");
// Or while waiting for an event.
await page.WaitForPopup();
} catch (PlaywrightException e) {
// When the page crashes, exception message contains "crash".
}
用法
Page.Crash += async (_, page) => {};
事件数据
event Dialog
v1.9 之前添加当出现 JavaScript 对话框时（例如 alert、prompt、confirm 或 beforeunload）触发。监听器**必须** Dialog.AcceptAsync() 或 Dialog.DismissAsync() 对话框 - 否则页面将 冻结 等待对话框，并且点击等操作将永远无法完成。
用法
page.RequestFailed += (_, request) =>
{
Console.WriteLine(request.Url + " " + request.Failure);
};
当没有 Page.Dialog 或 BrowserContext.Dialog 监听器时，所有对话框都会自动关闭。
事件数据
event DOMContentLoaded
添加于：v1.9当 JavaScript DOMContentLoaded 事件被分派时发出。
用法
Page.DOMContentLoaded += async (_, page) => {};
事件数据
event Download
v1.9 之前添加附件下载开始时触发。用户可以通过传入的 Download 实例访问下载内容的基本文件操作。
用法
Page.Download += async (_, download) => {};
事件数据
event FileChooser
添加于：v1.9当文件选择器应该出现时（例如点击 <input type=file> 后）触发。Playwright 可以通过使用 FileChooser.SetFilesAsync() 设置输入文件来响应，之后可以上传文件。
page.FileChooser += (_, fileChooser) =>
{
fileChooser.SetFilesAsync(@"C:\temp\myfile.pdf");
};
用法
Page.FileChooser += async (_, fileChooser) => {};
事件数据
event FrameAttached
添加于：v1.9当框架附加时发出。
用法
Page.FrameAttached += async (_, frame) => {};
事件数据
event FrameDetached
添加于：v1.9当框架分离时发出。
用法
Page.FrameDetached += async (_, frame) => {};
事件数据
event FrameNavigated
添加于：v1.9当框架导航到新的 URL 时发出。
用法
Page.FrameNavigated += async (_, frame) => {};
事件数据
event Load
v1.9 之前添加当 JavaScript load 事件被分派时发出。
用法
Page.Load += async (_, page) => {};
事件数据
event PageError
添加于：v1.9当页面内发生未捕获异常时发出。
// Log all uncaught errors to the terminal
page.PageError += (_, exception) =>
{
Console.WriteLine("Uncaught exception: " + exception);
};
用法
Page.PageError += async (_, value) => {};
事件数据
event Popup
v1.9 之前添加当页面打开新标签页或窗口时触发。此事件除了 BrowserContext.Page 之外还会触发，但仅限于与此页面相关的弹出窗口。
页面可用的最早时刻是它导航到初始 URL 时。例如，当使用 window.open('http://example.com') 打开弹出窗口时，此事件将在对 "http://example.com" 的网络请求完成并且其响应开始在弹出窗口中加载时触发。如果您想路由/监听此网络请求，请使用 BrowserContext.RouteAsync() 和 BrowserContext.Request，而不是 Page 上的类似方法。
var popup = await page.RunAndWaitForPopupAsync(async () =>
{
await page.GetByText("open the popup").ClickAsync();
});
Console.WriteLine(await popup.EvaluateAsync<string>("location.href"));
使用 Page.WaitForLoadStateAsync() 等待页面达到特定状态（在大多数情况下您应该不需要它）。
用法
Page.Popup += async (_, page) => {};
事件数据
event Request
v1.9 之前添加当页面发出请求时触发。request 对象是只读的。要拦截和修改请求，请参阅 Page.RouteAsync() 或 BrowserContext.RouteAsync()。
用法
Page.Request += async (_, request) => {};
事件数据
event RequestFailed
添加于：v1.9当请求失败时发出，例如由于超时。
HTTP 错误响应，例如 404 或 503，从 HTTP 角度来看仍然是成功的响应，因此请求将以 Page.RequestFinished 事件完成，而不是 Page.RequestFailed。只有当客户端无法从服务器获取 HTTP 响应时，例如由于网络错误 net::ERR_FAILED，请求才会被视为失败。
用法
Page.RequestFailed += async (_, request) => {};
事件数据
event RequestFinished
添加于：v1.9当请求成功下载响应体后完成时发出。对于成功的响应，事件序列是 request、response 和 requestfinished。
用法
Page.RequestFinished += async (_, request) => {};
事件数据
event Response
v1.9 之前添加当接收到请求的 response 状态和 headers 时触发。对于成功的响应，事件序列是 request、response 和 requestfinished。
用法
Page.Response += async (_, response) => {};
事件数据
event WebSocket
添加于：v1.9当 WebSocket 请求发送时触发。
用法
Page.WebSocket += async (_, webSocket) => {};
事件数据
event Worker
v1.9 之前添加当页面生成专用 WebWorker 时发出。
用法
Page.Worker += async (_, worker) => {};
事件数据
已弃用
Accessibility
v1.9 之前添加用法
Page.Accessibility
类型
CheckAsync
v1.9 之前添加请改用基于定位器的 Locator.CheckAsync()。阅读有关 定位器 的更多信息。
此方法通过执行以下步骤来检查与 selector 匹配的元素：
- 查找与 selector 匹配的元素。如果没有，则等待匹配元素附加到 DOM。
- 确保匹配的元素是复选框或单选输入。如果不是，此方法将抛出。如果元素已被选中，此方法将立即返回。
- 对匹配元素执行 可操作性 检查，除非设置了 Force 选项。如果在检查期间元素被分离，则整个操作将重试。
- 如果需要，将元素滚动到视图中。
- 使用 Page.Mouse 点击元素的中心。
- 确保元素现在已选中。如果不是，此方法将抛出异常。
当所有步骤在指定的 Timeout 内未完成时，此方法会抛出 TimeoutError。传递零超时会禁用此功能。
用法
await Page.CheckAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageCheckOptions?(可选)-
是否绕过可操作性检查。默认为
false。 -
已弃用
此选项无效。
此选项无效。
-
PositionPosition? (可选)添加于：v1.11#-
X[float] -
Y[float]
相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
-
-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。 -
设置后，此方法仅执行可操作性检查并跳过操作。默认为
false。在不执行操作的情况下等待元素准备好进行操作很有用。
-
返回
ClickAsync
v1.9 之前添加请改用基于定位器的 Locator.ClickAsync()。阅读有关 定位器 的更多信息。
此方法通过执行以下步骤点击与 selector 匹配的元素：
- 查找与 selector 匹配的元素。如果没有，则等待匹配元素附加到 DOM。
- 对匹配元素执行 可操作性 检查，除非设置了 Force 选项。如果在检查期间元素被分离，则整个操作将重试。
- 如果需要，将元素滚动到视图中。
- 使用 Page.Mouse 点击元素的中心，或指定的 Position。
- 等待已启动的导航成功或失败，除非设置了 NoWaitAfter 选项。
当所有步骤在指定的 Timeout 内未完成时，此方法会抛出 TimeoutError。传递零超时会禁用此功能。
用法
await Page.ClickAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageClickOptions?(可选)-
Buttonenum MouseButton { Left, Right, Middle }?(可选)#默认为
left。 -
默认为 1。参见 UIEvent.detail。
-
Delay[float]? (可选)#mousedown和mouseup之间等待的时间（毫秒）。默认为 0。 -
是否绕过可操作性检查。默认为
false。 -
ModifiersIEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#要按下的修饰键。确保在操作期间只按下这些修饰键，然后将当前修饰键恢复。如果未指定，则使用当前按下的修饰键。“ControlOrMeta”在 Windows 和 Linux 上解析为“Control”，在 macOS 上解析为“Meta”。
-
已弃用
此选项将来默认为
true。启动导航的操作会等待这些导航发生并等待页面开始加载。您可以通过设置此标志选择不等待。您仅在导航到不可访问页面等特殊情况下才需要此选项。默认为
false。 -
PositionPosition? (可选)#-
X[float] -
Y[float]
相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
-
-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。 -
设置后，此方法仅执行 可操作性 检查并跳过操作。默认为
false。用于等待元素准备好执行操作而不实际执行。请注意，无论trial如何，都会按下键盘modifiers以允许测试仅在按下这些键时才可见的元素。
-
返回
DblClickAsync
v1.9 之前添加请改用基于定位器的 Locator.DblClickAsync()。阅读有关 定位器 的更多信息。
此方法通过执行以下步骤双击与 selector 匹配的元素：
- 查找与 selector 匹配的元素。如果没有，则等待匹配元素附加到 DOM。
- 对匹配元素执行 可操作性 检查，除非设置了 Force 选项。如果在检查期间元素被分离，则整个操作将重试。
- 如果需要，将元素滚动到视图中。
- 使用 Page.Mouse 双击元素的中心，或指定的 Position。
当所有步骤在指定的 Timeout 内未完成时，此方法会抛出 TimeoutError。传递零超时会禁用此功能。
page.dblclick() 分派两次 click 事件和一次 dblclick 事件。
用法
await Page.DblClickAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageDblClickOptions?(可选)-
Buttonenum MouseButton { Left, Right, Middle }?(可选)#默认为
left。 -
Delay[float]? (可选)#mousedown和mouseup之间等待的时间（毫秒）。默认为 0。 -
是否绕过可操作性检查。默认为
false。 -
ModifiersIEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#要按下的修饰键。确保在操作期间只按下这些修饰键，然后将当前修饰键恢复。如果未指定，则使用当前按下的修饰键。“ControlOrMeta”在 Windows 和 Linux 上解析为“Control”，在 macOS 上解析为“Meta”。
-
已弃用
此选项无效。
此选项无效。
-
PositionPosition? (可选)#-
X[float] -
Y[float]
相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
-
-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。 -
设置后，此方法仅执行 可操作性 检查并跳过操作。默认为
false。用于等待元素准备好执行操作而不实际执行。请注意，无论trial如何，都会按下键盘modifiers以允许测试仅在按下这些键时才可见的元素。
-
返回
DispatchEventAsync
v1.9 之前添加请改用基于定位器的 Locator.DispatchEventAsync()。阅读有关 定位器 的更多信息。
下面的代码片段在元素上分派 click 事件。无论元素的可见性状态如何，都会分派 click 事件。这等同于调用 element.click()。
用法
await page.DispatchEventAsync("button#submit", "click");
在底层，它根据给定的 type 创建事件实例，使用 eventInit 属性对其进行初始化，并在元素上分派。事件默认是 composed、cancelable 和冒泡的。
由于 eventInit 是事件特定的，请参阅事件文档以获取初始属性列表。
- DeviceMotionEvent
- DeviceOrientationEvent
- DragEvent
- Event
- FocusEvent
- KeyboardEvent
- MouseEvent
- PointerEvent
- TouchEvent
- WheelEvent
您还可以指定 JSHandle 作为属性值，如果您希望将实时对象传递到事件中
var dataTransfer = await page.EvaluateHandleAsync("() => new DataTransfer()");
await page.DispatchEventAsync("#source", "dragstart", new { dataTransfer });
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
DOM 事件类型：
"click"、"dragstart"等。 -
eventInitEvaluationArgument? (可选)#可选的事件特定初始化属性。
-
optionsPageDispatchEventOptions?(可选)-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
EvalOnSelectorAsync
添加于：v1.9此方法不等待元素通过可操作性检查，因此可能导致测试不稳定。请改用 Locator.EvaluateAsync()、其他 Locator 辅助方法或 web-first 断言。
此方法在页面中查找与指定选择器匹配的元素，并将其作为第一个参数传递给 expression。如果没有元素与选择器匹配，该方法将抛出错误。返回 expression 的值。
如果 expression 返回一个 Promise，那么 Page.EvalOnSelectorAsync() 将等待 promise 解析并返回其值。
用法
var searchValue = await page.EvalOnSelectorAsync<string>("#search", "el => el.value");
var preloadHref = await page.EvalOnSelectorAsync<string>("link[rel=preload]", "el => el.href");
var html = await page.EvalOnSelectorAsync(".main-container", "(e, suffix) => e.outerHTML + suffix", "hello");
参数
-
要查询的选择器。
-
要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
-
argEvaluationArgument? (可选)#要传递给 expression 的可选参数。
-
optionsPageEvalOnSelectorOptions?(可选)
返回
- [object]#
EvalOnSelectorAllAsync
添加于：v1.9在大多数情况下，Locator.EvaluateAllAsync()、其他 Locator 辅助方法和 web-first 断言做得更好。
此方法在页面中查找与指定选择器匹配的所有元素，并将匹配元素的数组作为第一个参数传递给 expression。返回 expression 调用的结果。
如果 expression 返回一个 Promise，那么 Page.EvalOnSelectorAllAsync() 将等待 promise 解析并返回其值。
用法
var divsCount = await page.EvalOnSelectorAllAsync<bool>("div", "(divs, min) => divs.length >= min", 10);
参数
-
要查询的选择器。
-
要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
-
argEvaluationArgument? (可选)#要传递给 expression 的可选参数。
返回
- [object]#
FillAsync
v1.9 之前添加请改用基于定位器的 Locator.FillAsync()。阅读有关 定位器 的更多信息。
此方法等待与 selector 匹配的元素，等待 可操作性 检查，聚焦元素，填充它并在填充后触发 input 事件。请注意，您可以传入空字符串以清除输入字段。
如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，此方法将抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内，则将填充该控件。
要发送细粒度的键盘事件，请使用 Locator.PressSequentiallyAsync()。
用法
await Page.FillAsync(selector, value, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
要填充
<input>、<textarea>或[contenteditable]元素的值。 -
optionsPageFillOptions?(可选)-
是否绕过可操作性检查。默认为
false。 -
已弃用
此选项无效。
此选项无效。
-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
FocusAsync
v1.9 之前添加请改用基于定位器的 Locator.FocusAsync()。阅读有关 定位器 的更多信息。
此方法获取具有 selector 的元素并将其聚焦。如果没有与 selector 匹配的元素，该方法将等待直到 DOM 中出现匹配元素。
用法
await Page.FocusAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageFocusOptions?(可选)-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
GetAttributeAsync
v1.9 之前添加请改用基于定位器的 Locator.GetAttributeAsync()。阅读有关 定位器 的更多信息。
返回元素属性值。
用法
await Page.GetAttributeAsync(selector, name, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
要获取值的属性名称。
-
optionsPageGetAttributeOptions?(可选)-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
HoverAsync
v1.9 之前添加请改用基于定位器的 Locator.HoverAsync()。阅读有关 定位器 的更多信息。
此方法通过执行以下步骤将鼠标悬停在与 selector 匹配的元素上：
- 查找与 selector 匹配的元素。如果没有，则等待匹配元素附加到 DOM。
- 对匹配元素执行 可操作性 检查，除非设置了 Force 选项。如果在检查期间元素被分离，则整个操作将重试。
- 如果需要，将元素滚动到视图中。
- 使用 Page.Mouse 将鼠标悬停在元素的中心，或指定的 Position。
当所有步骤在指定的 Timeout 内未完成时，此方法会抛出 TimeoutError。传递零超时会禁用此功能。
用法
await Page.HoverAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageHoverOptions?(可选)-
是否绕过可操作性检查。默认为
false。 -
ModifiersIEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#要按下的修饰键。确保在操作期间只按下这些修饰键，然后将当前修饰键恢复。如果未指定，则使用当前按下的修饰键。“ControlOrMeta”在 Windows 和 Linux 上解析为“Control”，在 macOS 上解析为“Meta”。
-
NoWaitAfterbool? (可选)新增于: v1.28#已弃用此选项无效。
此选项无效。
-
PositionPosition? (可选)#-
X[float] -
Y[float]
相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
-
-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。 -
设置后，此方法仅执行 可操作性 检查并跳过操作。默认为
false。用于等待元素准备好执行操作而不实际执行。请注意，无论trial如何，都会按下键盘modifiers以允许测试仅在按下这些键时才可见的元素。
-
返回
InnerHTMLAsync
v1.9 之前添加请改用基于定位器的 Locator.InnerHTMLAsync()。阅读有关 定位器 的更多信息。
返回 element.innerHTML。
用法
await Page.InnerHTMLAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageInnerHTMLOptions?(可选)-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
InnerTextAsync
v1.9 之前添加请改用基于定位器的 Locator.InnerTextAsync()。阅读有关 定位器 的更多信息。
返回 element.innerText。
用法
await Page.InnerTextAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageInnerTextOptions?(可选)-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
InputValueAsync
添加于：v1.13请改用基于定位器的 Locator.InputValueAsync()。阅读有关 定位器 的更多信息。
返回选定的 <input>、<textarea> 或 <select> 元素的 input.value。
对于非输入元素抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内，则返回控件的值。
用法
await Page.InputValueAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageInputValueOptions?(可选)-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
IsCheckedAsync
v1.9 之前添加请改用基于定位器的 Locator.IsCheckedAsync()。阅读有关 定位器 的更多信息。
返回元素是否已选中。如果元素不是复选框或单选输入，则抛出异常。
用法
await Page.IsCheckedAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageIsCheckedOptions?(可选)-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
IsDisabledAsync
v1.9 之前添加请改用基于定位器的 Locator.IsDisabledAsync()。阅读有关 定位器 的更多信息。
返回元素是否已禁用，与 enabled 相反。
用法
await Page.IsDisabledAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageIsDisabledOptions?(可选)-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
IsEditableAsync
v1.9 之前添加请改用基于定位器的 Locator.IsEditableAsync()。阅读有关 定位器 的更多信息。
返回元素是否 可编辑。
用法
await Page.IsEditableAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageIsEditableOptions?(可选)-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
IsEnabledAsync
v1.9 之前添加请改用基于定位器的 Locator.IsEnabledAsync()。阅读有关 定位器 的更多信息。
返回元素是否 已启用。
用法
await Page.IsEnabledAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageIsEnabledOptions?(可选)-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
IsHiddenAsync
v1.9 之前添加请改用基于定位器的 Locator.IsHiddenAsync()。阅读有关 定位器 的更多信息。
返回元素是否隐藏，与 可见 相反。不匹配任何元素的 selector 被认为是隐藏的。
用法
await Page.IsHiddenAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageIsHiddenOptions?(可选)-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#已弃用此选项被忽略。Page.IsHiddenAsync() 不会等待元素变为隐藏并立即返回。
-
返回
IsVisibleAsync
v1.9 之前添加请改用基于定位符的 Locator.IsVisibleAsync()。了解更多关于定位符的信息。
用法
await Page.IsVisibleAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageIsVisibleOptions?(可选)-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#已弃用此选项被忽略。Page.IsVisibleAsync() 不会等待元素变为可见，并立即返回。
-
返回
PressAsync
v1.9 之前添加请改用基于定位符的 Locator.PressAsync()。了解更多关于定位符的信息。
聚焦元素，然后使用 Keyboard.DownAsync() 和 Keyboard.UpAsync()。
key 可以指定预期的 keyboardEvent.key 值或生成文本的单个字符。key 值的一个超集可以在这里找到。按键示例包括
F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, 等。
还支持以下修饰符快捷键：Shift, Control, Alt, Meta, ShiftLeft, ControlOrMeta。ControlOrMeta 在 Windows 和 Linux 上解析为 Control，在 macOS 上解析为 Meta。
按住 Shift 将输入与 key 对应的大写文本。
如果 key 是一个单字符，它区分大小写，因此值 a 和 A 将生成不同的相应文本。
也支持快捷键，例如 key: "Control+o"、key: "Control++ 或 key: "Control+Shift+T"。当与修饰符一起指定时，修饰符在按下后续键时被按下并保持。
用法
var page = await browser.NewPageAsync();
await page.GotoAsync("https://keycode.info");
await page.PressAsync("body", "A");
await page.ScreenshotAsync(new() { Path = "A.png" });
await page.PressAsync("body", "ArrowLeft");
await page.ScreenshotAsync(new() { Path = "ArrowLeft.png" });
await page.PressAsync("body", "Shift+O");
await page.ScreenshotAsync(new() { Path = "O.png" });
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
要按下的键的名称或要生成的字符，例如
ArrowLeft或a。 -
optionsPagePressOptions?(可选)-
Delay[float]? (可选)#keydown和keyup之间等待的时间（毫秒）。默认为 0。 -
已弃用
此选项将来默认为
true。启动导航的操作会等待这些导航发生并等待页面开始加载。您可以通过设置此标志选择不等待。您仅在导航到不可访问页面等特殊情况下才需要此选项。默认为
false。 -
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
QuerySelectorAsync
添加于：v1.9请改用基于定位符的 Page.Locator()。了解更多关于定位符的信息。
此方法在页面内查找匹配指定选择器的元素。如果没有元素匹配选择器，返回值解析为 null。要等待页面上的元素，请使用 Locator.WaitForAsync()。
用法
await Page.QuerySelectorAsync(selector, options);
参数
-
要查询的选择器。
-
optionsPageQuerySelectorOptions?(可选)
返回
QuerySelectorAllAsync
添加于：v1.9请改用基于定位符的 Page.Locator()。了解更多关于定位符的信息。
此方法在页面中查找与指定选择器匹配的所有元素。如果没有元素匹配选择器，返回值解析为 []。
用法
await Page.QuerySelectorAllAsync(selector);
参数
返回
RunAndWaitForNavigationAsync
v1.9 之前添加此方法本质上存在竞态条件，请改用 Page.WaitForURLAsync()。
等待主框架导航并返回主资源响应。如果存在多个重定向，导航将解析为最后一次重定向的响应。如果导航到不同的锚点或由于 History API 使用而导航，导航将解析为 null。
用法
当页面导航到新 URL 或重新加载时，此方法解析。当您运行间接导致页面导航的代码时，它很有用。例如，点击目标有一个 onclick 处理程序，该处理程序通过 setTimeout 触发导航。请考虑以下示例
await page.RunAndWaitForNavigationAsync(async () =>
{
// This action triggers the navigation after a timeout.
await page.GetByText("Navigate after timeout").ClickAsync();
});
// The method continues after navigation has finished
使用 History API 更改 URL 被视为导航。
参数
-
触发事件的操作。
-
optionsPageRunAndWaitForNavigationOptions?(可选)-
Timeout[float]? (可选)#最大操作时间（毫秒），默认为 30 秒，传入
0以禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。 -
Url|UrlRegex|UrlFuncstring? | Regex? | Func<string?, bool> (可选)#用于在等待导航时匹配的 glob 模式、正则表达式模式或接收 URL 的谓词。请注意，如果参数是没有通配符的字符串，该方法将等待导航到与该字符串完全相同的 URL。
-
WaitUntilenum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?(可选)#何时认为操作成功，默认为
load。事件可以是以下之一'domcontentloaded'- 当DOMContentLoaded事件触发时，认为操作完成。'load'- 当load事件触发时，认为操作完成。'networkidle'- 不建议 当至少500毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。'commit'- 当收到网络响应且文档开始加载时，认为操作完成。
-
返回
WaitForNavigationAsync
v1.9 之前添加此方法本质上存在竞态条件，请改用 Page.WaitForURLAsync()。
等待主框架导航并返回主资源响应。如果存在多个重定向，导航将解析为最后一次重定向的响应。如果导航到不同的锚点或由于 History API 使用而导航，导航将解析为 null。
用法
当页面导航到新 URL 或重新加载时，此方法解析。当您运行间接导致页面导航的代码时，它很有用。例如，点击目标有一个 onclick 处理程序，该处理程序通过 setTimeout 触发导航。请考虑以下示例
await page.RunAndWaitForNavigationAsync(async () =>
{
// This action triggers the navigation after a timeout.
await page.GetByText("Navigate after timeout").ClickAsync();
});
// The method continues after navigation has finished
使用 History API 更改 URL 被视为导航。
参数
optionsPageRunAndWaitForNavigationOptions?(可选)-
Timeout[float]? (可选)#最大操作时间（毫秒），默认为 30 秒，传入
0以禁用超时。默认值可以通过 BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout() 或 Page.SetDefaultTimeout() 方法更改。 -
Url|UrlRegex|UrlFuncstring? | Regex? | Func<string?, bool> (可选)#用于在等待导航时匹配的 glob 模式、正则表达式模式或接收 URL 的谓词。请注意，如果参数是没有通配符的字符串，该方法将等待导航到与该字符串完全相同的 URL。
-
WaitUntilenum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }?(可选)#何时认为操作成功，默认为
load。事件可以是以下之一'domcontentloaded'- 当DOMContentLoaded事件触发时，认为操作完成。'load'- 当load事件触发时，认为操作完成。'networkidle'- 不建议 当至少500毫秒内没有网络连接时，认为操作完成。不要使用此方法进行测试，请改用 Web 断言来评估准备情况。'commit'- 当收到网络响应且文档开始加载时，认为操作完成。
-
返回
SelectOptionAsync
v1.9 之前添加请改用基于定位符的 Locator.SelectOptionAsync()。了解更多关于定位符的信息。
此方法等待匹配 selector 的元素，执行可操作性检查，等待所有指定的选项出现在 <select> 元素中，然后选择这些选项。
如果目标元素不是 <select> 元素，此方法将抛出错误。但是，如果元素位于具有关联控件的 <label> 元素内，则将改用该控件。
返回已成功选择的选项值数组。
一旦所有提供的选项都已选中，将触发 change 和 input 事件。
用法
// Single selection matching the value or label
await page.SelectOptionAsync("select#colors", new[] { "blue" });
// single selection matching both the value and the label
await page.SelectOptionAsync("select#colors", new[] { new SelectOptionValue() { Label = "blue" } });
// multiple
await page.SelectOptionAsync("select#colors", new[] { "red", "green", "blue" });
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
valuesstring | ElementHandle | IEnumerable |SelectOption| IEnumerable | IEnumerable?#-
Valuestring? (可选)按
option.value匹配。可选。 -
Labelstring? (可选)按
option.label匹配。可选。 -
Indexint? (可选)按索引匹配。可选。
要选择的选项。如果
<select>具有multiple属性，则选择所有匹配的选项，否则只选择与传入选项之一匹配的第一个选项。字符串值同时匹配值和标签。如果所有指定的属性都匹配，则选项被认为是匹配的。 -
-
optionsPageSelectOptionOptions?(可选)-
是否绕过可操作性检查。默认为
false。 -
已弃用
此选项无效。
此选项无效。
-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
SetCheckedAsync
新增于: v1.15请改用基于定位符的 Locator.SetCheckedAsync()。了解更多关于定位符的信息。
此方法通过执行以下步骤来选中或取消选中匹配 selector 的元素：
- 查找匹配 selector 的元素。如果没有，则等待匹配元素附加到 DOM。
- 确保匹配的元素是复选框或单选输入。如果不是，此方法将抛出错误。
- 如果元素已经处于正确的选中状态，此方法将立即返回。
- 对匹配的元素执行可操作性检查，除非设置了 Force 选项。如果在检查期间元素被分离，整个操作将重试。
- 如果需要，将元素滚动到视图中。
- 使用 Page.Mouse 点击元素的中心。
- 确保元素现在已选中或未选中。如果不是，此方法将抛出异常。
如果在指定的 Timeout 内所有步骤未完成，此方法将抛出 TimeoutError。传递零超时将禁用此功能。
用法
await Page.SetCheckedAsync(selector, checked, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
是否选中或取消选中复选框。
-
optionsPageSetCheckedOptions?(可选)-
是否绕过可操作性检查。默认为
false。 -
已弃用
此选项无效。
此选项无效。
-
PositionPosition? (可选)#-
X[float] -
Y[float]
相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
-
-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。 -
设置后，此方法仅执行可操作性检查并跳过操作。默认为
false。在不执行操作的情况下等待元素准备好进行操作很有用。
-
返回
SetInputFilesAsync
v1.9 之前添加请改用基于定位符的 Locator.SetInputFilesAsync()。了解更多关于定位符的信息。
将文件输入的值设置为这些文件路径或文件。如果某些 filePaths 是相对路径，则它们相对于当前工作目录解析。对于空数组，清除选定的文件。对于具有 [webkitdirectory] 属性的输入，只支持单个目录路径。
此方法期望 selector 指向一个 input 元素。但是，如果元素位于具有关联控件的 <label> 元素内，则会改为针对该控件。
用法
await Page.SetInputFilesAsync(selector, files, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
filesstring | IEnumerable<string> |FilePayload| IEnumerable<FilePayload># -
optionsPageSetInputFilesOptions?(可选)-
已弃用
此选项无效。
此选项无效。
-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
TapAsync
v1.9 之前添加请改用基于定位符的 Locator.TapAsync()。了解更多关于定位符的信息。
此方法通过执行以下步骤来点击匹配 selector 的元素：
- 查找匹配 selector 的元素。如果没有，则等待匹配元素附加到 DOM。
- 对匹配的元素执行可操作性检查，除非设置了 Force 选项。如果在检查期间元素被分离，整个操作将重试。
- 如果需要，将元素滚动到视图中。
- 使用 Page.Touchscreen 点击元素的中心，或指定的 Position。
如果在指定的 Timeout 内所有步骤未完成，此方法将抛出 TimeoutError。传递零超时将禁用此功能。
如果浏览器上下文的 HasTouch 选项为 false，Page.TapAsync() 方法将抛出异常。
用法
await Page.TapAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageTapOptions?(可选)-
是否绕过可操作性检查。默认为
false。 -
ModifiersIEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#要按下的修饰键。确保在操作期间只按下这些修饰键，然后将当前修饰键恢复。如果未指定，则使用当前按下的修饰键。“ControlOrMeta”在 Windows 和 Linux 上解析为“Control”，在 macOS 上解析为“Meta”。
-
已弃用
此选项无效。
此选项无效。
-
PositionPosition? (可选)#-
X[float] -
Y[float]
相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
-
-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。 -
设置后，此方法仅执行 可操作性 检查并跳过操作。默认为
false。用于等待元素准备好执行操作而不实际执行。请注意，无论trial如何，都会按下键盘modifiers以允许测试仅在按下这些键时才可见的元素。
-
返回
TextContentAsync
v1.9 之前添加请改用基于定位符的 Locator.TextContentAsync()。了解更多关于定位符的信息。
返回 element.textContent。
用法
await Page.TextContentAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageTextContentOptions?(可选)-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
TypeAsync
v1.9 之前添加在大多数情况下，您应该改用 Locator.FillAsync()。只有在页面上有特殊的键盘处理时才需要逐个按键——在这种情况下，请使用 Locator.PressSequentiallyAsync()。
为文本中的每个字符发送一个 keydown、keypress/input 和 keyup 事件。page.type 可用于发送细粒度的键盘事件。要填充表单字段中的值，请使用 Page.FillAsync()。
要按特殊键，例如 Control 或 ArrowDown，请使用 Keyboard.PressAsync()。
用法
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
要输入到聚焦元素的文本。
-
optionsPageTypeOptions?(可选)-
Delay[float]? (可选)#按键之间等待的时间，以毫秒为单位。默认为 0。
-
已弃用
此选项无效。
此选项无效。
-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
UncheckAsync
v1.9 之前添加请改用基于定位符的 Locator.UncheckAsync()。了解更多关于定位符的信息。
此方法通过执行以下步骤来取消选中匹配 selector 的元素：
- 查找匹配 selector 的元素。如果没有，则等待匹配元素附加到 DOM。
- 确保匹配的元素是复选框或单选输入。如果不是，此方法将抛出错误。如果元素已取消选中，此方法会立即返回。
- 对匹配的元素执行可操作性检查，除非设置了 Force 选项。如果在检查期间元素被分离，整个操作将重试。
- 如果需要，将元素滚动到视图中。
- 使用 Page.Mouse 点击元素的中心。
- 确保元素现在未选中。如果不是，此方法将抛出异常。
如果在指定的 Timeout 内所有步骤未完成，此方法将抛出 TimeoutError。传递零超时将禁用此功能。
用法
await Page.UncheckAsync(selector, options);
参数
-
用于搜索元素的选取器。如果有多个元素满足选取器，则使用第一个。
-
optionsPageUncheckOptions?(可选)-
是否绕过可操作性检查。默认为
false。 -
已弃用
此选项无效。
此选项无效。
-
PositionPosition? (可选)添加于：v1.11#-
X[float] -
Y[float]
相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
-
-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。 -
设置后，此方法仅执行可操作性检查并跳过操作。默认为
false。在不执行操作的情况下等待元素准备好进行操作很有用。
-
返回
WaitForSelectorAsync
v1.9 之前添加请改用断言可见性的 Web 断言或基于定位符的 Locator.WaitForAsync()。了解更多关于定位符的信息。
当由选择器指定的元素满足 State 选项时返回。如果等待 hidden 或 detached，则返回 null。
Playwright 在执行操作之前会自动等待元素准备就绪。使用 Locator 对象和 Web 优先断言可以使代码摆脱 wait-for-selector 的限制。
等待 selector 满足 State 选项（出现/从 DOM 消失，或变为可见/隐藏）。如果在调用方法时 selector 已经满足条件，该方法将立即返回。如果选择器在 Timeout 毫秒内不满足条件，该函数将抛出异常。
用法
此方法适用于跨导航
using Microsoft.Playwright;
using System;
using System.Threading.Tasks;
class FrameExamples
{
public static async Task Images()
{
using var playwright = await Playwright.CreateAsync();
await using var browser = await playwright.Chromium.LaunchAsync();
var page = await browser.NewPageAsync();
foreach (var currentUrl in new[] { "https://www.google.com", "https://bbc.com" })
{
await page.GotoAsync(currentUrl);
var element = await page.WaitForSelectorAsync("img");
Console.WriteLine($"Loaded image: {await element.GetAttributeAsync("src")}");
}
await browser.CloseAsync();
}
}
参数
-
要查询的选择器。
-
optionsPageWaitForSelectorOptions?(可选)-
Stateenum WaitForSelectorState { Attached, Detached, Visible, Hidden }?(可选)#默认为
'visible'。可以是以下之一：'attached'- 等待元素出现在 DOM 中。'detached'- 等待元素不在 DOM 中。'visible'- 等待元素具有非空的边界框且没有visibility:hidden。请注意，没有任何内容或具有display:none的元素具有空的边界框，不被视为可见。'hidden'- 等待元素从 DOM 中分离，或具有空的边界框或visibility:hidden。这与'visible'选项相反。
-
如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
-
Timeout[float]? (可选)#最大时间（毫秒）。默认为
30000（30 秒）。传入0以禁用超时。可以使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
-
返回
WaitForTimeoutAsync
v1.9 之前添加在生产环境中切勿等待超时。等待时间的测试本质上是不可靠的。请使用自动等待的 定位符 操作和 Web 断言。
等待给定 timeout 毫秒。
请注意，page.waitForTimeout() 仅应用于调试。在生产环境中使用定时器的测试将会变得不稳定。请改用网络事件、选择器可见性等信号。
用法
// Wait for 1 second
await page.WaitForTimeoutAsync(1000);
参数
-
timeout[float]#要等待的超时时间。
返回