Метод используется для добавления локализованного комментария в историю работы с сущностью. Комментарий заполняется при вызове методов Grant(), Revoke() или RevokeAll() и добавляется через точку к стандартному комментарию системы. Метод доступен только в серверном коде.

Чтобы локализовать комментарий, в дереве решений в контекстном меню решения, модуля или типа сущности выберите пункт Открыть ресурсы. Добавьте ресурс в формате Enum_OperationDetailed_{ключ ресурса}. Ключ ресурса далее указывается в параметрах метода и должен состоять из букв латинского алфавита.

Синтаксис

Параметры

resourceKey – ключ ресурса;

paramsComment – параметры для форматированного комментария.

Примечание. Рекомендуется задавать максимально короткое название ключа ресурса и значения для параметров paramsComment метода. Это связано с тем, что они записываются в базу данных и влияют на ее размер, если таких записей будет много.

Пример

При выполнении фонового процесса «Копирование прав доступа» необходимо в историю работы с объектом добавлять комментарий с информацией, от какого сотрудника скопированы права. Для этого добавьте ресурс Enum_OperationDetailed_CopyAccessRights:

При вызове метода SetLocalizationComment() укажите ключ ресурса CopyAccessRights:

// Добавить в историю дополнительный комментарий.

using (var historyCommentScope = new HistoryCommentScope())
{
  var document = Sungero.Content.ElectronicDocuments.Get(documentId);
  historyCommentScope.SetLocalizationComment("CopyAccessRights", fromUser.DisplayValue, fromUser.Id);
  document.AccessRights.Grant(toUser, copyAccessRightsTypes);
  document.AccessRights.Save();
}

В результате к стандартному комментарию системы добавится уточнение: