Skip to content

Commit 3c468b6

Browse files
ArgoZhangArgoZhang
authored
doc(Extensions): update extensions method coments (#7838)
1 parent be9a680 commit 3c468b6

File tree

3 files changed

+250
-69
lines changed

3 files changed

+250
-69
lines changed

‎src/BootstrapBlazor/Extensions/DialogServiceExtensions.cs‎

Lines changed: 180 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,22 @@ public static class DialogServiceExtensions
1717
/// <para lang="zh">Show 对话框泛型方法</para>
1818
/// <para lang="en">Show dialog with generic type</para>
1919
/// </summary>
20-
/// <param name="service"><para lang="zh">DialogService 服务实例</para><para lang="en">DialogService instance</para></param>
21-
/// <param name="title"><para lang="zh">对话框标题，优先级高于 <see cref="DialogOption.Title"/></para><para lang="en">Dialog title, priority higher than <see cref="DialogOption.Title"/></para></param>
22-
/// <param name="parameters"><para lang="zh">TComponent 组件所需要的参数集合</para><para lang="en">TComponent parameters</para></param>
23-
/// <param name="dialog"><para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para><para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para></param>
20+
/// <param name="service">
21+
/// <para lang="zh">DialogService 服务实例</para>
22+
/// <para lang="en">DialogService instance</para>
23+
/// </param>
24+
/// <param name="title">
25+
/// <para lang="zh">对话框标题，优先级高于 <see cref="DialogOption.Title"/></para>
26+
/// <para lang="en">Dialog title, priority higher than <see cref="DialogOption.Title"/></para>
27+
/// </param>
28+
/// <param name="parameters">
29+
/// <para lang="zh">TComponent 组件所需要的参数集合</para>
30+
/// <para lang="en">TComponent parameters</para>
31+
/// </param>
32+
/// <param name="dialog">
33+
/// <para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para>
34+
/// <para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para>
35+
/// </param>
2436
public static Task Show<TComponent>(this DialogService service, string title, IDictionary<string, object?>? parameters = null, Dialog? dialog = null) where TComponent : IComponent
2537
{
2638
var option = new DialogOption();
@@ -37,9 +49,18 @@ public static Task Show<TComponent>(this DialogService service, string title, ID
3749
/// <para lang="zh">弹出搜索对话框</para>
3850
/// <para lang="en">Show search dialog</para>
3951
/// </summary>
40-
/// <param name="service"><para lang="zh">DialogService 服务实例</para><para lang="en">DialogService instance</para></param>
41-
/// <param name="option"><para lang="zh">SearchDialogOption 配置类实例</para><para lang="en">SearchDialogOption instance</para></param>
42-
/// <param name="dialog"><para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para><para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para></param>
52+
/// <param name="service">
53+
/// <para lang="zh">DialogService 服务实例</para>
54+
/// <para lang="en">DialogService instance</para>
55+
/// </param>
56+
/// <param name="option">
57+
/// <para lang="zh">SearchDialogOption 配置类实例</para>
58+
/// <para lang="en">SearchDialogOption instance</para>
59+
/// </param>
60+
/// <param name="dialog">
61+
/// <para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para>
62+
/// <para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para>
63+
/// </param>
4364
public static async Task ShowSearchDialog<TModel>(this DialogService service, SearchDialogOption<TModel> option, Dialog? dialog = null)
4465
{
4566
var parameters = new Dictionary<string, object?>
@@ -81,9 +102,18 @@ public static async Task ShowSearchDialog<TModel>(this DialogService service, Se
81102
/// <para lang="zh">弹出编辑对话框</para>
82103
/// <para lang="en">Show edit dialog</para>
83104
/// </summary>
84-
/// <param name="service"><see cref="DialogService"/> <para lang="zh">服务实例</para><para lang="en">Instance</para></param>
85-
/// <param name="option"><see cref="ITableEditDialogOption{TModel}"/> <para lang="zh">配置类实例</para><para lang="en">Option Instance</para></param>
86-
/// <param name="dialog"></param>
105+
/// <param name="service">
106+
/// <para lang="zh">DialogService 服务实例</para>
107+
/// <para lang="en">DialogService instance</para>
108+
/// </param>
109+
/// <param name="option">
110+
/// <para lang="zh">EditDialogOption 配置类实例</para>
111+
/// <para lang="en">EditDialogOption instance</para>
112+
/// </param>
113+
/// <param name="dialog">
114+
/// <para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para>
115+
/// <para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para>
116+
/// </param>
87117
public static async Task ShowEditDialog<TModel>(this DialogService service, EditDialogOption<TModel> option, Dialog? dialog = null)
88118
{
89119
option.Component = BootstrapDynamicComponent.CreateComponent<EditDialog<TModel>>(option.ToParameter());
@@ -94,9 +124,18 @@ public static async Task ShowEditDialog<TModel>(this DialogService service, Edit
94124
/// <para lang="zh">弹出带结果的对话框</para>
95125
/// <para lang="en">Show dialog with result</para>
96126
/// </summary>
97-
/// <param name="service"><para lang="zh">DialogService 服务实例</para><para lang="en">DialogService instance</para></param>
98-
/// <param name="option"><para lang="zh">对话框参数</para><para lang="en">Dialog option</para></param>
99-
/// <param name="dialog"><para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para><para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para></param>
127+
/// <param name="service">
128+
/// <para lang="zh">DialogService 服务实例</para>
129+
/// <para lang="en">DialogService instance</para>
130+
/// </param>
131+
/// <param name="option">
132+
/// <para lang="zh">对话框参数</para>
133+
/// <para lang="en">Dialog option</para>
134+
/// </param>
135+
/// <param name="dialog">
136+
/// <para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para>
137+
/// <para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para>
138+
/// </param>
100139
public static async Task<DialogResult> ShowModal<TDialog>(this DialogService service, ResultDialogOption option, Dialog? dialog = null)
101140
where TDialog : IComponent, IResultDialog
102141
{
@@ -140,11 +179,26 @@ public static async Task<DialogResult> ShowModal<TDialog>(this DialogService ser
140179
/// <para lang="zh">弹出带结果的对话框</para>
141180
/// <para lang="en">Show dialog with result</para>
142181
/// </summary>
143-
/// <param name="service"><para lang="zh">DialogService 服务实例</para><para lang="en">DialogService instance</para></param>
144-
/// <param name="title"><para lang="zh">对话框标题，优先级高于 <see cref="DialogOption.Title"/></para><para lang="en">Dialog title, priority higher than <see cref="DialogOption.Title"/></para></param>
145-
/// <param name="content"><para lang="zh">对话框 <see cref="MarkupString"/> 文本参数</para><para lang="en">Dialog <see cref="MarkupString"/> content parameter</para></param>
146-
/// <param name="option"><see cref="ResultDialogOption"/> <para lang="zh">对话框参数实例</para><para lang="en">Dialog option instance</para></param>
147-
/// <param name="dialog"><para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para><para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para></param>
182+
/// <param name="service">
183+
/// <para lang="zh">DialogService 服务实例</para>
184+
/// <para lang="en">DialogService instance</para>
185+
/// </param>
186+
/// <param name="title">
187+
/// <para lang="zh">对话框标题，优先级高于 <see cref="DialogOption.Title"/></para>
188+
/// <para lang="en">Dialog title, priority higher than <see cref="DialogOption.Title"/></para>
189+
/// </param>
190+
/// <param name="content">
191+
/// <para lang="zh">对话框 <see cref="MarkupString"/> 文本参数</para>
192+
/// <para lang="en">Dialog <see cref="MarkupString"/> content parameter</para>
193+
/// </param>
194+
/// <param name="option">
195+
/// <para lang="zh">对话框参数实例</para>
196+
/// <para lang="en">Dialog option instance</para>
197+
/// </param>
198+
/// <param name="dialog">
199+
/// <para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para>
200+
/// <para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para>
201+
/// </param>
148202
public static Task<DialogResult> ShowModal(this DialogService service, string title, string content, ResultDialogOption? option = null, Dialog? dialog = null)
149203
{
150204
option ??= new();
@@ -188,12 +242,30 @@ public Task OnClose(DialogResult result)
188242
/// <para lang="en">Show dialog with save button</para>
189243
/// </summary>
190244
/// <typeparam name="TComponent"></typeparam>
191-
/// <param name="service"><para lang="zh">DialogService 服务实例</para><para lang="en">DialogService instance</para></param>
192-
/// <param name="title"><para lang="zh">弹窗标题</para><para lang="en">Dialog title</para></param>
193-
/// <param name="saveCallback"><para lang="zh">点击保存按钮回调委托方法 返回 true 时关闭弹窗</para><para lang="en">Save button callback delegate, return true to close dialog</para></param>
194-
/// <param name="parametersFactory"><para lang="zh">TComponent 组件所需参数</para><para lang="en">TComponent parameters</para></param>
195-
/// <param name="configureOption"><para lang="zh"><see cref="DialogOption"/> 实例配置回调方法</para><para lang="en"><see cref="DialogOption"/> configuration callback</para></param>
196-
/// <param name="dialog"></param>
245+
/// <param name="service">
246+
/// <para lang="zh">DialogService 服务实例</para>
247+
/// <para lang="en">DialogService instance</para>
248+
/// </param>
249+
/// <param name="title">
250+
/// <para lang="zh">弹窗标题</para>
251+
/// <para lang="en">Dialog title</para>
252+
/// </param>
253+
/// <param name="saveCallback">
254+
/// <para lang="zh">点击保存按钮回调委托方法 返回 true 时关闭弹窗</para>
255+
/// <para lang="en">Save button callback delegate, return true to close dialog</para>
256+
/// </param>
257+
/// <param name="parametersFactory">
258+
/// <para lang="zh">TComponent 组件所需参数</para>
259+
/// <para lang="en">TComponent parameters</para>
260+
/// </param>
261+
/// <param name="configureOption">
262+
/// <para lang="zh"><see cref="DialogOption"/> 实例配置回调方法</para>
263+
/// <para lang="en"><see cref="DialogOption"/> configuration callback</para>
264+
/// </param>
265+
/// <param name="dialog">
266+
/// <para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para>
267+
/// <para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para>
268+
/// </param>
197269
public static async Task ShowSaveDialog<TComponent>(this DialogService service, string title, Func<Task<bool>>? saveCallback = null, Action<Dictionary<string, object?>>? parametersFactory = null, Action<DialogOption>? configureOption = null, Dialog? dialog = null) where TComponent : ComponentBase
198270
{
199271
var option = new DialogOption()
@@ -214,11 +286,26 @@ public static async Task ShowSaveDialog<TComponent>(this DialogService service,
214286
/// <para lang="en">Show dialog with close button</para>
215287
/// </summary>
216288
/// <typeparam name="TComponent"></typeparam>
217-
/// <param name="service"></param>
218-
/// <param name="title"></param>
219-
/// <param name="parametersFactory"></param>
220-
/// <param name="configureOption"></param>
221-
/// <param name="dialog"></param>
289+
/// <param name="service">
290+
/// <para lang="zh">DialogService 服务实例</para>
291+
/// <para lang="en">DialogService instance</para>
292+
/// </param>
293+
/// <param name="title">
294+
/// <para lang="zh">弹窗标题</para>
295+
/// <para lang="en">Dialog title</para>
296+
/// </param>
297+
/// <param name="parametersFactory">
298+
/// <para lang="zh">TComponent 组件所需参数</para>
299+
/// <para lang="en">TComponent parameters</para>
300+
/// </param>
301+
/// <param name="configureOption">
302+
/// <para lang="zh"><see cref="DialogOption"/> 实例配置回调方法</para>
303+
/// <para lang="en"><see cref="DialogOption"/> configuration callback</para>
304+
/// </param>
305+
/// <param name="dialog">
306+
/// <para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para>
307+
/// <para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para>
308+
/// </param>
222309
public static async Task ShowCloseDialog<TComponent>(this DialogService service, string title, Action<Dictionary<string, object?>>? parametersFactory = null, Action<DialogOption>? configureOption = null, Dialog? dialog = null) where TComponent : ComponentBase
223310
{
224311
var option = new DialogOption()
@@ -237,11 +324,26 @@ public static async Task ShowCloseDialog<TComponent>(this DialogService service,
237324
/// <para lang="en">Show validate form dialog</para>
238325
/// </summary>
239326
/// <typeparam name="TComponent"></typeparam>
240-
/// <param name="service"><para lang="zh">DialogService 服务实例</para><para lang="en">DialogService instance</para></param>
241-
/// <param name="title"><para lang="zh">弹窗标题</para><para lang="en">Dialog title</para></param>
242-
/// <param name="parametersFactory"><para lang="zh">TComponent 组件所需参数</para><para lang="en">TComponent parameters</para></param>
243-
/// <param name="configureOption"><para lang="zh"><see cref="DialogOption"/> 实例配置回调方法</para><para lang="en"><see cref="DialogOption"/> configuration callback</para></param>
244-
/// <param name="dialog"></param>
327+
/// <param name="service">
328+
/// <para lang="zh">DialogService 服务实例</para>
329+
/// <para lang="en">DialogService instance</para>
330+
/// </param>
331+
/// <param name="title">
332+
/// <para lang="zh">弹窗标题</para>
333+
/// <para lang="en">Dialog title</para>
334+
/// </param>
335+
/// <param name="parametersFactory">
336+
/// <para lang="zh">TComponent 组件所需参数</para>
337+
/// <para lang="en">TComponent parameters</para>
338+
/// </param>
339+
/// <param name="configureOption">
340+
/// <para lang="zh"><see cref="DialogOption"/> 实例配置回调方法</para>
341+
/// <para lang="en"><see cref="DialogOption"/> configuration callback</para>
342+
/// </param>
343+
/// <param name="dialog">
344+
/// <para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para>
345+
/// <para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para>
346+
/// </param>
245347
public static async Task ShowValidateFormDialog<TComponent>(this DialogService service, string title, Func<DialogOption, Dictionary<string, object?>>? parametersFactory = null, Action<DialogOption>? configureOption = null, Dialog? dialog = null) where TComponent : ComponentBase
246348
{
247349
var option = new DialogOption()
@@ -259,9 +361,18 @@ public static async Task ShowValidateFormDialog<TComponent>(this DialogService s
259361
/// <para lang="zh">显示异常信息对话框扩展方法</para>
260362
/// <para lang="en">Show error handler dialog</para>
261363
/// </summary>
262-
/// <param name="service"></param>
263-
/// <param name="fragment"></param>
264-
/// <param name="dialog"></param>
364+
/// <param name="service">
365+
/// <para lang="zh">DialogService 服务实例</para>
366+
/// <para lang="en">DialogService instance</para>
367+
/// </param>
368+
/// <param name="fragment">
369+
/// <para lang="zh">渲染片段</para>
370+
/// <para lang="en">Render fragment</para>
371+
/// </param>
372+
/// <param name="dialog">
373+
/// <para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para>
374+
/// <para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para>
375+
/// </param>
265376
[Obsolete("已弃用，请使用 ShowExceptionDialog 方法。Deprecated, please use ShowExceptionDialog method")]
266377
[ExcludeFromCodeCoverage]
267378
public static Task ShowErrorHandlerDialog(this DialogService service, RenderFragment fragment, Dialog? dialog = null)
@@ -273,10 +384,22 @@ public static Task ShowErrorHandlerDialog(this DialogService service, RenderFrag
273384
/// <para lang="zh">显示异常信息对话框扩展方法</para>
274385
/// <para lang="en">Show error handler dialog</para>
275386
/// </summary>
276-
/// <param name="service"></param>
277-
/// <param name="title"></param>
278-
/// <param name="fragment"></param>
279-
/// <param name="dialog"></param>
387+
/// <param name="service">
388+
/// <para lang="zh">DialogService 服务实例</para>
389+
/// <para lang="en">DialogService instance</para>
390+
/// </param>
391+
/// <param name="title">
392+
/// <para lang="zh">弹窗标题</para>
393+
/// <para lang="en">Dialog title</para>
394+
/// </param>
395+
/// <param name="fragment">
396+
/// <para lang="zh">渲染片段</para>
397+
/// <para lang="en">Render fragment</para>
398+
/// </param>
399+
/// <param name="dialog">
400+
/// <para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para>
401+
/// <para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para>
402+
/// </param>
280403
public static async Task ShowExceptionDialog(this DialogService service, string? title, RenderFragment fragment, Dialog? dialog = null)
281404
{
282405
var option = new DialogOption
@@ -292,10 +415,22 @@ public static async Task ShowExceptionDialog(this DialogService service, string?
292415
/// <para lang="zh">显示异常信息对话框扩展方法</para>
293416
/// <para lang="en">Show exception dialog</para>
294417
/// </summary>
295-
/// <param name="service"></param>
296-
/// <param name="title"></param>
297-
/// <param name="exception"></param>
298-
/// <param name="dialog"></param>
418+
/// <param name="service">
419+
/// <para lang="zh">DialogService 服务实例</para>
420+
/// <para lang="en">DialogService instance</para>
421+
/// </param>
422+
/// <param name="title">
423+
/// <para lang="zh">弹窗标题</para>
424+
/// <para lang="en">Dialog title</para>
425+
/// </param>
426+
/// <param name="exception">
427+
/// <para lang="zh">异常对象</para>
428+
/// <para lang="en">Exception object</para>
429+
/// </param>
430+
/// <param name="dialog">
431+
/// <para lang="zh">指定弹窗组件 默认为 null 使用 <see cref="BootstrapBlazorRoot"/> 组件内置弹窗组件</para>
432+
/// <para lang="en">Specify the dialog component, default is null, use <see cref="BootstrapBlazorRoot"/> built-in dialog component</para>
433+
/// </param>
299434
public static async Task ShowExceptionDialog(this DialogService service, string? title, Exception exception, Dialog? dialog = null)
300435
{
301436
RenderFragment fragment = builder =>

0 commit comments

Comments
 (0)