5 lines
31 KiB
JSON
5 lines
31 KiB
JSON
{
|
|
"id": "api/forms/AbstractControlDirective",
|
|
"title": "AbstractControlDirective",
|
|
"contents": "\n\n<article>\n <div class=\"breadcrumb-container\">\n <div class=\"breadcrumb\">\n <script type=\"application/ld+json\">\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"BreadcrumbList\",\n \"itemListElement\": [\n { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io//api\", \"name\": \"API\" } },\n { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/api/forms\", \"name\": \"@angular/forms\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/forms/AbstractControlDirective\", \"name\": \"AbstractControlDirective\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/forms\">@angular/forms</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/forms/src/directives/abstract_control_directive.ts?message=docs(forms)%3A%20describe%20your%20change...#L15-L329\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/forms/src/directives/abstract_control_directive.ts#L15-L329\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n \n <header class=\"api-header\">\n <h1 id=\"abstractcontroldirective\">AbstractControlDirective<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/AbstractControlDirective#abstractcontroldirective\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label class\">class</label>\n \n \n \n </header>\n \n <aio-toc class=\"embedded\"></aio-toc>\n\n <div class=\"api-body\">\n \n <section class=\"short-description\">\n <p>Base class for control directives.</p>\n\n <p><a href=\"api/forms/AbstractControlDirective#description\">See more...</a></p>\n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nabstract class <a href=\"api/forms/AbstractControlDirective\" class=\"code-anchor\">AbstractControlDirective</a> {\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#control\">abstract <span class=\"member-name\">control</span>: AbstractControl | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#value\"><span class=\"member-name\">value</span>: any</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#valid\"><span class=\"member-name\">valid</span>: boolean | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#invalid\"><span class=\"member-name\">invalid</span>: boolean | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#pending\"><span class=\"member-name\">pending</span>: boolean | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#disabled\"><span class=\"member-name\">disabled</span>: boolean | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#enabled\"><span class=\"member-name\">enabled</span>: boolean | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#errors\"><span class=\"member-name\">errors</span>: ValidationErrors | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#pristine\"><span class=\"member-name\">pristine</span>: boolean | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#dirty\"><span class=\"member-name\">dirty</span>: boolean | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#touched\"><span class=\"member-name\">touched</span>: boolean | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#status\"><span class=\"member-name\">status</span>: string | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#untouched\"><span class=\"member-name\">untouched</span>: boolean | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#statusChanges\"><span class=\"member-name\">statusChanges</span>: Observable<any> | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#valueChanges\"><span class=\"member-name\">valueChanges</span>: Observable<any> | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#path\"><span class=\"member-name\">path</span>: string[] | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#validator\"><span class=\"member-name\">validator</span>: ValidatorFn | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#asyncValidator\"><span class=\"member-name\">asyncValidator</span>: AsyncValidatorFn | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#reset\"><span class=\"member-name\">reset</span>(value: any = undefined): void</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#hasError\"><span class=\"member-name\">hasError</span>(errorCode: string, path?: string | (string | number)[]): boolean</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#getError\"><span class=\"member-name\">getError</span>(errorCode: string, path?: string | (string | number)[]): any</a>\n}\n</code-example>\n\n \n \n <div class=\"descendants class\">\n <h2 id=\"subclasses\">Subclasses<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/AbstractControlDirective#subclasses\"><i class=\"material-icons\">link</i></a></h2>\n \n\n<ul>\n \n <li>\n <code><a href=\"api/forms/ControlContainer\" class=\"code-anchor\">ControlContainer</a></code>\n \n\n<ul>\n \n <li>\n <code><a href=\"api/forms/AbstractFormGroupDirective\" class=\"code-anchor\">AbstractFormGroupDirective</a></code>\n \n\n<ul>\n \n <li>\n <code><a href=\"api/forms/NgModelGroup\" class=\"code-anchor\">NgModelGroup</a></code>\n \n\n\n </li>\n \n <li>\n <code><a href=\"api/forms/FormGroupName\" class=\"code-anchor\">FormGroupName</a></code>\n \n\n\n </li>\n \n</ul>\n\n\n </li>\n \n <li>\n <code><a href=\"api/forms/NgForm\" class=\"code-anchor\">NgForm</a></code>\n \n\n\n </li>\n \n <li>\n <code><a href=\"api/forms/FormGroupDirective\" class=\"code-anchor\">FormGroupDirective</a></code>\n \n\n\n </li>\n \n <li>\n <code><a href=\"api/forms/FormArrayName\" class=\"code-anchor\">FormArrayName</a></code>\n \n\n\n </li>\n \n</ul>\n\n\n </li>\n \n <li>\n <code><a href=\"api/forms/NgControl\" class=\"code-anchor\">NgControl</a></code>\n \n\n<ul>\n \n <li>\n <code><a href=\"api/forms/NgModel\" class=\"code-anchor\">NgModel</a></code>\n \n\n\n </li>\n \n <li>\n <code><a href=\"api/forms/FormControlDirective\" class=\"code-anchor\">FormControlDirective</a></code>\n \n\n\n </li>\n \n <li>\n <code><a href=\"api/forms/FormControlName\" class=\"code-anchor\">FormControlName</a></code>\n \n\n\n </li>\n \n</ul>\n\n\n </li>\n \n</ul>\n\n\n </div>\n \n\n</section>\n\n\n \n\n \n \n<section class=\"description\">\n <h2 id=\"description\">Description<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/AbstractControlDirective#description\"><i class=\"material-icons\">link</i></a></h2>\n <p>This class is only used internally in the <code><a href=\"api/forms/ReactiveFormsModule\" class=\"code-anchor\">ReactiveFormsModule</a></code> and the <code><a href=\"api/forms/FormsModule\" class=\"code-anchor\">FormsModule</a></code>.</p>\n\n \n</section>\n\n \n\n\n\n\n\n\n\n\n<section class=\"instance-properties\">\n <h2 id=\"properties\">Properties<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/AbstractControlDirective#properties\"><i class=\"material-icons\">link</i></a></h2>\n <table class=\"is-full-width list-table property-table\">\n <thead>\n <tr>\n <th>Property</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"control\"></a>\n <code class=\"\">abstract <span class=\"member-name\">control</span>: AbstractControl | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>A reference to the underlying control.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"value\"></a>\n <code class=\"\"><span class=\"member-name\">value</span>: any</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Reports the value of the control if it is present, otherwise null.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"valid\"></a>\n <code class=\"\"><span class=\"member-name\">valid</span>: boolean | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Reports whether the control is valid. A control is considered valid if no\nvalidation errors exist with the current value.\nIf the control is not present, null is returned.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"invalid\"></a>\n <code class=\"\"><span class=\"member-name\">invalid</span>: boolean | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Reports whether the control is invalid, meaning that an error exists in the input value.\nIf the control is not present, null is returned.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"pending\"></a>\n <code class=\"\"><span class=\"member-name\">pending</span>: boolean | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Reports whether a control is pending, meaning that that async validation is occurring and\nerrors are not yet available for the input value. If the control is not present, null is\nreturned.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"disabled\"></a>\n <code class=\"\"><span class=\"member-name\">disabled</span>: boolean | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Reports whether the control is disabled, meaning that the control is disabled\nin the UI and is exempt from validation checks and excluded from aggregate\nvalues of ancestor controls. If the control is not present, null is returned.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"enabled\"></a>\n <code class=\"\"><span class=\"member-name\">enabled</span>: boolean | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Reports whether the control is enabled, meaning that the control is included in ancestor\ncalculations of validity or value. If the control is not present, null is returned.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"errors\"></a>\n <code class=\"\"><span class=\"member-name\">errors</span>: <a href=\"api/forms/ValidationErrors\" class=\"code-anchor\">ValidationErrors</a> | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Reports the control's validation errors. If the control is not present, null is returned.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"pristine\"></a>\n <code class=\"\"><span class=\"member-name\">pristine</span>: boolean | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Reports whether the control is pristine, meaning that the user has not yet changed\nthe value in the UI. If the control is not present, null is returned.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"dirty\"></a>\n <code class=\"\"><span class=\"member-name\">dirty</span>: boolean | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Reports whether the control is dirty, meaning that the user has changed\nthe value in the UI. If the control is not present, null is returned.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"touched\"></a>\n <code class=\"\"><span class=\"member-name\">touched</span>: boolean | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Reports whether the control is touched, meaning that the user has triggered\na <code>blur</code> event on it. If the control is not present, null is returned.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"status\"></a>\n <code class=\"\"><span class=\"member-name\">status</span>: string | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Reports the validation status of the control. Possible values include:\n'VALID', 'INVALID', 'DISABLED', and 'PENDING'.\nIf the control is not present, null is returned.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"untouched\"></a>\n <code class=\"\"><span class=\"member-name\">untouched</span>: boolean | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Reports whether the control is untouched, meaning that the user has not yet triggered\na <code>blur</code> event on it. If the control is not present, null is returned.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"statusChanges\"></a>\n <code class=\"\"><span class=\"member-name\">statusChanges</span>: Observable<any> | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Returns a multicasting observable that emits a validation status whenever it is\ncalculated for the control. If the control is not present, null is returned.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"valueChanges\"></a>\n <code class=\"\"><span class=\"member-name\">valueChanges</span>: Observable<any> | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Returns a multicasting observable of value changes for the control that emits every time the\nvalue of the control changes in the UI or programmatically.\nIf the control is not present, null is returned.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"path\"></a>\n <code class=\"\"><span class=\"member-name\">path</span>: string[] | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Returns an array that represents the path from the top-level form to this control.\nEach index is the string name of the control on that level.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"validator\"></a>\n <code class=\"\"><span class=\"member-name\">validator</span>: <a href=\"api/forms/ValidatorFn\" class=\"code-anchor\">ValidatorFn</a> | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Synchronous validator function composed of all the synchronous validators registered with this\ndirective.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"asyncValidator\"></a>\n <code class=\"\"><span class=\"member-name\">asyncValidator</span>: <a href=\"api/forms/AsyncValidatorFn\" class=\"code-anchor\">AsyncValidatorFn</a> | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Asynchronous validator function composed of all the asynchronous validators registered with\nthis directive.</p>\n\n \n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\n\n\n\n<section class=\"instance-methods\">\n <h2 id=\"methods\">Methods<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/AbstractControlDirective#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"reset\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"reset\">\n reset()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/AbstractControlDirective#reset\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/forms/src/directives/abstract_control_directive.ts?message=docs(forms)%3A%20describe%20your%20change...#L256-L263\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/forms/src/directives/abstract_control_directive.ts#L256-L263\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Resets the control with the provided value if the control is present.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">reset</span>(value: any = undefined): void</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>value</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>Optional. Default is <code>undefined</code>.</p>\n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code>void</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"hasError\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"haserror\">\n hasError()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/AbstractControlDirective#haserror\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/forms/src/directives/abstract_control_directive.ts?message=docs(forms)%3A%20describe%20your%20change...#L264-L297\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/forms/src/directives/abstract_control_directive.ts#L264-L297\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Reports whether the control with the given path has the error specified.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">hasError</span>(errorCode: string, path?: string | (string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a>)[]): boolean</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-1\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>errorCode</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The code of the error to check</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>path</code>\n </td>\n <td class=\"param-type\"><code>string | (string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a>)[]</code></td>\n <td class=\"param-description\">\n <p>A list of control names that designates how to move from the current control\nto the control that should be queried for errors.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-1\">Returns</h6>\n <p><code>boolean</code>: whether the given error is present in the control at the given path.</p>\n<p>If the control is not present, false is returned.</p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n <tr>\n <td class=\"usage-notes\">\n <h4 id=\"hasError-usage-notes\">Usage Notes<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/AbstractControlDirective#hasError-usage-notes\"><i class=\"material-icons\">link</i></a></h4>\n <p>For example, for the following <code><a href=\"api/forms/FormGroup\" class=\"code-anchor\">FormGroup</a></code>:</p>\n<code-example>\nform = new <a href=\"api/forms/FormGroup\" class=\"code-anchor\">FormGroup</a>({\n address: new <a href=\"api/forms/FormGroup\" class=\"code-anchor\">FormGroup</a>({ street: new <a href=\"api/forms/FormControl\" class=\"code-anchor\">FormControl</a>() })\n});\n</code-example>\n<p>The path to the 'street' control from the root form would be 'address' -> 'street'.</p>\n<p>It can be provided to this method in one of two formats:</p>\n<ol>\n<li>An array of string control names, e.g. <code>['address', 'street']</code></li>\n<li>A period-delimited list of control names in one string, e.g. <code>'address.street'</code></li>\n</ol>\n<p>If no path is given, this method checks for the error on the current control.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <a id=\"getError\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"geterror\">\n getError()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/AbstractControlDirective#geterror\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/forms/src/directives/abstract_control_directive.ts?message=docs(forms)%3A%20describe%20your%20change...#L298-L328\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/forms/src/directives/abstract_control_directive.ts#L298-L328\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Reports error data for the control with the given path.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">getError</span>(errorCode: string, path?: string | (string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a>)[]): any</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-2\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>errorCode</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The code of the error to check</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>path</code>\n </td>\n <td class=\"param-type\"><code>string | (string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a>)[]</code></td>\n <td class=\"param-description\">\n <p>A list of control names that designates how to move from the current control\nto the control that should be queried for errors.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-2\">Returns</h6>\n <p><code>any</code>: error data for that particular error. If the control or error is not present,\nnull is returned.</p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n <tr>\n <td class=\"usage-notes\">\n <h4 id=\"getError-usage-notes\">Usage Notes<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/AbstractControlDirective#getError-usage-notes\"><i class=\"material-icons\">link</i></a></h4>\n <p>For example, for the following <code><a href=\"api/forms/FormGroup\" class=\"code-anchor\">FormGroup</a></code>:</p>\n<code-example>\nform = new <a href=\"api/forms/FormGroup\" class=\"code-anchor\">FormGroup</a>({\n address: new <a href=\"api/forms/FormGroup\" class=\"code-anchor\">FormGroup</a>({ street: new <a href=\"api/forms/FormControl\" class=\"code-anchor\">FormControl</a>() })\n});\n</code-example>\n<p>The path to the 'street' control from the root form would be 'address' -> 'street'.</p>\n<p>It can be provided to this method in one of two formats:</p>\n<ol>\n<li>An array of string control names, e.g. <code>['address', 'street']</code></li>\n<li>A period-delimited list of control names in one string, e.g. <code>'address.street'</code></li>\n</ol>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n</section>\n\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/forms\n - api/forms/AbstractFormGroupDirective\n - api/forms/ControlContainer\n - api/forms/FormArrayName\n - api/forms/FormControlDirective\n - api/forms/FormControlName\n - api/forms/FormGroupDirective\n - api/forms/FormGroupName\n - api/forms/NgControl\n - api/forms/NgForm\n - api/forms/NgModel\n - api/forms/NgModelGroup\n-->\n<!-- links from this doc:\n - /api\n - api/common/DecimalPipe\n - api/forms\n - api/forms/AbstractControlDirective#abstractcontroldirective\n - api/forms/AbstractControlDirective#asyncValidator\n - api/forms/AbstractControlDirective#control\n - api/forms/AbstractControlDirective#description\n - api/forms/AbstractControlDirective#dirty\n - api/forms/AbstractControlDirective#disabled\n - api/forms/AbstractControlDirective#enabled\n - api/forms/AbstractControlDirective#errors\n - api/forms/AbstractControlDirective#getError\n - api/forms/AbstractControlDirective#getError-usage-notes\n - api/forms/AbstractControlDirective#geterror\n - api/forms/AbstractControlDirective#hasError\n - api/forms/AbstractControlDirective#hasError-usage-notes\n - api/forms/AbstractControlDirective#haserror\n - api/forms/AbstractControlDirective#invalid\n - api/forms/AbstractControlDirective#methods\n - api/forms/AbstractControlDirective#path\n - api/forms/AbstractControlDirective#pending\n - api/forms/AbstractControlDirective#pristine\n - api/forms/AbstractControlDirective#properties\n - api/forms/AbstractControlDirective#reset\n - api/forms/AbstractControlDirective#status\n - api/forms/AbstractControlDirective#statusChanges\n - api/forms/AbstractControlDirective#subclasses\n - api/forms/AbstractControlDirective#touched\n - api/forms/AbstractControlDirective#untouched\n - api/forms/AbstractControlDirective#valid\n - api/forms/AbstractControlDirective#validator\n - api/forms/AbstractControlDirective#value\n - api/forms/AbstractControlDirective#valueChanges\n - api/forms/AbstractFormGroupDirective\n - api/forms/AsyncValidatorFn\n - api/forms/ControlContainer\n - api/forms/FormArrayName\n - api/forms/FormControl\n - api/forms/FormControlDirective\n - api/forms/FormControlName\n - api/forms/FormGroup\n - api/forms/FormGroupDirective\n - api/forms/FormGroupName\n - api/forms/FormsModule\n - api/forms/NgControl\n - api/forms/NgForm\n - api/forms/NgModel\n - api/forms/NgModelGroup\n - api/forms/ReactiveFormsModule\n - api/forms/ValidationErrors\n - api/forms/ValidatorFn\n - https://github.com/angular/angular/edit/master/packages/forms/src/directives/abstract_control_directive.ts?message=docs(forms)%3A%20describe%20your%20change...#L15-L329\n - https://github.com/angular/angular/edit/master/packages/forms/src/directives/abstract_control_directive.ts?message=docs(forms)%3A%20describe%20your%20change...#L256-L263\n - https://github.com/angular/angular/edit/master/packages/forms/src/directives/abstract_control_directive.ts?message=docs(forms)%3A%20describe%20your%20change...#L264-L297\n - https://github.com/angular/angular/edit/master/packages/forms/src/directives/abstract_control_directive.ts?message=docs(forms)%3A%20describe%20your%20change...#L298-L328\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/forms/src/directives/abstract_control_directive.ts#L15-L329\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/forms/src/directives/abstract_control_directive.ts#L256-L263\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/forms/src/directives/abstract_control_directive.ts#L264-L297\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/forms/src/directives/abstract_control_directive.ts#L298-L328\n-->"
|
|
} |