IDocumentService.SyncPropertiesToFile — метод (Document, DocumentFile, IList<IDocumentPropertySetting>)

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

Синтаксис

bool SyncPropertiesToFile(Document document, DocumentFile file, IList<IDocumentPropertySetting> propertySettings)
Параметры
document

Тип: Document

Документ

file

Тип: DocumentFile

Файл документа

propertySettings

Тип: System.Collections.Generic.IList<IDocumentPropertySetting>

Синхронизируемые свойства документа

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

Тип: System.Boolean

Значение всегда false

Исключения

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

System.ArgumentNullException

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

Заметки

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

Синхронизация производится только с файлами Microsoft Office.

Примеры

Ниже приведён пример использования метода SyncPropertiesToFile при синхронизации названия документа со свойствами основного файла, привязанного к документу

(1)

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

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

document.MainInfo.Name = "Изменение названия и синхронизация";
objectContext.SaveObject(document); (4)

DocumentSetting documentSetting = documentService.GetKindSettings(document.SystemInfo.CardKind);
IList<IDocumentPropertySetting> setting = documentSetting.Properties.Cast<IDocumentPropertySetting>().ToList(); (5)

documentService.SyncPropertiesToFile(document, document.Files.First(t => t.FileType = DocumentFileType.Main), setting); (6)
1 Инициализация контекста объектов.
2 Получение сервиса для работы с документами.
3 Получение документа.
4 Изменение данных.
5 Получение настроек для вида документа и приведение к требуемому типу.
6 Передача названия карточки в файл.