填写这份《一分钟调查》，帮我们（开发组）做得更好！去填写Home
API 参考手册
API > @angular/forms

AbstractControl

这是 FormControl、FormGroup 和 FormArray 的基类。

This is the base class for FormControl, FormGroup, and FormArray.

查看"说明"...

      
      abstract class AbstractControl {
  constructor(validators: ValidatorFn | ValidatorFn[], asyncValidators: AsyncValidatorFn | AsyncValidatorFn[])
  value: any
  validator: ValidatorFn | null
  asyncValidator: AsyncValidatorFn | null
  parent: FormGroup | FormArray | null
  status: string
  valid: boolean
  invalid: boolean
  pending: boolean
  disabled: boolean
  enabled: boolean
  errors: ValidationErrors | null
  pristine: boolean
  dirty: boolean
  touched: boolean
  untouched: boolean
  valueChanges: Observable<any>
  statusChanges: Observable<any>
  updateOn: FormHooks
  root: AbstractControl
  setValidators(newValidator: ValidatorFn | ValidatorFn[]): void
  setAsyncValidators(newValidator: AsyncValidatorFn | AsyncValidatorFn[]): void
  clearValidators(): void
  clearAsyncValidators(): void
  markAsTouched(opts: { onlySelf?: boolean; } = {}): void
  markAllAsTouched(): void
  markAsUntouched(opts: { onlySelf?: boolean; } = {}): void
  markAsDirty(opts: { onlySelf?: boolean; } = {}): void
  markAsPristine(opts: { onlySelf?: boolean; } = {}): void
  markAsPending(opts: { onlySelf?: boolean; emitEvent?: boolean; } = {}): void
  disable(opts: { onlySelf?: boolean; emitEvent?: boolean; } = {}): void
  enable(opts: { onlySelf?: boolean; emitEvent?: boolean; } = {}): void
  setParent(parent: FormGroup | FormArray): void
  abstract setValue(value: any, options?: Object): void
  abstract patchValue(value: any, options?: Object): void
  abstract reset(value?: any, options?: Object): void
  updateValueAndValidity(opts: { onlySelf?: boolean; emitEvent?: boolean; } = {}): void
  setErrors(errors: ValidationErrors, opts: { emitEvent?: boolean; } = {}): void
  get(path: string | (string | number)[]): AbstractControl | null
  getError(errorCode: string, path?: string | (string | number)[]): any
  hasError(errorCode: string, path?: string | (string | number)[]): boolean
}

子类

参见

说明

它提供了一些所有控件和控件组共有的行为，比如运行验证器、计算状态和重置状态。 它还定义了一些所有子类共享的属性，如 value、valid 和 dirty。不允许直接实例化它。

It provides some of the shared behavior that all controls and groups of controls have, like running validators, calculating status, and resetting state. It also defines the properties that are shared between all sub-classes, like value, valid, and dirty. It shouldn't be instantiated directly.

构造函数

初始化这个 AbstractControl 实例。

Initialize the AbstractControl instance.

      
      constructor(validators: ValidatorFn | ValidatorFn[], asyncValidators: AsyncValidatorFn | AsyncValidatorFn[])
参数
validators ValidatorFn | ValidatorFn[]

用于决定该控件有效性的同步函数。

The function or array of functions that is used to determine the validity of this control synchronously.

asyncValidators AsyncValidatorFn | AsyncValidatorFn[]

用于异步确定此控件有效性的函数或函数数组。

The function or array of functions that is used to determine validity of this control asynchronously.

属性

属性说明
value: any只读

控件的当前值。

The current value of the control.

  • 对于 FormControl，它是当前值。

    For a FormControl, the current value.

  • 对于启用状态的 FormGroup，它是由组中的每个已启用的成员控件的名称和值组成的对象。

    For an enabled FormGroup, the values of enabled controls as an object with a key-value pair for each member of the group.

  • 对于禁用状态的 FormGroup，它是由组中的所有成员控件的名称和值组成的对象。

    For a disabled FormGroup, the values of all controls as an object with a key-value pair for each member of the group.

  • 对于 FormArray，它是有所有已启用的控件的值组成的数组。

    For a FormArray, the values of enabled controls as an array.

validator: ValidatorFn | null

用于决定该控件有效性的异步函数。

The function that is used to determine the validity of this control synchronously.

asyncValidator: AsyncValidatorFn | null

用于异步确定此控件的有效性的函数。

The function that is used to determine the validity of this control asynchronously.

parent: FormGroup | FormArray | null只读

父控件。

The parent control.

status: string只读

控件的有效性状态。有四个可能的值：

The validation status of the control. There are four possible validation status values:

  • VALID: 该控件通过了所有有效性检查。

    VALID: This control has passed all validation checks.

  • INVALID 该控件至少有一个有效性检查失败了。

    INVALID: This control has failed at least one validation check.

  • PENDING：该控件正在进行有效性检查，处于中间状态。

    PENDING: This control is in the midst of conducting a validation check.

  • DISABLED：该控件被禁用，豁免了有效性检查。

    DISABLED: This control is exempt from validation checks.

这些状态值是互斥的，因此一个控件不可能同时处于有效状态和无效状态或无效状态和禁用状态。

These status values are mutually exclusive, so a control cannot be both valid AND invalid or invalid AND disabled.

valid: boolean只读

当控件的 status 为 VALID 时，它就是 valid 的。

A control is valid when its status is VALID.

参见:

invalid: boolean只读

当控件的 status 为 INVALID 时，它就是 invalid 的。

A control is invalid when its status is INVALID.

参见:

pending: boolean只读

当控件的 status 为 PENDING 时，它就是 pending 的。

A control is pending when its status is PENDING.

参见:

disabled: boolean只读

当控件的 status 为 DISABLED 时，它就是 disabled。

A control is disabled when its status is DISABLED.

被禁用的控件会豁免有效性检查，并且它的值不会聚合进其祖先控件中。

Disabled controls are exempt from validation checks and are not included in the aggregate value of their ancestor controls.

参见:

enabled: boolean只读

如果控件的 status 不是 DISABLED 时，它就是 enabled。

A control is enabled as long as its status is not DISABLED.

参见:

errors: ValidationErrors | null只读

一个对象，包含由失败的验证所生成的那些错误，如果没出错则为 null。

An object containing any errors generated by failing validation, or null if there are no errors.

pristine: boolean只读

如果用户尚未修改 UI 中的值，则该控件是 pristine（原始状态）的。

A control is pristine if the user has not yet changed the value in the UI.

dirty: boolean只读

如果用户修改过 UI 中的值，则控件是 dirty（脏） 的。

A control is dirty if the user has changed the value in the UI.

touched: boolean只读

如果控件被标记为 touched（碰过） 则为 true。

True if the control is marked as touched.

一旦用户在控件上触发了 blur 事件，则会将其标记为 touched。

A control is marked touched once the user has triggered a blur event on it.

untouched: boolean只读

如果该控件尚未标记为 touched，则为 true。

True if the control has not been marked as touched

如果用户尚未在控件上触发过 blur 事件，则该控件为 untouched。

A control is untouched if the user has not yet triggered a blur event on it.

valueChanges: Observable<any>只读

一个多播 Observable（可观察对象），每当控件的值发生变化时，它就会发出一个事件 —— 无论是通过 UI 还是通过程序。每当你调用 enable() 或 disable()，但没有传入 {emitEvent: false} 参数时，它也同样会发出一个事件。

A multicasting observable that emits an event every time the value of the control changes, in the UI or programmatically. It also emits an event each time you call enable() or disable() without passing along {emitEvent: false} as a function argument.

statusChanges: Observable<any>只读

一个多播 Observable（可观察对象），每当控件的验证 status 被重新计算时，就会发出一个事件。

A multicasting observable that emits an event every time the validation status of the control recalculates.

参见:

updateOn: FormHooks只读

报告这个 AbstractControl 的更新策略（表示控件用来更新自身状态的事件）。 可能的值有 'change' | 'blur' | 'submit'，默认值是 'change'。

Reports the update strategy of the AbstractControl (meaning the event on which the control updates itself). Possible values: 'change' | 'blur' | 'submit' Default value: 'change'

root: AbstractControl只读

获取该控件的顶级祖先。

Retrieves the top-level ancestor of this control.

方法

setValidators()

设置该控件上所激活的同步验证器。调用它将会覆盖所有现存的同步验证器。

Sets the synchronous validators that are active on this control. Calling this overwrites any existing sync validators.

      
      setValidators(newValidator: ValidatorFn | ValidatorFn[]): void
参数
newValidator ValidatorFn | ValidatorFn[]
返回值

void

在运行时添加或删除验证器时，必须调用 updateValueAndValidity() 才能使新验证生效。

When you add or remove a validator at run time, you must call updateValueAndValidity() for the new validation to take effect.

setAsyncValidators()

设置该控件上所激活的异步验证器。调用它就会覆盖所有现存的异步验证器。

Sets the async validators that are active on this control. Calling this overwrites any existing async validators.

      
      setAsyncValidators(newValidator: AsyncValidatorFn | AsyncValidatorFn[]): void
参数
newValidator AsyncValidatorFn | AsyncValidatorFn[]
返回值

void

在运行时添加或删除验证器时，必须调用 updateValueAndValidity() 才能使新验证生效。

When you add or remove a validator at run time, you must call updateValueAndValidity() for the new validation to take effect.

clearValidators()

清空同步验证器列表。

Empties out the sync validator list.

      
      clearValidators(): void
参数

没有参数。

返回值

void

在运行时添加或删除验证器时，必须调用 updateValueAndValidity() 才能使新验证生效。

When you add or remove a validator at run time, you must call updateValueAndValidity() for the new validation to take effect.

clearAsyncValidators()

清空异步验证器列表。

Empties out the async validator list.

      
      clearAsyncValidators(): void
参数

没有参数。

返回值

void

在运行时添加或删除验证器时，必须调用 updateValueAndValidity() 才能使新验证生效。

When you add or remove a validator at run time, you must call updateValueAndValidity() for the new validation to take effect.

markAsTouched()

将控件标记为已 touched。focus 和 blur 事件不会改变该值，从而让控件变为已触摸状态。

Marks the control as touched. A control is touched by focus and blur events that do not change the value.

See also:

  • markAsUntouched()

  • markAsDirty()

  • 把该控件标记为 touched。控件获得焦点并失去焦点不会修改这个值。与 markAsDirty 相对。

    markAsPristine()

      
      markAsTouched(opts: { onlySelf?: boolean; } = {}): void
参数
opts object

在应用完此标记后，该配置项会决定控件如何传播变更及发出事件。

Configuration options that determine how the control propagates changes and emits events after marking is applied.

  • onlySelf：如果为 true 则只标记当前控件。如果为 false 或不提供，则标记它所有的直系祖先。默认为 false。

    onlySelf: When true, mark only this control. When false or not supplied, marks all direct ancestors. Default is false.

可选. 默认值是 `{}`.
返回值

void

markAllAsTouched()

将控件及其所有后代控件标记为已 touched 。

Marks the control and all its descendant controls as touched.

See also:

  • markAsTouched()

      
      markAllAsTouched(): void
参数

没有参数。

返回值

void

markAsUntouched()

把该控件标记为 untouched。

Marks the control as untouched.

See also:

  • markAsTouched()

  • markAsDirty()

  • markAsPristine()

      
      markAsUntouched(opts: { onlySelf?: boolean; } = {}): void
参数
opts object

在应用完此标记后，该配置项会决定控件如何传播变更及发出事件。

Configuration options that determine how the control propagates changes and emits events after the marking is applied.

  • onlySelf：如果为 true 则只标记当前控件。如果为 false 或不提供，则标记它所有的直系祖先。默认为 false。

    onlySelf: When true, mark only this control. When false or not supplied, marks all direct ancestors. Default is false.

可选. 默认值是 `{}`.
返回值

void

如果该控件有任何子控件，还会把所有子控件标记为 untouched，并重新计算所有父控件的 touched 状态。

If the control has any children, also marks all children as untouched and recalculates the touched status of all parent controls.

markAsDirty()

把控件标记为 dirty。当控件通过 UI 修改过时控件会变成 dirty 的；与 markAsTouched 相对。

Marks the control as dirty. A control becomes dirty when the control's value is changed through the UI; compare markAsTouched.

See also:

  • markAsTouched()

  • markAsUntouched()

  • markAsPristine()

      
      markAsDirty(opts: { onlySelf?: boolean; } = {}): void
参数
opts object

在应用完此标记后，该配置项会决定控件如何传播变更以及发出事件。

Configuration options that determine how the control propagates changes and emits events after marking is applied.

  • onlySelf：如果为 true 则只标记当前控件。如果为 false 或不提供，则标记它所有的直系祖先。默认为 false。

    onlySelf: When true, mark only this control. When false or not supplied, marks all direct ancestors. Default is false.

可选. 默认值是 `{}`.
返回值

void

markAsPristine()

把该控件标记为 pristine（原始状态）。

Marks the control as pristine.

See also:

  • markAsTouched()

  • markAsUntouched()

  • markAsDirty()

      
      markAsPristine(opts: { onlySelf?: boolean; } = {}): void
参数
opts object

在应用完此标记后，该配置项会决定控件如何传播更改以及发出事件。

Configuration options that determine how the control emits events after marking is applied.

  • onlySelf：如果为 true 则只标记当前控件。如果为 false 或不提供，则标记它所有的直系祖先。默认为 false。

    onlySelf: When true, mark only this control. When false or not supplied, marks all direct ancestors. Default is false.

可选. 默认值是 `{}`.
返回值

void

如果该控件有任何子控件，则把所有子控件标记为 pristine，并重新计算所有父控件的 pristine 状态。

If the control has any children, marks all children as pristine, and recalculates the pristine status of all parent controls.

markAsPending()

把该控件标记为 pending（待定）的。

Marks the control as pending.

See also:

      
      markAsPending(opts: { onlySelf?: boolean; emitEvent?: boolean; } = {}): void
参数
opts object

在应用完此标记后，该配置项会决定控件如何传播变更以及发出事件。

Configuration options that determine how the control propagates changes and emits events after marking is applied.

  • onlySelf：如果为 true 则只标记当前控件。如果为 false 或不提供，则标记它所有的直系祖先。默认为 false。

    onlySelf: When true, mark only this control. When false or not supplied, marks all direct ancestors. Default is false.

  • emitEvent：如果为 true 或未提供（默认值），则 statusChanges（Observable）会发出一个事件，传入控件的最近状态，并把控件标记为 pending 状态。 如果为 false，则不会发出事件。

    emitEvent: When true or not supplied (the default), the statusChanges observable emits an event with the latest status the control is marked pending. When false, no events are emitted.

可选. 默认值是 `{}`.
返回值

void

当控件正在执行异步验证时，该控件是 pending 的。

A control is pending while the control performs async validation.

disable()

禁用此控件。这意味着该控件在表单验证检查时会被豁免，并且从其父控件的聚合值中排除它的值。它的状态是 DISABLED。

Disables the control. This means the control is exempt from validation checks and excluded from the aggregate value of any parent. Its status is DISABLED.

See also:

      
      disable(opts: { onlySelf?: boolean; emitEvent?: boolean; } = {}): void
参数
opts object

在该控件被禁用之后，该配置项决定如何传播更改以及发出事件。

Configuration options that determine how the control propagates changes and emits events after the control is disabled.

  • onlySelf：如果为 true，则只标记当前控件。如果为 false 或没有提供，则标记所有直系祖先。默认为 false。

    onlySelf: When true, mark only this control. When false or not supplied, marks all direct ancestors. Default is false.

  • emitEvent：如果为 true 或没有提供（默认），则当控件被禁用时，statusChanges 和 valueChanges 这两个 Observable 都会发出最近的状态和值。 如果为 false，则不会发出事件。

    emitEvent: When true or not supplied (the default), both the statusChanges and valueChanges observables emit events with the latest status and value when the control is disabled. When false, no events are emitted.

可选. 默认值是 `{}`.
返回值

void

如果该控件有子控件，则所有子控件也会被禁用。

If the control has children, all children are also disabled.

enable()

启用该控件。这意味着该控件包含在有效性检查中，并会出现在其父控件的聚合值中。它的状态会根据它的值和验证器而重新计算。

Enables the control. This means the control is included in validation checks and the aggregate value of its parent. Its status recalculates based on its value and its validators.

See also:

      
      enable(opts: { onlySelf?: boolean; emitEvent?: boolean; } = {}): void
参数
opts object

当标记为 untouched 时，该配置项会决定该控件如何传播变更以及发出事件。

Configure options that control how the control propagates changes and emits events when marked as untouched

  • onlySelf：如果为 true，则只标记当前控件。如果为 false 或没有提供，则标记所有直系祖先。默认为 false。

    onlySelf: When true, mark only this control. When false or not supplied, marks all direct ancestors. Default is false.

  • emitEvent：如果为 true 或没有提供（默认），则当控件被启用时，statusChanges 和 valueChanges 这两个 Observable 都会发出最近的状态和值。 如果为 false，则不会发出事件。

    emitEvent: When true or not supplied (the default), both the statusChanges and valueChanges observables emit events with the latest status and value when the control is enabled. When false, no events are emitted.

可选. 默认值是 `{}`.
返回值

void

默认情况下，如果该控件具有子控件，则所有子控件都会被启用。

By default, if the control has children, all children are enabled.

setParent() 

      
      setParent(parent: FormGroup | FormArray): void
参数
parent FormGroup | FormArray

设置该控件的父控件

Sets the parent of the control

返回值

void

setValue()

设置该控件的值。这是一个抽象方法（由子类实现）。

Sets the value of the control. Abstract method (implemented in sub-classes).

      
      abstract setValue(value: any, options?: Object): void
参数
value any
options Object
可选. 默认值是 `undefined`.
返回值

void

patchValue()

修补（patch）该控件的值。这是一个抽象方法（由子类实现）。

Patches the value of the control. Abstract method (implemented in sub-classes).

      
      abstract patchValue(value: any, options?: Object): void
参数
value any
options Object
可选. 默认值是 `undefined`.
返回值

void

reset()

重置控件。这是一个抽象方法（由子类实现）。

Resets the control. Abstract method (implemented in sub-classes).

      
      abstract reset(value?: any, options?: Object): void
参数
value any
可选. 默认值是 `undefined`.
options Object
可选. 默认值是 `undefined`.
返回值

void

updateValueAndValidity()

重新计算控件的值和校验状态。

Recalculates the value and validation status of the control.

      
      updateValueAndValidity(opts: { onlySelf?: boolean; emitEvent?: boolean; } = {}): void
参数
opts object

当更新和进行有效性检查之后，该配置项会决定控件如何传播变更并发出事件。

Configuration options determine how the control propagates changes and emits events after updates and validity checks are applied.

  • onlySelf：如果为 true，则只标记当前控件。如果为 false 或没有提供，则标记所有直系祖先。默认为 false。

    onlySelf: When true, only update this control. When false or not supplied, update all direct ancestors. Default is false.

  • emitEvent：如果为 true 或没有提供（默认），则当控件被启用时，statusChanges 和 valueChanges 这两个 Observable 都会发出最近的状态和值。 如果为 false，则不会发出事件。

    emitEvent: When true or not supplied (the default), both the statusChanges and valueChanges observables emit events with the latest status and value when the control is updated. When false, no events are emitted.

可选. 默认值是 `{}`.
返回值

void

默认情况下，它还会更新其直系祖先的值和有效性状态。

By default, it also updates the value and validity of its ancestors.

setErrors()

在手动（而不是自动）运行校验之后，设置表单控件上的错误信息。

Sets errors on a form control when running validations manually, rather than automatically.

      
      setErrors(errors: ValidationErrors, opts: { emitEvent?: boolean; } = {}): void
参数
errors ValidationErrors
opts object
可选. 默认值是 `{}`.
返回值

void

调用 setErrors 还会更新父控件的有效性状态。

Calling setErrors also updates the validity of the parent control.

使用说明

手动设置控件上的错误信息。
Manually set the errors for a control
      
      const login = new FormControl('someLogin');
login.setErrors({
  notUnique: true
});

expect(login.valid).toEqual(false);
expect(login.errors).toEqual({ notUnique: true });

login.setValue('someOtherLogin');

expect(login.valid).toEqual(true);

get()

根据指定的控件名称或路径获取子控件。

Retrieves a child control given the control's name or path.

      
      get(path: string | (string | number)[]): AbstractControl | null
参数
path string | (string | number)[]

一个由点号（.）分隔的字符串或 "字符串/数字" 数组定义的控件路径。

A dot-delimited string or array of string/number values that define the path to the control.

返回值

AbstractControl | null

使用说明

获取嵌套的控件
Retrieve a nested control

比如，要获取子控件组 person 中的 name 控件：

For example, to get a name control nested within a person sub-group:

  • this.form.get('person.name');

-OR-

  • 或 -
  • this.form.get(['person', 'name']);
Retrieve a control in a FormArray

When accessing an element inside a FormArray, you can use an element index. For example, to get a price control from the first element in an items array you can use:

  • this.form.get('items.0.price');

-OR-

  • this.form.get(['items', 0, 'price']);

getError()

报告具有指定路径的控件的错误数据。

Reports error data for the control with the given path.

      
      getError(errorCode: string, path?: string | (string | number)[]): any
参数
errorCode string

所查出的错误的错误码

The code of the error to check

path string | (string | number)[]

一个控件名列表，用于指定要如何从当前控件移动到要查询错误的那个控件。

A list of control names that designates how to move from the current control to the control that should be queried for errors.

可选. 默认值是 `undefined`.
返回值

特定错误的数据，如果该控件不存在或没有错误，则返回 null。

any: error data for that particular error. If the control or error is not present, null is returned.

使用说明

比如，对于下列 FormGroup：

For example, for the following FormGroup:

      
      form = new FormGroup({
  address: new FormGroup({ street: new FormControl() })
});

此 'street' 控件的从根表单开始的路径应该是 'address' -> 'street'。

The path to the 'street' control from the root form would be 'address' -> 'street'.

调用此方法有两种形式：

It can be provided to this method in one of two formats:

  1. 控件名称的字符串数组，如 ['address', 'street']

    An array of string control names, e.g. ['address', 'street']

  2. 以一个字符串表示的句号分隔的控件名称列表，如 'address.street'

    A period-delimited list of control names in one string, e.g. 'address.street'

hasError()

报告指定路径下的控件上是否有指定的错误。

Reports whether the control with the given path has the error specified.

      
      hasError(errorCode: string, path?: string | (string | number)[]): boolean
参数
errorCode string

要获取的数据的错误码

The code of the error to check

path string | (string | number)[]

控件名称列表，用于指定如何从当前控件移至应查询错误的控件。

A list of control names that designates how to move from the current control to the control that should be queried for errors.

可选. 默认值是 `undefined`.
返回值

给定路径中的控件中是否存在给定的错误。

boolean: whether the given error is present in the control at the given path.

如果指定路径下的控件有这个错误则返回 true，否则返回 false。

If the control is not present, false is returned.

使用说明

例如，对于以下 FormGroup ：

For example, for the following FormGroup:

      
      form = new FormGroup({
  address: new FormGroup({ street: new FormControl() })
});

此 'street' 控件的从根表单开始的路径应该是 'address' -> 'street'。

The path to the 'street' control from the root form would be 'address' -> 'street'.

调用此方法有两种形式：

It can be provided to this method in one of two formats:

  1. 控件名称的字符串数组，如 ['address', 'street']

    An array of string control names, e.g. ['address', 'street']

  2. 以一个字符串表示的句号分隔的控件名称列表，如 'address.street'

    A period-delimited list of control names in one string, e.g. 'address.street'

如果没有提供路径，则检查当前控件中的错误。

If no path is given, this method checks for the error on the current control.