ТекстовыйДокумент.НачатьЗапись (TextDocument.BeginWriting)

ТекстовыйДокумент (TextDocument)

НачатьЗапись (BeginWriting)

Доступен, начиная с версии 8.3.7.

Синтаксис:

НачатьЗапись(<ОписаниеОповещения>, <ИмяФайла>, <ТипФайла>, <РазделительСтрок>)

Параметры:

<ОписаниеОповещения> (необязательный)

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

<Результат> - результат операции.
- Истина, если запись была инициирована с помощью расширений для браузера и пользователь согласился на его получение, то есть запись файла была завершена.
- Ложь, если запись была инициирована с помощью расширений для браузера, но пользователь не согласился на его получение, то есть запись файла не была завершена.
- Неопределено если запись была инициирована скачиванием файла средствами браузера и неизвестно - был ли файл записан или нет.
<ДополнительныеПараметры> - значение, которое было указано при создании объекта ОписаниеОповещения.

Если параметр не указан или имеет тип Неопределено, то по завершении никакая процедура вызвана не будет.

<ИмяФайла> (обязательный)

Тип: Строка.
Имя файла для сохранения текста.

<ТипФайла> (необязательный)

Тип: КодировкаТекста, Строка.
Тип кодировки файла. Тип файла может быть задан как в виде значения перечисления КодировкаТекста, так и в виде строки с указанием названия кодировки.
Поддерживаемые названия кодировок:

UTF-8
UTF-16
UTF-16BE
UTF-16LE
ISO-8859-1
US-ASCII
gb18030
iso-8859-2
iso-8859-3
iso-8859-4
iso-8859-5
iso-8859-6
iso-8859-7
iso-8859-8
iso-8859-9
iso-8859-13
iso-8859-15
Shift_JIS
EUC-JP
Big5
Big5-HKSCS
GBK
GB2312
GB_2312-80
EUC-KR
KSC_5601
windows-949
windows-874
cp866
KOI8-R
KOI8-U
windows-1250
windows-1251
windows-1252
windows-1253
windows-1254
windows-1255
windows-1256
windows-1257
windows-1258
macintosh
x-mac-cyrillic
ISO-2022-JP
ISO-2022-KR
ISO-2022-CN
ISO-2022-CN-EXT
HZ-GB-2312

Значение по умолчанию: UTF8.

<РазделительСтрок> (необязательный)

Тип: Строка.
Задается строка, являющаяся разделителем строк, к которой при записи файла будет преобразован символ ПС. Если строка пустая, то разделители строк при записи не конвертируются.
Допустимые варианты разделителей строк:

ВК;
ПС;
ВК + ПС (значение по умолчанию - может не указываться).

При использовании других строк в качестве разделителей будет вызвано исключение.
Значение по умолчанию: ВК + ПС.

Описание:

Вызывает начало записи текстового документа в файл с указанным именем.

Доступность:

Тонкий клиент, веб-клиент, толстый клиент.

Примечание:

При работе на веб-клиенте вызов метода выполняет обращение к серверу.

См. также:

ТекстовыйДокумент, метод Записать
ТекстовыйДокумент, метод ЗаписатьАсинх

Использование в версии:

Доступен, начиная с версии 8.3.7.

Описание изменено в версии 8.3.18.

Методическая информация