<< Click to Display Table of Contents >> Объектная модель > Действия с репозиториями и сущностями > AddError, AddInformation, AddWarning – валидация AddWarning – добавить предупреждение |
Метод e.AddWarning() применяется, когда необходимо заранее предупредить пользователя об ошибке, которая может повлиять на бизнес-процесс. При этом ошибка не влияет на работоспособность системы в целом. Например, сообщить о наличии дублей записей справочника или предупредить от том, что нужно дозаполнить поля в карточке:
Метод не прекращает текущие операции. Метод доступен в событиях:
Наименование события |
Тип сущности, где вызывается событие |
---|---|
Серверные события |
|
«До сохранения», «До удаления» |
Все типы сущностей |
«До подписания» |
Документ |
«До старта», «До рестарта», «До прекращения» |
Задача |
«До выполнения», «До принятия», «До отправки на доработку» |
Задание, задание на приемку и уведомление |
Клиентские события |
|
«Показ формы», «Обновление формы» |
Все типы сущностей |
События свойств типа сущности |
|
«Изменение значения контрола» |
Все типы сущностей |
События действия типа сущности |
|
«Выполнение» |
Все типы сущностей |
В зависимости от того, в каком событии вызывается метод, количество его перегрузок может отличаться:
Перегрузки
AddWarning(string message) |
Добавить предупреждение. Текст сообщения задается в коде |
AddWarning(LocalizedString message) |
Добавить предупреждение. Текст сообщения задается в виде строки локализации |
AddWarning(IPropertyInfo propertyInfo, string message, params IPropertyInfo[] relatedPropertiesInfo) |
Добавить предупреждение для свойства. Текст сообщения задается в коде |
AddWarning(IPropertyInfo propertyInfo, LocalizedString message, params IPropertyInfo[] relatedPropertiesInfo) |
Добавить предупреждение для свойства. Текст сообщения задается в виде строки локализации |
AddWarning(string message, params IActionInfo[] actions) |
Добавить предупреждение для действия. Текст сообщения задается в коде |
AddWarning(LocalizedString message, params IActionInfo[] actions) |
Добавить предупреждение для действия. Текст сообщения задается в виде строки локализации |
AddWarning(IChildEntity childEntity, string message) |
Добавить предупреждение для дочерней сущности. Текст сообщения задается в коде |
AddWarning(IChildEntity childEntity, LocalizedString message) |
Добавить предупреждение для дочерней сущности. Текст сообщения задается в виде строки локализации |
AddWarning(IChildEntity childEntity, IPropertyInfo propertyInfo, string message, params IPropertyInfo[] relatedPropertiesInfo) |
Добавить предупреждение для свойства дочерней сущности. Текст сообщения задается в коде |
AddWarning(IChildEntity childEntity, IPropertyInfo propertyInfo, LocalizedString message, params IPropertyInfo[] relatedPropertiesInfo) |
Добавить предупреждение для свойства дочерней сущности. Текст сообщения задается в виде строки локализации |
Синтаксис
C# |
public void AddWarning(string message); public void AddWarning(LocalizedString message); public void AddWarning(IPropertyInfo propertyInfo, string message, params IPropertyInfo[] relatedPropertiesInfo); public void AddWarning(IPropertyInfo propertyInfo, LocalizedString message, params IPropertyInfo[] relatedPropertiesInfo); public void AddWarning(string message, params IActionInfo[] actions); public void AddWarning(LocalizedString message, params IActionInfo[] actions); public void AddWarning(IChildEntity childEntity, string message); public void AddWarning(IChildEntity childEntity, LocalizedString message); public void AddWarning(IChildEntity childEntity, IPropertyInfo propertyInfo, string message, params IPropertyInfo[] relatedPropertiesInfo); public void AddWarning(IChildEntity childEntity, IPropertyInfo propertyInfo, LocalizedString message, params IPropertyInfo[] relatedPropertiesInfo); |
Параметры
message – текст предупреждения;
propertyInfo – свойство сущности, для которого необходимо выполнить валидацию. Если свойство изменено, то предупреждение скрывается;
relatedPropertiesInfo – дополнительные свойства. В параметре указываются все свойства, которые влияют на значение свойства из параметра propertyInfo. Если хотя бы одно из дополнительных свойств изменено, предупреждение скрывается;
actions – действия, которые отображаются вместе с ошибкой. Если для продолжения работы пользователю необходимо выполнить действие, рядом с текстом ошибки можно добавить ссылку на действие;
childEntity – дочерняя сущность. Является строкой свойства-коллекции.
Пример. Проверка даты публикации перед сохранением сущности
// Отобразить предупреждение, если дата публикации указана неверно.
public override void BeforeSave(BeforeSaveEventArgs e)
{
if (_obj.PublishDate == null)
e.AddWarning("Рекомендуется указать дату публикации");
}
Пример. Проверка email-адреса
// Отобразить предупреждение, если формат email-адреса указан некорректно.
public virtual void EmailValueInput(Sungero.Presentation.StringValueInputEventArgs e)
{
if (!string.IsNullOrWhiteSpace(e.NewValue) && !Functions.Module.EmailIsValid(e.NewValue))
e.AddWarning(Resources.WrongEmailFormat);
}
Actions – метаданные действия сущности Properties – метаданные свойства сущности AddError, AddInformation, AddWarning – валидация Как настроить валидацию панели фильтрации для входящих документов |
© Компания Directum, 2024 |