Frame

ページは、常に Page.MainFrame および Frame.ChildFrames メソッドを介して、現在のフレームツリーを公開します。

Frame オブジェクトのライフサイクルは、ページオブジェクトでディスパッチされる3つのイベントによって制御されます。

Page.FrameAttached - フレームがページにアタッチされると発生します。フレームはページに一度だけアタッチできます。
Page.FrameNavigated - フレームが別のURLへのナビゲーションをコミットすると発生します。
Page.FrameDetached - フレームがページからデタッチされると発生します。フレームはページから一度だけデタッチできます。

フレームツリーのダンプ例

using Microsoft.Playwright;
using System;
using System.Threading.Tasks;

class FrameExamples
{
    public static async Task Main()
    {
        using var playwright = await Playwright.CreateAsync();
        await using var browser = await playwright.Firefox.LaunchAsync();
        var page = await browser.NewPageAsync();

        await page.GotoAsync("https://www.bing.com");
        DumpFrameTree(page.MainFrame, string.Empty);
    }

    private static void DumpFrameTree(IFrame frame, string indent)
    {
        Console.WriteLine($"{indent}{frame.Url}");
        foreach (var child in frame.ChildFrames)
            DumpFrameTree(child, indent + " ");
    }
}

メソッド

AddScriptTagAsync

v1.9より前に追加

frame.AddScriptTagAsync

スクリプトのonloadが発生したとき、またはスクリプトコンテンツがフレームに挿入されたときに、追加されたタグを返します。

目的のURLまたはコンテンツを持つ<script>タグをページに追加します。

使用法

await Frame.AddScriptTagAsync(options);

引数

options FrameAddScriptTagOptions? (オプション)
- Content string? (オプション)#
  
  フレームに挿入する生のJavaScriptコンテンツ。
- Path string? (オプション)#
  
  フレームに挿入するJavaScriptファイルへのパス。pathが相対パスの場合、現在の作業ディレクトリからの相対パスとして解決されます。
- Type string? (オプション)#
  
  スクリプトタイプ。JavaScript ES6モジュールをロードするには 'module' を使用します。詳細については、script を参照してください。
- Url string? (オプション)#
  
  追加するスクリプトのURL。

戻り値

ElementHandle #

AddStyleTagAsync

v1.9より前に追加

frame.AddStyleTagAsync

スタイルシートのonloadが発生したとき、またはCSSコンテンツがフレームに挿入されたときに、追加されたタグを返します。

目的のURLを持つ<link rel="stylesheet">タグ、またはコンテンツを持つ<style type="text/css">タグをページに追加します。

使用法

await Frame.AddStyleTagAsync(options);

引数

options FrameAddStyleTagOptions? (オプション)
- Content string? (オプション)#
  
  フレームに挿入する生のCSSコンテンツ。
- Path string? (オプション)#
  
  フレームに挿入するCSSファイルへのパス。pathが相対パスの場合、現在の作業ディレクトリからの相対パスとして解決されます。
- Url string? (オプション)#
  
  <link>タグのURL。

戻り値

ElementHandle #

ChildFrames

v1.9より前に追加

frame.ChildFrames

使用法

Frame.ChildFrames

戻り値

IEnumerable<Frame>#

ContentAsync

v1.9より前に追加

frame.ContentAsync

doctypeを含む、フレームの完全なHTMLコンテンツを取得します。

使用法

await Frame.ContentAsync();

戻り値

string #

DragAndDropAsync

v1.13で追加

frame.DragAndDropAsync

使用法

await Frame.DragAndDropAsync(source, target, options);

引数

source string #

ドラッグする要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
target string #

ドロップ先の要素を検索するセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameDragAndDropOptions? (オプション)
- Force bool? (オプション)#
  
  アクション実行可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- SourcePosition SourcePosition? (オプション)v1.14で追加#
  - X [float]
  - Y [float]
  要素のパディングボックスの左上隅を基準としたこのポイントで、ソース要素をクリックします。指定しない場合、要素の可視点が使用されます。
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- TargetPosition TargetPosition? (オプション)v1.14で追加#
  - X [float]
  - Y [float]
  要素のパディングボックスの左上隅を基準としたこのポイントで、ターゲット要素にドロップします。指定しない場合、要素の可視点が使用されます。
- Timeout [float]? (オプション)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。
- Trial bool? (オプション)#
  
  設定すると、このメソッドはアクション実行可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。アクションを実行せずに要素がアクションの準備が整うまで待機するのに役立ちます。

戻り値

void #

EvaluateAsync

v1.9より前に追加

frame.EvaluateAsync

expressionの戻り値を返します。

Frame.EvaluateAsync()に渡された関数がPromiseを返す場合、Frame.EvaluateAsync()はPromiseが解決されるのを待機し、その値を返します。

Frame.EvaluateAsync()に渡された関数がシリアライズ可能でない値を返す場合、Frame.EvaluateAsync()はundefinedを返します。Playwrightは、JSONによってシリアライズ可能でない追加の値（-0、NaN、Infinity、-Infinity）の転送もサポートしています。

使用法

var result = await frame.EvaluateAsync<int>("([x, y]) => Promise.resolve(x * y)", new[] { 7, 8 });
Console.WriteLine(result);

関数の代わりに文字列を渡すこともできます。

Console.WriteLine(await frame.EvaluateAsync<int>("1 + 2")); // prints "3"

ElementHandleインスタンスは、Frame.EvaluateAsync()の引数として渡すことができます。

var bodyHandle = await frame.EvaluateAsync("document.body");
var html = await frame.EvaluateAsync<string>("([body, suffix]) => body.innerHTML + suffix", new object [] { bodyHandle, "hello" });
await bodyHandle.DisposeAsync();

引数

expression string #

ブラウザコンテキストで評価されるJavaScript式。式が関数として評価される場合、関数は自動的に呼び出されます。
arg EvaluationArgument? (オプション)#

expressionに渡すオプションの引数。

戻り値

[object]#

EvaluateHandleAsync

v1.9より前に追加

frame.EvaluateHandleAsync

expressionの戻り値をJSHandleとして返します。

Frame.EvaluateAsync()とFrame.EvaluateHandleAsync()の唯一の違いは、Frame.EvaluateHandleAsync()がJSHandleを返すことです。

Frame.EvaluateHandleAsync()に渡された関数がPromiseを返す場合、Frame.EvaluateHandleAsync()はPromiseが解決されるのを待機し、その値を返します。

使用法

// Handle for the window object.
var aWindowHandle = await frame.EvaluateHandleAsync("() => Promise.resolve(window)");

関数の代わりに文字列を渡すこともできます。

var docHandle = await frame.EvaluateHandleAsync("document"); // Handle for the `document`

JSHandleインスタンスは、Frame.EvaluateHandleAsync()の引数として渡すことができます。

var handle = await frame.EvaluateHandleAsync("() => document.body");
var resultHandle = await frame.EvaluateHandleAsync("([body, suffix]) => body.innerHTML + suffix", new object[] { handle, "hello" });
Console.WriteLine(await resultHandle.JsonValueAsync<string>());
await resultHandle.DisposeAsync();

引数

expression string #

ブラウザコンテキストで評価されるJavaScript式。式が関数として評価される場合、関数は自動的に呼び出されます。
arg EvaluationArgument? (オプション)#

expressionに渡すオプションの引数。

戻り値

JSHandle #

FrameElementAsync

v1.9より前に追加

frame.FrameElementAsync

このフレームに対応するframeまたはiframe要素ハンドルを返します。

これはElementHandle.ContentFrameAsync()の逆です。返されるハンドルは実際には親フレームに属していることに注意してください。

このメソッドは、frameElement()が戻る前にフレームがデタッチされた場合、エラーをスローします。

使用法

var frameElement = await frame.FrameElementAsync();
var contentFrame = await frameElement.ContentFrameAsync();
Console.WriteLine(frame == contentFrame); // -> True

戻り値

ElementHandle #

FrameLocator

v1.17で追加

frame.FrameLocator

iframeを操作する場合、iframeに入り、そのiframe内の要素を選択できるようにするフレームロケーターを作成できます。

使用法

次のスニペットは、<iframe id="my-frame">のように、idがmy-frameのiframe内のテキスト「Submit」を持つ要素を見つけます。

var locator = frame.FrameLocator("#my-iframe").GetByText("Submit");
await locator.ClickAsync();

引数

selector string #

DOM要素を解決するときに使用するセレクター。

戻り値

FrameLocator #

GetByAltText

v1.27で追加

frame.GetByAltText

要素をaltテキストで検索できます。

使用法

たとえば、このメソッドはaltテキスト「Playwright logo」で画像を検索します。

<img alt='Playwright logo'>

await page.GetByAltText("Playwright logo").ClickAsync();

引数

text string | Regex #

要素を検索するテキスト。
options FrameGetByAltTextOptions? (オプション)
- Exact bool? (オプション)#
  
  完全一致を検索するかどうか：大文字と小文字を区別し、文字列全体を比較します。デフォルトはfalseです。正規表現で検索する場合は無視されます。完全一致でも空白はトリミングされることに注意してください。

戻り値

Locator #

GetByLabel

v1.27で追加

frame.GetByLabel

関連付けられた<label>またはaria-labelledby要素のテキスト、またはaria-label属性によって、入力要素を検索できます。

使用法

たとえば、このメソッドは次のDOMでラベル「Username」と「Password」で入力を検索します。

<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");

引数

text string | Regex #

要素を検索するテキスト。
options FrameGetByLabelOptions? (オプション)
- Exact bool? (オプション)#
  
  完全一致を検索するかどうか：大文字と小文字を区別し、文字列全体を比較します。デフォルトはfalseです。正規表現で検索する場合は無視されます。完全一致でも空白はトリミングされることに注意してください。

戻り値

Locator #

GetByPlaceholder

v1.27で追加

frame.GetByPlaceholder

プレースホルダーテキストによって入力要素を検索できます。

使用法

たとえば、次のDOM構造を考えてみましょう。

<input type="email" placeholder="name@example.com" />

プレースホルダーテキストで検索した後、入力を入力できます。

await page
    .GetByPlaceholder("name@example.com")
    .FillAsync("playwright@microsoft.com");

引数

text string | Regex #

要素を検索するテキスト。
options FrameGetByPlaceholderOptions? (オプション)
- Exact bool? (オプション)#
  
  完全一致を検索するかどうか：大文字と小文字を区別し、文字列全体を比較します。デフォルトはfalseです。正規表現で検索する場合は無視されます。完全一致でも空白はトリミングされることに注意してください。

戻り値

Locator #

GetByRole

v1.27で追加

frame.GetByRole

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();

引数

role enum 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ロール。
options FrameGetByRoleOptions? (オプション)
- Checked bool? (オプション)#
  
  通常、aria-checkedまたはネイティブ<input type=checkbox>コントロールによって設定される属性。
  
  aria-checkedの詳細をご覧ください。
- Disabled bool? (オプション)#
  
  通常、aria-disabledまたはdisabledによって設定される属性。
  
  注
  他のほとんどの属性とは異なり、disabledはDOM階層を介して継承されます。aria-disabledの詳細をご覧ください。
- Exact bool? (オプション)v1.28で追加#
  
  Name|NameRegexを完全に一致させるかどうか：大文字と小文字を区別し、文字列全体を比較します。デフォルトはfalseです。Name|NameRegexが正規表現の場合は無視されます。完全一致でも空白はトリミングされることに注意してください。
- Expanded bool? (オプション)#
  
  通常、aria-expandedによって設定される属性。
  
  aria-expandedの詳細をご覧ください。
- IncludeHidden bool? (オプション)#
  
  非表示要素を一致させるかどうかを制御するオプション。デフォルトでは、ARIAによって定義されている非表示でない要素のみがロールセレクターによって一致します。
  
  aria-hiddenの詳細をご覧ください。
- Level int? (オプション)#
  
  通常、heading、listitem、row、treeitemロールに存在する数値属性。<h1>-<h6>要素のデフォルト値。
  
  aria-levelの詳細をご覧ください。
- Name|NameRegex string? | Regex? (オプション)#
  
  アクセシブル名を一致させるオプション。デフォルトでは、一致は大文字と小文字を区別せず、部分文字列を検索します。Exactを使用してこの動作を制御します。
  
  アクセシブル名の詳細をご覧ください。
- Pressed bool? (オプション)#
  
  通常、aria-pressedによって設定される属性。
  
  aria-pressedの詳細をご覧ください。
- Selected bool? (オプション)#
  
  通常、aria-selectedによって設定される属性。
  
  aria-selectedの詳細をご覧ください。

戻り値

Locator #

詳細

ロールセレクターは、アクセシビリティ監査および適合性テストを置き換えるものではありませんが、ARIAガイドラインに関する早期フィードバックを提供します。

多くのHTML要素には、ロールセレクターによって認識される暗黙的に定義されたロールがあります。サポートされているすべてのロールはこちらで確認できます。ARIAガイドラインは、roleやaria-*属性をデフォルト値に設定して、暗黙的なロールと属性を複製することを推奨していません。

GetByTestId

v1.27で追加

frame.GetByTestId

テストIDで要素を検索します。

使用法

次のDOM構造を考えてみましょう。

<button data-testid="directions">Itinéraire</button>

テストIDで要素を検索できます。

await page.GetByTestId("directions").ClickAsync();

引数

testId string | Regex #

要素を検索するID。

戻り値

Locator #

詳細

デフォルトでは、data-testid属性がテストIDとして使用されます。必要に応じて別のテストID属性を設定するには、Selectors.SetTestIdAttribute()を使用します。

GetByText

v1.27で追加

frame.GetByText

指定されたテキストを含む要素を検索できます。

アクセシブルロールなどの別の基準で一致させ、テキストコンテンツでフィルター処理できる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));

引数

text string | Regex #

要素を検索するテキスト。
options FrameGetByTextOptions? (オプション)
- Exact bool? (オプション)#
  
  完全一致を検索するかどうか：大文字と小文字を区別し、文字列全体を比較します。デフォルトはfalseです。正規表現で検索する場合は無視されます。完全一致でも空白はトリミングされることに注意してください。

戻り値

Locator #

詳細

テキストによるマッチングは、完全一致の場合でも常に空白を正規化します。たとえば、複数のスペースを1つに変換し、改行をスペースに変換し、先頭と末尾の空白を無視します。

タイプbuttonおよびsubmitの入力要素は、テキストコンテンツの代わりにvalueによって一致します。たとえば、テキスト"Log in"で検索すると、<input type=button value="Log in">に一致します。

GetByTitle

v1.27で追加

frame.GetByTitle

要素をタイトル属性で検索できます。

使用法

次のDOM構造を考えてみましょう。

<span title='Issues count'>25 issues</span>

タイトルテキストで検索した後、問題の数を確認できます。

await Expect(Page.GetByTitle("Issues count")).toHaveText("25 issues");

引数

text string | Regex #

要素を検索するテキスト。
options FrameGetByTitleOptions? (オプション)
- Exact bool? (オプション)#
  
  完全一致を検索するかどうか：大文字と小文字を区別し、文字列全体を比較します。デフォルトはfalseです。正規表現で検索する場合は無視されます。完全一致でも空白はトリミングされることに注意してください。

戻り値

Locator #

GotoAsync

v1.9より前に追加

frame.GotoAsync

メインリソースレスポンスを返します。複数のリダイレクトの場合、ナビゲーションは最後のリダイレクトのレスポンスで解決されます。

このメソッドは、次の場合にエラーをスローします。

SSLエラーがある場合（自己署名証明書の場合など）。
ターゲットURLが無効な場合。
Timeoutがナビゲーション中に超過した場合。
リモートサーバーが応答しないか、到達不能な場合。
メインリソースのロードに失敗した場合。

このメソッドは、404 "Not Found" や 500 "Internal Server Error" など、リモートサーバーから有効なHTTPステータスコードが返された場合はエラーをスローしません。このようなレスポンスのステータスコードは、Response.Statusを呼び出すことで取得できます。

注

このメソッドは、エラーをスローするか、メインリソースレスポンスを返します。唯一の例外は、about:blankへのナビゲーション、またはハッシュが異なる同じURLへのナビゲーションで、成功してnullを返します。

注

ヘッドレスモードでは、PDFドキュメントへのナビゲーションはサポートされていません。詳細は上流のIssueを参照してください。

使用法

await Frame.GotoAsync(url, options);

引数

url string #

フレームをナビゲートするURL。urlにはスキーム（例：https://）を含める必要があります。
options FrameGotoOptions? (オプション)
- Referer string? (オプション)#
  
  Refererヘッダーの値。指定された場合、Page.SetExtraHTTPHeadersAsync()によって設定されたrefererヘッダーの値よりも優先されます。
- Timeout [float]? (オプション)#
  
  操作の最大時間（ミリ秒単位）。デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout()、またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (オプション)#
  
  操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかになります。
  - 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が完了したと見なします。
  - 'load' - loadイベントが発火したときに操作が完了したと見なします。
  - 'networkidle' - 非推奨 少なくとも500ミリ秒間ネットワーク接続がない場合に操作が完了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションを使用して準備状態を評価してください。
  - 'commit' - ネットワーク応答が受信され、ドキュメントのロードが開始されたときに操作が完了したと見なします。

戻り値

Response?#

IsDetached

v1.9より前に追加

frame.IsDetached

フレームがデタッチされている場合はtrue、そうでない場合はfalseを返します。

使用法

Frame.IsDetached

戻り値

bool #

IsEnabledAsync

v1.9より前に追加

frame.IsEnabledAsync

要素が有効かどうかを返します。

使用法

await Frame.IsEnabledAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameIsEnabledOptions? (オプション)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

bool #

Locator

v1.14で追加

frame.Locator

このメソッドは、このページ/フレームでアクションを実行するために使用できる要素ロケーターを返します。ロケーターは、アクションを実行する直前に要素に解決されるため、同じロケーターに対する一連のアクションは、実際には異なるDOM要素に対して実行される可能性があります。これは、それらのアクション間のDOM構造が変更された場合に発生します。

ロケーターの詳細.

使用法

Frame.Locator(selector, options);

引数

selector string #

DOM要素を解決するときに使用するセレクター。
options FrameLocatorOptions? (オプション)
- Has Locator? (オプション)#
  
  メソッドの結果を、この相対ロケーターに一致する要素を含むものに絞り込みます。たとえば、text=Playwrightを持つarticleは、<article><div>Playwright</div></article>に一致します。
  
  インナーロケーターは、アウターロケーターに対して相対的である必要があります。ドキュメントルートではなく、アウターロケーターの一致からクエリが開始されます。たとえば、<article><content><div>Playwright</div></content></article>内のdivを持つcontentを見つけることができます。ただし、article divを持つcontentを探すと失敗します。インナーロケーターは相対的である必要があり、contentの外部の要素を使用すべきではないためです。
  
  アウターロケーターとインナーロケーターは同じフレームに属している必要があることに注意してください。インナーロケーターにFrameLocatorを含めることはできません。
- HasNot Locator? (オプション)v1.33で追加#
  
  インナーロケーターに一致する要素を含まない要素に一致します。インナーロケーターはアウターロケーターに対してクエリされます。たとえば、divを持たないarticleは、<article><span>Playwright</span></article>に一致します。
  
  アウターロケーターとインナーロケーターは同じフレームに属している必要があることに注意してください。インナーロケーターにFrameLocatorを含めることはできません。
- HasNotText|HasNotTextRegex string? | Regex? (オプション)v1.33で追加#
  
  内部のどこかに、おそらく子要素または子孫要素に、指定されたテキストを含まない要素に一致します。stringが渡されると、マッチングは大文字と小文字を区別せず、部分文字列を検索します。
- HasText|HasTextRegex string? | Regex? (オプション)#
  
  内部のどこかに、おそらく子要素または子孫要素に、指定されたテキストを含む要素に一致します。stringが渡されると、マッチングは大文字と小文字を区別せず、部分文字列を検索します。たとえば、"Playwright"は<article><div>Playwright</div></article>に一致します。

戻り値

Locator #

Name

v1.9より前に追加

frame.Name

タグで指定されたフレームの名前属性を返します。

名前が空の場合、代わりにid属性を返します。

注

この値は、フレームが作成されたときに一度計算され、後で属性が変更されても更新されません。

使用法

Frame.Name

戻り値

string #

Page

v1.9より前に追加

frame.Page

このフレームを含むページを返します。

使用法

Frame.Page

戻り値

Page #

ParentFrame

v1.9より前に追加

frame.ParentFrame

親フレーム（存在する場合）。デタッチされたフレームとメインフレームはnullを返します。

使用法

Frame.ParentFrame

戻り値

Frame?#

SetContentAsync

v1.9より前に追加

frame.SetContentAsync

このメソッドは、内部的にdocument.write()を呼び出し、そのすべての特定の特性と動作を継承します。

使用法

await Frame.SetContentAsync(html, options);

引数

html string #

ページに割り当てるHTMLマークアップ。
options FrameSetContentOptions? (オプション)
- Timeout [float]? (オプション)#
  
  操作の最大時間（ミリ秒単位）。デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout()、またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (オプション)#
  
  操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかになります。
  - 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が完了したと見なします。
  - 'load' - loadイベントが発火したときに操作が完了したと見なします。
  - 'networkidle' - 非推奨 少なくとも500ミリ秒間ネットワーク接続がない場合に操作が完了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションを使用して準備状態を評価してください。
  - 'commit' - ネットワーク応答が受信され、ドキュメントのロードが開始されたときに操作が完了したと見なします。

戻り値

void #

TitleAsync

v1.9より前に追加

frame.TitleAsync

ページタイトルを返します。

使用法

await Frame.TitleAsync();

戻り値

string #

Url

v1.9より前に追加

frame.Url

フレームのURLを返します。

使用法

Frame.Url

戻り値

string #

WaitForFunctionAsync

v1.9より前に追加

frame.WaitForFunctionAsync

expressionが真の値を返すときに値を返し、その値を返します。

使用法

Frame.WaitForFunctionAsync()は、ビューポートサイズの変更を監視するために使用できます。

using Microsoft.Playwright;
using System.Threading.Tasks;

class FrameExamples
{
    public static async Task Main()
    {
        using var playwright = await Playwright.CreateAsync();
        await using var browser = await playwright.Firefox.LaunchAsync();
        var page = await browser.NewPageAsync();
        await page.SetViewportSizeAsync(50, 50);
        await page.MainFrame.WaitForFunctionAsync("window.innerWidth < 100");
    }
}

frame.waitForFunction関数の述語に引数を渡すには

var selector = ".foo";
await page.MainFrame.WaitForFunctionAsync("selector => !!document.querySelector(selector)", selector);

引数

expression string #

ブラウザコンテキストで評価されるJavaScript式。式が関数として評価される場合、関数は自動的に呼び出されます。
arg EvaluationArgument? (オプション)#

expressionに渡すオプションの引数。
options FrameWaitForFunctionOptions? (オプション)
- PollingInterval [float]? (オプション)#
  
  指定された場合、関数が実行される間隔（ミリ秒単位）として扱われます。オプションが指定されていない場合、デフォルトではexpressionはrequestAnimationFrameコールバックで実行されます。
- Timeout [float]? (オプション)#
  
  最大待機時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout()またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

JSHandle #

WaitForLoadStateAsync

v1.9より前に追加

frame.WaitForLoadStateAsync

必要なロード状態になるまで待機します。

これは、フレームが必要なロード状態（デフォルトではload）に達したときに返されます。ナビゲーションは、このメソッドが呼び出されたときにコミットされている必要があります。現在のドキュメントがすでに必要な状態に達している場合、すぐに解決されます。

注

Playwrightはすべてのアクションの前に自動ウェイトするため、ほとんどの場合、このメソッドは必要ありません。

使用法

await frame.ClickAsync("button");
await frame.WaitForLoadStateAsync(); // Defaults to LoadState.Load

引数

state enum LoadState { Load, DOMContentLoaded, NetworkIdle }? (オプション)#

待機するオプションのロード状態。デフォルトはloadです。現在のドキュメントのロード中に状態がすでに到達している場合、メソッドはすぐに解決されます。次のいずれかになります。
- 'load' - loadイベントが発火するのを待ちます。
- 'domcontentloaded' - DOMContentLoadedイベントが発火するのを待ちます。
- 'networkidle' - 非推奨 少なくとも500ミリ秒間ネットワーク接続がなくなるまで待ちます。テストにはこのメソッドを使用せず、代わりにWebアサーションを使用して準備状態を評価してください。
options FrameWaitForLoadStateOptions? (オプション)
- Timeout [float]? (オプション)#
  
  操作の最大時間（ミリ秒単位）。デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout()、またはPage.SetDefaultTimeout()メソッドを使用して変更できます。

戻り値

void #

WaitForURLAsync

v1.11で追加

frame.WaitForURLAsync

フレームが指定されたURLにナビゲートするのを待ちます。

使用法

await frame.ClickAsync("a.delayed-navigation"); // clicking the link will indirectly cause a navigation
await frame.WaitForURLAsync("**/target.html");

引数

url string | Regex | Func<string, bool>#

ナビゲーションを待機中に一致させる、globパターン、正規表現パターン、またはURLを受け取る述語。パラメーターがワイルドカード文字を含まない文字列の場合、メソッドは文字列と完全に等しいURLへのナビゲーションを待機することに注意してください。
options FrameWaitForURLOptions? (オプション)
- Timeout [float]? (オプション)#
  
  操作の最大時間（ミリ秒単位）。デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout()、またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (オプション)#
  
  操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかになります。
  - 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が完了したと見なします。
  - 'load' - loadイベントが発火したときに操作が完了したと見なします。
  - 'networkidle' - 非推奨 少なくとも500ミリ秒間ネットワーク接続がない場合に操作が完了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションを使用して準備状態を評価してください。
  - 'commit' - ネットワーク応答が受信され、ドキュメントのロードが開始されたときに操作が完了したと見なします。

戻り値

void #

Deprecated

CheckAsync

v1.9より前に追加

frame.CheckAsync

非推奨

代わりにロケーターベースのLocator.CheckAsync()を使用してください。ロケーターの詳細をご覧ください。

このメソッドは、次の手順を実行して、selectorに一致する要素をチェックします。

selectorに一致する要素を見つけます。一致する要素がない場合は、一致する要素がDOMに追加されるまで待ちます。
一致した要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドは例外をスローします。要素がすでにチェックされている場合、このメソッドはすぐに戻ります。
Forceオプションが設定されていない限り、一致した要素のアクション実行可能性チェックをアクション実行可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
Page.Mouseを使用して、要素の中央をクリックします。
要素がチェックされていることを確認します。そうでない場合、このメソッドは例外をスローします。

指定されたTimeout中にすべての手順が完了しなかった場合、このメソッドはTimeoutErrorをスローします。タイムアウトを無効にするには、ゼロタイムアウトを渡します。

使用法

await Frame.CheckAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameCheckOptions? (オプション)
- Force bool? (オプション)#
  
  アクション実行可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Position Position? (オプション)v1.11で追加#
  - X [float]
  - Y [float]
  要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の表示可能なポイントを使用します。
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。
- Trial bool? (オプション)v1.11で追加#
  
  設定すると、このメソッドはアクション実行可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。アクションを実行せずに要素がアクションの準備が整うまで待機するのに役立ちます。

戻り値

void #

ClickAsync

v1.9より前に追加

frame.ClickAsync

非推奨

代わりにロケーターベースのLocator.ClickAsync()を使用してください。ロケーターの詳細をご覧ください。

このメソッドは、次の手順を実行して、selectorに一致する要素をクリックします。

selectorに一致する要素を見つけます。一致する要素がない場合は、一致する要素がDOMに追加されるまで待ちます。
Forceオプションが設定されていない限り、一致した要素のアクション実行可能性チェックをアクション実行可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
Page.Mouseを使用して、要素の中央、または指定されたPositionをクリックします。
NoWaitAfterオプションが設定されていない限り、開始されたナビゲーションが成功または失敗するのを待ちます。

使用法

await Frame.ClickAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameClickOptions? (オプション)
- 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]
  要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の表示可能なポイントを使用します。
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。
- Trial bool? (オプション)v1.11で追加#
  
  設定すると、このメソッドはアクション実行可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。要素がアクションの準備ができるまで待機するのに役立ちますが、アクションは実行しません。キーボードmodifiersは、それらのキーが押されている場合にのみ表示される要素をテストできるように、trialに関係なく押されることに注意してください。

戻り値

void #

DblClickAsync

v1.9より前に追加

frame.DblClickAsync

非推奨

代わりにロケーターベースのLocator.DblClickAsync()を使用してください。ロケーターの詳細をご覧ください。

このメソッドは、次の手順を実行して、selectorに一致する要素をダブルクリックします。

selectorに一致する要素を見つけます。一致する要素がない場合は、一致する要素がDOMに追加されるまで待ちます。
アクション実行可能性チェックを、Forceオプションが設定されていない限り、一致した要素に対して待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
Page.Mouseを使用して、要素の中央、または指定されたPositionをダブルクリックします。dblclick()の最初のクリックがナビゲーションイベントをトリガーした場合、このメソッドは例外をスローします。

注

frame.dblclick()は、2つのclickイベントと1つのdblclickイベントをディスパッチします。

使用法

await Frame.DblClickAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameDblClickOptions? (オプション)
- 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]
  要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の表示可能なポイントを使用します。
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。
- Trial bool? (オプション)v1.11で追加#
  
  設定すると、このメソッドはアクション実行可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。要素がアクションの準備ができるまで待機するのに役立ちますが、アクションは実行しません。キーボードmodifiersは、それらのキーが押されている場合にのみ表示される要素をテストできるように、trialに関係なく押されることに注意してください。

戻り値

void #

DispatchEventAsync

v1.9より前に追加

frame.DispatchEventAsync

非推奨

代わりにロケーターベースのLocator.DispatchEventAsync()を使用してください。ロケーターの詳細をご覧ください。

以下のスニペットは、要素でclickイベントをディスパッチします。要素の表示状態に関係なく、clickがディスパッチされます。これは、element.click()を呼び出すことと同等です。

使用法

await frame.DispatchEventAsync("button#submit", "click");

内部的には、指定されたtypeに基づいてイベントのインスタンスを作成し、eventInitプロパティで初期化し、要素でディスパッチします。イベントは、デフォルトでcomposed、cancelable、およびバブルです。

eventInitはイベント固有であるため、初期プロパティのリストについては、イベントのドキュメントを参照してください。

ライブオブジェクトをイベントに渡したい場合は、プロパティ値としてJSHandleを指定することもできます。

// Note you can only create DataTransfer in Chromium and Firefox
var dataTransfer = await frame.EvaluateHandleAsync("() => new DataTransfer()");
await frame.DispatchEventAsync("#source", "dragstart", new { dataTransfer });

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
type string #

DOMイベントタイプ："click"、"dragstart"など。
eventInit EvaluationArgument? (オプション)#

オプションのイベント固有の初期化プロパティ。
options FrameDispatchEventOptions? (オプション)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

EvalOnSelectorAsync

v1.9で追加

frame.EvalOnSelectorAsync

非推奨

このメソッドは、要素がアクション実行可能性チェックに合格するのを待機しないため、テストが不安定になる可能性があります。代わりに、Locator.EvaluateAsync()、その他のLocatorヘルパーメソッド、またはWebファーストアサーションを使用してください。

expressionの戻り値を返します。

このメソッドは、フレーム内で指定されたセレクターに一致する要素を見つけ、expressionの最初の引数として渡します。セレクターに一致する要素がない場合、メソッドはエラーをスローします。

expressionがPromiseを返す場合、Frame.EvalOnSelectorAsync()はPromiseが解決されるのを待機し、その値を返します。

使用法

var searchValue = await frame.EvalOnSelectorAsync<string>("#search", "el => el.value");
var preloadHref = await frame.EvalOnSelectorAsync<string>("link[rel=preload]", "el => el.href");
var html = await frame.EvalOnSelectorAsync(".main-container", "(e, suffix) => e.outerHTML + suffix", "hello");

引数

selector string #

クエリするセレクター。
expression string #

ブラウザコンテキストで評価されるJavaScript式。式が関数として評価される場合、関数は自動的に呼び出されます。
arg EvaluationArgument? (オプション)#

expressionに渡すオプションの引数。
options FrameEvalOnSelectorOptions? (オプション)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。

戻り値

[object]#

EvalOnSelectorAllAsync

v1.9で追加

frame.EvalOnSelectorAllAsync

非推奨

ほとんどの場合、Locator.EvaluateAllAsync()、その他のLocatorヘルパーメソッド、およびWebファーストアサーションの方が適しています。

expressionの戻り値を返します。

このメソッドは、フレーム内で指定されたセレクターに一致するすべての要素を見つけ、一致した要素の配列をexpressionの最初の引数として渡します。

expressionがPromiseを返す場合、Frame.EvalOnSelectorAllAsync()はPromiseが解決されるのを待機し、その値を返します。

使用法

var divsCount = await frame.EvalOnSelectorAllAsync<bool>("div", "(divs, min) => divs.length >= min", 10);

引数

selector string #

クエリするセレクター。
expression string #

ブラウザコンテキストで評価されるJavaScript式。式が関数として評価される場合、関数は自動的に呼び出されます。
arg EvaluationArgument? (省略可能)#

expression に渡すオプションの引数。

戻り値

[object]#

FillAsync

v1.9より前に追加

frame.FillAsync

非推奨

ロケーターベースの Locator.FillAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

このメソッドは、selector に一致する要素を待ち、操作可能性のチェックを待ち、要素にフォーカスし、入力し、入力後に input イベントをトリガーします。入力フィールドをクリアするには、空の文字列を渡すことができることに注意してください。

ターゲット要素が <input>、<textarea>、または [contenteditable] 要素でない場合、このメソッドはエラーをスローします。ただし、要素が関連する control を持つ <label> 要素内にある場合、代わりにコントロールが入力されます。

きめ細かいキーボードイベントを送信するには、Locator.PressSequentiallyAsync() を使用してください。

使用法

await Frame.FillAsync(selector, value, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
value string #

<input>、<textarea>、または [contenteditable] 要素に入力する値。
options FrameFillOptions? (省略可能)
- Force bool? (省略可能)v1.13で追加#
  
  アクション実行可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- NoWaitAfter bool? (省略可能)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (省略可能)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

FocusAsync

v1.9より前に追加

frame.FocusAsync

非推奨

ロケーターベースの Locator.FocusAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

このメソッドは、selector を持つ要素を取得し、フォーカスします。selector に一致する要素がない場合、メソッドは一致する要素が DOM に現れるまで待ちます。

使用法

await Frame.FocusAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameFocusOptions? (省略可能)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (省略可能)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

GetAttributeAsync

v1.9より前に追加

frame.GetAttributeAsync

非推奨

ロケーターベースの Locator.GetAttributeAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

要素の属性値を返します。

使用法

await Frame.GetAttributeAsync(selector, name, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
name string #

値を取得する属性名。
options FrameGetAttributeOptions? (省略可能)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (省略可能)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

string?#

HoverAsync

v1.9より前に追加

frame.HoverAsync

非推奨

ロケーターベースの Locator.HoverAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

このメソッドは、次の手順を実行して selector に一致する要素にホバーします。

selector に一致する要素を見つけます。一致する要素がない場合は、一致する要素が DOM にアタッチされるまで待ちます。
Force オプションが設定されていない限り、一致した要素の操作可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
Page.Mouse を使用して、要素の中心、または指定された Position 上にホバーします。

指定された Timeout 中にすべての手順が完了しなかった場合、このメソッドは TimeoutError をスローします。タイムアウトにゼロを渡すと、これは無効になります。

使用法

await Frame.HoverAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameHoverOptions? (省略可能)
- 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]
  要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の表示可能なポイントを使用します。
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (省略可能)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。
- Trial bool? (オプション)v1.11で追加#
  
  設定すると、このメソッドはアクション実行可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。要素がアクションの準備ができるまで待機するのに役立ちますが、アクションは実行しません。キーボードmodifiersは、それらのキーが押されている場合にのみ表示される要素をテストできるように、trialに関係なく押されることに注意してください。

戻り値

void #

InnerHTMLAsync

v1.9より前に追加

frame.InnerHTMLAsync

非推奨

ロケーターベースの Locator.InnerHTMLAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

element.innerHTML を返します。

使用法

await Frame.InnerHTMLAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameInnerHTMLOptions? (省略可能)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (省略可能)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

string #

InnerTextAsync

v1.9より前に追加

frame.InnerTextAsync

非推奨

ロケーターベースの Locator.InnerTextAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

element.innerText を返します。

使用法

await Frame.InnerTextAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameInnerTextOptions? (省略可能)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (省略可能)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

string #

InputValueAsync

v1.13で追加

frame.InputValueAsync

非推奨

ロケーターベースの Locator.InputValueAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

選択された <input>、<textarea>、または <select> 要素の input.value を返します。

入力要素以外の場合は例外をスローします。ただし、要素が関連する control を持つ <label> 要素内にある場合、コントロールの値を返します。

使用法

await Frame.InputValueAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameInputValueOptions? (省略可能)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (省略可能)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

string #

IsCheckedAsync

v1.9より前に追加

frame.IsCheckedAsync

非推奨

ロケーターベースの Locator.IsCheckedAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

要素がチェックされているかどうかを返します。要素がチェックボックスまたはラジオ入力でない場合は例外をスローします。

使用法

await Frame.IsCheckedAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameIsCheckedOptions? (省略可能)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (省略可能)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

bool #

IsDisabledAsync

v1.9より前に追加

frame.IsDisabledAsync

非推奨

ロケーターベースの Locator.IsDisabledAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

要素が無効になっているかどうかを返します。有効の反対です。

使用法

await Frame.IsDisabledAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameIsDisabledOptions? (省略可能)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (省略可能)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

bool #

IsEditableAsync

v1.9より前に追加

frame.IsEditableAsync

非推奨

ロケーターベースの Locator.IsEditableAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

要素が編集可能かどうかを返します。

使用法

await Frame.IsEditableAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameIsEditableOptions? (省略可能)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (省略可能)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

bool #

IsHiddenAsync

v1.9より前に追加

frame.IsHiddenAsync

非推奨

ロケーターベースの Locator.IsHiddenAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

要素が非表示かどうかを返します。表示の反対です。selector がどの要素にも一致しない場合、非表示と見なされます。

使用法

await Frame.IsHiddenAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameIsHiddenOptions? (省略可能)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (省略可能)#
  
  非推奨
  このオプションは無視されます。Frame.IsHiddenAsync() は要素が非表示になるのを待たずに、すぐに返します。

戻り値

bool #

IsVisibleAsync

v1.9より前に追加

frame.IsVisibleAsync

非推奨

ロケーターベースの Locator.IsVisibleAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

要素が表示されているかどうかを返します。selector がどの要素にも一致しない場合、非表示と見なされます。

使用法

await Frame.IsVisibleAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameIsVisibleOptions? (省略可能)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (省略可能)#
  
  非推奨
  このオプションは無視されます。Frame.IsVisibleAsync() は要素が表示されるのを待たずに、すぐに返します。

戻り値

bool #

PressAsync

v1.9より前に追加

frame.PressAsync

非推奨

ロケーターベースの Locator.PressAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

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" などのショートカットもサポートされています。修飾子を指定すると、修飾子が押され、後続のキーが押されている間、保持されます。

使用法

await Frame.PressAsync(selector, key, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
key string #

押すキーの名前、または ArrowLeft や a などの生成する文字。
options FramePressOptions? (省略可能)
- Delay [float]? (省略可能)#
  
  keydown と keyup の間の待機時間（ミリ秒単位）。デフォルトは 0 です。
- NoWaitAfter bool? (省略可能)#
  
  非推奨
  このオプションは、将来デフォルトでtrueになります。
  
  ナビゲーションを開始するアクションは、これらのナビゲーションが発生し、ページがロードを開始するのを待機しています。このフラグを設定して、待機をオプトアウトできます。このオプションは、アクセスできないページにナビゲートするなど、例外的な場合にのみ必要になります。デフォルトはfalseです。
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (省略可能)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

QuerySelectorAsync

v1.9で追加

frame.QuerySelectorAsync

非推奨

ロケーターベースの Frame.Locator() を代わりに使用してください。ロケーターの詳細をお読みください。

フレーム要素を指す ElementHandle を返します。

注意

ElementHandle の使用は推奨されません。Locator オブジェクトと Web ファーストのアサーションを代わりに使用してください。

このメソッドは、フレーム内で指定されたセレクターに一致する要素を検索します。セレクターに一致する要素がない場合、null を返します。

使用法

await Frame.QuerySelectorAsync(selector, options);

引数

selector string #

クエリするセレクター。
options FrameQuerySelectorOptions? (省略可能)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。

戻り値

ElementHandle?#

QuerySelectorAllAsync

v1.9で追加

frame.QuerySelectorAllAsync

非推奨

ロケーターベースの Frame.Locator() を代わりに使用してください。ロケーターの詳細をお読みください。

フレーム要素を指す ElementHandle の配列を返します。

注意

ElementHandle の使用は推奨されません。Locator オブジェクトを代わりに使用してください。

このメソッドは、フレーム内で指定されたセレクターに一致するすべての要素を検索します。セレクターに一致する要素がない場合、空の配列を返します。

使用法

await Frame.QuerySelectorAllAsync(selector);

引数

selector string #

クエリするセレクター。

戻り値

IEnumerable<ElementHandle>#

v1.9より前に追加

frame.RunAndWaitForNavigationAsync

非推奨

このメソッドは本質的に競合状態が発生しやすいため、代わりに Frame.WaitForURLAsync() を使用してください。

フレームのナビゲーションを待機し、メインリソースのレスポンスを返します。複数のリダイレクトが発生した場合、ナビゲーションは最後のリダイレクトのレスポンスで解決されます。別なアンカーへのナビゲーションや History API の使用によるナビゲーションの場合、ナビゲーションは null で解決されます。

使用法

このメソッドは、フレームが新しい URL にナビゲートするのを待ちます。フレームを間接的にナビゲートさせるコードを実行する場合に便利です。次の例を考えてみてください。

await frame.RunAndWaitForNavigationAsync(async () =>
{
    // Clicking the link will indirectly cause a navigation.
    await frame.ClickAsync("a.delayed-navigation");
});

// Resolves after navigation has finished

注

URL を変更するための History API の使用は、ナビゲーションと見なされます。

引数

action Func<Task>v1.12 で追加#

イベントをトリガーするアクション。
options FrameRunAndWaitForNavigationOptions? (省略可能)
- Timeout [float]? (省略可能)#
  
  操作の最大時間（ミリ秒単位）。デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout()、またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- Url|UrlRegex|UrlFunc string? | Regex? | Func<string?, bool> (省略可能)#
  
  ナビゲーションを待機中に一致させる、globパターン、正規表現パターン、またはURLを受け取る述語。パラメーターがワイルドカード文字を含まない文字列の場合、メソッドは文字列と完全に等しいURLへのナビゲーションを待機することに注意してください。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (省略可能)#
  
  操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかになります。
  - 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が完了したと見なします。
  - 'load' - loadイベントが発火したときに操作が完了したと見なします。
  - 'networkidle' - 非推奨 少なくとも500ミリ秒間ネットワーク接続がない場合に操作が完了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションを使用して準備状態を評価してください。
  - 'commit' - ネットワーク応答が受信され、ドキュメントのロードが開始されたときに操作が完了したと見なします。

戻り値

Response?#

v1.9より前に追加

frame.WaitForNavigationAsync

非推奨

このメソッドは本質的に競合状態が発生しやすいため、代わりに Frame.WaitForURLAsync() を使用してください。

使用法

await frame.RunAndWaitForNavigationAsync(async () =>
{
    // Clicking the link will indirectly cause a navigation.
    await frame.ClickAsync("a.delayed-navigation");
});

// Resolves after navigation has finished

注

URL を変更するための History API の使用は、ナビゲーションと見なされます。

引数

options FrameRunAndWaitForNavigationOptions? (省略可能)
- Timeout [float]? (省略可能)#
  
  操作の最大時間（ミリ秒単位）。デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultNavigationTimeout()、BrowserContext.SetDefaultTimeout()、Page.SetDefaultNavigationTimeout()、またはPage.SetDefaultTimeout()メソッドを使用して変更できます。
- Url|UrlRegex|UrlFunc string? | Regex? | Func<string?, bool> (省略可能)#
  
  ナビゲーションを待機中に一致させる、globパターン、正規表現パターン、またはURLを受け取る述語。パラメーターがワイルドカード文字を含まない文字列の場合、メソッドは文字列と完全に等しいURLへのナビゲーションを待機することに注意してください。
- WaitUntil enum WaitUntilState { Load, DOMContentLoaded, NetworkIdle, Commit }? (省略可能)#
  
  操作が成功したと見なすタイミング。デフォルトはloadです。イベントは次のいずれかになります。
  - 'domcontentloaded' - DOMContentLoadedイベントが発火したときに操作が完了したと見なします。
  - 'load' - loadイベントが発火したときに操作が完了したと見なします。
  - 'networkidle' - 非推奨 少なくとも500ミリ秒間ネットワーク接続がない場合に操作が完了したと見なします。テストにはこのメソッドを使用せず、代わりにWebアサーションを使用して準備状態を評価してください。
  - 'commit' - ネットワーク応答が受信され、ドキュメントのロードが開始されたときに操作が完了したと見なします。

戻り値

Response?#

SelectOptionAsync

v1.9より前に追加

frame.SelectOptionAsync

非推奨

ロケーターベースの Locator.SelectOptionAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

このメソッドは、selector に一致する要素を待ち、操作可能性のチェックを待ち、指定されたすべてのオプションが <select> 要素に存在することを確認し、これらのオプションを選択します。

ターゲット要素が <select> 要素でない場合、このメソッドはエラーをスローします。ただし、要素が関連する control を持つ <label> 要素内にある場合、代わりにコントロールが使用されます。

正常に選択されたオプション値の配列を返します。

指定されたすべてのオプションが選択されると、change および input イベントをトリガーします。

使用法

// Single selection matching the value or label
await frame.SelectOptionAsync("select#colors", new[] { "blue" });
// single selection matching both the value and the label
await frame.SelectOptionAsync("select#colors", new[] { new SelectOptionValue() { Label = "blue" } });
// multiple selection
await frame.SelectOptionAsync("select#colors", new[] { "red", "green", "blue" });

引数

selector string #

クエリするセレクター。
values string | ElementHandle | IEnumerable | SelectOption | IEnumerable | IEnumerable?#
- Value string? (省略可能)
  
  option.value で一致します。オプション。
- Label string? (省略可能)
  
  option.label で一致します。オプション。
- Index int? (省略可能)
  
  インデックスで一致します。オプション。
選択するオプション。<select> に multiple 属性がある場合、一致するすべてのオプションが選択されます。それ以外の場合は、渡されたオプションのいずれかに一致する最初のオプションのみが選択されます。文字列値は、値とラベルの両方に一致します。すべての指定されたプロパティが一致する場合、オプションは一致すると見なされます。
options FrameSelectOptionOptions? (省略可能)
- Force bool? (省略可能)v1.13で追加#
  
  アクション実行可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- NoWaitAfter bool? (省略可能)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (省略可能)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

IEnumerable<string>#

SetCheckedAsync

v1.15 で追加

frame.SetCheckedAsync

非推奨

ロケーターベースの Locator.SetCheckedAsync() を代わりに使用してください。ロケーターの詳細をお読みください。

このメソッドは、次の手順を実行して selector に一致する要素をチェックまたはチェック解除します。

selector に一致する要素を見つけます。一致する要素がない場合は、一致する要素が DOM にアタッチされるまで待ちます。
一致する要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドは例外をスローします。
要素がすでに正しいチェック状態になっている場合、このメソッドはすぐに返します。
Force オプションが設定されていない限り、一致した要素の操作可能性チェックを待ちます。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
Page.Mouseを使用して、要素の中央をクリックします。
要素がチェックまたはチェック解除されたことを確認します。そうでない場合、このメソッドは例外をスローします。

使用法

await Frame.SetCheckedAsync(selector, checked, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
checkedState bool #

チェックボックスをチェックするか、またはチェックを外すかを指定します。
options FrameSetCheckedOptions? (オプション)
- Force bool? (オプション)#
  
  アクション実行可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Position Position? (オプション)#
  - X [float]
  - Y [float]
  要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の表示可能なポイントを使用します。
- Strict bool? (オプション)#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。
- Trial bool? (オプション)#
  
  設定すると、このメソッドはアクション実行可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。アクションを実行せずに要素がアクションの準備が整うまで待機するのに役立ちます。

戻り値

void #

SetInputFilesAsync

v1.9より前に追加

frame.SetInputFilesAsync

非推奨

代わりにロケーターベースの Locator.SetInputFilesAsync() を使用してください。詳細については、locators を参照してください。

ファイル入力の値を、これらのファイルパスまたはファイルに設定します。 filePaths の一部が相対パスの場合、それらは現在の作業ディレクトリからの相対パスとして解決されます。空の配列の場合、選択されたファイルをクリアします。

このメソッドは、selector が <input> 要素を指すことを想定しています。ただし、要素が関連付けられた control を持つ <label> 要素内にある場合、代わりに control をターゲットにします。

使用法

await Frame.SetInputFilesAsync(selector, files, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
files string | IEnumerable<string> | FilePayload | IEnumerable<FilePayload>#
- Name string
  
  ファイル名
- MimeType string
  
  ファイルタイプ
- Buffer byte[]
  
  ファイルの内容
options FrameSetInputFilesOptions? (オプション)
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

TapAsync

v1.9より前に追加

frame.TapAsync

非推奨

代わりにロケーターベースの Locator.TapAsync() を使用してください。詳細については、locators を参照してください。

このメソッドは、以下の手順を実行して、selector に一致する要素をタップします。

selector に一致する要素を見つけます。存在しない場合は、一致する要素が DOM にアタッチされるまで待機します。
Force オプションが設定されていない限り、一致した要素に対する操作可能性チェックを待機します。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
要素の中央、または指定された Position をタップするには、Page.Touchscreen を使用します。

指定された Timeout 内にすべての手順が完了しなかった場合、このメソッドは TimeoutError をスローします。タイムアウトに 0 を渡すと、これは無効になります。

注

frame.tap() は、ブラウザコンテキストの hasTouch オプションが true に設定されている必要があります。

使用法

await Frame.TapAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameTapOptions? (オプション)
- 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]
  要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の表示可能なポイントを使用します。
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。
- Trial bool? (オプション)v1.11で追加#
  
  設定すると、このメソッドはアクション実行可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。要素がアクションの準備ができるまで待機するのに役立ちますが、アクションは実行しません。キーボードmodifiersは、それらのキーが押されている場合にのみ表示される要素をテストできるように、trialに関係なく押されることに注意してください。

戻り値

void #

TextContentAsync

v1.9より前に追加

frame.TextContentAsync

非推奨

代わりにロケーターベースの Locator.TextContentAsync() を使用してください。詳細については、locators を参照してください。

element.textContent を返します。

使用法

await Frame.TextContentAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameTextContentOptions? (オプション)
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

string?#

TypeAsync

v1.9より前に追加

frame.TypeAsync

非推奨

ほとんどの場合、代わりに Locator.FillAsync() を使用する必要があります。ページに特別なキーボード処理がある場合にのみ、キーを 1 つずつ押す必要があります。その場合は、Locator.PressSequentiallyAsync() を使用してください。

テキスト内の各文字に対して、keydown、keypress/input、および keyup イベントを送信します。 frame.type は、きめ細かいキーボードイベントを送信するために使用できます。フォームフィールドに値を入力するには、Frame.FillAsync() を使用してください。

Keyboard.PressAsync() を使用して、Control や ArrowDown などの特殊キーを押します。

使用法

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
text string #

フォーカスされた要素に入力するテキスト。
options FrameTypeOptions? (オプション)
- Delay [float]? (オプション)#
  
  キーを押す間隔の待ち時間（ミリ秒単位）。デフォルトは 0 です。
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

void #

UncheckAsync

v1.9より前に追加

frame.UncheckAsync

非推奨

代わりにロケーターベースの Locator.UncheckAsync() を使用してください。詳細については、locators を参照してください。

このメソッドは、以下の手順を実行して、selector に一致する要素をチェックします。

selector に一致する要素を見つけます。存在しない場合は、一致する要素が DOM にアタッチされるまで待機します。
一致した要素がチェックボックスまたはラジオ入力であることを確認します。そうでない場合、このメソッドは例外をスローします。要素がすでにチェックされていない場合、このメソッドはすぐに戻ります。
Force オプションが設定されていない限り、一致した要素に対する操作可能性チェックを待機します。チェック中に要素がデタッチされた場合、アクション全体が再試行されます。
必要に応じて、要素をビューにスクロールします。
Page.Mouseを使用して、要素の中央をクリックします。
要素が現在チェックされていないことを確認します。そうでない場合、このメソッドは例外をスローします。

使用法

await Frame.UncheckAsync(selector, options);

引数

selector string #

要素を検索するためのセレクター。セレクターに一致する要素が複数ある場合は、最初の要素が使用されます。
options FrameUncheckOptions? (オプション)
- Force bool? (オプション)#
  
  アクション実行可能性チェックをバイパスするかどうか。デフォルトはfalseです。
- NoWaitAfter bool? (オプション)#
  
  非推奨
  このオプションは効果がありません。
  
  このオプションは効果がありません。
- Position Position? (オプション)v1.11で追加#
  - X [float]
  - Y [float]
  要素のパディングボックスの左上隅を基準に使用するポイント。指定しない場合は、要素の表示可能なポイントを使用します。
- Strict bool? (オプション)v1.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。
- Trial bool? (オプション)v1.11で追加#
  
  設定すると、このメソッドはアクション実行可能性チェックのみを実行し、アクションをスキップします。デフォルトはfalseです。アクションを実行せずに要素がアクションの準備が整うまで待機するのに役立ちます。

戻り値

void #

WaitForSelectorAsync

v1.9より前に追加

frame.WaitForSelectorAsync

非推奨

可視性をアサートするウェブアサーション、またはロケーターベースの Locator.WaitForAsync() を代わりに使用してください。詳細については、locators を参照してください。

selector で指定された要素が State オプションを満たす場合に返ります。 hidden または detached を待機している場合は null を返します。

注

Playwright は、アクションを実行する前に要素が準備完了になるのを自動的に待機します。 Locator オブジェクトとウェブファーストのアサーションを使用すると、コードは wait-for-selector を使用する必要がなくなります。

selector が State オプション（DOM に表示/非表示になるか、または可視/不可視になるかのいずれか）を満たすまで待機します。メソッドを呼び出す瞬間に selector がすでに条件を満たしている場合、メソッドはすぐに戻ります。セレクターが Timeout ミリ秒間条件を満たさない場合、関数は例外をスローします。

使用法

このメソッドは、ナビゲーションをまたいで機能します。

using Microsoft.Playwright;
using System;
using System.Threading.Tasks;

class FrameExamples
{
    public static async Task Main()
    {
        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);
            element = await page.MainFrame.WaitForSelectorAsync("img");
            Console.WriteLine($"Loaded image: {await element.GetAttributeAsync("src")}");
        }
    }
}

引数

selector string #

クエリするセレクター。
options FrameWaitForSelectorOptions? (オプション)
- 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.14で追加#
  
  trueの場合、この呼び出しはセレクターが単一の要素に解決されることを要求します。指定されたセレクターが複数の要素に解決される場合、この呼び出しは例外をスローします。
- Timeout [float]? (オプション)#
  
  最大タイムアウト時間（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。デフォルト値は、BrowserContext.SetDefaultTimeout() または Page.SetDefaultTimeout() メソッドを使用して変更できます。

戻り値

ElementHandle?#

WaitForTimeoutAsync

v1.9より前に追加

frame.WaitForTimeoutAsync

非推奨

本番環境でタイムアウトを待機しないでください。時間を待機するテストは本質的に不安定です。自動的に待機する Locator アクションとウェブアサーションを使用してください。

指定された timeout （ミリ秒単位）の間、待機します。

frame.waitForTimeout() はデバッグにのみ使用する必要があることに注意してください。本番環境でタイマーを使用するテストは不安定になる可能性があります。代わりに、ネットワークイベント、セレクターが可視になるなどのシグナルを使用してください。

使用法

await Frame.WaitForTimeoutAsync(timeout);

引数

timeout [float]#

待機するタイムアウト

戻り値

void #

メソッド​

AddScriptTagAsync​

AddStyleTagAsync​

ChildFrames​

ContentAsync​

DragAndDropAsync​

EvaluateAsync​

EvaluateHandleAsync​

FrameElementAsync​

FrameLocator​

GetByAltText​

GetByLabel​

GetByPlaceholder​

GetByRole​

GetByTestId​

GetByText​

GetByTitle​

GotoAsync​

IsDetached​

IsEnabledAsync​

Locator​

Name​

Page​

ParentFrame​

SetContentAsync​

TitleAsync​

Url​

WaitForFunctionAsync​

WaitForLoadStateAsync​

WaitForURLAsync​

Deprecated​

CheckAsync​

ClickAsync​

DblClickAsync​

DispatchEventAsync​

EvalOnSelectorAsync​

EvalOnSelectorAllAsync​

FillAsync​

FocusAsync​

GetAttributeAsync​

HoverAsync​

InnerHTMLAsync​

InnerTextAsync​

InputValueAsync​

IsCheckedAsync​

IsDisabledAsync​

IsEditableAsync​

IsHiddenAsync​

IsVisibleAsync​

PressAsync​

QuerySelectorAsync​

QuerySelectorAllAsync​

RunAndWaitForNavigationAsync​

WaitForNavigationAsync​

SelectOptionAsync​

SetCheckedAsync​

SetInputFilesAsync​

TapAsync​

TextContentAsync​

TypeAsync​

UncheckAsync​

WaitForSelectorAsync​

WaitForTimeoutAsync​

メソッド

AddScriptTagAsync

AddStyleTagAsync

ChildFrames

ContentAsync

DragAndDropAsync

EvaluateAsync

EvaluateHandleAsync

FrameElementAsync

FrameLocator

GetByAltText

GetByLabel

GetByPlaceholder

GetByRole

GetByTestId

GetByText

GetByTitle

GotoAsync

IsDetached

IsEnabledAsync

Locator

Name

Page

ParentFrame

SetContentAsync

TitleAsync

Url

WaitForFunctionAsync

WaitForLoadStateAsync

WaitForURLAsync

Deprecated

CheckAsync

ClickAsync

DblClickAsync

DispatchEventAsync

EvalOnSelectorAsync

EvalOnSelectorAllAsync

FillAsync

FocusAsync

GetAttributeAsync

HoverAsync

InnerHTMLAsync

InnerTextAsync

InputValueAsync

IsCheckedAsync

IsDisabledAsync

IsEditableAsync

IsHiddenAsync

IsVisibleAsync

PressAsync

QuerySelectorAsync

QuerySelectorAllAsync

RunAndWaitForNavigationAsync

WaitForNavigationAsync

SelectOptionAsync

SetCheckedAsync

SetInputFilesAsync

TapAsync

TextContentAsync

TypeAsync

UncheckAsync

WaitForSelectorAsync

WaitForTimeoutAsync