Skip to content

Commit d8f3539

Browse files
committed
doc: 文档注释更新为英语
1 parent 28a9d85 commit d8f3539

File tree

1 file changed

+41
-41
lines changed

1 file changed

+41
-41
lines changed

src/BootstrapBlazor/Components/Dialog/DialogOption.cs

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -6,194 +6,194 @@
66
namespace BootstrapBlazor.Components;
77

88
/// <summary>
9-
/// Dialog 组件配置类
9+
/// Configuration class for the Dialog component
1010
/// </summary>
1111
public class DialogOption
1212
{
1313
/// <summary>
14-
/// 获得/设置 相关弹窗实例
14+
/// Gets or sets the related modal instance
1515
/// </summary>
1616
internal Modal? Modal { get; set; }
1717

1818
/// <summary>
19-
/// 获得/设置 弹窗标题
19+
/// Gets or sets the dialog title
2020
/// </summary>
2121
public string? Title { get; set; }
2222

2323
/// <summary>
24-
/// 获得/设置 弹窗自定义样式
24+
/// Gets or sets the custom style of the dialog
2525
/// </summary>
2626
public string? Class { get; set; }
2727

2828
/// <summary>
29-
/// 获得/设置 弹窗大小
29+
/// Gets or sets the size of the dialog
3030
/// </summary>
3131
public Size Size { get; set; } = Size.ExtraExtraLarge;
3232

3333
/// <summary>
34-
/// 获得/设置 全屏弹窗 默认 None
34+
/// Gets or sets the full screen size of the dialog, default is None
3535
/// </summary>
36-
/// <remarks>为保证功能正常,设置值后 <see cref="ShowMaximizeButton"/> <seealso cref="ShowResize"/> <seealso cref="IsDraggable"/> 均不可用</remarks>
36+
/// <remarks>To ensure functionality, when this value is set, <see cref="ShowMaximizeButton"/>, <seealso cref="ShowResize"/>, and <seealso cref="IsDraggable"/> are not available</remarks>
3737
public FullScreenSize FullScreenSize { get; set; } = FullScreenSize.None;
3838

3939
/// <summary>
40-
/// 获得/设置 是否显示最大化按钮 默认 false 不显示
40+
/// Gets or sets whether to show the maximize button, default is false
4141
/// </summary>
42-
/// <remarks>为保证功能正常,设置值为 true 后 <seealso cref="ShowResize"/> <seealso cref="IsDraggable"/> 均不可用</remarks>
42+
/// <remarks>To ensure functionality, when this value is set to true, <seealso cref="ShowResize"/> and <seealso cref="IsDraggable"/> are not available</remarks>
4343
public bool ShowMaximizeButton { get; set; }
4444

4545
/// <summary>
46-
/// 获得/设置 是否垂直居中 默认为 true
46+
/// Gets or sets whether the dialog is vertically centered, default is true
4747
/// </summary>
4848
public bool IsCentered { get; set; } = true;
4949

5050
/// <summary>
51-
/// 获得/设置 是否弹窗正文超长时滚动 默认为 false
51+
/// Gets or sets whether the dialog content scrolls when it is too long, default is false
5252
/// </summary>
5353
public bool IsScrolling { get; set; } = false;
5454

5555
/// <summary>
56-
/// 获得/设置 是否显示调整大小按钮 默认为 false
56+
/// Gets or sets whether to show the resize button, default is false
5757
/// </summary>
5858
public bool ShowResize { get; set; }
5959

6060
/// <summary>
61-
/// 获得/设置 是否显示关闭按钮 默认为 true
61+
/// Gets or sets whether to show the close button, default is true
6262
/// </summary>
6363
public bool ShowCloseButton { get; set; } = true;
6464

6565
/// <summary>
66-
/// 获得/设置 是否显示 Header 关闭按钮 默认为 true
66+
/// Gets or sets whether to show the header close button, default is true
6767
/// </summary>
6868
public bool ShowHeaderCloseButton { get; set; } = true;
6969

7070
/// <summary>
71-
/// 获得/设置 是否支持键盘 ESC 关闭当前弹窗 默认 true 支持
71+
/// Gets or sets whether to support closing the dialog with the ESC key, default is true
7272
/// </summary>
7373
public bool IsKeyboard { get; set; } = true;
7474

7575
/// <summary>
76-
/// 获得/设置 是否支持点击遮罩关闭弹窗 默认 false
76+
/// Gets or sets whether to support closing the dialog by clicking the backdrop, default is false
7777
/// </summary>
7878
public bool IsBackdrop { get; set; }
7979

8080
/// <summary>
81-
/// 获得/设置 是否显示 Footer 默认为 true
81+
/// Gets or sets whether to show the footer, default is true
8282
/// </summary>
8383
public bool ShowFooter { get; set; } = true;
8484

8585
/// <summary>
86-
/// 获得/设置 是否显示打印按钮 默认 false 不显示
86+
/// Gets or sets whether to show the print button, default is false
8787
/// </summary>
8888
public bool ShowPrintButton { get; set; }
8989

9090
/// <summary>
91-
/// 获得/设置 是否显示保存按钮 默认 false 不显示
91+
/// Gets or sets whether to show the save button, default is false
9292
/// </summary>
9393
public bool ShowSaveButton { get; set; }
9494

9595
/// <summary>
96-
/// 获得/设置 打印按钮是否显示在 Header 中 默认 false 不显示
96+
/// Gets or sets whether to show the print button in the header, default is false
9797
/// </summary>
9898
public bool ShowPrintButtonInHeader { get; set; }
9999

100100
/// <summary>
101-
/// 获得/设置 Header 中打印按钮显示文字 默认为资源文件中 打印
101+
/// Gets or sets the text of the print button in the header, default is "Print" from the resource file
102102
/// </summary>
103103
public string? PrintButtonText { get; set; }
104104

105105
/// <summary>
106-
/// 获得/设置 相关连数据,多用于传值使用
106+
/// Gets or sets the related data, mostly used for passing values
107107
/// </summary>
108108
public object? BodyContext { get; set; }
109109

110110
/// <summary>
111-
/// 获得/设置 ModalBody 组件
111+
/// Gets or sets the ModalBody component
112112
/// </summary>
113113
public RenderFragment? BodyTemplate { get; set; }
114114

115115
/// <summary>
116-
/// 获得/设置 ModalFooter 组件
116+
/// Gets or sets the ModalFooter component
117117
/// </summary>
118118
public RenderFragment? FooterTemplate { get; set; }
119119

120120
/// <summary>
121-
/// 获得/设置 ModalHeader 组件模板
121+
/// Gets or sets the ModalHeader component template
122122
/// </summary>
123123
public RenderFragment? HeaderTemplate { get; set; }
124124

125125
/// <summary>
126-
/// 获得/设置 ModalHeader 组件自定义按钮
126+
/// Gets or sets the custom buttons in the ModalHeader component
127127
/// </summary>
128128
public RenderFragment? HeaderToolbarTemplate { get; set; }
129129

130130
/// <summary>
131-
/// 获得/设置 自定义组件
131+
/// Gets or sets the custom component
132132
/// </summary>
133133
public BootstrapDynamicComponent? Component { get; set; }
134134

135135
/// <summary>
136-
/// 获得/设置 保存按钮图标 默认 null 使用当前主题图标
136+
/// Gets or sets the icon of the save button, default is null and uses the current theme icon
137137
/// </summary>
138138
public string? SaveButtonIcon { get; set; }
139139

140140
/// <summary>
141-
/// 获得/设置 保存按钮文本
141+
/// Gets or sets the text of the save button
142142
/// </summary>
143143
public string? SaveButtonText { get; set; }
144144

145145
/// <summary>
146-
/// 获得/设置 保存按钮回调方法
146+
/// Gets or sets the callback method for the save button
147147
/// </summary>
148148
public Func<Task<bool>>? OnSaveAsync { get; set; }
149149

150150
/// <summary>
151-
/// 获得/设置 关闭按钮图标 默认 null 使用当前主题图标
151+
/// Gets or sets the icon of the close button, default is null and uses the current theme icon
152152
/// </summary>
153153
public string? CloseButtonIcon { get; set; }
154154

155155
/// <summary>
156-
/// 获得/设置 关闭按钮文本
156+
/// Gets or sets the text of the close button
157157
/// </summary>
158158
public string? CloseButtonText { get; set; }
159159

160160
/// <summary>
161-
/// 获得/设置 关闭弹窗回调方法
161+
/// Gets or sets the callback method for closing the dialog
162162
/// </summary>
163163
public Func<Task>? OnCloseAsync { get; set; }
164164

165165
/// <summary>
166-
/// 获得/设置 保存成功后是否自动关闭弹窗 默认 true 自动关闭
166+
/// Gets or sets whether to automatically close the dialog after saving successfully, default is true
167167
/// </summary>
168168
public bool IsAutoCloseAfterSave { get; set; } = true;
169169

170170
/// <summary>
171-
/// 获得/设置 是否可以拖拽弹窗 默认 false 不可以拖动
171+
/// Gets or sets whether the dialog can be dragged, default is false
172172
/// </summary>
173173
public bool IsDraggable { get; set; }
174174

175175
/// <summary>
176-
/// 获得/设置 弹窗已显示时回调此方法
176+
/// Gets or sets the callback method when the dialog is shown
177177
/// </summary>
178178
public Func<Task>? OnShownAsync { get; set; }
179179

180180
/// <summary>
181-
/// 获得/设置 是否显示导出 Pdf 按钮 默认为 false 不显示
181+
/// Gets or sets whether to show the export PDF button, default is false
182182
/// </summary>
183183
public bool ShowExportPdfButton { get; set; }
184184

185185
/// <summary>
186-
/// 获得/设置 Header 中是否显示导出 Pdf 按钮 默认 false 不显示
186+
/// Gets or sets whether to show the export PDF button in the header, default is false
187187
/// </summary>
188188
public bool ShowExportPdfButtonInHeader { get; set; }
189189

190190
/// <summary>
191-
/// 获得/设置 导出 Pdf 按钮配置项
191+
/// Gets or sets the configuration options for the export PDF button
192192
/// </summary>
193193
public ExportPdfButtonOptions? ExportPdfButtonOptions { get; set; }
194194

195195
/// <summary>
196-
/// 关闭弹窗方法
196+
/// Method to close the dialog
197197
/// </summary>
198198
public async Task CloseDialogAsync()
199199
{
@@ -204,7 +204,7 @@ public async Task CloseDialogAsync()
204204
}
205205

206206
/// <summary>
207-
/// 将参数转换为组件属性方法
207+
/// Method to convert parameters to component attributes
208208
/// </summary>
209209
/// <returns></returns>
210210
public Dictionary<string, object> ToAttributes()

0 commit comments

Comments
 (0)