IDialogService
この IDialogService は、確認プロンプト、エラーメッセージ、情報通知、成功通知や警告、そして自分自身の内容を含むダイアログなど、モーダルダイアログを表示する方法を提供しています。
サービスの注入
任意のコンポーネントからダイアログサービスにアクセスできます。Reactでは、フレームワークダイアログプロバイダーによってラップされた木の内部から useDialogService() を呼び出します。Blazorではプロパティ注入によってサービスに注入します。PowerPortalsProのダイアログサービスは、基盤となるFluentUIダイアログサービスとは異なることに注意してください。
確認ダイアログ
ShowConfirmationAsyncを使ってユーザーにはい/いいえの質問を促します。ユーザーが二次(ネガティブ)オプションを選択すると、返DialogResult.Cancelledプロパティがtrueされます。
メッセージダイアログ
以下の方法で、異なるビジュアルスタイルでシングルボタンのメッセージダイアログを表示します:
ShowInfoAsync— 中立アイコン付きの情報メッセージ。ShowSuccessAsync— 緑色のチェックマークアイコン付きの成功メッセージ。ShowWarningAsync— 黄色の警告アイコン付きの警告メッセージ。ShowErrorAsync— 赤いエラーアイコン付きのエラーメッセージ。
自分のコンテンツとの対話
ShowDialogAsync フォーム、ピッカー、プレビューなど自分のコンテンツを表示し、ダイアログの最後に返す内容を返します。Blazorではコンポーネント(または RenderFragment)を渡し、Reactではそのコンテンツをレンダリングする関数を渡します。サービスが描画するボタンに対して PrimaryText と SecondaryText を設定し、または自ら描画するコンテンツのために両方を省きます。
コンテンツは表示されるダイアログが与えられます。BlazorのIDialogContextはカスケードパラメータとして受け取り、ReactではDialogHandleがレンダリング関数に渡され、useDialogHandle()を通じてどこでも利用可能です。それを使って値で閉じたり、主ボタンをキャンセルしたり、有効または無効にしたり、主ボタンの動作を設定することができます。そのアクションが返すものがダイアログの返す内容です。ReactでKEEP_OPENKeepOpenを返して、例えば入力がまだ有効でない間にダイアログを開いたままにします。
カスタムコンテンツデモ
フォームでダイアログを開きます。 セーブ は名前が入力されるまでダイアログを開いたままにし、その後ページに戻します。 キャンセルは 何も返しません。
一般的なパラメータ
すべてのダイアログメソッドはオプションの title および primaryText パラメータを受け付けています。省略する場合は、ローカライズされたデフォルト値が使われます。確認ダイアログではキャンセルボタンラベルの secondaryText パラメータも受け入れられます。
ダイアログ結果
すべてのメソッドは DialogResult オブジェクトを返します。確認ダイアログについては、 Cancelled プロパティを確認してユーザーの選択を決定してください。メッセージのダイアログでは、結果がダイアログが終了したことを示します。
インタラクティブデモ
以下の操作でダイアログのタイトルとメッセージをカスタマイズし、任意のボタンをクリックすると対応するダイアログタイプが表示されます。
IDialogService Interface
性質
名称 | 種類 | デフォルト | 概要 |
|---|---|---|---|
OpenDialogCount | int | このサービスが現在開いているダイアログはいくつありますか。 |
名称:
OpenDialogCount種類:
int
概要:
このサービスが現在開いているダイアログはいくつありますか。 それは独自のダイアログのみで、以下の方法でメッセージボックスや確認が出されます。 レコードパネルはFluentUI のサービス を通じて作成されたダイアログなので、そうではありません ここでカウントされており、この数値がオーバーレイ層にとって有用な理由です。つまり「a 「メッセージはユーザーが読んで応答できるようにならない」と言われ、「何かダイアログ型のものが開かれている」という意味ではありません。
方法
名称 | パラメータ | 種類 | 概要 |
|---|---|---|---|
ShowConfirmationAsync | string message string title string primaryText string secondaryText | Task<DialogResult> | 提供された message と2つのアクションボタンで確認ダイアログが表示され、その後 ユーザーが一つ選ぶことができます。返 Services.DialogResult は DialogResult.Cancelled ユーザーが二次(マイナス)オプションを選択すると |
ShowDialogAsync<TComponent> | Action<CustomDialogOptions> configure IDictionary<string, Object> parameters | Task<DialogResult> | ダイアログで |
ShowErrorAsync | string message string title string primaryText | Task<DialogResult> | 提供された message とのエラーダイアログが表示され、ユーザーがそれを終了するのを待ちます。 |
ShowInfoAsync | string message string title string primaryText | Task<DialogResult> | 提供された message に関する情報ダイアログが表示され、ユーザーが終了するのを待ちます。 |
ShowSuccessAsync | string message string title string primaryText | Task<DialogResult> | 提供された message との成功ダイアログが表示され、ユーザーが終了するのを待ちます。 |
ShowWarningAsync | string message string title string primaryText | Task<DialogResult> | 提供された message で警告ダイアログが表示され、ユーザーがそれを終了するのを待ちます。 |
名称:
ShowConfirmationAsyncパラメータ:
string message
string title
string primaryText
string secondaryText
string title
string primaryText
string secondaryText
種類:
Task<DialogResult>
概要:
提供された 真となります 。
message と2つのアクションボタンで確認ダイアログが表示され、その後 ユーザーが一つ選ぶことができます。返 Services.DialogResult は DialogResult.Cancelled ユーザーが二次(マイナス)オプションを選択すると 名称:
ShowDialogAsync<TComponent>パラメータ:
Action<CustomDialogOptions> configure
IDictionary<string, Object> parameters
IDictionary<string, Object> parameters
種類:
Task<DialogResult>
概要:
ダイアログで
名称:
ShowErrorAsyncパラメータ:
string message
string title
string primaryText
string title
string primaryText
種類:
Task<DialogResult>
概要:
提供された
message とのエラーダイアログが表示され、ユーザーがそれを終了するのを待ちます。名称:
ShowInfoAsyncパラメータ:
string message
string title
string primaryText
string title
string primaryText
種類:
Task<DialogResult>
概要:
提供された
message に関する情報ダイアログが表示され、ユーザーが終了するのを待ちます。名称:
ShowSuccessAsyncパラメータ:
string message
string title
string primaryText
string title
string primaryText
種類:
Task<DialogResult>
概要:
提供された
message との成功ダイアログが表示され、ユーザーが終了するのを待ちます。名称:
ShowWarningAsyncパラメータ:
string message
string title
string primaryText
string title
string primaryText
種類:
Task<DialogResult>
概要:
提供された
message で警告ダイアログが表示され、ユーザーがそれを終了するのを待ちます。DialogResult クラス
性質
名称 | 種類 | デフォルト | 概要 |
|---|---|---|---|
Cancelled | bool | False | ダイアログがキャンセルされたかどうか(例:ユーザーが確認せずに終了した)を示す値が付与されます。 |
Data | Object? | ダイアログが閉じたときに返されるオプションのデータペイロード。 |
名称:
Cancelled種類:
bool
デフォルト:
False
概要:
ダイアログがキャンセルされたかどうか(例:ユーザーが確認せずに終了した)を示す値が付与されます。
名称:
Data種類:
Object?
概要:
ダイアログが閉じたときに返されるオプションのデータペイロード。
方法
名称 | パラメータ | 種類 | 概要 |
|---|---|---|---|
Cancel | Object data | DialogResult | キャンセルされた結果を表す Services.DialogResult を作成し、オプションでデータペイロードを搭載します。 |
GetData<T> | T? | ダイアログが終了したときの値( | |
Ok<T> | T result | DialogResult | resultをデータペイロードとして運ぶ、確認された結果を表すServices.DialogResultを作成します。 |
TryGetData<T> | out T value | bool | ダイアログの終了時に使った値を読み取 |
名称:
Cancelパラメータ:
Object data
種類:
DialogResult
概要:
キャンセルされた結果を表す
Services.DialogResult を作成し、オプションでデータペイロードを搭載します。名称:
GetData<T>種類:
T?
概要:
ダイアログが終了したときの値( デフォルト ) キャンセルされた、何もで閉じられなかった、または別の種類の値で閉じた。
名称:
Ok<T>パラメータ:
T result
種類:
DialogResult
概要:
resultをデータペイロードとして運ぶ、確認された結果を表すServices.DialogResultを作成します。名称:
TryGetData<T>パラメータ:
out T value
種類:
bool
概要:
ダイアログの終了時に使った値を読み取
CustomDialogOptions クラス
性質
名称 | 種類 | デフォルト | 概要 |
|---|---|---|---|
PreventDismissOnEscape | bool | False | Escapeがダイアログを閉じられないようにするかどうか。デフォルトの false。 |
PrimaryText | string? | 主ボタンのラベル。サービスはこれが設定されるとボタンを引きます。両方とも残しておきます そして CustomDialogOptions.SecondaryText 独自のボタンを引くコンテンツのために設定されていません。何だってボタンだ DOSは1 IDialogContext.OnPrimaryまでです。 | |
SecondaryText | string? | セカンダリーボタンのラベルです。これが設定されるとサービスがボタンを引き出し、キャンセルします その対話。 | |
ShowDismiss | bool | True | ヘッダーに閉じボタンが表示されているかどうか。デフォルトの true。 |
Title | string? | ダイアログのタイトルはヘッダーに表示されています。タイトルのないダイアログの場合は省略してください。 | |
Width | string? | ダイアログの幅はCSSの長さとして使われます。例:「 |
名称:
PreventDismissOnEscape種類:
bool
デフォルト:
False
概要:
Escapeがダイアログを閉じられないようにするかどうか。デフォルトの
false。名称:
PrimaryText種類:
string?
概要:
主ボタンのラベル。サービスはこれが設定されるとボタンを引きます。両方とも残しておきます そして
CustomDialogOptions.SecondaryText 独自のボタンを引くコンテンツのために設定されていません。何だってボタンだ DOSは1 IDialogContext.OnPrimaryまでです。名称:
SecondaryText種類:
string?
概要:
セカンダリーボタンのラベルです。これが設定されるとサービスがボタンを引き出し、キャンセルします その対話。
名称:
ShowDismiss種類:
bool
デフォルト:
True
概要:
ヘッダーに閉じボタンが表示されているかどうか。デフォルトの
true。名称:
Title種類:
string?
概要:
ダイアログのタイトルはヘッダーに表示されています。タイトルのないダイアログの場合は省略してください。
名称:
Width種類:
string?
概要:
ダイアログの幅はCSSの長さとして使われます。例:「 min(700px, 90vw)」 デフォルトでは省略してください。
IDialogContext Interface
性質
名称 | 種類 | デフォルト | 概要 |
|---|---|---|---|
OnPrimary | Func<Task<Object>>? | サービスで引き出されたプライマリボタンが押されると実行されます。その結果はダイアログが返す結果です。 DialogResult.Data;ダイアログを開いたままにするために IDialogContext.KeepOpen 戻る 代わりに。未設定の場合、ボタンはデータなしでダイアログを閉じます。実行中、ボタンは 無効化され、Escapeはダイアログを終了しません(Blazor Server上では、 クリック:ブロックは往復後にブラウザに到達します)。もし 投げられたら、 エラーは記録され、ダイアログは開いたまま、一般的なエラーメッセージが表示されます。に対して ユーザーが修正できる故障は、自分で何が問題だったか言い、返品すればいい IDialogContext.KeepOpen。 | |
PrimaryEnabled | bool | サービスで引き出されたプライマリボタンを押せるかどうか、例えば必要な選択を一度だけ押せるかどうかは 作った。デフォルトの true。 |
名称:
OnPrimary種類:
Func<Task<Object>>?
概要:
サービスで引き出されたプライマリボタンが押されると実行されます。その結果はダイアログが返す結果です。
DialogResult.Data;ダイアログを開いたままにするために IDialogContext.KeepOpen 戻る 代わりに。未設定の場合、ボタンはデータなしでダイアログを閉じます。実行中、ボタンは 無効化され、Escapeはダイアログを終了しません(Blazor Server上では、 クリック:ブロックは往復後にブラウザに到達します)。もし 投げられたら、 エラーは記録され、ダイアログは開いたまま、一般的なエラーメッセージが表示されます。に対して ユーザーが修正できる故障は、自分で何が問題だったか言い、返品すればいい IDialogContext.KeepOpen。名称:
PrimaryEnabled種類:
bool
概要:
サービスで引き出されたプライマリボタンを押せるかどうか、例えば必要な選択を一度だけ押せるかどうかは 作った。デフォルトの
true。方法
名称 | パラメータ | 種類 | 概要 |
|---|---|---|---|
CancelAsync | Task | ダイアログをキャンセルとして閉じ、 Cancel(System.Object)を返します。 | |
CloseAsync | Object data | Task | ダイアログを閉じ、会話は dataでDialogResult.Ok`<T>(`<U>)戻ります。 |
名称:
CancelAsync種類:
Task
概要:
ダイアログをキャンセルとして閉じ、
Cancel(System.Object)を返します。名称:
CloseAsyncパラメータ:
Object data
種類:
Task
概要:
ダイアログを閉じ、会話は
dataでDialogResult.Ok`<T>(`<U>)戻ります。