{ "id": "api/forms/Form", "title": "Form", "contents": "\n\n
\n
\n
\n \n API > @angular/forms\n
\n \n
\n \n
\n

Formlink

\n \n \n \n \n \n
\n \n \n\n
\n \n
\n

An interface implemented by FormGroupDirective and NgForm directives.

\n\n

See more...

\n
\n \n \n
\n\ninterface Form {\n addControl(dir: NgControl): void\n removeControl(dir: NgControl): void\n getControl(dir: NgControl): FormControl\n addFormGroup(dir: AbstractFormGroupDirective): void\n removeFormGroup(dir: AbstractFormGroupDirective): void\n getFormGroup(dir: AbstractFormGroupDirective): FormGroup\n updateModel(dir: NgControl, value: any): void\n}\n\n\n \n \n\n\n \n \n
\n

Class implementationslink

\n \n\n\n\n\n
\n \n\n
\n\n \n\n \n \n
\n

Descriptionlink

\n

Only used by the ReactiveFormsModule and FormsModule.

\n\n \n
\n\n \n\n \n\n
\n

Methodslink

\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n addControl()\n \n link

\n \n
\n
\n

Add a control to this form.

\n\n
\n
\n \n\n addControl(dir: NgControl): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n dir\n NgControl\n

The control directive to add to the form.

\n\n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n removeControl()\n \n link

\n \n
\n
\n

Remove a control from this form.

\n\n
\n
\n \n\n removeControl(dir: NgControl): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n dir\n NgControl\n \n \n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n getControl()\n \n link

\n \n
\n
\n

The control directive from which to get the FormControl.

\n\n
\n
\n \n\n getControl(dir: NgControl): FormControl\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n dir\n NgControl\n \n \n
\n\n \n
Returns
\n

FormControl

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n addFormGroup()\n \n link

\n \n
\n
\n

Add a group of controls to this form.

\n\n
\n
\n \n\n addFormGroup(dir: AbstractFormGroupDirective): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n dir\n AbstractFormGroupDirective\n \n \n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n removeFormGroup()\n \n link

\n \n
\n
\n

Remove a group of controls to this form.

\n\n
\n
\n \n\n removeFormGroup(dir: AbstractFormGroupDirective): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n dir\n AbstractFormGroupDirective\n \n \n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n getFormGroup()\n \n link

\n \n
\n
\n

The FormGroup associated with a particular AbstractFormGroupDirective.

\n\n
\n
\n \n\n getFormGroup(dir: AbstractFormGroupDirective): FormGroup\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n dir\n AbstractFormGroupDirective\n \n \n
\n\n \n
Returns
\n

FormGroup

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n updateModel()\n \n link

\n \n
\n
\n

Update the model for a particular control with a new value.

\n\n
\n
\n \n\n updateModel(dir: NgControl, value: any): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n dir\n NgControl\n \n \n
\n \n value\n any\n \n \n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n
\n\n\n \n\n\n
\n
\n\n\n" }