angular-cn/aio/dist/generated/docs/api/forms/ControlContainer.json

5 lines
11 KiB
JSON

{
"id": "api/forms/ControlContainer",
"title": "ControlContainer",
"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/ControlContainer\", \"name\": \"ControlContainer\" } }\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/control_container.ts?message=docs(forms)%3A%20describe%20your%20change...#L11-L43\" 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/control_container.ts#L11-L43\" 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=\"controlcontainer\">ControlContainer<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/forms/ControlContainer#controlcontainer\"><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>A base class for directives that contain multiple registered instances of <code><a href=\"api/forms/NgControl\" class=\"code-anchor\">NgControl</a></code>.\nOnly used by the forms module.</p>\n\n \n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nabstract class <a href=\"api/forms/ControlContainer\" class=\"code-anchor\">ControlContainer</a> extends <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective\">AbstractControlDirective</a> {\n <a class=\"code-anchor\" href=\"api/forms/ControlContainer#name\"><span class=\"member-name\">name</span>: string | number | null</a>\n <a class=\"code-anchor\" href=\"api/forms/ControlContainer#formDirective\"><span class=\"member-name\">formDirective</span>: Form | null</a>\n <a class=\"code-anchor\" href=\"api/forms/ControlContainer#path\"><span class=\"member-name\">path</span>: string[] | null</a>\n\n // inherited from <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective\">forms/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&#x3C;any> | null</a>\n <a class=\"code-anchor\" href=\"api/forms/AbstractControlDirective#valueChanges\"><span class=\"member-name\">valueChanges</span>: Observable&#x3C;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/ControlContainer#subclasses\"><i class=\"material-icons\">link</i></a></h2>\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 </div>\n \n\n</section>\n\n\n \n\n \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/ControlContainer#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=\"name\"></a>\n <code class=\"\"><span class=\"member-name\">name</span>: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | null</code>\n </td>\n <td>\n \n <p>The name for the control</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"formDirective\"></a>\n <code class=\"\"><span class=\"member-name\">formDirective</span>: <a href=\"api/forms/Form\" class=\"code-anchor\">Form</a> | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>The top-level form directive for the control.</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>The path to this group.</p>\n\n \n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\n\n\n\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/forms\n - api/forms/AbstractControlDirective\n - api/forms/AbstractFormGroupDirective\n - api/forms/FormArrayName\n - api/forms/FormGroupDirective\n - api/forms/FormGroupName\n - api/forms/NgForm\n - api/forms/NgModelGroup\n-->\n<!-- links from this doc:\n - /api\n - api/common/DecimalPipe\n - api/forms\n - api/forms/AbstractControlDirective\n - api/forms/AbstractControlDirective#asyncValidator\n - api/forms/AbstractControlDirective#control\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#hasError\n - api/forms/AbstractControlDirective#invalid\n - api/forms/AbstractControlDirective#path\n - api/forms/AbstractControlDirective#pending\n - api/forms/AbstractControlDirective#pristine\n - api/forms/AbstractControlDirective#reset\n - api/forms/AbstractControlDirective#status\n - api/forms/AbstractControlDirective#statusChanges\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/ControlContainer#controlcontainer\n - api/forms/ControlContainer#formDirective\n - api/forms/ControlContainer#name\n - api/forms/ControlContainer#path\n - api/forms/ControlContainer#properties\n - api/forms/ControlContainer#subclasses\n - api/forms/Form\n - api/forms/FormArrayName\n - api/forms/FormGroupDirective\n - api/forms/FormGroupName\n - api/forms/NgControl\n - api/forms/NgForm\n - api/forms/NgModelGroup\n - https://github.com/angular/angular/edit/master/packages/forms/src/directives/control_container.ts?message=docs(forms)%3A%20describe%20your%20change...#L11-L43\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/forms/src/directives/control_container.ts#L11-L43\n-->"
}