Выполняется перед показом формы карточки сущности.

Назначение. Задание первоначальных настроек формы.

Важно. В обработчике события не рекомендуется вызывать серверные функции (с атрибутом Remote) и использовать логику, которая будет долго обрабатываться. Данный обработчик выполняется часто. Поэтому, если в нем есть серверные функции, то на веб-сервер отправляется большое количество запросов, что, в свою очередь, влияет на быстродействие системы.

Аргументы события:

•_obj – сущность, карточка которой открывается;

•e.AddError() – добавление сообщения об ошибке. Выполняемые операции не будут прерваны, их нужно прекратить вручную. Для этого в коде после валидации необходимо проверить состояние сущности с помощью свойства IsValid или метода Validate();

•e.AddInformation() – добавление информационного сообщения. Выполняемые операции не будут прерваны;

•e.AddWarning() – добавление предупреждения. Выполняемые операции не будут прерваны;

•e.Instruction – инструкция к сущности. С помощью аргумента можно:

•полностью заменить текст инструкции;

•добавить текст в конец инструкции;

•отключить отображение инструкции в веб-клиенте. Для этого задайте в свойстве значение null, пробелы или пустую строку;

•добавить ссылку на сущность, например на документ;

•e.IsValid – признак того, что сущность валидная. Возможные значения:

•True. Сущность валидная (можно открыть форму карточки сущности);

•False. Сущность не валидная. При открытии формы появится сообщение об ошибке, заданное в AddError;

•e.Params – дополнительные параметры;

•e.Title – заголовок открываемой формы;

•e.HideAction(<информация о действии>) – скрытие действия или результата выполнения на ленте в карточке сущности. Например, метод e.HideAction(_obj.Info.Actions.DeleteEntity) скроет действие удаления сущности на ленте. Подробнее см. «Как в задании скрыть результат выполнения».

Пример 1:

public override void Showing(Sungero.Presentation.FormShowingEventArgs e)

{
  // Не показывать свойство Department, если карточка справочника "Сотрудники"
  // была открыта из карточки справочника "Подразделения".
  base.Showing(e);
  if (CallContext.CalledFrom(Departments.Info))
    _obj.State.Properties.Department.IsVisible = false;
}

Пример 2:

public override void Showing(Sungero.Presentation.FormShowingEventArgs e)

{
  // Добавить текст в конец инструкции.
  if (e.Instruction != null)
    e.Instruction += "Экземпляр согласованного договора передайте контрагенту.";
}

Пример 3:

public override void Showing(Sungero.Presentation.FormShowingEventArgs e)

{
  // Отключить отображение инструкции.
  e.Instruction = null;
}

Пример 4:

public override void Showing(Sungero.Presentation.FormShowingEventArgs e)

{
  // Вставить ссылку на документ в текст инструкции.
  var hyperlink = Hyperlinks.Get(Sungero.Docflow.OfficialDocuments, 334);
  e.Instruction = string.Format("При согласовании документа учитывайте требования {0}", hyperlink);
}

Выполняется перед закрытием формы карточки сущности.

Назначение. Задание дополнительной логики.

Аргументы события:

•_obj – сущность, карточка которой закрывается;

•Params – дополнительные параметры.

Пример:

// При закрытии карточки входящего счета сделать необязательными для заполнения

// свойства Номер счета, Дата счета, Сумма и Валюта.
public override void Closing(Sungero.Presentation.FormClosingEventArgs e)
{
  base.Closing(e);
 
  _obj.State.Properties.Number.IsRequired = false;
  _obj.State.Properties.Date.IsRequired = false;
  _obj.State.Properties.TotalAmount.IsRequired = false;
  _obj.State.Properties.Currency.IsRequired = false;
}

Вызывается при открытии и сохранении карточки сущности, выполнении обработчика клиентского события или действия на ленте, в котором идет обращение к серверной функции.

Назначение:

•задание логики для обновления видимости и доступности свойств на форме;

•валидация сущности после выполнения серверной функции.

Важно. В обработчике события не рекомендуется вызывать серверные функции (с атрибутом Remote) и использовать логику, которая будет долго обрабатываться. Данный обработчик выполняется часто. Поэтому, если в нем есть серверные функции, на веб-сервер отправляется большое количество запросов, что, в свою очередь, влияет на быстродействие системы.

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

Аргументы события:

•_obj – сущность, которая будет обновлена;

•e.AddError() – добавление сообщения об ошибке. Выполняемые операции не будут прерваны, их нужно прекратить вручную. Для этого в коде после валидации необходимо проверить состояние сущности с помощью свойства IsValid или метода Validate();

•e.AddInformation() – добавление информационного сообщения. Выполняемые операции не будут прерваны;

•e.AddWarning() – добавление предупреждения. Выполняемые операции не будут прерваны.

Примечание. Сообщение об ошибке, информационное сообщение и предупреждение отображаются с соответствующей иконкой в верхней части карточки сущности. Например, информационное сообщение выглядит следующим образом:

•e.IsValid – признак того, что сущность валидная. Возможные значения:

•True. Сущность валидная (доступна для обновления);

•False. Сущность не валидная. При сохранении сущности появится сообщение об ошибке, заданное в AddError.

Например, карточка документа обновится после резервирования номера по кнопке Присвоить номер на ленте. Если номер зарезервирован успешно, то карточка документа обновится и в ней появится информационное сообщение о том, что номер зарезервирован.

•e.Params – дополнительные параметры;

•e.Title – заголовок формы после обновления. Например, после регистрации документа в заголовок добавится его регистрационный номер.

Пример 1:

public override void Refresh(Sungero.Presentation.FormRefreshEventArgs e)

{
  // Изменить заголовок окна карточки в соответствии с именем документа.
  e.Title = _obj.Name == Docflow.Resources.DocumentNameAutotext ? null : _obj.Name;
}

Пример 2:

// Если повестка совещания ранее была создана из карточки совещания,

// то в карточке документа поле "Совещание" должно быть недоступно для изменения.
public override void Refresh(Sungero.Presentation.FormRefreshEventArgs e)
{
  var isCalledFromMeeting = CallContext.CalledFrom(Meetings.Info);
  if (isCalledFromMeeting)
    _obj.State.Properties.Meeting.IsEnabled = false;
 
  base.Refresh(e);
}

Выполняется на стороне клиентского приложения при подписании документа.

Назначение. Настройка диалога подписания.

Аргументы события:

•e.CanApprove – доступность кнопки Утвердить в диалоге подписания;

•e.CanEndorse – доступность кнопок Согласовать и Не согласовать в диалоге подписания;

•e.Hint – подсказка в диалоге подписания. Используется, например, для предупреждения о том, что содержимое документа изменилось после последнего просмотра.

Пример:

// До показа диалога подписания проверить ошибки валидации.

public override void ShowingSignDialog(Sungero.Domain.Client.ShowingSignDialogEventArgs e)
{
  var errors = Functions.OfficialDocument.Remote.GetApprovalValidationErrors(_obj, true);
  foreach (var error in errors)
    // Отобразить подсказку, если есть ошибки.
    e.Hint.Add(error);
  // Если нет ошибок, будет разрешена утверждающая подпись.
  e.CanApprove = !errors.Any();
}

Пример. Передача данных между событиями одной сущности

Валидация