Form表单
高性能表单控件,自带数据域管理。包含数据录入、校验以及对应样式。
何时使用
- 用于创建一个实体或收集信息。
- 需要对输入的数据类型进行校验时。
Examples
Form API#
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
RequiredMark | 属性更改必填/可选字段标签在表单上的显示方式。
|
FormRequiredMark | -- |
Layout | 属性表单中表单项的布局 | String | FormLayout.Horizontal |
ChildContent | 属性表格的内容。通常包含不同的表单输入和布局元素。 | RenderFragment<TModel> | -- |
LabelCol | 属性控制标签的布局。通常用于为不同的屏幕尺寸设置宽度。 | ColLayoutParam | -- |
LabelAlign | 属性将标签向左或向右对齐 | AntLabelAlignType? | -- |
LabelColSpan | 属性获取/设置 AntDesign.Form`1.LabelCol 的 Span 属性。 |
OneOf<String, Int32> | -- |
LabelColOffset | 属性获取/设置 AntDesign.Form`1.LabelCol 的 Offset 属性。 |
OneOf<String, Int32> | -- |
WrapperCol | 属性控制输入元素包装器的布局。通常用于为不同的屏幕尺寸设置宽度。 | ColLayoutParam | -- |
WrapperColSpan | 属性获取/设置 AntDesign.Form`1.WrapperCol 的 Span 属性。 |
OneOf<String, Int32> | -- |
WrapperColOffset | 属性获取/设置 AntDesign.Form`1.WrapperColOffset 的 Offset 属性。 |
OneOf<String, Int32> | -- |
Size | 属性表单内ant组件的大小 | String | -- |
Name | 属性获取或设置表单处理程序名称。这是将其发布到服务器端终端节点所必需的。或者使用 for 从 FormProviderFinishEventArgs 获取表单实例。 |
String | -- |
Method | 属性用于提交表单的 Http 方法 | String | -- |
Model | 属性将表单输入绑定到的模型 | TModel | -- |
Loading | 属性表单是否正在加载 | Boolean | false |
OnFinish | 属性提交表单并通过验证时执行的回调。 | EventCallback<EditContext> | -- |
OnFinishFailed | 属性提交表单且验证失败时执行的回调。 | EventCallback<EditContext> | -- |
OnFieldChanged | 属性当表单中的字段更改时执行的回调 | EventCallback<FieldChangedEventArgs> | -- |
OnValidationRequested | 属性请求验证时执行的回调 | EventCallback<ValidationRequestedEventArgs> | -- |
OnValidationStateChanged | 属性验证更改时执行的回调 | EventCallback<ValidationStateChangedEventArgs> | -- |
Validator | 属性在表单中使用的验证器。当 AntDesign.Form`1.ValidateMode 为 FormValidateMode.Default 或 FormValidateMode.Complex 时使用 |
RenderFragment | -- |
ValidateOnChange | 属性组件值更改时启用验证 | Boolean | -- |
ValidateMode | 属性表单应使用哪种验证模式将同时使用 attributes 和 rules。 Obsolete 将在未来的版本中删除。 |
FormValidateMode | FormValidateMode.Complex |
Enhance | 属性如果启用,则无需完全重新加载页面即可执行表单提交。这相当于将 data-enhance 添加到表单中。 | Boolean | -- |
Autocomplete | 属性默认情况下,input 元素是否可以由浏览器自动完成其值 | String | -- |
Locale | 属性本地化选项 | FormLocale | -- |
IsModified | 指示表单是否已修改的标志 | Boolean | -- |
EditContext | 在表单中获取 AntDesign.Form'1.EditContext 实例 |
EditContext | -- |
Id | 属性组件 HTML 的 ID | String | Uniquely Generated ID |
Class | 属性为 DOM 元素指定一个或多个类名。 | String | -- |
Style | 属性指定 DOM 元素的内联样式。 | String | -- |
RefBack | 属性一个 ForwardRef 实例。您可以使用 AntDesign.ForwardRef.Current 获取对内部 DOM 的引用。 |
ForwardRef | -- |
方法签名 | 返回类型 | 描述 |
---|---|---|
Reset() | void | 重置表单中的所有值 |
Submit() | void | 提交表格。将触发验证和 AntDesign.Form`1.OnFinish 或 AntDesign.Form`1.OnFinishFailed 。 |
Validate() | Boolean | 执行验证 |
ValidationReset() | void | 重置验证 |
SetValidationMessages(String field, String[] errorMessages) | void | 将验证消息设置为特定字段。 |
FormValidateMode API#
基础类型: Int32
名称 | 描述 |
---|---|
Default | 验证将来自提供给 AntDesign.Form`1.Model 的模型上的数据属性 |
Rules | 验证将来自表单中 FormItems 的规则 |
Complex | 同时使用默认模式和规则模式 |
FormItem API#
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
Name | 属性指定表单项的名称。它也可以用作 Member Path 来绑定 Model 的属性。 | String | -- |
ChildContent | 属性表单项的内容。通常将包含输入元素之一 | RenderFragment | -- |
Label | 属性项目的自定义标签。如果未提供 AntDesign.FormItem.Label 或 AntDesign.FormItem.LabelTemplate ,则将使用 DisplayName 属性值或字段名称(按此顺序)。 |
String | -- |
LabelTemplate | 属性项目的自定义标签内容。优先于 AntDesign.FormItem.Label 。如果未提供 AntDesign.FormItem.Label 或 AntDesign.FormItem.LabelTemplate ,则将使用 DisplayName 属性值或字段名称(按此顺序)。 |
RenderFragment | -- |
LabelCol | 属性控制标签的布局。通常用于为不同的屏幕尺寸设置宽度。 | ColLayoutParam | -- |
LabelAlign | 属性将标签向左或向右对齐 | AntLabelAlignType? | -- |
LabelColSpan | 属性获取/设置 AntDesign.FormItem.LabelCol 的 Span 属性。 |
OneOf<String, Int32> | -- |
LabelColOffset | 属性获取/设置 AntDesign.FormItem.LabelCol 的 Offset 属性。 |
OneOf<String, Int32> | -- |
WrapperCol | 属性控制输入元素包装器的布局。通常用于为不同的屏幕尺寸设置宽度。 | ColLayoutParam | -- |
WrapperColSpan | 属性获取/设置 AntDesign.FormItem.WrapperCol 的 Span 属性。 |
OneOf<String, Int32> | -- |
WrapperColOffset | 属性获取/设置 AntDesign.FormItem.WrapperColOffset 上的 Offset 属性。 |
OneOf<String, Int32> | -- |
NoStyle | 属性true时无样式,用作纯字段控件 | Boolean | -- |
Required | 属性将此项目标记为验证所需 | Boolean | -- |
LabelStyle | 属性仅应用于标签元素的样式。如果设置了 LabelTemplate,则不会应用。 | String | -- |
Rules | 属性应用于此项目的验证规则 | FormValidationRule[] | -- |
HasFeedback | 属性与AntDesign.FormItem.ValidateStatus 配合使用,显示验证状态图标。建议仅与 Input 组件一起使用 |
Boolean | -- |
ShowFeedbackOnError | 属性是否在出错时显示反馈图标。如果设置为 false,则即使字段处于错误状态,它也不会显示图标。 | Boolean | -- |
ValidateStatus | 属性验证状态,不设置则根据验证规则自动生成 | FormValidateStatus | -- |
Help | 属性提示信息 | String | -- |
ToolTip | 属性设置表单字段的帮助提示信息 | String | -- |
Id | 属性组件 HTML 的 ID | String | Uniquely Generated ID |
Class | 属性为 DOM 元素指定一个或多个类名。 | String | -- |
Style | 属性指定 DOM 元素的内联样式。 | String | -- |
RefBack | 属性一个 ForwardRef 实例。您可以使用 AntDesign.ForwardRef.Current 获取对内部 DOM 的引用。 |
ForwardRef | -- |
FormValidationRule API#
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
Len | 验证长度。有效的 AntDesign.FormValidationRule.Type :字符串、数字或数组。 |
Decimal? | -- |
Min | 验证长度是否大于或等于此数字。有效的 AntDesign.FormValidationRule.Type :字符串、数字或数组。 |
Decimal? | -- |
Max | 验证长度是否小于或等于此数字。有效的 AntDesign.FormValidationRule.Type :字符串、数字或数组。 |
Decimal? | -- |
Required | 填写必填字段 | Boolean? | -- |
Pattern | 验证值是否传递正则表达式模式 | String | -- |
Message | 自定义错误信息。如果没有提供,将自动生成。 | String | -- |
Range | 验证值是否在指定范围内 | ValueTuple<Double, Double?? | -- |
DefaultField | 验证所有数组元素的规则。有效的 AntDesign.FormValidationRule.Type :数组。 (现在不支持 FormItem ) |
FormValidationRule | -- |
OneOf | 该值是否在指定值内 | Object[] | -- |
Enum | 验证该值是否在指定的枚举类型中。 | Type | -- |
Fields | 验证子元素的规则。有效的 AntDesign.FormValidationRule.Type :数组、对象(现在不支持 FormItem ) |
Dictionary<Object, FormValidationRule> | -- |
Validator | 自定义验证函数 | Func<FormValidationContext, ValidationResult> | -- |
Transform | 在执行验证之前调用的转换函数。返回值将对其运行验证。 | Func<Object, Object> | -- |
Type | 表单域的类型。有关所有可能的值,请参阅 FormFieldType 。 |
FormFieldType? | -- |
ValidationAttribute | 使用指定的属性验证值。 | ValidationAttribute | -- |
FormValidateErrorMessages API#
属性 | 描述 | 类型 | 默认值 |
---|---|---|---|
Default | 默认通用验证错误消息 | String | -- |
Required | Required 规则的默认验证消息 | String | -- |
Enum | Enum 规则的默认验证消息 | String | -- |
Whitespace | 空白规则的默认验证消息 | String | -- |
Date | 日期类型的消息 | DateMessage | -- |
Types | 字段类型与预期类型不匹配时的消息 | TypesMessage | -- |
String | 字符串类型的消息 | CompareMessage | -- |
Number | 字符串类型的消息 | CompareMessage | -- |
Array | 数组类型的消息 | CompareMessage | -- |
Pattern | 模式验证规则的消息 | PatternMessage | -- |