IDocumentService.AddMainFileComment — метод (Document, DocumentFile, String)

Добавляет комментарий к основному файлу документа.

Синтаксис

bool AddMainFileComment(Document document, DocumentFile file, string comment)
Параметры
document

Тип: Document

Документ, содержащий файл file

file

Тип: DocumentFile

Объектная модель файла документа

comment

Тип: System.String

Комментарий к файлу

Возвращаемое значение

Тип: System.Boolean

true — комментарий был успешно добавлен, иначе — false

Исключения

Исключение Условие

System.ArgumentNullException

Ошибка возвращается в случае, если не задан параметр document, file или comment.

Примеры

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

(1)

IDocumentService documentService = objectContext.GetService<IDocumentService>(); (2)

Document document = objectContext.GetObject<Document>(new Guid("00000000-0000-0000-0000-000000000000")); (3)

DocumentFile file = document.Files.First(t => t.FileType = DocumentFileType.Main); (4)

documentService.AddMainFileComment(document, file, "Данный файл был проверен"); (5)
1 Инициализация контекста объектов.
2 Получение сервиса.
3 Получение документа.
4 Получение первого основного файла.
5 Добавление комментария.