Skip to content

Commit 8bdebb0

Browse files
ArgoZhangArgoZhang
committed
refactor: 文档注释更改为英语
1 parent 88e446f commit 8bdebb0

2 files changed

Lines changed: 64 additions & 64 deletions

File tree

‎src/BootstrapBlazor/Components/EditorForm/IEditorItem.cs‎

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

88
/// <summary>
9-
/// IEditorItem 接口
9+
/// IEditorItem interface
1010
/// </summary>
1111
public interface IEditorItem : ILookup
1212
{
1313
/// <summary>
14-
/// 获得/设置 绑定列类型
14+
/// Gets or sets the type of the bound column.
1515
/// </summary>
1616
Type PropertyType { get; }
1717

1818
/// <summary>
19-
/// 获得/设置 当前编辑项是否可编辑 默认为 true
19+
/// Gets or sets whether the current edit item is editable. Default is true.
2020
/// </summary>
21-
[Obsolete("已弃用，是否显示使用 Visible 参数，新建时使用 IsVisibleWhenAdd 编辑时使用 IsVisibleWhenEdit 只读使用 Readonly 参数，新建时使用 IsReadonlyWhenAdd 编辑时使用 IsReadonlyWhenEdit 参数; Deprecated use Visible parameter. IsVisibleWhenAdd should be used when creating a new one, and IsVisibleWhenEdit should be used when editing")]
21+
[Obsolete("Deprecated. Use the Visible parameter. IsVisibleWhenAdd should be used when creating a new one, and IsVisibleWhenEdit should be used when editing. Use the Readonly parameter for read-only. IsReadonlyWhenAdd should be used when creating a new one, and IsReadonlyWhenEdit should be used when editing.")]
2222
bool Editable { get; set; }
2323

2424
/// <summary>
25-
/// 获得/设置 当前编辑项是否只读 默认为 false
25+
/// Gets or sets whether the current edit item is read-only. Default is false.
2626
/// </summary>
2727
bool? Readonly { get; set; }
2828

2929
/// <summary>
30-
/// 获得/设置 当前编辑项是否忽略 默认为 false 当设置为 true 时 UI 不生成此列
30+
/// Gets or sets whether the current edit item is ignored. Default is false. When set to true, the UI will not generate this column.
3131
/// </summary>
3232
bool? Ignore { get; set; }
3333

3434
/// <summary>
35-
/// 获得/设置 是否不进行验证 默认为 false
35+
/// Gets or sets whether to skip validation. Default is false.
3636
/// </summary>
3737
bool SkipValidate { get; set; }
3838

3939
/// <summary>
40-
/// 获得/设置 表头显示文字
40+
/// Gets or sets the header display text.
4141
/// </summary>
4242
string? Text { get; set; }
4343

4444
/// <summary>
45-
/// 获得/设置 是否显示标签 Tooltip 多用于标签文字过长导致裁减时使用 默认 null
45+
/// Gets or sets whether to show label tooltip. Mostly used when the label text is too long and gets truncated. Default is null.
4646
/// </summary>
4747
bool? ShowLabelTooltip { get; set; }
4848

4949
/// <summary>
50-
/// 获得/设置 placeholder 文本 默认为 null
50+
/// Gets or sets the placeholder text. Default is null.
5151
/// </summary>
5252
string? PlaceHolder { get; set; }
5353

5454
/// <summary>
55-
/// 获得/设置 额外数据源一般用于 Select 或者 CheckboxList 这种需要额外配置数据源组件使用
55+
/// Gets or sets the additional data source, generally used for components like Select or CheckboxList that require additional configuration.
5656
/// </summary>
5757
IEnumerable<SelectedItem>? Items { get; set; }
5858

5959
/// <summary>
60-
/// 获得/设置 步长 默认为 null 设置 any 时忽略检查
60+
/// Gets or sets the step. Default is null. When set to "any", validation is ignored.
6161
/// </summary>
6262
string? Step { get; set; }
6363

6464
/// <summary>
65-
/// 获得/设置 Textarea 行数 默认为 0
65+
/// Gets or sets the number of rows for a Textarea. Default is 0.
6666
/// </summary>
6767
int Rows { get; set; }
6868

6969
/// <summary>
70-
/// 获得/设置 编辑模板
70+
/// Gets or sets the edit template.
7171
/// </summary>
7272
RenderFragment<object>? EditTemplate { get; set; }
7373

7474
/// <summary>
75-
/// 获得/设置 组件类型 默认为 null
75+
/// Gets or sets the component type. Default is null.
7676
/// </summary>
7777
Type? ComponentType { get; set; }
7878

7979
/// <summary>
80-
/// 获得/设置 组件自定义类型参数集合 默认为 null
80+
/// Gets or sets the custom component parameters. Default is null.
8181
/// </summary>
8282
IEnumerable<KeyValuePair<string, object>>? ComponentParameters { get; set; }
8383

8484
/// <summary>
85-
/// 获得/设置 字段数据源下拉框是否显示搜索栏 默认 false 不显示
85+
/// Gets or sets whether to show the search bar in the dropdown list. Default is false.
8686
/// </summary>
8787
bool ShowSearchWhenSelect { get; set; }
8888

8989
/// <summary>
90-
/// 获得/设置 是否使用 Popover 渲染下拉框 默认 false
90+
/// Gets or sets whether to use Popover to render the dropdown list. Default is false.
9191
/// </summary>
9292
bool IsPopover { get; set; }
9393

9494
/// <summary>
95-
/// 获得/设置 自定义验证集合
95+
/// Gets or sets the custom validation rules.
9696
/// </summary>
9797
List<IValidator>? ValidateRules { get; set; }
9898

9999
/// <summary>
100-
/// 获取绑定字段显示名称方法
100+
/// Gets the display name of the bound field.
101101
/// </summary>
102102
string GetDisplayName();
103103

104104
/// <summary>
105-
/// 获取绑定字段信息方法
105+
/// Gets the field information of the bound field.
106106
/// </summary>
107107
string GetFieldName();
108108

109109
/// <summary>
110-
/// 获得/设置 顺序号
110+
/// Gets or sets the order number.
111111
/// </summary>
112112
int Order { get; set; }
113113

114114
/// <summary>
115-
/// 获得/设置 当前属性分组
115+
/// Gets or sets the group name of the current property.
116116
/// </summary>
117117
string? GroupName { get; set; }
118118

119119
/// <summary>
120-
/// 获得/设置 当前属性分组排序 默认 0
120+
/// Gets or sets the group order of the current property. Default is 0.
121121
/// </summary>
122122
int GroupOrder { get; set; }
123123

124124
/// <summary>
125-
/// 获得/设置 是否为必填项 默认为 null
125+
/// Gets or sets whether the field is required. Default is null.
126126
/// </summary>
127127
bool? Required { get; set; }
128128

129129
/// <summary>
130-
/// 获得/设置 必填项缺失时错误提示文本 默认为 null
130+
/// Gets or sets the error message when the required field is missing. Default is null.
131131
/// </summary>
132132
string? RequiredErrorMessage { get; set; }
133133
}

‎src/BootstrapBlazor/Components/Table/ITableColumn.cs‎

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

88
/// <summary>
9-
/// ITableHeader 接口
9+
/// ITableHeader interface
1010
/// </summary>
1111
public interface ITableColumn : IEditorItem
1212
{
1313
/// <summary>
14-
/// 获得/设置 是否允许排序 默认为 null
14+
/// Gets or sets whether sorting is allowed. Default is null.
1515
/// </summary>
1616
bool? Sortable { get; set; }
1717

1818
/// <summary>
19-
/// 获得/设置 是否为默认排序列 默认为 false
19+
/// Gets or sets whether it is the default sort column. Default is false.
2020
/// </summary>
2121
bool DefaultSort { get; set; }
2222

2323
/// <summary>
24-
/// 获得/设置 默认排序规则 默认为 SortOrder.Unset
24+
/// Gets or sets the default sort order. Default is SortOrder.Unset.
2525
/// </summary>
2626
SortOrder DefaultSortOrder { get; set; }
2727

2828
/// <summary>
29-
/// 获得/设置 是否允许过滤数据 默认为 null
29+
/// Gets or sets whether data filtering is allowed. Default is null.
3030
/// </summary>
3131
bool? Filterable { get; set; }
3232

3333
/// <summary>
34-
/// 获得/设置 是否参与搜索 默认为 null
34+
/// Gets or sets whether the column participates in search. Default is null.
3535
/// </summary>
3636
bool? Searchable { get; set; }
3737

3838
/// <summary>
39-
/// 获得/设置 列宽
39+
/// Gets or sets the column width.
4040
/// </summary>
4141
int? Width { get; set; }
4242

4343
/// <summary>
44-
/// 获得/设置 是否固定本列 默认 false 不固定
44+
/// Gets or sets whether the column is fixed. Default is false.
4545
/// </summary>
4646
bool Fixed { get; set; }
4747

4848
/// <summary>
49-
/// 获得/设置 本列是否允许换行 默认为 null
49+
/// Gets or sets whether text wrapping is allowed in this column. Default is null.
5050
/// </summary>
5151
bool? TextWrap { get; set; }
5252

5353
/// <summary>
54-
/// 获得/设置 本列文本超出省略 默认为 null
54+
/// Gets or sets whether text overflow is ellipsis in this column. Default is null.
5555
/// </summary>
5656
bool? TextEllipsis { get; set; }
5757

5858
/// <summary>
59-
/// 获得/设置 是否表头允许折行 默认 false 不折行
59+
/// Gets or sets whether the header text is allowed to wrap. Default is false.
6060
/// </summary>
6161
bool HeaderTextWrap { get; set; }
6262

6363
/// <summary>
64-
/// 获得/设置 是否表头显示 Tooltip 默认 false 不显示 可配合 <see cref="HeaderTextEllipsis"/> 使用 设置 <see cref="HeaderTextWrap"/> 为 true 时本参数不生效
64+
/// Gets or sets whether the header shows a tooltip. Default is false. Can be used with <see cref="HeaderTextEllipsis"/>. This parameter is not effective when <see cref="HeaderTextWrap"/> is set to true.
6565
/// </summary>
6666
bool ShowHeaderTooltip { get; set; }
6767

6868
/// <summary>
69-
/// 获得/设置 是否表头 Tooltip 内容
69+
/// Gets or sets the header tooltip content.
7070
/// </summary>
7171
string? HeaderTextTooltip { get; set; }
7272

7373
/// <summary>
74-
/// 获得/设置 是否表头溢出时截断 默认 false 不截断 可配合 <see cref="HeaderTextTooltip"/> 使用 设置 <see cref="HeaderTextWrap"/> 为 true 时本参数不生效
74+
/// Gets or sets whether the header text is truncated when overflowing. Default is false. Can be used with <see cref="HeaderTextTooltip"/>. This parameter is not effective when <see cref="HeaderTextWrap"/> is set to true.
7575
/// </summary>
7676
bool HeaderTextEllipsis { get; set; }
7777

7878
/// <summary>
79-
/// 获得/设置 列 td 自定义样式 默认为 null 未设置
79+
/// Gets or sets the custom CSS class for the column td. Default is null.
8080
/// </summary>
8181
string? CssClass { get; set; }
8282

8383
/// <summary>
84-
/// 显示节点阈值 默认值 BreakPoint.None 未设置
84+
/// Gets or sets the breakpoint at which the column is shown. Default is BreakPoint.None.
8585
/// </summary>
8686
BreakPoint ShownWithBreakPoint { get; set; }
8787

8888
/// <summary>
89-
/// 获得/设置 是否可以拷贝列 默认 null 不可以
89+
/// Gets or sets whether the column can be copied. Default is null.
9090
/// </summary>
9191
bool? ShowCopyColumn { get; set; }
9292

9393
/// <summary>
94-
/// 获得/设置 显示模板
94+
/// Gets or sets the display template.
9595
/// </summary>
9696
RenderFragment<object>? Template { get; set; }
9797

9898
/// <summary>
99-
/// 获得/设置 搜索模板
99+
/// Gets or sets the search template.
100100
/// </summary>
101101
RenderFragment<object>? SearchTemplate { get; set; }
102102

103103
/// <summary>
104-
/// 获得/设置 过滤模板
104+
/// Gets or sets the filter template.
105105
/// </summary>
106106
RenderFragment? FilterTemplate { get; set; }
107107

108108
/// <summary>
109-
/// 获得/设置 表头模板
109+
/// Gets or sets the header template.
110110
/// </summary>
111111
RenderFragment<ITableColumn>? HeaderTemplate { get; set; }
112112

113113
/// <summary>
114-
/// 获得/设置 工具栏模板 默认 null
114+
/// Gets or sets the toolbox template. Default is null.
115115
/// </summary>
116116
RenderFragment<ITableColumn>? ToolboxTemplate { get; set; }
117117

118118
/// <summary>
119-
/// 获得/设置 列过滤器
119+
/// Gets or sets the column filter.
120120
/// </summary>
121121
IFilter? Filter { get; set; }
122122

123123
/// <summary>
124-
/// 获得/设置 格式化字符串 如时间类型设置 yyyy-MM-dd
124+
/// Gets or sets the format string, such as "yyyy-MM-dd" for date types.
125125
/// </summary>
126126
string? FormatString { get; set; }
127127

128128
/// <summary>
129-
/// 获得/设置 列格式化回调委托 <see cref="TableColumnContext{TItem, TValue}"/>
129+
/// Gets or sets the column format callback delegate <see cref="TableColumnContext{TItem, TValue}"/>.
130130
/// </summary>
131131
Func<object?, Task<string?>>? Formatter { get; set; }
132132

133133
/// <summary>
134-
/// 获得/设置 文字对齐方式 默认为 null 使用 Alignment.None
134+
/// Gets or sets the text alignment. Default is null, using Alignment.None.
135135
/// </summary>
136136
Alignment? Align { get; set; }
137137

138138
/// <summary>
139-
/// 获得/设置 字段鼠标悬停提示 默认为 null 使用 false 值
139+
/// Gets or sets whether to show tooltips on mouse hover. Default is null, using false value.
140140
/// </summary>
141141
bool? ShowTips { get; set; }
142142

143143
/// <summary>
144-
/// 获得/设置 鼠标悬停提示自定义内容回调委托 默认 null 使用当前值
144+
/// Gets or sets the custom tooltip content callback delegate. Default is null, using the current value.
145145
/// </summary>
146146
Func<object?, Task<string?>>? GetTooltipTextCallback { get; set; }
147147

148148
/// <summary>
149-
/// 获得/设置 单元格回调方法
149+
/// Gets or sets the cell render callback method.
150150
/// </summary>
151151
Action<TableCellArgs>? OnCellRender { get; set; }
152152

153153
/// <summary>
154-
/// 获得/设置 是否为 MarkupString 默认 false
154+
/// Gets or sets whether the column is a MarkupString. Default is false.
155155
/// </summary>
156156
bool IsMarkupString { get; set; }
157157

158158
/// <summary>
159-
/// 获得/设置 新建时是否为必填项 默认为 null
159+
/// Gets or sets whether the column is required when adding a new item. Default is null.
160160
/// </summary>
161161
bool? IsRequiredWhenAdd { get; set; }
162162

163163
/// <summary>
164-
/// 获得/设置 编辑时是否为必填项 默认为 null
164+
/// Gets or sets whether the column is required when editing an item. Default is null.
165165
/// </summary>
166166
bool? IsRequiredWhenEdit { get; set; }
167167

168168
/// <summary>
169-
/// 获得/设置 新建时此列只读 默认为 null 使用 <see cref="IEditorItem.Readonly"/> 值
169+
/// Gets or sets whether the column is read-only when adding a new item. Default is null, using the <see cref="IEditorItem.Readonly"/> value.
170170
/// </summary>
171171
bool? IsReadonlyWhenAdd { get; set; }
172172

173173
/// <summary>
174-
/// 获得/设置 编辑时此列只读 默认为 null 使用 <see cref="IEditorItem.Readonly"/> 值
174+
/// Gets or sets whether the column is read-only when editing an item. Default is null, using the <see cref="IEditorItem.Readonly"/> value.
175175
/// </summary>
176176
bool? IsReadonlyWhenEdit { get; set; }
177177

178178
/// <summary>
179-
/// 获得/设置 当前编辑项是否显示 默认为 null 未设置时为 true
179+
/// Gets or sets whether the current edit item is visible. Default is null, using true value.
180180
/// </summary>
181181
bool? Visible { get; set; }
182182

183183
/// <summary>
184-
/// 获得/设置 新建时是否此列显示 默认为 null 使用 <see cref="Visible"/> 值
184+
/// Gets or sets whether the column is visible when adding a new item. Default is null, using the <see cref="Visible"/> value.
185185
/// </summary>
186186
bool? IsVisibleWhenAdd { get; set; }
187187

188188
/// <summary>
189-
/// 获得/设置 编辑时是否此列显示 默认为 null 使用 <see cref="Visible"/> 值
189+
/// Gets or sets whether the column is visible when editing an item. Default is null, using the <see cref="Visible"/> value.
190190
/// </summary>
191191
bool? IsVisibleWhenEdit { get; set; }
192192

193193
/// <summary>
194-
/// 获得/设置 自定义搜索逻辑
194+
/// Gets or sets the custom search logic.
195195
/// </summary>
196196
Func<ITableColumn, string?, SearchFilterAction>? CustomSearch { get; set; }
197197
}

0 commit comments

Comments
 (0)