AbstractControlDirective — Angular

Базовый класс для директив элементов управления.

API

abstract class AbstractControlDirective {
  abstract readonly control: AbstractControl<any, any, any> | null;
  readonly value: any;
  readonly valid: boolean | null;
  readonly invalid: boolean | null;
  readonly pending: boolean | null;
  readonly disabled: boolean | null;
  readonly enabled: boolean | null;
  readonly errors: ValidationErrors | null;
  readonly pristine: boolean | null;
  readonly dirty: boolean | null;
  readonly touched: boolean | null;
  readonly status: string | null;
  readonly untouched: boolean | null;
  readonly statusChanges: any;
  readonly valueChanges: any;
  readonly path: string[] | null;
  readonly validator: ValidatorFn | null;
  readonly asyncValidator: AsyncValidatorFn | null;
  reset(value?: any): void;
  hasError(errorCode: string, path?: string | (string | number)[] | undefined): boolean;
  getError(errorCode: string, path?: string | (string | number)[] | undefined): any;
}

control

AbstractControl<any, any, any> | null

Ссылка на базовый элемент управления.

value

any

Возвращает значение элемента управления, если он существует; в противном случае возвращает null.

valid

boolean | null

Указывает, является ли элемент управления допустимым. Элемент управления считается допустимым, если для текущего значения отсутствуют ошибки проверки. Если элемент управления отсутствует, возвращается null.

invalid

boolean | null

Указывает, является ли элемент управления недопустимым, то есть содержит ли входное значение ошибку. Если элемент управления отсутствует, возвращается null.

pending

boolean | null

Указывает, ожидает ли элемент управления завершения проверки: выполняется асинхронная проверка, и ошибки для входного значения пока недоступны. Если элемент управления отсутствует, возвращается null.

disabled

boolean | null

Указывает, отключен ли элемент управления, то есть отключен ли он в пользовательском интерфейсе, освобожден ли от проверок и исключен ли из агрегированных значений родительских элементов управления. Если элемент управления отсутствует, возвращается null.

enabled

boolean | null

Указывает, включен ли элемент управления, то есть учитывается ли он при вычислении допустимости или значения родительских элементов управления. Если элемент управления отсутствует, возвращается null.

errors

ValidationErrors | null

Возвращает ошибки проверки элемента управления. Если элемент управления отсутствует, возвращается null.

pristine

boolean | null

Указывает, является ли элемент управления неизмененным, то есть изменял ли пользователь его значение в пользовательском интерфейсе. Если элемент управления отсутствует, возвращается null.

dirty

boolean | null

Указывает, был ли изменен элемент управления, то есть изменял ли пользователь его значение в пользовательском интерфейсе. Если элемент управления отсутствует, возвращается null.

touched

boolean | null

Указывает, был ли затронут элемент управления, то есть инициировал ли пользователь для него событие blur. Если элемент управления отсутствует, возвращается null.

status

string | null

Возвращает статус проверки элемента управления. Возможные значения: 'VALID', 'INVALID', 'DISABLED' и 'PENDING'. Если элемент управления отсутствует, возвращается null.

untouched

boolean | null

statusChanges

any

Возвращает широковещательный Observable, который отправляет статус проверки при каждом его вычислении для элемента управления. Если элемент управления отсутствует, возвращается null.

valueChanges

any

Возвращает широковещательный Observable изменений значения элемента управления, который отправляет событие каждый раз, когда значение элемента управления изменяется в пользовательском интерфейсе или программно. Если элемент управления отсутствует, возвращается null.

path

string[] | null

Возвращает массив, представляющий путь от формы верхнего уровня до этого элемента управления. Каждый индекс содержит строковое имя элемента управления на соответствующем уровне.

validator

ValidatorFn | null

Функция синхронной проверки, объединяющая все синхронные валидаторы, зарегистрированные в этой директиве.

asyncValidator

AsyncValidatorFn | null

Функция асинхронной проверки, объединяющая все асинхронные валидаторы, зарегистрированные в этой директиве.

reset

void

Сбрасывает элемент управления, устанавливая переданное значение, если элемент управления существует.

@paramvalueany

@returnsvoid

hasError

boolean

Проверяет, есть ли у элемента управления, указанного путем, заданная ошибка.

@paramerrorCodestring

Код ошибки для проверки

@parampathstring | (string | number)[] | undefined

Список имен элементов управления, указывающий путь от текущего элемента управления к элементу, в котором нужно проверить наличие ошибок.

@returnsboolean

наличие указанной ошибки у элемента управления по заданному пути.

Если элемент управления отсутствует, возвращается false.

Примечания по использованию

Например, для следующего FormGroup:

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

Путь от корневой формы к элементу управления 'street' будет таким: 'address' -> 'street'.

Его можно передать этому методу в одном из двух форматов:

Массив строковых имен элементов управления, например ['address', 'street']
Список имен элементов управления, разделенных точками и записанных в одной строке, например 'address.street'

Если путь не указан, этот метод проверяет наличие ошибки у текущего элемента управления.

getError

any

Возвращает сведения об ошибке для элемента управления, указанного путем.

@paramerrorCodestring

Код ошибки для проверки

@parampathstring | (string | number)[] | undefined

@returnsany

сведения об указанной ошибке. Если элемент управления или ошибка отсутствует, возвращается null.

Примечания по использованию

Например, для следующего FormGroup:

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

Путь от корневой формы к элементу управления 'street' будет таким: 'address' -> 'street'.

Его можно передать этому методу в одном из двух форматов:

Массив строковых имен элементов управления, например ['address', 'street']
Список имен элементов управления, разделенных точками и записанных в одной строке, например 'address.street'

Описание

Базовый класс для директив элементов управления.

Этот класс используется только внутри ReactiveFormsModule и FormsModule.