Программный интерфейс (API) надстройки FillDocuments (для запуска из макроса)

Надстройка FillDocuments поддерживает возможность управления из стороннего макроса.

ВНИМАНИЕ: техподдержка не распространяется на вопросы, связанные с запуском надстройки из ваших макросов, а также при запуске из планировщика Windows по расписанию.

В общей инструкции по API надстроек описано:

  • как запустить надстройку, и проверить, запущена ли она
  • как выполнить основные команды, при запущенной надстройке
  • как произвести импорт ранее сохранённых настроек из файла xml
  • как программно изменить настройки FillDocuments

а также присутствует файл Excel с примерами макросов для этих задач.

 

Ниже описаны параметры, имеющие отношение только к надстройке FillDocuments.

Команды меню, и соответствующие им макросы:

 

Пункт меню Код VBA для выполнения команды
Сформировать документы Run "CreateAllDocuments"

 

Параметры настроек, и их значения по умолчанию:

 

Описание параметра Название параметра Значение по умолчанию
Номер строки с заголовком таблицы (названиями полей) ComboBox_FirstRow 1
Считать строку заполненной, если присутствует значение в столбце ComboBox_BaseColumn 2 «B»
Использовать только те шаблоны, имена которых перечислены в столбце ComboBox_TemplatesFilter_Column 5 «E»
Заменять перенос строк из Excel (Alt + Enter)
на следующий символ при подстановке в Word
ComboBox_LineFeed  
Маска имени файла TextBox_OutputMask {%str%} - {%filename%}.{%ext%}
<не используется> ComboBox_FirstColumn 1 «A»
<не используется> ComboBox_BaseRow 2
<не используется> CheckBox_UseAllColumns True
Маска прикрепляемых к письму созданных файлов TextBox_AttachCreatedFilesMask *
Маска прикрепляемых к письму файлов из отдельной папки TextBox_AttachStaticFilesMask *
Открывать папку с документами по окончании процесса (да / нет) CheckBox_ShowFolderWhenDone True
Использовать только те шаблоны, имена которых перечислены в столбце (да / нет) CheckBox_TemplatesFilter_Enabled False
При рассылке писем, ставить отметку «отправлено» в столбце ComboBox_SendMark_Column 10 «J»
  ComboBox_SendTime_Column 11 «K»
Столбец, по которому группируются строки в режиме Multirow ComboBox_Multirow_GroupColumn 1 «A»
Путь к файлу приложения TheBAT! TextBox_TheBAT_Path C:\Program Files\The Bat!\thebat64.exe
Папки «ШАБЛОНЫ» и «ДОКУМЕНТЫ» в той же папке, где текущий файл Excel (да / нет) CheckBox_UseCurrentFolder False
Папка с шаблонами документов TextBox_TemplatesFolder D:\Шаблоны\
Папка для создаваемых файлов TextBox_OutputFolder D:\Документы\
  MultiPage_Options 0
Автоматически выводить на печать создаваемые файлы Excel и Word (да / нет) CheckBox_ImmediatePrintOut False
  CheckBox_PDF False
Производить подстановку значений в колонтитулы, надписи и прочие внедрённые объекты Word (да / нет) CheckBox_ReplaceInColon False
Добавлять гиперссылки на сформированные файлы в исходную таблицу
(в столбцы с заголовками вида "Гиперссылка - ИмяФайлаШаблона") (да / нет)
CheckBox_AddHyperlinks False
Включить режим «MultiRow» (да / нет) CheckBox_MultiRow False
Формировать документы ПО ВСЕМ заполненным строкам таблицы (да / нет) CheckBox_UseAllRows False
В режиме автоматического вывода документов на печать,
количество печатаемых копий по-умолчанию
TextBox_PrintCopies_FieldName  
Выполнять рассылку писем (да / нет) CheckBox_SendEmail False
Текст письма (в текстовом или HTML формате) TextBox_MailBody  
Тема письма TextBox_MailSubject  
Отправлять письма с ящика ComboBox_TheBAT_Account  
Отправлять письма автоматически (да / нет) CheckBox_ImmediateSendMail False
Получатель писем в формате {поле_c_email} или {поле_с_именем} <{поле_c_email}> TextBox_MailTo  
Прикреплять к письму сформированные файлы (да / нет) CheckBox_Mail_AttachCreatedFiles False
Прикреплять к письму все файлы из заданной папки (да / нет) CheckBox_Mail_AttachStaticFiles False
Пароль к почтовому ящику TextBox_TheBAT_Password  
  TextBox_TheBAT_LOGIN_USER  
  TextBox_TheBAT_LOGIN_PASSWORD  
Автоматически закрывать индикатор процесса, по окончании формирования документов (да / нет) CheckBox_CloseProgressBar False
Выбирать шаблоны для заполнения, при каждом запуске формирования документов (да / нет) CheckBox_SelectTemplates False
Вставлять формулы для разбивки слова по буквам (по нажатию Ctrl + Shift + V) CheckBox_PasteFormulasForSeparateLetters False
Отключить функцию копирования текста из заголовка таблицы по двойному щелчку на ячейке CheckBox_DisableDoubleClickOnHeader False
  CheckBox_FormulasToValues False
  CheckBox_CombineXLSsheets False
  CheckBox_ShowAdditionalMenu False
  CheckBox_AddSendMarkIntoRow False
Папка со вставляемыми картинками TextBox_ImagesFolder  
Папка со вставляемыми файлами Word TextBox_WordDocFolder  
Вести лог распечатанных строк в файле Excel CheckBox_EnableLog False
Данные, выводимые в лог (в формате ТекстСтолбца1|ТекстСтолбца2 ) TextBox_LogRowTemplate {%date%}|{Фамилия}|Номер {номер}|{=B2}
Путь к файлу лога (формат Excel. Файл должен существовать) TextBox_LogFilename  
Заменять коды полей в гиперссылках CheckBox_ReplaceCodesInHyperlinks False
  CheckBox_Multirow_InsertPageBreaks False
  CheckBox_USE_TEMPLATES_WITH_NAMES_LIKE_WORKSHEET_NAME False
  TextBox_EmailAPI_APIkey  
  CheckBox_ReplaceInColonShapes False
Копия письма (CC) TextBox_Mail_CC  
Скрытая копия (BCC) TextBox_Mail_BCC  
  CheckBox_AddSendTimeIntoRow False
  CheckBox_ProcessUnsupportedTemplates False
  CheckBox_EmailAPI_CreateReport False
  CheckBox_UnisenderFrame False
  CheckBox_SpecifiedTemplateWorksheets False
Формировать по каждому шаблону столько файлов, сколько уникальных значений содержится в столбце CheckBox_Multirow_GroupRows True
Подставлять значения в текстовые поля защищённых от изменения шаблонов Word CheckBox_InsertIntoFields False
Искать в шаблонах коды полей, и заменять только найденные CheckBox_ReplaceExistingFieldCodesOnly True
Имя сводного файла Excel TextBox_CombineXLS_filename Сводный файл.xls
Интервал отправки писем, от TextBox_SendInterval_Min 0
Интервал отправки писем, до TextBox_SendInterval_Max 0
  TextBox_HyperlinkText открыть файл