ElementHandle

继承自: JSHandle

ElementHandle 代表页面内的 DOM 元素。ElementHandle 可以使用 Page.QuerySelectorAsync() 方法创建。

不建议使用

不建议使用 ElementHandle，请改用 Locator 对象和 web-first 断言。

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

ElementHandle 会阻止 DOM 元素被垃圾回收，除非句柄使用 JsHandle.DisposeAsync() 方法释放。当 ElementHandle 的源框架被导航时，它们会自动释放。

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

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

在下面的示例中，句柄（handle）指向页面上的一个特定 DOM 元素。如果该元素的文本发生变化或 React 使用它来渲染一个完全不同的组件，句柄仍然指向那个特定的 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" 等待直到元素不可见或未附加。请注意，等待 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 的 Locator.CheckAsync()。了解更多关于 locators 的信息。

此方法通过执行以下步骤来勾选元素

确保元素是复选框或单选输入框。如果不是，此方法将抛出错误。如果元素已经被勾选，此方法会立即返回。
等待对元素进行 actionability 检查，除非设置了 Force 选项。
如果需要，将元素滚动到视图中。
使用 Page.Mouse 在元素的中心点击。
确保元素现在已被勾选。如果不是，此方法将抛出错误。

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

如果所有步骤在指定的 Timeout 时间内未能完成，此方法将抛出 TimeoutError。传递零超时可以禁用此功能。

用法

await ElementHandle.CheckAsync(options);

参数

options ElementHandleCheckOptions? (可选)
- Force bool? (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position? (可选)添加于: v1.11#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角的坐标点。如果未指定，则使用元素的某个可见点。
- Timeout [float]? (可选)#
  
  最大等待时间（毫秒）。默认为 30000（30 秒）。传递 0 表示禁用超时。可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)添加于: v1.11#
  
  设置后，此方法仅执行 actionability 检查并跳过实际操作。默认为 false。这对于等待元素准备好执行操作但不实际执行操作时很有用。

返回值

void #

ClickAsync

在 v1.9 之前添加

elementHandle.ClickAsync

不建议使用

请改用基于 locator 的 Locator.ClickAsync()。了解更多关于 locators 的信息。

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

等待对元素进行 actionability 检查，除非设置了 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? (可选)#
  
  是否绕过 actionability 检查。默认为 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]
  相对于元素内边距框左上角的坐标点。如果未指定，则使用元素的某个可见点。
- Timeout [float]? (可选)#
  
  最大等待时间（毫秒）。默认为 30000（30 秒）。传递 0 表示禁用超时。可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)添加于: v1.11#
  
  设置后，此方法仅执行 actionability 检查并跳过实际操作。默认为 false。这对于等待元素准备好执行操作但不实际执行操作时很有用。

返回值

void #

DblClickAsync

在 v1.9 之前添加

elementHandle.DblClickAsync

不建议使用

请改用基于 locator 的 Locator.DblClickAsync()。了解更多关于 locators 的信息。

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

等待对元素进行 actionability 检查，除非设置了 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? (可选)#
  
  是否绕过 actionability 检查。默认为 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#
  
  设置后，此方法仅执行 actionability 检查并跳过实际操作。默认为 false。这对于等待元素准备好执行操作但不实际执行操作时很有用。

返回值

void #

DispatchEventAsync

在 v1.9 之前添加

elementHandle.DispatchEventAsync

不建议使用

请改用基于 locator 的 Locator.DispatchEventAsync()。了解更多关于 locators 的信息。

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

用法

await elementHandle.DispatchEventAsync("click");

底层实现是根据给定的 type 创建事件实例，使用 eventInit 属性对其进行初始化，然后在元素上分派。事件默认是 composed、cancelable 和 bubble 的。

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

如果您希望将 live 对象传递到事件中，也可以将 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

不建议使用

此方法不等待元素通过 actionability 检查，因此可能导致测试不稳定。请改用 Locator.EvaluateAsync()、其他 Locator 辅助方法或 web-first 断言。

返回 expression 的返回值。

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

如果 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-first 断言会做得更好。

返回 expression 的返回值。

此方法在 ElementHandle 的子树中查找所有匹配指定 selector 的元素，并将匹配元素的数组作为第一个参数传递给 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 的 Locator.FillAsync()。了解更多关于 locators 的信息。

此方法等待 actionability 检查，聚焦元素，填充值，并在填充后触发 input 事件。请注意，您可以传递空字符串来清空输入字段。

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

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

用法

await ElementHandle.FillAsync(value, options);

参数

value string #

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

返回值

void #

FocusAsync

在 v1.9 之前添加

elementHandle.FocusAsync

不建议使用

请改用基于 locator 的 Locator.FocusAsync()。了解更多关于 locators 的信息。

在元素上调用 focus。

用法

await ElementHandle.FocusAsync();

返回值

void #

GetAttributeAsync

在 v1.9 之前添加

elementHandle.GetAttributeAsync

不建议使用

请改用基于 locator 的 Locator.GetAttributeAsync()。了解更多关于 locators 的信息。

返回元素属性值。

用法

await ElementHandle.GetAttributeAsync(name);

参数

name string #

要获取值的属性名。

返回值

string?#

HoverAsync

在 v1.9 之前添加

elementHandle.HoverAsync

不建议使用

请改用基于 locator 的 Locator.HoverAsync()。了解更多关于 locators 的信息。

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

等待对元素执行可操作性检查，除非设置了强制 (Force) 选项。
如果需要，将元素滚动到视图中。
使用Page.Mouse 将鼠标悬停在元素的中心或指定的位置 (Position)。

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

如果所有组合步骤未在指定的超时 (Timeout)时间内完成，此方法将抛出TimeoutError (超时错误)。传递零超时将禁用此功能。

用法

await ElementHandle.HoverAsync(options);

参数

options ElementHandleHoverOptions? (可选)
- 强制 (Force) bool? (可选)#
  
  是否绕过 actionability 检查。默认为 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#
  
  设置后，此方法仅执行 actionability 检查并跳过实际操作。默认为 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。

对非输入元素抛出异常。但是，如果元素位于具有关联控件的 <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()。详细了解定位符。

返回元素是否被禁用，与启用状态相反。

用法

await ElementHandle.IsDisabledAsync();

返回值

bool #

IsEditableAsync

在 v1.9 之前添加

elementHandle.IsEditableAsync

不建议使用

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

返回元素是否可编辑。

用法

await ElementHandle.IsEditableAsync();

返回值

bool #

IsEnabledAsync

在 v1.9 之前添加

elementHandle.IsEnabledAsync

不建议使用

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

返回元素是否已启用。

用法

await ElementHandle.IsEnabledAsync();

返回值

bool #

IsHiddenAsync

在 v1.9 之前添加

elementHandle.IsHiddenAsync

不建议使用

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

返回元素是否被隐藏，与可见状态相反。

用法

await ElementHandle.IsHiddenAsync();

返回值

bool #

IsVisibleAsync

在 v1.9 之前添加

elementHandle.IsVisibleAsync

不建议使用

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

返回元素是否可见。

用法

await ElementHandle.IsVisibleAsync();

返回值

bool #

PressAsync

在 v1.9 之前添加

elementHandle.PressAsync

不建议使用

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

聚焦元素，然后使用Keyboard.DownAsync() 和 Keyboard.UpAsync()。

key 可以指定预期的 keyboardEvent.key 值，或用于生成文本的单个字符。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 Animations。动画根据其持续时间有不同的处理：
  - 有限动画将快进到完成状态，因此它们会触发 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()。详细了解定位符。

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

如果目标元素不是 <select> 元素，此方法将抛出错误。但是，如果元素位于具有关联控件的 <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 属性，则选择所有匹配的选项，否则只选择与传递的选项之一匹配的第一个选项。字符串值匹配 value 和 label。如果所有指定属性都匹配，则认为选项匹配。
options ElementHandleSelectOptionOptions? (可选)
- Force bool? (可选)添加于: v1.13#
  
  是否绕过 actionability 检查。默认为 false。
- 不等待操作完成 (NoWaitAfter) bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- 超时 (Timeout) [float]? (可选)#
  
  最大等待时间（毫秒）。默认为 30000（30 秒）。传递 0 表示禁用超时。可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

IReadOnlyList<string>#

SelectTextAsync

在 v1.9 之前添加

elementHandle.SelectTextAsync

不建议使用

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

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

如果元素位于具有关联控件的 <label> 元素内，则转而聚焦并选择该控件中的文本。

用法

await ElementHandle.SelectTextAsync(options);

参数

options ElementHandleSelectTextOptions? (可选)
- Force bool? (可选)添加于: v1.13#
  
  是否绕过 actionability 检查。默认为 false。
- 超时 (Timeout) [float]? (可选)#
  
  最大等待时间（毫秒）。默认为 30000（30 秒）。传递 0 表示禁用超时。可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。

返回值

void #

SetCheckedAsync

添加于: v1.15

elementHandle.SetCheckedAsync

不建议使用

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

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

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

当所有组合步骤未在指定的超时 (Timeout)时间内完成时，此方法将抛出TimeoutError (超时错误)。传递零超时将禁用此功能。

用法

await ElementHandle.SetCheckedAsync(checked, options);

参数

checkedState bool #

是否选中或取消选中复选框。
options ElementHandleSetCheckedOptions? (可选)
- 强制 (Force) bool? (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- 不等待操作完成 (NoWaitAfter) bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- 位置 (Position) Position? (可选)#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角的坐标点。如果未指定，则使用元素的某个可见点。
- 超时 (Timeout) [float]? (可选)#
  
  最大等待时间（毫秒）。默认为 30000（30 秒）。传递 0 表示禁用超时。可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- 试运行 (Trial) bool? (可选)#
  
  设置后，此方法仅执行 actionability 检查并跳过实际操作。默认为 false。这对于等待元素准备好执行操作但不实际执行操作时很有用。

返回值

void #

SetInputFilesAsync

在 v1.9 之前添加

elementHandle.SetInputFilesAsync

不建议使用

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

设置文件输入的 value 为这些文件路径或文件。如果某些 filePaths 是相对路径，则相对于当前工作目录解析。对于空数组，清除选定的文件。对于具有 [webkitdirectory] 属性的输入框，只支持单个目录路径。

此方法要求 ElementHandle 指向一个 input 元素。但是，如果元素位于具有关联控件的 <label> 元素内，则转而将目标设为该控件。

用法

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()。阅读更多关于定位符的信息。

此方法通过执行以下步骤来轻触元素

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

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

当所有步骤在指定的 Timeout 内未完成时，此方法将抛出 TimeoutError。传递零超时会禁用此功能。

注意

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

用法

await ElementHandle.TapAsync(options);

参数

options ElementHandleTapOptions? (可选)
- Force bool? (可选)#
  
  是否绕过 actionability 检查。默认为 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#
  
  设置后，此方法仅执行 actionability 检查并跳过实际操作。默认为 false。这对于等待元素准备好执行操作但不实际执行操作时很有用。

返回值

void #

TextContentAsync

在 v1.9 之前添加

elementHandle.TextContentAsync

不建议使用

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

返回 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()。阅读更多关于定位符的信息。

此方法通过执行以下步骤来勾选元素

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

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

当所有步骤在指定的 Timeout 内未完成时，此方法将抛出 TimeoutError。传递零超时会禁用此功能。

用法

await ElementHandle.UncheckAsync(options);

参数

options ElementHandleUncheckOptions? (可选)
- Force bool? (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- NoWaitAfter bool? (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- Position Position? (可选)添加于: v1.11#
  - X [float]
  - Y [float]
  相对于元素内边距框左上角的坐标点。如果未指定，则使用元素的某个可见点。
- Timeout [float]? (可选)#
  
  最大等待时间（毫秒）。默认为 30000（30 秒）。传递 0 表示禁用超时。可以通过使用 BrowserContext.SetDefaultTimeout() 或 Page.SetDefaultTimeout() 方法更改默认值。
- Trial bool? (可选)添加于: v1.11#
  
  设置后，此方法仅执行 actionability 检查并跳过实际操作。默认为 false。这对于等待元素准备好执行操作但不实际执行操作时很有用。

返回值

void #

WaitForSelectorAsync

在 v1.9 之前添加

elementHandle.WaitForSelectorAsync

不建议使用

改用断言可见性的 Web 断言或基于定位符的 Locator.WaitForAsync()。

当由 State 选项指定的元素满足条件时返回该元素。如果等待 hidden 或 detached，则返回 null。

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

用法

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，则调用要求 selector 解析为单个元素。如果给定的 selector 解析为多个元素，则调用将抛出异常。
- 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