ElementHandle

继承自: JSHandle

ElementHandle 表示页内的 DOM 元素。可以通过 Page.QuerySelectorAsync() 方法创建 ElementHandle。

不推荐

不建议使用 ElementHandle，请使用 Locator 对象和 web 优先的断言（web-first assertions）。

var handle = await page.QuerySelectorAsync("a");
await handle.ClickAsync();

ElementHandle 会阻止 DOM 元素被垃圾回收，除非使用 JsHandle.DisposeAsync() 释放句柄。当所属的帧（frame）导航时，ElementHandle 会自动释放。

ElementHandle 实例可用作 Page.EvalOnSelectorAsync() 和 Page.EvaluateAsync() 方法的参数。

Locator 和 ElementHandle 的区别在于：ElementHandle 指向一个特定的元素，而 Locator 捕获了如何获取元素的逻辑。

在下面的示例中，handle 指向页面上一个特定的 DOM 元素。如果该元素更改文本或被 React 用于渲染一个完全不同的组件，handle 仍然指向该 DOM 元素。这可能导致意外的行为。

var handle = await page.QuerySelectorAsync("text=Submit");
await handle.HoverAsync();
await handle.ClickAsync();

使用 locator，每次使用 element 时，都会使用选择器在页面中定位最新的 DOM 元素。因此在下面的代码片段中，底层 DOM 元素将被定位两次。

var locator = page.GetByText("Submit");
await locator.HoverAsync();
await locator.ClickAsync();

方法

BoundingBoxAsync

v1.9 之前添加

elementHandle.BoundingBoxAsync

此方法返回元素的边界框，如果元素不可见，则返回 null。边界框是相对于主帧视口计算的，主帧视口通常与浏览器窗口相同。

滚动会影响返回的边界框，类似于 Element.getBoundingClientRect。这意味着 x 和/或 y 可能是负数。

与 Element.getBoundingClientRect 不同，来自子框架的元素返回的是相对于主框架的边界框。

假设页面是静态的，使用边界框坐标执行输入是安全的。例如，以下代码片段应该单击元素的中心。

用法

var box = await elementHandle.BoundingBoxAsync();
await page.Mouse.ClickAsync(box.X + box.Width / 2, box.Y + box.Height / 2);

BoundingBox?#
- x [float]
  
  元素的 x 坐标（以像素为单位）。
- y [float]
  
  元素的 y 坐标（以像素为单位）。
- width [float]
  
  元素的宽度（以像素为单位）。
- height [float]
  
  元素的高度（以像素为单位）。

ContentFrameAsync

v1.9 之前添加

elementHandle.ContentFrameAsync

对于引用 iframe 节点的元素句柄，返回内容帧，否则返回 null。

用法

await ElementHandle.ContentFrameAsync();

Frame?#

OwnerFrameAsync

v1.9 之前添加

elementHandle.OwnerFrameAsync

返回包含给定元素的帧。

用法

await ElementHandle.OwnerFrameAsync();

Frame?#

WaitForElementStateAsync

v1.9 之前添加

elementHandle.WaitForElementStateAsync

当元素满足 state 时返回。

根据 state 参数，此方法会等待其中一个可操作性（actionability）检查通过。除非正在等待 "hidden" 状态，否则如果在等待时元素被分离，此方法会抛出异常。

"visible" 等待元素可见。
"hidden" 等待元素不可见或从 DOM 分离。注意，等待 hidden 时，如果元素被分离不会抛出异常。
"stable" 等待元素既可见且稳定。
"enabled" 等待元素启用。
"disabled" 等待元素未启用。
"editable" 等待元素可编辑。

如果元素在 Timeout 毫秒内未满足条件，此方法将抛出异常。

用法

await ElementHandle.WaitForElementStateAsync(state, options);

参数

state enum ElementState { Visible, Hidden, Stable, Enabled, Disabled, Editable }#

要等待的状态，更多详情见下文。
options ElementHandleWaitForElementStateOptions? (可选)
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

void #

已弃用

CheckAsync

v1.9 之前添加

elementHandle.CheckAsync

不推荐

请改用基于定位器的 Locator.CheckAsync()。详细了解定位器。

此方法通过执行以下步骤检查元素

确保元素是复选框或单选输入。如果不是，此方法将抛出异常。如果元素已选中，此方法将立即返回。
对元素进行可操作性检查，除非设置了 Force 选项。
如果需要，将元素滚动到视图中。
使用 Page.Mouse 点击元素中心。
确保元素现在已选中。如果不是，此方法将抛出异常。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤合并计算的时间超过指定的 Timeout 时，此方法会抛出 TimeoutError。传入零超时将禁用此机制。

用法

await ElementHandle.CheckAsync(options);

参数

options ElementHandleCheckOptions? (可选)
- Force bool? (可选)#
  
  是否跳过可操作性检查。默认为 false。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position? (可选)添加于：v1.11#
  - X [float]
  - Y [float]
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。
- Trial bool? (可选)添加于：v1.11#
  
  设置此项后，该方法仅执行可操作性检查并跳过实际操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

void #

ClickAsync

v1.9 之前添加

elementHandle.ClickAsync

不推荐

请改用基于定位器的 Locator.ClickAsync()。详细了解定位器。

此方法通过执行以下步骤单击元素

对元素进行可操作性检查，除非设置了 Force 选项。
如果需要，将元素滚动到视图中。
使用 Page.Mouse 点击元素中心或指定的 Position。
等待发起的导航成功或失败，除非设置了 NoWaitAfter 选项。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤合并计算的时间超过指定的 Timeout 时，此方法会抛出 TimeoutError。传入零超时将禁用此机制。

用法

await ElementHandle.ClickAsync(options);

参数

options ElementHandleClickOptions? (可选)
- Button enum MouseButton { Left, Right, Middle }? (可选)#
  
  默认为 left。
- ClickCount int? (可选)#
  
  默认为 1。参见 UIEvent.detail。
- Delay [float]? (可选)#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 0。
- Force bool? (可选)#
  
  是否跳过可操作性检查。默认为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#
  
  要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项将来默认为 true。
  
  发起导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志来选择退出等待。您只有在例外情况下才需要此选项，例如导航到无法访问的页面。默认为 false。
- Position Position? (可选)#
  - X [float]
  - Y [float]
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- Steps int? (可选)Added in: v1.57#
  
  默认为 1。发送 n 个插值过的 mousemove 事件，以表示从 Playwright 当前光标位置到目标位置的移动。当设置为 1 时，将发出一个到达目标位置的 mousemove 事件。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。
- Trial bool? (可选)添加于：v1.11#
  
  设置此项后，该方法仅执行可操作性检查并跳过实际操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

void #

DblClickAsync

v1.9 之前添加

elementHandle.DblClickAsync

不推荐

请改用基于定位器的 Locator.DblClickAsync()。详细了解定位器。

此方法通过执行以下步骤双击元素

对元素进行可操作性检查，除非设置了 Force 选项。
如果需要，将元素滚动到视图中。
使用 Page.Mouse 双击元素中心或指定的 Position。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤合并计算的时间超过指定的 Timeout 时，此方法会抛出 TimeoutError。传入零超时将禁用此机制。

注意

elementHandle.dblclick() 会分派两次 click 事件和一次 dblclick 事件。

用法

await ElementHandle.DblClickAsync(options);

参数

options ElementHandleDblClickOptions? (可选)
- Button enum MouseButton { Left, Right, Middle }? (可选)#
  
  默认为 left。
- Delay [float]? (可选)#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 0。
- Force bool? (可选)#
  
  是否跳过可操作性检查。默认为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#
  
  要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position? (可选)#
  - X [float]
  - Y [float]
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- Steps int? (可选)Added in: v1.57#
  
  默认为 1。发送 n 个插值过的 mousemove 事件，以表示从 Playwright 当前光标位置到目标位置的移动。当设置为 1 时，将发出一个到达目标位置的 mousemove 事件。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。
- Trial bool? (可选)添加于：v1.11#
  
  设置此项后，该方法仅执行可操作性检查并跳过实际操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

void #

DispatchEventAsync

v1.9 之前添加

elementHandle.DispatchEventAsync

不推荐

请改用基于定位器的 Locator.DispatchEventAsync()。详细了解定位器。

下面的代码片段在元素上分发 click 事件。无论元素的可见性状态如何，click 事件都会被分发。这等同于调用 element.click()。

用法

await elementHandle.DispatchEventAsync("click");

底层实现中，它会根据给定的 type 创建一个事件实例，使用 eventInit 属性对其进行初始化，并在该元素上触发此事件。事件默认是 composed（组合）、cancelable（可取消）且冒泡的。

由于 eventInit 是特定于事件的，请参阅事件文档以获取初始属性列表。

您还可以指定 JSHandle 作为属性值，如果您希望将实时对象传递到事件中

var dataTransfer = await page.EvaluateHandleAsync("() => new DataTransfer()");
await elementHandle.DispatchEventAsync("dragstart", new Dictionary<string, object>
{
    { "dataTransfer", dataTransfer }
});

参数

type string #

DOM 事件类型："click"、"dragstart" 等。
eventInit EvaluationArgument? (可选)#

可选的事件特定初始化属性。

void #

EvalOnSelectorAsync

添加于：v1.9

elementHandle.EvalOnSelectorAsync

不推荐

此方法不会等待元素通过可操作性检查，因此可能导致测试不稳定。建议改用 Locator.EvaluateAsync()、其他 Locator 辅助方法或 web 优先的断言。

返回 expression 的返回值。

该方法会在 ElementHandle 的子树中查找与指定选择器匹配的元素，并将其作为第一个参数传递给 expression。如果没有元素匹配选择器，该方法将抛出错误。

如果 expression 返回一个 Promise，那么 ElementHandle.EvalOnSelectorAsync() 将等待该 Promise 解析并返回其值。

用法

var tweetHandle = await page.QuerySelectorAsync(".tweet");
Assert.AreEqual("100", await tweetHandle.EvalOnSelectorAsync(".like", "node => node.innerText"));
Assert.AreEqual("10", await tweetHandle.EvalOnSelectorAsync(".retweets", "node => node.innerText"));

参数

selector string #

要查询的选择器。
expression string #

要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
arg EvaluationArgument? (可选)#

传递给 expression 的可选参数。

[object]#

EvalOnSelectorAllAsync

添加于：v1.9

elementHandle.EvalOnSelectorAllAsync

不推荐

在大多数情况下，Locator.EvaluateAllAsync()、其他 Locator 辅助方法和基于 Web 的优先断言做得更好。

返回 expression 的返回值。

该方法会在 ElementHandle 的子树中查找所有与指定选择器匹配的元素，并将匹配元素的数组作为第一个参数传递给 expression。

如果 expression 返回一个 Promise，那么 ElementHandle.EvalOnSelectorAllAsync() 将等待该 Promise 解析并返回其值。

用法

<div class="feed">
  <div class="tweet">Hello!</div>
  <div class="tweet">Hi!</div>
</div>

var feedHandle = await page.QuerySelectorAsync(".feed");
Assert.AreEqual(new [] { "Hello!", "Hi!" }, await feedHandle.EvalOnSelectorAllAsync<string[]>(".tweet", "nodes => nodes.map(n => n.innerText)"));

参数

selector string #

要查询的选择器。
expression string #

要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
arg EvaluationArgument? (可选)#

传递给 expression 的可选参数。

[object]#

FillAsync

v1.9 之前添加

elementHandle.FillAsync

不推荐

请改用基于定位器的 Locator.FillAsync()。详细了解定位器。

此方法等待可操作性检查，聚焦元素，填充内容，并在填充后触发 input 事件。注意，传入空字符串可清除输入框。

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，此方法将抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内，则会填入该关联的控件。

要发送精细的键盘事件，请使用 Locator.PressSequentiallyAsync()。

用法

await ElementHandle.FillAsync(value, options);

参数

value string #

要为 <input>、<textarea> 或 [contenteditable] 元素设置的值。
options ElementHandleFillOptions? (可选)
- Force bool? (可选)添加于：v1.13#
  
  是否跳过可操作性检查。默认为 false。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

void #

FocusAsync

v1.9 之前添加

elementHandle.FocusAsync

不推荐

请改用基于定位器的 Locator.FocusAsync()。详细了解定位器。

调用元素上的 focus 方法。

用法

await ElementHandle.FocusAsync();

void #

GetAttributeAsync

v1.9 之前添加

elementHandle.GetAttributeAsync

不推荐

请改用基于定位器的 Locator.GetAttributeAsync()。详细了解定位器。

返回元素属性值。

用法

await ElementHandle.GetAttributeAsync(name);

参数

name string #

要获取值的属性名称。

string?#

HoverAsync

v1.9 之前添加

elementHandle.HoverAsync

不推荐

请改用基于定位器的 Locator.HoverAsync()。详细了解定位器。

此方法通过执行以下步骤将鼠标悬停在元素上

对元素进行可操作性检查，除非设置了 Force 选项。
如果需要，将元素滚动到视图中。
使用 Page.Mouse 悬停在元素中心或指定的 Position 上。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤合并计算的时间超过指定的 Timeout 时，此方法会抛出 TimeoutError。传入零超时将禁用此机制。

用法

await ElementHandle.HoverAsync(options);

参数

options ElementHandleHoverOptions? (可选)
- Force bool? (可选)#
  
  是否跳过可操作性检查。默认为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#
  
  要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- NoWaitAfter bool? (可选)新增于: v1.28#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position? (可选)#
  - X [float]
  - Y [float]
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。
- Trial bool? (可选)添加于：v1.11#
  
  设置此项后，该方法仅执行可操作性检查并跳过实际操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

void #

InnerHTMLAsync

v1.9 之前添加

elementHandle.InnerHTMLAsync

不推荐

请改用基于定位器的 Locator.InnerHTMLAsync()。详细了解定位器。

返回 element.innerHTML。

用法

await ElementHandle.InnerHTMLAsync();

string #

InnerTextAsync

v1.9 之前添加

elementHandle.InnerTextAsync

不推荐

请改用基于定位器的 Locator.InnerTextAsync()。详细了解定位器。

返回 element.innerText。

用法

await ElementHandle.InnerTextAsync();

string #

InputValueAsync

添加于：v1.13

elementHandle.InputValueAsync

不推荐

请改用基于定位器的 Locator.InputValueAsync()。详细了解定位器。

返回选定的 <input>、<textarea> 或 <select> 元素的 input.value。

对于非输入元素，此方法会抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内，则返回该控件的值。

用法

await ElementHandle.InputValueAsync(options);

参数

options ElementHandleInputValueOptions? (可选)
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

string #

IsCheckedAsync

v1.9 之前添加

elementHandle.IsCheckedAsync

不推荐

请改用基于定位器的 Locator.IsCheckedAsync()。详细了解定位器。

返回元素是否已选中。如果元素不是复选框或单选输入，则抛出异常。

用法

await ElementHandle.IsCheckedAsync();

bool #

IsDisabledAsync

v1.9 之前添加

elementHandle.IsDisabledAsync

不推荐

请改用基于定位器的 Locator.IsDisabledAsync()。阅读更多关于定位器 (locators) 的信息。

返回元素是否被禁用，与 enabled 相反。

用法

await ElementHandle.IsDisabledAsync();

bool #

IsEditableAsync

v1.9 之前添加

elementHandle.IsEditableAsync

不推荐

请改用基于定位器的 Locator.IsEditableAsync()。阅读更多关于定位器 (locators) 的信息。

返回元素是否可编辑。

用法

await ElementHandle.IsEditableAsync();

bool #

IsEnabledAsync

v1.9 之前添加

elementHandle.IsEnabledAsync

不推荐

请改用基于定位器的 Locator.IsEnabledAsync()。了解更多关于定位器的信息。

返回元素是否已启用。

用法

await ElementHandle.IsEnabledAsync();

bool #

IsHiddenAsync

v1.9 之前添加

elementHandle.IsHiddenAsync

不推荐

请改用基于定位器的 Locator.IsHiddenAsync()。阅读更多关于定位器 (locators) 的信息。

返回元素是否隐藏，即 visible 的反义词。

用法

await ElementHandle.IsHiddenAsync();

bool #

IsVisibleAsync

v1.9 之前添加

elementHandle.IsVisibleAsync

不推荐

请改用基于定位器的 Locator.IsVisibleAsync()。阅读更多关于定位器 (locators) 的信息。

返回元素是否可见。

用法

await ElementHandle.IsVisibleAsync();

bool #

PressAsync

v1.9 之前添加

elementHandle.PressAsync

不推荐

请改用基于定位器的 Locator.PressAsync()。阅读更多关于定位器 (locators) 的信息。

聚焦该元素，然后使用 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。

按住 Shift 将输入与 key 对应的大写文本。

如果 key 是单个字符，则区分大小写，因此值 a 和 A 将分别生成不同的文本。

也支持快捷键，例如 key: "Control+o"、key: "Control++ 或 key: "Control+Shift+T"。当与修饰符一起指定时，修饰符在按下后续键时被按下并保持。

用法

await ElementHandle.PressAsync(key, options);

参数

key string #

要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。
options ElementHandlePressOptions? (可选)
- Delay [float]? (可选)#
  
  keydown 和 keyup 之间等待的时间（毫秒）。默认为 0。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项将来默认为 true。
  
  发起导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志来选择退出等待。您只有在例外情况下才需要此选项，例如导航到无法访问的页面。默认为 false。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

void #

QuerySelectorAsync

添加于：v1.9

elementHandle.QuerySelectorAsync

不推荐

请改用基于定位器的 Page.Locator()。了解更多关于定位器的信息。

此方法在 ElementHandle 的子树中查找与指定选择器匹配的元素。如果没有元素匹配选择器，则返回 null。

用法

await ElementHandle.QuerySelectorAsync(selector);

参数

selector string #

要查询的选择器。

ElementHandle?#

QuerySelectorAllAsync

添加于：v1.9

elementHandle.QuerySelectorAllAsync

不推荐

请改用基于定位器的 Page.Locator()。了解更多关于定位器的信息。

此方法在 ElementHandle 的子树中查找所有与指定选择器匹配的元素。如果没有元素匹配选择器，则返回空数组。

用法

await ElementHandle.QuerySelectorAllAsync(selector);

参数

selector string #

要查询的选择器。

IReadOnlyList<ElementHandle>#

ScreenshotAsync

v1.9 之前添加

elementHandle.ScreenshotAsync

不推荐

请改用基于定位器的 Locator.ScreenshotAsync()。了解更多关于定位器的信息。

此方法捕获页面的屏幕截图，裁剪到此特定元素的大小和位置。如果元素被其他元素覆盖，它将不会真正显示在截图中。如果元素是可滚动的容器，截图中将仅显示当前滚动的内容。

此方法等待可操作性检查，然后在截图前将元素滚动到可视区域。如果元素已从 DOM 分离，此方法将抛出错误。

返回包含捕获的屏幕截图的缓冲区。

用法

await ElementHandle.ScreenshotAsync(options);

参数

options ElementHandleScreenshotOptions? (可选)
- Animations enum ScreenshotAnimations { Disabled, Allow }? (可选)#
  
  设置为 "disabled" 时，停止 CSS 动画、CSS 过渡和 Web 动画。动画的处理方式因其持续时间而异
  - 有限动画会快进到完成，因此它们会触发 transitionend 事件。
  - 无限动画会取消到初始状态，然后在截图后重新播放。
  默认为 "allow"，保持动画不变。
- Caret enum ScreenshotCaret { Hide, Initial }? (可选)#
  
  设置为 "hide" 时，截图将隐藏文本插入符号。设置为 "initial" 时，文本插入符号行为不会更改。默认为 "hide"。
- Mask IEnumerable?<Locator> (可选)#
  
  指定截图时应遮盖的定位器。被遮盖的元素将覆盖一个粉色框 #FF00FF（可通过 MaskColor 自定义），该框完全覆盖其边界框。遮盖也适用于不可见元素，参见仅匹配可见元素以禁用此行为。
- MaskColor string? (可选)添加于：v1.35#
  
  指定被遮盖元素的覆盖框颜色，使用 CSS 颜色格式。默认颜色为粉色 #FF00FF。
- OmitBackground bool? (可选)#
  
  隐藏默认的白色背景并允许捕获透明截图。不适用于 jpeg 图像。默认为 false。
- Path string? (可选)#
  
  保存图像的文件路径。截图类型将根据文件扩展名推断。如果 Path 是相对路径，则解析为相对于当前工作目录的路径。如果不提供路径，图像将不会保存到磁盘。
- Quality int? (可选)#
  
  图像质量，介于 0-100 之间。不适用于 png 图像。
- Scale enum ScreenshotScale { Css, Device }? (可选)#
  
  设置为 "css" 时，截屏将具有页面上每个 CSS 像素的单个像素。对于高 DPI 设备，这将保持截屏较小。使用 "device" 选项将产生每个设备像素的单个像素，因此高 DPI 设备的截屏将大两倍或更大。
  
  默认为 "device"。
- Style string? (可选)新增于: v1.41#
  
  在截屏时应用的样式表文本。您可以在此处隐藏动态元素、使元素不可见或更改其属性，以帮助您创建可重复的截屏。此样式表会穿透 Shadow DOM 并应用于内部框架。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。
- Type enum ScreenshotType { Png, Jpeg }? (可选)#
  
  指定截图类型，默认为 png。

byte[]#

ScrollIntoViewIfNeededAsync

v1.9 之前添加

elementHandle.ScrollIntoViewIfNeededAsync

不推荐

请改用基于定位器的 Locator.ScrollIntoViewIfNeededAsync()。了解更多关于定位器的信息。

此方法等待可操作性检查，然后尝试将元素滚动到可视区域，除非根据 IntersectionObserver 的 ratio 定义它已完全可见。

当 elementHandle 未指向与 Document 或 ShadowRoot 连接的元素时抛出异常。

查看滚动以获取替代滚动方法。

用法

await ElementHandle.ScrollIntoViewIfNeededAsync(options);

参数

options ElementHandleScrollIntoViewIfNeededOptions? (可选)
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

void #

SelectOptionAsync

v1.9 之前添加

elementHandle.SelectOptionAsync

不推荐

请改用基于定位器的 Locator.SelectOptionAsync()。阅读更多关于定位器 (locators) 的信息。

此方法等待可操作性检查，等待所有指定选项出现在 <select> 元素中并选择它们。

如果目标元素不是 <select> 元素，此方法将抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内，则将改为使用该控件。

返回已成功选择的选项值数组。

一旦所有提供的选项都已选中，将触发 change 和 input 事件。

用法

// Single selection matching the value or label
await handle.SelectOptionAsync(new[] { "blue" });
// single selection matching the label
await handle.SelectOptionAsync(new[] { new SelectOptionValue() { Label = "blue" } });
// multiple selection
await handle.SelectOptionAsync(new[] { "red", "green", "blue" });
// multiple selection for blue, red and second option
await handle.SelectOptionAsync(new[] {
    new SelectOptionValue() { Label = "blue" },
    new SelectOptionValue() { Index = 2 },
    new SelectOptionValue() { Value = "red" }});

参数

values string | ElementHandle | IEnumerable | SelectOption | IEnumerable | IEnumerable?#
- Value string? (可选)
  
  按 option.value 匹配。可选。
- Label string? (可选)
  
  按 option.label 匹配。可选。
- Index int? (可选)
  
  按索引匹配。可选。
要选择的选项。如果 <select> 具有 multiple 属性，则选择所有匹配的选项，否则仅选择与传入选项之一匹配的第一个选项。字符串值同时匹配值和标签。当所有指定的属性都匹配时，认为选项匹配。
options ElementHandleSelectOptionOptions? (可选)
- Force bool? (可选)添加于：v1.13#
  
  是否跳过可操作性检查。默认为 false。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

IReadOnlyList<string>#

SelectTextAsync

v1.9 之前添加

elementHandle.SelectTextAsync

不推荐

请改用基于定位器的 Locator.SelectTextAsync()。了解更多关于定位器的信息。

此方法等待可操作性检查，然后聚焦元素并选择其所有文本内容。

如果元素位于具有关联 control 的 <label> 元素内，则改为聚焦并选定控件中的文本。

用法

await ElementHandle.SelectTextAsync(options);

参数

options ElementHandleSelectTextOptions? (可选)
- Force bool? (可选)添加于：v1.13#
  
  是否跳过可操作性检查。默认为 false。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

void #

SetCheckedAsync

新增于: v1.15

elementHandle.SetCheckedAsync

不推荐

请改用基于定位器的 Locator.SetCheckedAsync()。阅读更多关于定位器 (locators) 的信息。

此方法通过执行以下步骤选中或取消选中元素

确保元素是复选框或单选输入。如果不是，此方法将抛出异常。
如果元素已经处于正确的选中状态，此方法将立即返回。
对匹配的元素进行可操作性检查，除非设置了 Force 选项。如果元素在检查期间被分离，整个操作将重试。
如果需要，将元素滚动到视图中。
使用 Page.Mouse 点击元素中心。
确保元素现在已选中或未选中。如果不是，此方法将抛出异常。

当所有步骤合并计算的时间超过指定的 Timeout 时，此方法会抛出 TimeoutError。传入零超时将禁用此机制。

用法

await ElementHandle.SetCheckedAsync(checked, options);

参数

checkedState bool #

是否选中或取消选中复选框。
options ElementHandleSetCheckedOptions? (可选)
- Force bool? (可选)#
  
  是否跳过可操作性检查。默认为 false。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position? (可选)#
  - X [float]
  - Y [float]
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。
- Trial bool? (可选)#
  
  设置此项后，该方法仅执行可操作性检查并跳过实际操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

void #

SetInputFilesAsync

v1.9 之前添加

elementHandle.SetInputFilesAsync

不推荐

请改用基于定位器的 Locator.SetInputFilesAsync()。阅读更多关于定位器 (locators) 的信息。

将文件输入的值设置为这些文件路径或文件。如果一些 filePaths 是相对路径，则它们相对于当前工作目录解析。空数组会清除选定的文件。对于带有 [webkitdirectory] 属性的输入，仅支持单个目录路径。

此方法要求 ElementHandle 指向一个 input 元素。但是，如果元素位于具有关联 control 的 <label> 元素内，则会定位到该 control。

用法

await ElementHandle.SetInputFilesAsync(files, options);

参数

files string | IEnumerable<string> | FilePayload | IEnumerable<FilePayload>#
- Name string
  
  文件名
- MimeType string
  
  文件类型
- Buffer byte[]
  
  文件内容
options ElementHandleSetInputFilesOptions? (可选)
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

void #

TapAsync

v1.9 之前添加

elementHandle.TapAsync

不推荐

请改用基于定位器的 Locator.TapAsync()。阅读更多关于定位器 (locators) 的信息。

此方法通过执行以下步骤来点击元素

对元素进行可操作性检查，除非设置了 Force 选项。
如果需要，将元素滚动到视图中。
使用 Page.Touchscreen 点击元素中心或指定的 Position。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤合并计算的时间超过指定的 Timeout 时，此方法会抛出 TimeoutError。传入零超时将禁用此机制。

注意

elementHandle.tap() 要求浏览器上下文的 hasTouch 选项设置为 true。

用法

await ElementHandle.TapAsync(options);

参数

options ElementHandleTapOptions? (可选)
- Force bool? (可选)#
  
  是否跳过可操作性检查。默认为 false。
- Modifiers IEnumerable?<enum KeyboardModifier { Alt, Control, ControlOrMeta, Meta, Shift }> (可选)#
  
  要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position? (可选)#
  - X [float]
  - Y [float]
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。
- Trial bool? (可选)添加于：v1.11#
  
  设置此项后，该方法仅执行可操作性检查并跳过实际操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

void #

TextContentAsync

v1.9 之前添加

elementHandle.TextContentAsync

不推荐

请改用基于定位器的 Locator.TextContentAsync()。阅读更多关于定位器 (locators) 的信息。

返回 node.textContent。

用法

await ElementHandle.TextContentAsync();

string?#

TypeAsync

v1.9 之前添加

elementHandle.TypeAsync

已弃用

在大多数情况下，您应该改用 Locator.FillAsync()。仅当页面上有特殊的键盘处理逻辑时，才需要逐个按键输入 - 在这种情况下，请使用 Locator.PressSequentiallyAsync()。

聚焦元素，然后为文本中的每个字符发送一个 keydown、keypress/input 和 keyup 事件。

要按下特殊键（如 Control 或 ArrowDown），请使用 ElementHandle.PressAsync()。

用法

参数

text string #

要输入到聚焦元素的文本。
options ElementHandleTypeOptions? (可选)
- Delay [float]? (可选)#
  
  按键之间等待的时间，以毫秒为单位。默认为 0。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

void #

UncheckAsync

v1.9 之前添加

elementHandle.UncheckAsync

不推荐

请改用基于定位器的 Locator.UncheckAsync()。阅读更多关于定位器 (locators) 的信息。

此方法通过执行以下步骤检查元素

确保元素是复选框或单选输入。如果不是，此方法将抛出异常。如果元素已经未选中，此方法将立即返回。
对元素进行可操作性检查，除非设置了 Force 选项。
如果需要，将元素滚动到视图中。
使用 Page.Mouse 点击元素中心。
确保元素现在未选中。如果不是，此方法将抛出异常。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤合并计算的时间超过指定的 Timeout 时，此方法会抛出 TimeoutError。传入零超时将禁用此机制。

用法

await ElementHandle.UncheckAsync(options);

参数

options ElementHandleUncheckOptions? (可选)
- Force bool? (可选)#
  
  是否跳过可操作性检查。默认为 false。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position? (可选)添加于：v1.11#
  - X [float]
  - Y [float]
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。
- Trial bool? (可选)添加于：v1.11#
  
  设置此项后，该方法仅执行可操作性检查并跳过实际操作。默认为 false。有助于在不执行操作的情况下等待元素准备就绪。

void #

WaitForSelectorAsync

v1.9 之前添加

elementHandle.WaitForSelectorAsync

不推荐

请改用断言可见性的 web 断言，或基于定位器的 Locator.WaitForAsync()。

当元素满足 State 选项时，返回选择器指定的元素。如果等待的是 hidden 或 detached，则返回 null。

等待相对于元素句柄的 selector 满足 State 选项（出现/消失于 DOM，或变为可见/隐藏）。如果在调用该方法时 selector 已经满足条件，则该方法将立即返回。如果选择器在 Timeout 毫秒内未满足条件，函数将抛出异常。

用法

await page.SetContentAsync("<div><span></span></div>");
var div = await page.QuerySelectorAsync("div");
// Waiting for the "span" selector relative to the div.
var span = await page.WaitForSelectorAsync("span", WaitForSelectorState.Attached);

注意

此方法不适用于跨页面导航，请改用 Page.WaitForSelectorAsync()。

参数

selector string #

要查询的选择器。
options ElementHandleWaitForSelectorOptions? (可选)
- State enum WaitForSelectorState { Attached, Detached, Visible, Hidden }? (可选)#
  
  默认为 'visible'。可以是以下之一：
  - 'attached' - 等待元素出现在 DOM 中。
  - 'detached' - 等待元素不在 DOM 中。
  - 'visible' - 等待元素具有非空的边界框且没有 visibility:hidden。请注意，没有任何内容或具有 display:none 的元素具有空的边界框，不被视为可见。
  - 'hidden' - 等待元素从 DOM 中分离，或具有空的边界框或 visibility:hidden。这与 'visible' 选项相反。
- Strict bool? (可选)新增于: v1.15#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- Timeout [float]? (可选)#
  
  以毫秒为单位的最长等待时间。默认为 30000（30 秒）。传递 0 以禁用超时。默认值可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法来更改。

ElementHandle?#

方法​

BoundingBoxAsync​

ContentFrameAsync​

OwnerFrameAsync​

WaitForElementStateAsync​

已弃用​

CheckAsync​

ClickAsync​

DblClickAsync​

DispatchEventAsync​

EvalOnSelectorAsync​

EvalOnSelectorAllAsync​

FillAsync​

FocusAsync​

GetAttributeAsync​

HoverAsync​

InnerHTMLAsync​

InnerTextAsync​

InputValueAsync​

IsCheckedAsync​

IsDisabledAsync​

IsEditableAsync​

IsEnabledAsync​

IsHiddenAsync​

IsVisibleAsync​

PressAsync​

QuerySelectorAsync​

QuerySelectorAllAsync​

ScreenshotAsync​

ScrollIntoViewIfNeededAsync​

SelectOptionAsync​

SelectTextAsync​

SetCheckedAsync​

SetInputFilesAsync​

TapAsync​

TextContentAsync​

TypeAsync​

UncheckAsync​

WaitForSelectorAsync​

方法

BoundingBoxAsync

ContentFrameAsync

OwnerFrameAsync

WaitForElementStateAsync

已弃用

CheckAsync

ClickAsync

DblClickAsync

DispatchEventAsync

EvalOnSelectorAsync

EvalOnSelectorAllAsync

FillAsync

FocusAsync

GetAttributeAsync

HoverAsync

InnerHTMLAsync

InnerTextAsync

InputValueAsync

IsCheckedAsync

IsDisabledAsync

IsEditableAsync

IsEnabledAsync

IsHiddenAsync

IsVisibleAsync

PressAsync

QuerySelectorAsync

QuerySelectorAllAsync

ScreenshotAsync

ScrollIntoViewIfNeededAsync

SelectOptionAsync

SelectTextAsync

SetCheckedAsync

SetInputFilesAsync

TapAsync

TextContentAsync

TypeAsync

UncheckAsync

WaitForSelectorAsync