Control<T> class

Defines a part of a form that cannot be divided into other controls. Controls have values and validation state, which is determined by an optional validation function.

Control is one of the three fundamental building blocks used to define forms in Angular, along with ControlGroup and ControlArray.

Usage

By default, a Control is created for every <input> or other form component. With NgFormControl or NgFormModel an existing Control can be bound to a DOM element instead. This Control can be configured with a custom validation function.

Inheritance

Object
AbstractControl<T>
Control

Annotations

@optionalTypeArgs

Constructors

Control([dynamic value, ValidatorFn? validator])

Properties

dirty → bool: no setterinherited
disabled → bool: no setterinherited
disabledChanges → Stream<bool>: no setterinherited
enabled → bool: no setterinherited
errors → Map<String, dynamic>?: Returns the errors of this control.
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
invalid → bool: no setterinherited
pending → bool: no setterinherited
pristine → bool: no setterinherited
rawValue → String?: If value was coerced from a HTML element this is the original value from that element.
no setter
root → AbstractControl: no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
status → String?: The validation status of the control.
no setterinherited
statusChanges → Stream<String>: no setterinherited
touched → bool: no setterinherited
untouched → bool: no setterinherited
valid → bool: no setterinherited
validator ↔ ValidatorFn?: getter/setter pairinherited
value → T?: no setterinherited
valueChanges → Stream<T?>: no setterinherited

Methods

find(String? path) → AbstractControl?: Walks the path supplied to find matching control.
inherited
findPath(List<String?>? path) → AbstractControl?: Walks the path to find the matching control.
inherited
getError(String errorCode, [List<String>? path]) → dynamic: inherited
hasError(String errorCode, [List<String>? path]) → bool: inherited
markAsDirty({bool? onlySelf, bool emitEvent = true}) → void: Mark the control as dirty.
inherited
markAsDisabled({bool updateParent = true, bool emitEvent = true}) → void: Disables the control. This means the control will be exempt from validation checks and excluded from the aggregate value of any parent. Its status is DISABLED.
inherited
markAsEnabled({bool updateParent = true, bool emitEvent = true}) → void: Enables the control. This means the control will be included in validation checks and the aggregate value of its parent. Its status is re-calculated based on its value and its validators.
inherited
markAsPending({bool onlySelf = false}) → void: inherited
markAsPristine({bool updateParent = true}) → void: Marks the control as pristine.
inherited
markAsTouched({bool updateParent = true}) → void: Marks the control as touched.
inherited
markAsUntouched({bool updateParent = true}) → void: Marks the control as untouched.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
onUpdate() → void: Callback when control is asked to update its value.
override
registerOnChange(Function fn) → void: Register a listener for change events.
reset({T? value, bool? isDisabled, bool? updateParent, bool? emitEvent}) → void: Resets the form control.
inherited
setErrors(Map<String, dynamic> errors, {bool emitEvent = true}) → void: Sets errors on a control.
inherited
setParent(AbstractControl parent) → void: inherited
toString() → String: A string representation of this object.
inherited
updateValue(T? value, {bool? onlySelf, bool? emitEvent, bool? emitModelToViewChange, String? rawValue}) → void: Set the value of the control to value.
override
updateValueAndValidity({bool? onlySelf, bool? emitEvent}) → void: inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited