Для windows-приложений перечислены уровни проверки данных (во время редактирования, при сохранении на форме, в бизнес-серверах), приведена их сравнительная характеристика

Валидация данных происходит в несколько этапов.

  • Проверки во время редактирования на форме.
  • Проверки во время сохранения объекта.
  • Проверки в бизнес-сервере.
Приём Преимущества Недостатки
Во время редактирования Позволяет оперативно сообщать пользователю о некорректности значения в каком-то поле Не позволяет в полной мере проверять сложные взаимосвязи между полями объекта и другими объектами
Во время сохранения Позволяет проверять сложные взаимосвязи между полями объекта, поскольку проверка происходит единовременно Проверка начинается только при попытке сохранения формы
В бизнес-сервере Позволяет проверять сложные взаимосвязи между полями объекта, а также связи с другими объектами Проверка начинается только при попытке сохранения формы

Общие замечания по реализации экранных форм редактирования можно посмотреть в статье Рекомендации по доработке форм редактирования.

Самым предпочтительным вариантом является реализация проверок на всех уровнях.

Проверка и подсветка полей на форме редактирования

DataObjectErrorProvider - компонент, позволяющий осуществлять проверку и подсветку полей на форме редактирования.

Основная последовательность действий для работы с DataObjectErrorProvider отображена в способах проверки обязательных полей на этапе редактирования и на этапе сохранения данных.

Проверка данных на форме во время редактирования

Проверка данных на форме во время редактирования может осуществляться за счёт:

  • генерации исключения при неправильном вводе в методе set соответствующего поля объекта
  • определения обязательных для заполнения полей на диаграмме классов через атрибут NotNull
  • проверки через DataObjectErrorProvider
Приём Преимущества Недостатки
Генерация исключения при неправильном вводе в методе set соответствующего поля объекта Позволяет организовать работу таким образом, что пользователь не выйдет из поля до тех пор, пока значение поля не будет введено корректно Для начала проверки требуется, чтобы фокус попал на соответствующее поле
Определение обязательных для заполнения полей на диаграмме классов через атрибут NotNull Позволяет в модели задать обязательные для заполнения поля
Ненавязчивое сигнализирование о незаполненности поля		 Не позволяет определять поля, обязательные только в некоторых ситуациях
Проверка через DataObjectErrorProvider Позволяет быстро прописать в коде перечень обязательных полей и пользователи приложения не смогут его менять,
Ненавязчивое сигнализирование о незаполненности поля		 Не позволяет пользователям менять условия проверки данных на форме

Проверка данных на форме во время сохранения

Проверка данных на форме во время сохранения осуществляется через события OnSave/OnSaveEvent и может включать следующие элементы:

  • Определение обязательных для заполнения полей на диаграмме классов через атрибут NotNull.
  • Проверка через DataObjectErrorProvider.
Приём Преимущества Недостатки
Определение обязательных для заполнения полей на диаграмме классов через атрибут NotNull Позволяет в модели задать обязательные для заполнения поля Не позволяет определять поля, обязательные только в некоторых ситуациях
Проверка через DataObjectErrorProvider + позволяет быстро прописать в коде перечень обязательных полей и пользователи приложения не смогут его менять - не позволяет пользователям менять условия проверки данных на форме

Пример использования всех методов:

protected override void OnSave(ICSSoft.STORMNET.UI.SaveEventArgs e) //метод OnSave(ICSSoft.STORMNET.UI.SaveEventArgs e) независимой формы
{
  System.Collections.ArrayList arl = new System.Collections.ArrayList();
  arl.AddRange(e.dataobject.CheckNotNullProperties(m_objView, true)); //проверяем заданные в модели NotNull-поля
  arl.AddRange((Editor as WinformВещьE).dataObjectErrorProvider1.GetNullProperties()); //проверяем заданные с помощью DataObjectErrorProvider обязательные поля
  if (arl.Count > 0)
  {
    System.Windows.Forms.MessageBox.Show("Остались незаполненными обязательные поля: " + Environment.NewLine + string.Join(", ", (string[])arl.ToArray(typeof(string))), "Внимание");
    (Editor as WinformВещьE).dataObjectErrorProvider1.FocusProperty(arl[0].ToString());
    m_bFailedSave = true;
    Editor.FailedSave(null);
    ((ICSSoft.STORMNET.UI.IDpdEditForm)Editor).SetStatusMessage(ICSSoft.STORMNET.UI.EditFormStatusMessage.ErrorInSave);
  }
  else
  {
    #region //проверка логических условий и подсветка через DataObjectErrorProvider
    SpecificControls.DataObjectErrorProvider errorProvider = null;
    if (Editor != null) errorProvider = (Editor as WinformВещьE).ValidationErrorProvider;
    if (!SQLValidationManagerIntegrator.CheckAllRulesDigitReport(e.dataobject, this, null, errorProvider))
    {
      ОтменитьСохранение();
      return;
    }
    #endregion
    base.OnSave(e); //сохранить, если все проверки пройдены
  }
}

Проверка обязательных полей

Если поля одного класса на одной форме редактирования должны быть обязательно заполнены, а на другой нет, то для отображения и проверки обязательных для заполнения полей (не отмеченных в классе атрибутом NotNull) можно воспользоваться DataObjectErrorProvider.

Порядок действий

  • кинуть DataObjectErrorProvider на форму
  • привязать DataObjectErrorProvider к EditManager, к которому привязаны проверяемые поля(DataObjectErrorProvider.EditManagerForBind)
  • задать проверяемые поля в DataObjectErrorProvider.Properties
//
// dataObjectErrorProvider1
//
this.dataObjectErrorProvider1.DpdEditContainer = this;
this.dataObjectErrorProvider1.EditManagerForBind = this.EditManager;
this.dataObjectErrorProvider1.Properties = new string[] {
  "НомерКУСП",
  "ТипКарточки",
  "ВремяЗаполнения"};
  • связать DataObjectErrorProvider с объектом данных. Вызвать dataObjectErrorProvider1.BindToData(); в методе Edit
  • для того чтобы отобразить ошибку для поля объекта (таракан), можно воспользоваться BindToData() или SetError() для определенного поля
if (obj #  null || obj.ToString()  "")
    dataObjectErrorProvider1.SetError(property, EditManager.NotNullToolTip);
else
    dataObjectErrorProvider1.SetError(property, string.Empty);
  • добавления полей в сообщение о не заполненности обязательных полей при сохранении. В независимой форме редактирования в методе OnSave() написать:
System.Collections.ArrayList arl = new System.Collections.ArrayList();//массив, куда попадут заголовки, из указанного представления, незаполненные полей
arl.AddRange(obj.CheckNotNullProperties(m_objView, true));//обязательные поля объекта (отмеченных в классе атрибутом NotNull)
string[] s1 = form.dataObjectErrorProvider1.GetNullProperties();//обязательные поля, указанные в dataObjectErrorProvider1
for (int i = 0; i < s1.Length; i++)
   arl.Add(m_objView.GetProperty(s1[i]).Caption);
if (arl.Count > 0)
{
   form.dataObjectErrorProvider1.FocusFirstNullProperty();//устанавливаем фокус на первое в массиве не заполненное обязательное поле
   IIS.WinUI.Tools.ShowWarning("Остались незаполненными обязательные поля: " + Environment.NewLine + string.Join(", ", (string[])arl.ToArray(typeof(string))), "Внимание");
   ОтменитьСохранение();
   return;
}

Пример проверки данных на форме через OnSave/OnSaveEvent

Cуть проверки состоит в том, что событие OnSave/OnSaveEvent переопределяется и, если данные не удовлетворяют некоторым условиям, базовый метод вызван не будет.

OnSaveEvent зависимой формы:

protected override void OnSaveEvent()
{
  ОбъектыДанных.ЗаявНаВыплату vЗаяв = (ОбъектыДанных.ЗаявНаВыплату) EditManager.DataObject;bool bContinueSave = true;
  if (vЗаяв.ДатаНачалаНачисл != null && vЗаяв.ЛгКатЛичн != null && vЗаяв.ЛгКатЛичн.ДатаНазначения != null && vЗаяв.ДатаНачалаНачисл.Value < vЗаяв.ЛгКатЛичн.ДатаНазначения.Value)
  {
    if (System.Windows.Forms.MessageBox.Show("Выплата может быть назначена с " + vЗаяв.ЛгКатЛичн.ДатаНазначения.Value.ToString("dd.MM.yyyy") + ". Сохранить изменения? ","Внимание", System.Windows.Forms.MessageBoxButtons.YesNo, System.Windows.Forms.MessageBoxIcon.Question) == System.Windows.Forms.DialogResult.No)
      bContinueSave = false;
  }
  if (bContinueSave)
    base.OnSaveEvent (); //вызов базового метода
  if (!m_bFailedSave) //значение переменной могло измениться в базовом методе
  {
    olПереплата.FillData();
    olУдержания.FillData();
  }
}

OnSave независимой формы:

protected override void OnSave(ICSSoft.STORMNET.UI.SaveEventArgs e)
{
  BS.BFСправочникиBS BS = new ICSSoft.Соцзащита.BS.BFСправочникиBS();
  ОбъектыДанных.Специалист vСпециалист;
  vСпециалист = BS.ИдентифицироватьСпециалиста();
  if (vСпециалист != null)
  {
    ОбъектыДанных.Личность vПолучатель = заявка.Получатель;
    if (!vСпециалист.ПроверитьСпеца(vПолучатель))
    {
      FailedSave(new Exception ("Сохранение изменений не возможно!")); //генерация исключения о том, что сохранение невозможно
      return;
    }
  }
  base.OnSave(e); //вызов базового метода
}

«Тараканы» и перечислимый тип

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

  1. Значение перечислимого типа помечено атрибутом Caption("") с пустой строкой в качестве параметра. Данная функциональность является стандартной для Flexberry. Следует напомнить, для задания атрибута Caption с пустым значением в редакторе Flexberry необходимо использовать символ «~» (тильда).

  2. Значение перечислимого типа помечено атрибутом EmptyEnumValue.

Замечания:

  1. Для отображения таракана и контроля ввода значения при сохранении свойство класса должно быть помечено атрибутом NotNull().

  2. «Тараканы» могут не отображаться в GroupEdit, что связано с механизмом отображения списка значений (используется встроенная возможность FlexGrid), но контроль при сохранении формы будет осуществляться. Если для отображения будет использован стандартный ComboBox, «тараканы» будут отображаться верно.

Сценарии доработки