Асинхронная функция. Записывает таблицу в файл.
Синтаксис
ЗаписатьАсинх(<ИмяФайла>, <ТипФайлаТаблицы>, <Вложения>)ЗаписатьАсинх(<Поток>, <ТипФайлаТаблицы>, <Вложения>)Полное описание, параметры и ограничения
ТабличныйДокумент.ЗаписатьАсинх (SpreadsheetDocument.WriteAsync)
ТабличныйДокумент (SpreadsheetDocument)
ЗаписатьАсинх (WriteAsync)
Доступен, начиная с версии 8.3.18.
Вариант синтаксиса: В файл
Синтаксис:
ЗаписатьАсинх(<ИмяФайла>, <ТипФайлаТаблицы>, <Вложения>)
Параметры:
<ИмяФайла> (обязательный)
Тип: Строка.
Имя файла, в котором сохраняется табличный документ.
<ТипФайлаТаблицы> (необязательный)
Тип: ТипФайлаТабличногоДокумента.
Формат, в котором будет сохранен табличный документ.
Поддерживаются форматы: ANSITXT, DOCX, MXL, MXL7, ODS, PDF, TXT.
Значение по умолчанию: MXL.
<Вложения> (необязательный)
Тип: КоллекцияВложенийPDF.
Объект, содержащий вложения PDF-документов.
Используется только при записи в форматы PDF и PDF/A-3.
Если табличный документ записывается в формате PDF или PDF/A-3 и указан параметр <Вложения>, то вложения добавляются в документ в формате PDF и PDF/A-3.
Описание варианта метода:
Записывает табличного документа в файл.
Вариант синтаксиса: В поток
Синтаксис:
ЗаписатьАсинх(<Поток>, <ТипФайлаТаблицы>, <Вложения>)
Параметры:
<Поток> (обязательный)
Тип: Поток, ПотокВПамяти, ФайловыйПоток.
Поток для записи табличного документа.
<ТипФайлаТаблицы> (необязательный)
Тип: ТипФайлаТабличногоДокумента.
Формат, в котором будет сохранен табличный документ.
Поддерживаются форматы: ANSITXT, DOCX, MXL, MXL7, ODS, PDF, TXT.
Значение по умолчанию: MXL.
<Вложения> (необязательный)
Тип: КоллекцияВложенийPDF.
Объект, содержащий вложения PDF-документов.
Если табличный документ записывается в формате PDF или PDF/A-3 и указан параметр <Вложения>, то вложения добавляются в документ в формате PDF и PDF/A-3.
Описание варианта метода:
Записывает табличного документа в поток.
При записи в поток допускается использование только форматов: ANSITXT, DOCX, XLSX, MXL, MXL7, ODS, PDF, TXT.
Внимание! Данный вариант метода не поддерживается в веб-клиенте.
Возвращаемое значение:
Тип: Обещание.
Результат выполнения обещания:
Истина - если запись была инициирована с помощью расширения браузера и пользователь подтвердил его получение, то есть запись файла была завершена.
Ложь - если запись была инициирована с помощью расширения браузера, но пользователь не подтвердил его получение, то есть запись файла не была завершена.
Неопределено - если запись была инициирована скачиванием файла средствами браузера и неизвестно, был ли файл записан или нет.
Описание:
Асинхронная функция. Записывает таблицу в файл.
Доступность:
Тонкий клиент, веб-клиент, мобильный клиент, толстый клиент, мобильное приложение (клиент).
Примечание:
При работе на сервере, веб-клиенте или через внешнее соединение:
нет возможности сохранять в формате XLS95;
нет возможности сохранять в формате MXL7 табличные документы, содержащие картинки. При попытке сохранить такой документ в формате MXL7 будет сгенерировано исключение.
Не поддерживается сохранение в PDF картинок типа Метафайл.
При работе на веб-клиенте вызов метода выполняет обращение к серверу.
При работе на мобильной платформе возможно сохранение только в форматах MXL и PDF.
При выводе в формат PDF шрифты, которые нельзя внедрять, а также шрифты, не являющиеся TrueType или OpenType, будут заменены на шрифт Arial. Если данный шрифт не обнаружен, то будет использован шрифт Helvetica.
См. также:
ТабличныйДокумент, метод Записать
ТабличныйДокумент, метод НачатьЗапись
Использование в версии:
Доступен, начиная с версии 8.3.18.
Методическая информация
Практические примеры
Прочитать вложения собственного PDF через Ждать
Полный модуль учебной формы последовательно ожидает экспорт, открытие, чтение вложений и закрытие. Серверный код и callback-обработчики здесь не смешиваются.
Где и как запускать
Модуль пустой управляемой формы учебной внешней обработки; тонкий или толстый клиент Windows. Вставьте весь модуль. Это не серверный код.
Подготовка
Создайте учебную внешнюю обработку с пустой управляемой основной формой. Создайте команду УчебныйПример и кнопку этой команды.
В свойстве команды Действие выберите процедуру УчебныйПример. Вставьте полный приведённый модуль формы.
Откройте EPF в тонком или толстом клиенте Windows и нажмите кнопку. Не переносите Ждать и Асинх в серверный общий модуль.
Пример работает только со своими данными в памяти; записи в базу, файлы и сеть нет.
Документ PDF строится из собственной ячейки Книга: 3 шт. Внешний PDF, установленный PDF-редактор, криптографический сертификат и реальные персональные данные не нужны.
Файловый путь нигде не используется. Для просмотра в PDF-программе сохраните только полученные собственные двоичные данные в отдельно выбранный новый учебный файл.
&НаКлиенте
Асинх Процедура УчебныйПример(Команда)
Вложения = Новый КоллекцияВложенийPDF;
ТекстJSON = "{""товар"":""Книга"",""количество"":3}";
БайтыJSON = ПолучитьДвоичныеДанныеИзСтроки(ТекстJSON, КодировкаТекста.UTF8, Ложь);
Вложения.Добавить("товар.json", БайтыJSON, "application/json", ТипСвязиВложенияPDF.Данные);
Чтение = Неопределено;
Запись = Неопределено;
ПотокЧтения = Неопределено;
ПотокPDF = Новый ПотокВПамяти;
Документ = Новый ТабличныйДокумент;
Документ.Область("A1").Текст = "Книга: 3 шт.";
Документ.Область("A1").ЦветТекста = Новый Цвет(30, 90, 180);
Попытка
Ждать Документ.ЗаписатьАсинх(ПотокPDF, ТипФайлаТабличногоДокумента.PDF, Вложения);
БайтыPDF = ПотокPDF.ЗакрытьИПолучитьДвоичныеДанные();
ПотокPDF = Неопределено;
ПотокЧтения = БайтыPDF.ОткрытьПотокДляЧтения();
Чтение = Новый ЧтениеPDF;
Ждать Чтение.ОткрытьАсинх(ПотокЧтения);
Прочитанные = Ждать Чтение.ПолучитьВложенияАсинх();
ФайлJSON = Прочитанные.Найти("товар.json");
Если ФайлJSON = Неопределено Тогда
ВызватьИсключение "Асинхронное чтение не вернуло собственное вложение";
КонецЕсли;
Сообщить(Прочитанные.Количество() = 1);
Сообщить(ПолучитьСтрокуИзДвоичныхДанных(ФайлJSON.Содержимое, КодировкаТекста.UTF8) = ТекстJSON);
Ждать Чтение.ЗакрытьАсинх();
Чтение = Неопределено;
Исключение
Если Чтение <> Неопределено Тогда
Ждать Чтение.ЗакрытьАсинх();
КонецЕсли;
Если Запись <> Неопределено Тогда
Ждать Запись.ЗакрытьАсинх();
КонецЕсли;
Если ПотокЧтения <> Неопределено Тогда
ПотокЧтения.Закрыть();
КонецЕсли;
Если ПотокPDF <> Неопределено Тогда
ПотокPDF.Закрыть();
КонецЕсли;
ВызватьИсключение;
КонецПопытки;
Если Чтение <> Неопределено Тогда
Ждать Чтение.ЗакрытьАсинх();
КонецЕсли;
Если Запись <> Неопределено Тогда
Ждать Запись.ЗакрытьАсинх();
КонецЕсли;
Если ПотокЧтения <> Неопределено Тогда
ПотокЧтения.Закрыть();
КонецЕсли;
Если ПотокPDF <> Неопределено Тогда
ПотокPDF.Закрыть();
КонецЕсли;
КонецПроцедурыРазбор по шагам
Асинх Процедура находится в модуле формы с директивой НаКлиенте.
Ждать ЗаписатьАсинх завершается до получения байтов: нельзя читать ещё незавершённый экспорт.
Ждать ОткрытьАсинх завершается до ПолучитьВложенияАсинх. Возвращённый результат чтения — коллекция, а не Обещание.
Закрытие PDF тоже ожидается; после него переменная обнуляется. При исключении оставшиеся ресурсы освобождаются.
Как проверить результат
Две проверки Истина и завершённая цепочка без записи на диск.
В форме используйте полный модуль, а не отдельный Ждать внутри обычной процедуры.
Ожидаемый результат
Вложение собственного PDF прочитано последовательной асинхронной цепочкой.
На что обратить внимание
Асинх/Ждать в данном упражнении предназначены для клиентского модуля, не для серверного общего модуля.
Веб-клиент имеет отдельные ограничения расширений; этот учебный пример рассчитан на Windows-клиент.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.
Асинхронно добавить JSON в свой PDF
Открываем собственный поток записи через Ждать, дописываем вложение и ожидаем закрытие. Проверку выполняет другой PDF-объект после завершения записи.
Где и как запускать
Модуль пустой управляемой формы учебной внешней обработки; тонкий или толстый клиент Windows. Вставьте весь модуль. Это не серверный код.
Подготовка
Создайте учебную внешнюю обработку с пустой управляемой основной формой. Создайте команду УчебныйПример и кнопку этой команды.
В свойстве команды Действие выберите процедуру УчебныйПример. Вставьте полный приведённый модуль формы.
Откройте EPF в тонком или толстом клиенте Windows и нажмите кнопку. Не переносите Ждать и Асинх в серверный общий модуль.
Пример работает только со своими данными в памяти; записи в базу, файлы и сеть нет.
Документ PDF строится из собственной ячейки Книга: 3 шт. Внешний PDF, установленный PDF-редактор, криптографический сертификат и реальные персональные данные не нужны.
Файловый путь нигде не используется. Для просмотра в PDF-программе сохраните только полученные собственные двоичные данные в отдельно выбранный новый учебный файл.
&НаКлиенте
Асинх Процедура УчебныйПример(Команда)
Чтение = Неопределено;
Запись = Неопределено;
ПотокЧтения = Неопределено;
ПотокPDF = Новый ПотокВПамяти;
Документ = Новый ТабличныйДокумент;
Документ.Область("A1").Текст = "Книга: 3 шт.";
Документ.Область("A1").ЦветТекста = Новый Цвет(30, 90, 180);
Попытка
Ждать Документ.ЗаписатьАсинх(ПотокPDF, ТипФайлаТабличногоДокумента.PDF);
Вложения = Новый КоллекцияВложенийPDF;
ТекстJSON = "{""товар"":""Книга"",""количество"":3}";
БайтыJSON = ПолучитьДвоичныеДанныеИзСтроки(ТекстJSON, КодировкаТекста.UTF8, Ложь);
Вложения.Добавить("товар.json", БайтыJSON, "application/json", ТипСвязиВложенияPDF.Данные);
ПотокPDF.Перейти(0, ПозицияВПотоке.Начало);
Запись = Новый ЗаписьPDF;
Ждать Запись.ОткрытьАсинх(ПотокPDF);
Ждать Запись.ЗаписатьВложенияАсинх(Вложения);
Ждать Запись.ЗакрытьАсинх();
Запись = Неопределено;
БайтыPDF = ПотокPDF.ЗакрытьИПолучитьДвоичныеДанные();
ПотокPDF = Неопределено;
ПотокЧтения = БайтыPDF.ОткрытьПотокДляЧтения();
Чтение = Новый ЧтениеPDF;
Ждать Чтение.ОткрытьАсинх(ПотокЧтения);
Прочитанные = Ждать Чтение.ПолучитьВложенияАсинх();
ФайлJSON = Прочитанные.Найти("товар.json");
Если ФайлJSON = Неопределено Тогда
ВызватьИсключение "Нет вложения после завершённой асинхронной записи";
КонецЕсли;
Сообщить(Прочитанные.Количество() = 1);
Сообщить(ПолучитьСтрокуИзДвоичныхДанных(ФайлJSON.Содержимое, КодировкаТекста.UTF8) = ТекстJSON);
Исключение
Если Чтение <> Неопределено Тогда
Ждать Чтение.ЗакрытьАсинх();
КонецЕсли;
Если Запись <> Неопределено Тогда
Ждать Запись.ЗакрытьАсинх();
КонецЕсли;
Если ПотокЧтения <> Неопределено Тогда
ПотокЧтения.Закрыть();
КонецЕсли;
Если ПотокPDF <> Неопределено Тогда
ПотокPDF.Закрыть();
КонецЕсли;
ВызватьИсключение;
КонецПопытки;
Если Чтение <> Неопределено Тогда
Ждать Чтение.ЗакрытьАсинх();
КонецЕсли;
Если Запись <> Неопределено Тогда
Ждать Запись.ЗакрытьАсинх();
КонецЕсли;
Если ПотокЧтения <> Неопределено Тогда
ПотокЧтения.Закрыть();
КонецЕсли;
Если ПотокPDF <> Неопределено Тогда
ПотокPDF.Закрыть();
КонецЕсли;
КонецПроцедурыРазбор по шагам
Сначала ожидаем экспорт исходного PDF без вложений.
Создаём неинициализированный ЗаписьPDF; каждую следующую операцию выполняем после Ждать предыдущей.
Запись и её закрытие завершаются до получения итоговых байтов из потока.
Новый ЧтениеPDF независимо подтверждает имя и содержимое вложения; выводим именно результат, не объект Обещание.
Как проверить результат
Две проверки Истина; JSON проверен после завершения записи.
Файл товар.json на диске не создаётся; все байты принадлежат этой форме.
Ожидаемый результат
Асинхронная запись и независимая проверка завершены в правильном порядке.
На что обратить внимание
Обещание не является признаком уже завершённой записи: требуется Ждать.
Нельзя освобождать поток, пока асинхронная операция PDF ещё использует его.
Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.