SunFlurry wiki - User contributions [en]

Проект Розница

2026-04-03T15:03:05Z

Admin: /* Ссылки для скачивания бинарных файлов проекта */

{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Проект Розница|Общее описание розницы]]
* [[Установка проекта Розница|Пошаговая установка проекта розница]]}}
__NOTOC__
Проект "розница" является абсолютно '''бесплатной''' альтернативой коммерческим кассовым и учетным системам для розничной торговли. Проект может использоваться как на рабочем месте кассира, так и как учетная программа для розничной компании. Эта статья пытается дать исчерпывающую информацию о том, какими ограничениями обладает данная версия, что она уже умеет и какие предполагаются дальнейшие шаги по ее развитию, а также о том, каким образом начать с ней работать.

Проект появился для того, чтобы каким-то образом облегчить положение мелких розничных точек на рынке. Существующие программы слишком сложные в настройке, не обладают достаточной гибкостью, медленные в работе или заставляют торговые точки платить немалые деньги, в условиях, когда прибыль небольших магазинов постоянно сокращается из-за увеличения конкуренции с федеральными сетями. Мы представляем бесплатное решение, которое не только не требует какого-либо лицензирования, но и может быть модифицировано Вашими специалистами или сторонними организациями. В программе не используется реклама, нет ограничений по времени, скрытых платежей и пр. Если Ваша модель кассового или периферийного оборудования пока не поддерживается текстами драйверов проекта, Вы можете оставить заявку для создания драйвера (на github) или создать его самостоятельно. Данный Wiki-портал содержит описание всех программных возможностей системы, на которой работает проект, все статьи, связанные с описанием программных функций, имеют примеры. Любой человек, немного разбирающийся в программировании, сможет модифицировать текст проекта для изменения или увеличения функциональности. Также для пошаговой информации по установке проекта в магазине, смотрите статью '''[[Установка проекта Розница]]'''.

==== Лицензионное соглашение на использование проекта ====

Для того, чтобы скачивать, устанавливать, работать с проектом или модифицировать его с помощью исполняемых файлов проекта, Вам необходимо согласиться с лицензионным соглашением на использование исполняемых файлов проекта. Соглашение имеет определенные ограничения в использовании, для того, чтобы проект мог применяться только небольшими и средними организациями. Соглашение не относится к исходным текстам проекта, распространяемым на сервере github (или подобном), тексты проекта могут быть использованы в любых целях без ограничения.

* [http://{{SERVERNAME}}/download/EULASOFT.txt <big>'''Полный текст соглашения для использования исполняемых файлов (программного обеспечения) проекта.'''</big>]. Исполняемые файлы доступны для скачивания с данного портала (см. ниже ссылки для скачивания).
* [http://{{SERVERNAME}}/download/EULASRC.txt <big>'''Полный текст соглашения для использования исходных текстов проекта.'''</big>]. Свежую версию исходных текстов проекта можно скачать со страницы проекта на [https://github.com/sfsys132/project-free-Russian-retail github].

Ниже дается краткий свод ограничений соглашения на использование исполняемых файлов проекта (для понимания общей картины):
* Соглашение запрещает скачивать '''исполняемые файлы''', устанавливать их, или использовать их в коммерческих целях (в работе коммерческой организации) в случаях:
** Если проект будет использоваться в любой другой организации, кроме торговой розничной организации. Использование проекта для случаев, когда точка продает только через сеть Интернет, также не допускается.
** Если в розничной организации, использующей проект, зарегистрировано более десяти торговых точек на одном юридическом лице, за исключением юридических лиц, которые получили на это соответствующее разрешение у организации, распространяющей проект. Таким юридическим лицам будут предоставлены другие (коммерческие) исполняемые файлы системы.
** Если десять или более розничных точек используют одну контролирующую организацию или связанную группу организаций, им необходимо получить дополнительное разрешение у организации, распространяющей проект. Таким организациям будут предоставлены другие (коммерческие) исполняемые файлы системы.
** Организациям, производящим внедрение и обслуживание проекта, на более чем десяти торговых точках с целью продвижения своего продукта в эти торговые точки, необходимо получить дополнительное разрешение у организации, распространяющей проект. Таким организациям будут предоставлены другие (коммерческие) исполняемые файлы системы.
* Однако соглашение не запрещает использовать любые части '''исходных текстов проекта''', находящихся на сервере github (или подобном), в коммерческих или других целях, в других системах программного обеспечения или в системе SunFlurry.
* Организация, распространяющая проект, может в любой момент без предварительного оповещения изменить текст лицензионного соглашения, однако:
** Последняя версия исходных текстов проекта, распространяемая на сервере github (или подобном), а также любые исходные тексты, созданные сторонними разработчиками в рамках лицензионного соглашения до момента его изменения, ни при каких условиях не потеряют бесплатный статус.
** Последние версии исполняемых файлов, распространявшихся до момента изменения лицензионного соглашения, ни при каких условиях не потеряют бесплатный статус, эти старые версии можно будет использовать в рамках текста лицензионного соглашения до момента его изменения.
* Проект распространяется без какой-либо гарантии со стороны распространяющей организации ("как есть"). Организация не несет ответственности за возможный ущерб, причиненный программой, ее сбоями, возможностью или невозможностью ее использования (включая убытки и потерю информации).

Если Вы не можете использовать проект, так как деятельность или величина Вашей организация не удовлетворяет условиям лицензионного соглашения, однако у Вас есть интерес к системе или какие-либо коммерческие предложения, вы можете связаться с нами с помощью электронной почты, используя следующий адрес: '''<nowiki>sf@sfsys.ru</nowiki>'''. Мы читаем всю почту, но можем задержаться с ответом из-за высокой загруженности. Если Вы не получили ответ в течение недели, возможно дежурный сотрудник находится в отпуске. Из-за большого количества спама, приходящего на почту, наш почтовый сервер использует спам-фильтры. Если наш сервер отвергает Ваше письмо, попробуйте отослать его с бесплатных почтовых серверов.

==== Возможности проекта розница ====

Бесплатный проект розница состоит серверной части, клиентской части и файлов проекта.

Серверная часть хранит базу данных и обслуживает запросы к ней. Для одного магазина должна быть установлена одна серверная часть, даже если работа с базой данных будет происходить с нескольких машин одновременно. Некоммерческий проект розница использует '''x86''' '''SQLite3''' сервер ([[Общая информация о сервере базы данных#Доступные СУБД и особенности их использования|См. статью]]). Это ограничивает масштабируемость одной базы данных, и слишком большое количество пользователей может замедлить работу в ней. 32-битная версия сервера также накладывает некоторое ограничение на размер базы данных, так как слишком большие базы данных могут работать медленнее из-за невозможности использования буфера запросов больше предела в ~2Гб. Однако для розничных точек это не должно стать проблемой, так как базы данных в них обычно небольшие. Нужно добавить, что сама база данных не имеет никаких искусственных ограничений по размеру (максимальный размер определяется возможностями SQLite3). Для небольших магазинов, серверная часть обычно устанавливается на компьютер с кассовым оборудованием, где клиентская часть выступает как кассовый терминал.

[[Общая информация о консольном и визуальном клиентах|Клиентская часть]] проекта розница использует '''x86''' бинарный файл. Клиентская часть может использоваться как кассовый терминал, так и как учетная система и может быть установлена на любое количество компьютеров для работы с одним сервером магазина. Возможности клиентской части определяются исходными текстами проекта, поэтому, они постоянно дополняются и изменяются. Любой человек, разбирающийся в программировании, может изменить текст проекта и добавить в него новые возможности. На момент написания статьи, проект умеет:

* При использовании проекта, как учетной системы:
** Ведение любого количества юридических лиц и магазинов в одной базе.
** Анализы продаж и закупок, ABC, XYZ-анализы, анализы наценки и прибыли, прогнозирование закупки товаров.
** Система ценообразования и формирования цен, распечатка ценников.
** Ведение бухгалтерского учета, ручные проводки, ведение учета по основным средствам.
*** Книга покупок и книга продаж, книга доходов и расходов, бух. баланс и отчет по прибыли.
** Ведение финансового учета, ведение затрат, затраты по оплате и начислению.
*** Операционный капитал, отчет по прибылям и убыткам, маржинальная прибыль.
** Ведение и учет маркетинга поставщиков (начисление и закрытие скидок и т.д.).
** Ведение и анализы взаиморасчетов с поставщиками, платежная ведомость.
** Ведение кассовых и банковских остатков. Ведение подотчета.
** Ведение складских остатков в разрезе партий, марочный учет ЕГАИС и ГИС МТ.
** Обрезание, объединение и перенос базы данных.
** Обмен между базами данных, возможность выгрузки документов из периферийных баз данных в центральную.
** Система прав отдельных пользователей.
** Возможности обмена с другими информационными базами:
*** При разрелении центральной базы и локальных баз магазинов, возможность использования простого обмена по протоколу Фронтол.
*** Возможно выгрузки и зарузки из баз 1С по проколу EnterpriseData.
*** Возможность использования внутреннего протокола обмена с центральной базой.
* При использовании проекта, как кассового терминала:
** Драйверы для популярных ККМ (Атол, Штрих-М, Вики Принт, другие драйверы будут добавлены позже).
*** Продажа марочного товара ЕГАИС (алкоголь) и ГИС МТ (сигареты, молочная продукция и пр.). Работа с ФФД 1.2.
*** Продажа на несколько касс одновременно (если, к примеру, торговля алкоголем ведется от одного юр. лица, а все остальное продается от другого).
** Приемка поступлений ЕГАИС, автоматическое создание партий, работа с регистром 2, отчеты по сравнению с реальными остатками и прочее. Полный учет ЕГАИС.
*** Доступ к УТМ ЕГАИС через сервер позволяет принимать документы в ЕГАИС, работая с базой через Интернет без необходимости перенаправления соединения с УТМ.
*** Формирование декларации об объемах продаж алкоголя.
** Прием поступлений от поставщиков марочной продукции ГИС МТ.
** Использование концепции "рабочее место" и "магазин", что позволяет настроить оборудование в ККТ магазина нужным образом и исключить проблемы с путаницей между оборудованием и пользователями.
** Возможность выгружать и загружать информацию по протоколу Фронтол (к примеру, если центральная база будет использовать другую учетную систему). Другие способы обмена могут быть созданы Вашими или сторонними IT-специалистами.
** Возможность программировать запреты на продажу алкоголя.
** Вскрывать тару ЕГАИС непосредственно в интерфейсе продавца.
** Блок макетинга покупателей:
*** Использование торговых акций с скидкой на позиции, скидкой от суммы документа, акции типа 2+1, возможность добавления исходного кода для реализации более сложных акций.
*** Работа со скидочными картами, работа с подарочными картами, работа с депозитами.
*** Учет маркетинговых акций и скидок покупателям.
** Удобная и простая самомасштабируемая форма рабочего места продавца.
*** Операции типа: отложить чек, продолжить чек, возврат, аванс, кредит, временная замена прав для выполнения нужной операции и т.д.
*** Возможности подбора товаров в чек, в т.ч. с помощью терминала сбора данных.
*** Быстрое закрытие чека, быстрая работа с комбинированными оплатами.
*** Добавление часто выбираемых товаров в интерфейс рабочего места продавца, частые кнопки могут содержать исходный код для произвольных операций.
*** Возможность перехвата специальным исходным кодом управления в любой момент или при нажатии на стандартные кнопки. Примеры кода для кафе с номерами столов и депозитами.
* Возможности сервера базы данных:
** Автоматическое создание резервных копий базы данных.
* Возможность получения самых свежих обновлений из официального репозитория.

Требования к оборудованию для работы серверной и клиентской части проекта:
* Операционная система: Windows 2000, XP, 7, 8, 10 или 11
* Процессор: 1.1ГГц и выше (также поддерживаются младшие модели Celeron и Atom)
* Оперативная память: 2Гб и выше (4Гб и выше для Windows 10 и 11)
Проект будет работать практически на любом оборудовании. Помните, что если вся Ваша оперативная память используется, работа с компьютером будет замедлена, и это может негативно сказаться на кассовых продажах. Убедитесь, что у Вас достаточно оперативной памяти. Для баз данных, обычного размера, сервер не требует много дополнительной памяти, однако, если база данных будет очень большой (2Гб и более), сервер также будет использовать значительное количество памяти.

В проект также входит специальная версия [[Общая информация и интерфейс Студии|Студии]], программы, которая позволяет изменять исходный код проекта и его визуальные формы, а также, разворачивать эти изменения на существующих торговых точках простым нажатием нескольких клавиш. Студия используется в работе техническими специалистами и обычно не устанавливается в самих магазинах. Данный портал содержит исчерпывающую документацию для начала работы со Студией для изменения исходного кода проекта.

Для пошаговой информации по установке проекта в магазине, смотрите статью '''[[Установка проекта Розница]]'''.

==== Изменения, планируемые в будущем ====

На данный момент не все планируемые возможности проекта реализованы. Изменения в его исходном коде будут загружаться на [https://github.com/sfsys132/project-free-Russian-retail официальную страницу github] и бета-версии всегда доступы в официальном репозитории (см. параграф ниже), их можно будет скачать, и обновить рабочие базы данных магазинов. Среди планируемых изменений и добавлений, можно выделить следующие:
* Особый и более удобный инферфейс для кафе и ресторанов (сейчас есть возможность работы с номерами столов и пр. с помощью перехвата функций из интерфейса кассира).
* Расширение возможностей системы (внешние модули, создание собственных объектов в язывке (пользовательское ООП) и т.д.)
* Дополнительные функции редактора исходных Студии (выделенные уровни блоков текста, переходы к функциям, т.п.)
* Добавление новых драйверов для ККМ, банковских терминалов, т.с.д., электронных весов и дисплеев покупателей
* Работа над исправлением найденных ошибок

==== Официальный репозиторий исходных текстов проекта ====

Ссылка на официальный репозиторий исходных текстов проекта находится в списке серверов при установки Студии из комплекта бесплатного проекта Розница. Официальный репозиторий содержит самые свежие изменения в проекте и самые свежие исполняемые файлы. Изменения можно скачать выборочно при синхронизации с репозиторием из Студии (пункт меню "развертывание" - "развернуть проект" - галочка на репозитории). Пользователи проекта не могут изменить исходные тексты репозитория, им предоставляется доступ только для чтения. Важно понимать, что репозиторий может содержать непроверенные или мало проверенные изменения, скачивание которых в рабочий проект и затем развертывание в рабочие базы, может привести к ошибкам. Вы можете использовать репозиторий на свой страх и риск, в случаях, к примеру, если новое изменение еще не появилось в новом выпуске или на github, однако, оно необходимо. Проверяйте работу магазина после каждого обновления из репозитория!

==== Ссылки для скачивания бинарных файлов проекта ====

Приведенная здесь ссылка содержит текущую версию программы установки. Программа позволяет установить как клиентскую и серверную части, так и систему разработки Студия. Несмотря на то, что исходные файлы проекта в этой программе установки достаточно свежие, вероятно, они не содержат всех недавних изменений, которые доступны на сервере [https://github.com/sfsys132/project-free-Russian-retail github]. Если Вам необходимо обновить исходные тексты до самой свежей версии, Вы можете скачать их в виде архива или с помощью специальных инструментов (типа [https://tortoisegit.org/ tortoisegit]). Для подобной операции могут потребоваться дополнительные знания. Для пошаговой информации по установке проекта в магазине, смотрите статью '''[[Установка проекта Розница]]'''.

Программа установки, а также бинарные файлы проекта не содержат вирусов, однако при скачивании любых исполняемых файлов из Интернета, всегда рекомендуется использовать антивирус со свежими базами обновлений!

[http://{{SERVERNAME}}/download/sf_retail_x86_20260403_install.exe <big>'''Скачать файл установки проекта Розница.'''</big>]

==== Ссылка для скачивания простой демонстрации графических возможностей системы -- tetris.sfo ====

Для простой демонстрации графических возможностей системы был создан внешний объект системы ([[Функции общего назначения#Внешний загружаемый объект|Внешний загружаемый объект]]) '''Tetris'''. Вы можете скачать файл объекта и открыть его в визуальном клиенте. Для работы необходимы установленные драйверы видеокарты и OpenGL не ниже 2.1 (любая современная видеокарта, в т.ч. встроенные). Внешний объект также содержит исходный текст, его можно редактировать и изменять по желанию, если открыть в [[Общая информация и интерфейс Студии|Студии]]. Объект в свободном распространении. Копия, данная на скачивание здесь, возможно, будет в дальнейшем немного изменяться, чтобы улучшить читаемость. Ниже дана ссылка на скачивание:

[http://{{SERVERNAME}}/download/tetris.sfo '''Скачать демонстрацию графического объекта Tetris.''']

====Контактная информация====

Вы можете связаться с нами, используя следующий почтовый адрес: <big>'''<nowiki>sf@sfsys.ru</nowiki>'''</big>. Нам интересно будет услышать любые Ваши предложения. Мы читаем всю почту, но можем задержаться с ответом из-за высокой загруженности. Если Вы не получили ответ в течение недели, возможно дежурный сотрудник находится в отпуске. Из-за большого количества спама, приходящего на почту, наш почтовый сервер использует спам-фильтры. Если наш сервер отвергает Ваше письмо, попробуйте отослать его с бесплатных почтовых серверов.

Электронная таблица SFT

2026-04-01T10:01:41Z

Admin: 1 revision imported

{{infobox object
|image=table.png
|visual=[[Студия/Электронная таблица SFT|Таблица SFT]]
|object=Table
|status=2
|create=[[Table.Create|Create]]}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]}}
Объект '''электронная таблица SFT''' дает возможность создания, заполнения, вывода на экран и принтер, а также чтения данных и проведения других операций с электронными таблицами SFT. Обычно объект используется для создания и вывода на экран отчетов и печатных форм документов. В таких случаях, алгоритм работы с объектом следующий:
* Создается новый объект и задается таблица-шаблон (по умолчанию файл шаблона '''Table''' должен находиться в той же папке (объекте), где находится модуль, создающий объект, однако, путь и имя таблицы-шаблона можно задать с помощью функции [[Table.SetSourceName|SetSourceName]]). Создавать таблицу с нуля, программно изменяя шрифт каждой ячейки, тип границ и объединения, является очень сложной и трудоемкой задачей, поэтому, такой подход на практике не применяется, а используется таблица-шаблон (или несколько таких таблиц). Шаблон представляет собой обычную таблицу, при создании отчета или печатной формы документа, заданные части шаблона будут копироваться в новую создаваемую таблицу. При копировании частей шаблона, система автоматически заполняет ячейки с формулами результатом их выполнения (такие ячейки в таблице-шаблоне имеют галочку "Текст представляет собой выражения для вычисления", см. [[Студия/Редактор электронных таблиц|Редактор электронных таблиц]]), это дает возможность предусмотреть в шаблоне ячейки с сальдо, наименованиями и реквизитами юридических лиц и прочим, в зависимости от типа выводимой формы. Для удобства написания программ, нужные куски таблицы-шаблона отмечаются на этапе редактирования, им присваиваются свои наименования, по которым программа может обращаться к ним, чтобы из этих кусков сконструировать таблицу-результат.
* Выполняется запрос или требуемые данные подготавливаются другим путем.
* Происходит обход по результату запроса или другим данным и последовательное добавление нужных частей таблицы-шаблона в таблицу результат с заполнением ячеек данными, полученными в цикле обхода (Для копирования частей таблицы-шаблона можно использовать функции [[Table.CopyByX|CopyByX]], [[Table.CopyByY|CopyByY]], [[Table.CopyTitles|CopyTitles]], [[Table.Area.CopyTo|CopyTo]]).
* Созданная новая электронная таблица выводится на экран или принтер.
При программной работе с объектом нужно различать четыре типа объектов: сама электронная таблица SFT, объект область таблицы (''Area'') (получаемая с помощью вызова функций типа [[Table.Area|Area]] и необходимая для проведения прямого изменения в ячейках области), объект свойств таблицы (''Options'') (включающий множество подобъектов, к примеру, ''выделение'' или ''свойства печати'') и объект визуальных элементов (объектов) таблицы (''Objects''). Все объекты связаны с электронной таблицей SFT, которая не будет удалена из памяти до тех пор, пока останется по крайней мере один объект, ссылающийся на нее. Ячейки таблицы могут содержать объекты языка любого вида, поэтому кроме внешних ссылок на таблицу, иногда может возникнуть ситуация, когда внутри какой-либо ячейки (или визуального элемента) хранится ссылка на самую же таблицу, это бывает, к примеру, когда в визуальной кнопке таблицы для обновления результата отчета, хранится список с данными, связанными с этим отчетом, в том числе сама таблица. Для таблиц, которые хранят ссылки на самих себя требуется указывать количество таких ссылок с помощью атрибута [[Table.SelfReferenceCount|SelfReferenceCount]], иначе после удаления последнего объекта, ссылающегося на таблицу, таблица останется в памяти (см. [[Объекты#Ссылки на самого себя|Ссылки на самого себя]]).
Основные свойства ячейки таблицы перечислены ниже:
* Таблица может иметь практически неограниченное количество столбцов и строк (до 2 млрд.), сдвигая видимое поле, пользователь может увидеть любую ячейку таблицы. Память для хранения ячеек выделяется только для определенного количества столбцов и строк таблицы, этот диапазон задает высоту и ширину таблицы. При изменении текста или других свойств ячейки вне диапазона этих строк и столбцов, выделенный диапазон автоматически расширяется.
* Ячейка содержит текст в ANSI или UTF-16 кодировках, либо текст шаблона, представляющего собой программу на встроенном языке, программа будет исполнена и результат будет записан, как текст ячейки в момент копирования частей таблицы-шаблона в таблицу результат.
* Ячейка содержит произвольный объект встроенного языка, использующийся как значение ячейки при клике по ячейке или редактировании оной. Вместо объекта языка в ячейке может находиться текст шаблона, представляющего собой программу на встроенном языке, программа будет исполнена и результат будет записан, как значение ячейки в момент копирования частей таблицы-шаблона в таблицу результат.
* Текст ячейки может иметь стандартные свойства форматирования: шрифт, выделение, цвет фона, цвет текста и рамки и пр., либо для ячейки может быть задан шаблон цвета (color template). В последнем случае, пользователи смогут выбирать другую палитру цветов, по своему желанию, поэтому, использование шаблонов цвета предпочтительнее при формировании результатов отчетов.
* Ячейки могут быть объединены между собой в группы ячеек. Текст в такой группе будет использовать все пространство группы и будет получен из верхней левой ячейки группы.
* Ячейки имеют разнообразные свойства переноса текста, выравнивания по горизонтали и вертикали, отступов по горизонтали и вертикали, угол направления текста и пр.
* Каждая ячейка имеет четыре границы вокруг себя, каждая из границ может иметь свой рисунок и цвет. Из-за использования шаблонов для создания таблиц-результата, двух границ для каждой ячейки недостаточно.
* Столбцы и строки таблицы имеют дополнительное свойство "автоматическое расширение", обычно номера таких строк или столбцов выделены визуально для удобства создания таблиц-шаблонов. Строки или столбцы со свойством "автоматическое расширение" будут автоматически изменять размеры, в зависимости от текста, помещенного внутрь их ячеек.
* При печати больших таблиц, происходит их распределение на несколько листов, иногда важно, чтобы определенные блоки текста (строки или столбцы) не разделялись и шли всегда вместе (к примеру, блок с подписями и печатями), для этого предусмотрены блоки строк или столбцов без разделения.
Основные свойства визуальных элементов (объектов) таблицы перечислены ниже:
* Объекты могут быть добавлены в любое место таблицы и могут представлять собой не только текстовые поля, но и рисунки, OLE-объекты и пр.
* Объект содержит текст в ANSI или UTF-16 кодировках, либо текст шаблона, представляющего собой программу на встроенном языке. Для шаблонов, программа будет исполнена и результат будет записан, как текст ячейки в момент копирования частей таблицы-шаблона в таблицу результат.
* Объект содержит произвольный объект встроенного языка, использующийся как значение ячейки при клике по ячейке или редактировании оной. Вместо объекта языка в ячейке может находиться текст шаблона, представляющего собой программу на встроенном языке, программа будет исполнена и результат будет записан, как значение ячейки в момент копирования частей таблицы-шаблона в таблицу результат.
* Текст объекта может иметь стандартные свойства форматирования: шрифт, выделение, цвет фона, цвет текста и рамки и пр., либо для ячейки может быть задан шаблон цвета (color template). В последнем случае, пользователи смогут выбирать другую палитру цветов, по своему желанию, поэтому, использование шаблонов цвета предпочтительнее при формировании результатов отчетов.
* Объекты имеют разнообразные свойства переноса текста, выравнивания по горизонтали и вертикали, отступов по горизонтали и вертикали, угол направления текста и пр.
* Каждый объект имеет четыре границы вокруг себя, каждая из границ может иметь свой рисунок и цвет.
* Объект может не выводиться на печать, если это необходимо
* Объект может иметь наименование, по которому можно обратиться к нему из текста программы
* Положение и размеры объекта могут быть привязаны к абсолютной координате внутри таблицы или к определенной ячейке таблицы. Таким образом можно создать объекты, которые не будут перемещаться или/и изменять размеры при изменении размеров ячеек таблицы, либо будут привязаны к определенным ячейкам.

Не стоит путать электронные таблицы SFT (наименование интерфейса объекта '''Table''') и [[Таблица|таблицы значений]] (наименование интерфейса объекта '''Tab'''), это совершенно разные объекты.

== Пример создания электронной таблицы с помощью таблицы-шаблона и вывода ее на экран/печать ==
Простой пример выполнения запроса и вывода информации в виде отчета с произвольным количеством горизонтальных столбиков.
<pre>
//Переменные, которые были подготовлены заранее:
//спНоменклатура -- список номенклатурных позиций, выводящихся в отчет (горизонтальные строки отчета с папками)
//спТипыЦен -- список типов цен, которые будут следовать по горизонтали столбиками
//ДатаФормирования -- дата нахождения цены

//Выполняем запрос для получения горизонтального разреза
ТЗ:="зН:=Ref.Номенклатура;
|зСтатус:=Ref.Номенклатура.@STATUS;Condition(зСтатус=0);
|зПапка:=Ref.Номенклатура.@ISFOLDER;
|Condition(зПапка=0);
|Condition(зН IN спНоменклатура);
|Group зН with folders;";

З:=Query.Create();
З.Execute(ТЗ);

Т:=Table.Create();
Т.SetSourceName("Отчет");
//Здесь и далее переменные с префиксом "п" используются в таблице-шаблоне "Отчет" в соответствующих ячейках,
// при копировании куска таблицы с помощью CopyByX, ячейки автоматически заполняются значениями нужных переменных.
пЗагол:="Отчет по ценам номенклатуры";

//Копирование из таблицы-шаблона будет осуществляться слева направо и затем сверху вниз
//Столбец "h1" в таблице-шаблоне содержит столбец с наименованием номенклатурной позиции, левый отступ, порядковый номер и пр.
//Столбец "h2" -- цена текущей позиции по типу цен из спТипыЦен
//Столбец "h3" -- завершает таблицу (правая граница)
//Строка "v1" таблицы-шаблона содержит заголовок отчета с заголовками столбцов
//Строка "v2" таблицы-шаблона содержит одну строку отчета
//Строка "v3" таблицы-шаблона содержит одну строку папки отчета, цены для папок не выводятся
//Строка "v4" таблицы-шаблона завершает отчет снизу (нижняя граница)

//Первый блок добавляется "с начала строки"
Т.CopyByX("v1|h1",1);
For i:=1 to спТипыЦен.Size() Do
пТипЦен:=спТипыЦен.Get(i);
//Последующие блоки добавляются слева направо без перевода на другую строку, пТипЦен выводится в заголовки столбцов
Т.CopyByX("v1|h2");
EndDo;
//Окончание вывода блока заголовка таблицы
Т.CopyByX("v1|h3");
//Фиксирование заголовка, чтобы он всегда был на экране при перемещении курсора по таблице
Т.Options.FixedLine:=Т.Height();

пКолВо:=0;
While З.Next(1) Do
//Переменные используются в столбце "h1"
пН:=З.зН;
пКод:=пН.Code;

If пН.IsFolder() Then
//Вывод строки с папкой
Т.CopyByX("v3|h1",1);
For i:=1 to спТипыЦен.Size() Do
Т.CopyByX("v3|h2");
EndDo;
Т.CopyByX("v3|h3");
пКолВо:=пКолВо+1;
Else
//Вывод обычной строки
Т.CopyByX("v2|h1",1);
For i:=1 to спТипыЦен.Size() Do
пЦ:=глНайтиЦену(З.зН,спТипыЦен.Get(i),ДатаФормирования);
Т.CopyByX("v2|h2");
EndDo;
Т.CopyByX("v2|h3");
EndIf;

//Вывод информации о состоянии формирования отчета
пКолВо:=пКолВо+1;
//Этот текст выводится в строку состояния
Form.StatusText(""+пКолВо+" из "+З.ResultTable.Size());
//Этот текст выводится в виде индикатора выполнения, как подсказка при наведении курсора мыши на кнопку задачи отчета
Form.UpdateProgress(пКолВо,З.ResultTable.Size());
EndDo;
//Выведем нижнюю границу отчета
Т.CopyByX("v4|h1",1);
For i:=1 to спТипыЦен.Size() Do
Т.CopyByX("v4|h2");
EndDo;
Т.CopyByX("v4|h3");

//Изменим параметры печати
Т.Printing.Orientation:=1;
Т.Printing.ScaleMode:=1;
//Режим просмотра для удобства пользователя
Т.EditorMode:=1;
//Выводим на экран или принтер?
If флВывестиСразуНаПринтер Then
Т.Printing.Printer:=тПринтер;
Т.Print();
Else
Т.Show(пЗагол);
EndIf;
</pre>

== Основные атрибуты и функции ==
Данный раздел содержит основные функции, которые используются совместно с объектом электронной таблицы.

{{function header}}
{{function entry
|name=[[Table.Create|Create]]
|form={{Grey|Table.}}'''Create'''():''<Новый объект электронной таблицы (TABLE)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый объект электронной таблицы.
}}
{{function entry
|name=[[Table.CurLine|CurLine]]
|form={{Grey|Table.}}'''CurLine''':''<Строка визуального курсора таблицы (INT)>''
|type=0
|status=2
|visual=1
|description=Получить или изменить текущую строку курсора таблицы. Курсор таблицы только косвенно связан с выделенными ячейками таблицы и не зависит от текущего выделения, для получения информации по выделению в таблице, используйте атрибут [[Table.Selection|Selection]]. Нумерация строк начинается с единицы.
}}
{{function entry
|name=[[Table.CurColumn|CurColumn]], '''CurCol'''
|form={{Grey|Table.}}'''CurColumn''':''<Столбец визуального курсора таблицы (INT)>''
|type=0
|status=2
|visual=1
|description=Получить или изменить текущий столбец курсора таблицы. Курсор таблицы только косвенно связан с выделенными ячейками таблицы и не зависит от текущего выделения, для получения информации по выделению в таблице, используйте атрибут [[Table.Selection|Selection]]. Нумерация столбцов начинается с единицы.
}}
{{function entry
|name=[[Table.CurPutX|CurPutX]]
|form={{Grey|Table.}}'''CurPutX''':''<Столбец курсора добавления областей к таблице (INT)>''
|type=0
|status=2
|visual=0
|description=Получить или изменить текущий столбец курсора добавления областей к таблице. Курсор добавления областей используется в момент вызова функций [[Table.CopyByX|CopyByX]] и [[Table.CopyByY|CopyByY]] и определяет место добавления следующей области из таблицы-шаблона. Нумерация столбцов начинается с единицы.
}}
{{function entry
|name=[[Table.CurPutY|CurPutY]]
|form={{Grey|Table.}}'''CurPutY''':''<Строка курсора добавления областей к таблице (INT)>''
|type=0
|status=2
|visual=0
|description=Получить или изменить текущую строку курсора добавления областей к таблице. Курсор добавления областей используется в момент вызова функций [[Table.CopyByX|CopyByX]] и [[Table.CopyByY|CopyByY]] и определяет место добавления следующей области из таблицы-шаблона. Нумерация строк начинается с единицы.
}}
{{function entry
|name=[[Table.EditorMode|EditorMode]]
|form={{Grey|Table.}}'''EditorMode''':''<Режим редактирования таблицы (INT)>''
|type=0
|status=2
|visual=1
|description=Получить или изменить режим редактирования таблицы.
}}
{{function entry
|name=[[Table.Restrict|Restrict]]
|form={{Grey|Table.}}'''Restrict''':''<Режимы запрета работы с таблицей (INT)>''
|type=0
|status=2
|visual=1
|description=Получить или изменить режимы запрета работы с таблицей.
}}
{{function entry
|name=[[Table.Scale|Scale]]
|form={{Grey|Table.}}'''Scale''':''<Масштаб отображения таблицы (INT)>''
|type=0
|status=2
|visual=1
|description=Получить или изменить масштаб отображения таблицы на экране. Масштаб по умолчанию равен 100.
}}
{{function entry
|name=[[Table.SelectionMode|SelectionMode]]
|form={{Grey|Table.}}'''SelectionMode''':''<Тип текущего выделения ячеек (INT)>''
|type=0
|status=2
|visual=1
|description=Получить тип текущего выделения ячеек или визуальных элементов таблицы.
}}
{{function entry
|name=[[Table.SelfReferenceCount|SelfReferenceCount]]
|form={{Grey|Table.}}'''SelfReferenceCount''':''<Количество ссылок на себя в объектах таблицы (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут позволяет получить или изменить количество ссылок на себя, хранящихся в объектах таблицы. Если не установить это число корректно, таблица не может быть удалена из памяти, так как количество ссылок на нее останется больше нуля, когда она будет удалена из ссылающейся последней переменной, и это приведет к утечке памяти.
}}
{{function entry
|name=[[Table.AttachedModule|AttachedModule]]
|form={{Grey|Table.}}'''AttachedModule''':''<Связать текущий модуль с событиями таблицы (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут позволяет получить или изменить свойство связи текущего модуля со свободной таблицей. Если модуль будет закрыт позже, а таблица останется открытой, события таблиц типа [[OnDoubleClick]] будут вызываться сначала в этом связанном модуле, а уже потом в модуле, под которым работает таблица, или в глобальном модуле. Это удобно для отчетов, которые производят определенные действия при работе со свободными таблицами, получаемыми в результате их выполнения. Таким образом можно избежать утери этой функциональности, если обработка отчета будет закрыта, но нужно понимать, что вызванное таким образом событие, возможно будет работать со стеком и переменными другого модуля. Также стоит заметить, что функция [[ModuleTag]] понимает эту связь и будет отдавать переменную, привязанную именно к модулю таблицы.
}}
{{function entry
|name=[[Table.PrintSettingsChanged|PrintSettingsChanged]]
|form={{Grey|Table.}}'''PrintSettingsChanged'''():''<Были изменены установки печати таблицы (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает 1, если были изменены любые установки, связанные с печатью таблицы (кроме названия принтера). После выполнения печати этот атрибут автоматически сбрасывается. Атрибут может использоваться в универсальных обработчиках печати, а также для сохранения индивидуальных изменений печатных форм.
}}
{{function entry
|name=[[Table.ResetCursor|ResetCursor]]
|form={{Grey|Table.}}'''ResetCursor'''()
|type=1
|status=2
|visual=1
|description=Функция сдвигает видимое пространство таблицы таким образом, чтобы ячейка, в которой находится визуальный курсор, была видна на экране, если визуальный курсор уже виден на экране, функция не производит никаких изменений. Положение курсора не изменяется.
}}
{{function entry
|name=[[Table.SetCursor|SetCursor]]
|form={{Grey|Table.}}'''SetCursor'''(''<Столбец курсора (INT)>'',''<Строка курсора (INT)>'')
|type=1
|status=2
|visual=1
|description=Функция перемещает визуальный курсор в требуемую ячейку таблицы. При этом сдвига видимого пространства таблицы не происходит и курсор может оказаться за пределами видимости.
}}
{{function entry
|name=[[Table.AddObject|AddObject]]
|form={{Grey|Table.}}'''AddObject'''(''<Тип визуального объекта (INT)>''{{Optional|,<Наименование объекта (STRING)>,<Источник объекта>,<Тип координат объекта (INT)>{{Default|{{Eq}}0}},<Координаты объекта (STRING)>}})
|type=1
|status=2
|visual=0
|description=Функция добавляет новый объект в таблицу. Для объекта указывается тип, координаты, наименование. Если объект имеет тип OLE или картинка, также задается дополнительный параметр "источник объекта".
}}
{{function entry
|name=[[Table.Lock|Lock]]
|form={{Grey|Table.}}'''Lock'''()
|type=1
|status=2
|visual=1
|description=Функция блокирует отображения изменений в таблице до вызова функции [[Table.Unlock|Unlock]]. Функция может использоваться перед большим количеством обновлений или заполнении таблицы для получения значительного ускорения операции. Функцию не имеет смысла вызывать для таблиц, которые (еще) не были выведены на экран, так как такие таблицы не обновляются визуально.
}}
{{function entry
|name=[[Table.Unlock|Unlock]]
|form={{Grey|Table.}}'''Unlock'''()
|type=1
|status=2
|visual=1
|description=Функция снимает блокировку отображения изменений в таблице, установленную функцией [[Table.Lock|Lock]], и вызывает полное визуальное обновление таблицы.
}}
{{function entry
|name=[[Table.Update|Update]]
|form={{Grey|Table.}}'''Update'''()
|type=1
|status=2
|visual=1
|description=Функция вызывает полное визуальное обновление таблицы.
}}
{{function entry
|name=[[Table.Size|Size]], '''Lines''', '''Height'''
|form={{Grey|Table.}}'''Size'''({{Optional|<Новое количество выделенных строк в таблице (INT)>}}):''<Количество выделенных строк в таблице (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает или изменяет высоту таблицы (количество строк в таблице, где производились какие-либо изменения, либо строки были скопированы из таблицы-шаблона и т.п.). При уменьшении количества строк, удаление будет происходить с конца таблицы.
}}
{{function entry
|name=[[Table.SizeC|SizeC]], '''Columns''', '''Width'''
|form={{Grey|Table.}}'''SizeC'''({{Optional|<Новое количество выделенных столбцов в таблице (INT)>}}):''<Количество выделенных столбцов в таблице (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает или изменяет ширину таблицы (количество столбцов в таблице, где производились какие-либо изменения, либо столбцы были скопированы из таблицы-шаблона и т.п.). При уменьшении количества столбцов, удаление будет происходить с конца таблицы.
}}
{{function entry
|name=[[Table.InsertColumns|InsertColumns]]
|form={{Grey|Table.}}'''InsertColumns'''(''<Начиная со столбца (INT)>''{{Optional|,<Количество столбцов (INT)>{{Default|{{Eq}}1}},<Ширина вставляемых столбцов (INT)>,<Автоматическая ширина столбцов (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=0
|visual=0
|description=Функция вставляет требуемое количество столбцов начиная с требуемой позиции. Вставка столбцов может вызвать разъединение областей ячеек, если области включают позицию добавления.
}}
{{function entry
|name=[[Table.InsertLines|InsertLines]]
|form={{Grey|Table.}}'''InsertLines'''(''<Начиная со строки (INT)>''{{Optional|,<Количество строк (INT)>{{Default|{{Eq}}1}},<Высота вставляемых строк (INT)>,<Автоматическая высота строк (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=0
|visual=0
|description=Функция вставляет требуемое количество строк начиная с требуемой позиции. Вставка строк может вызвать разъединение областей ячеек, если области включают позицию добавления.
}}
{{function entry
|name=[[Table.RemoveColumns|RemoveColumns]]
|form={{Grey|Table.}}'''RemoveColumns'''(''<Начиная со столбца (INT)>''{{Optional|,<Количество столбцов (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=0
|visual=0
|description=Функция удаляет требуемое количество столбцов начиная с требуемой позиции. Удаление столбцов может вызвать разъединение областей ячеек, если области включают удаляемые столбцы.
}}
{{function entry
|name=[[Table.RemoveLines|RemoveLines]]
|form={{Grey|Table.}}'''RemoveLines'''(''<Начиная со строки (INT)>''{{Optional|,<Количество строк (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=0
|visual=0
|description=Функция удаляет требуемое количество строк начиная с требуемой позиции. Удаление строк может вызвать разъединение областей ячеек, если области включают удаляемые строки.
}}
{{function entry
|name=[[Table.Copy|Copy]]
|form={{Grey|Table.}}'''Copy'''():''<Копия таблицы (TABLE)>''
|type=1
|status=2
|visual=0
|description=Функция создает полную копию таблицы в памяти.
}}
{{function entry
|name=[[Table.Clear|Clear]]
|form={{Grey|Table.}}'''Clear'''()
|type=1
|status=2
|visual=0
|description=Функция удаляет все столбцы и ячейки и объекты из таблицы и устанавливает все свойства таблицы по умолчанию.
}}
{{function entry
|name=[[Table.Find|Find]]
|form={{Grey|Table.}}'''Find'''(''<Текст для поиска (STRING)>''{{Optional|,<Установки поиска (INT)>{{Default|{{Eq}}0}},<Область поиска (STRING)>,<Переместить курсор на найденную ячейку (INT)>{{Default|{{Eq}}0}}}}):''<Найденная ячейка (STRING)>''
|type=1
|status=0
|visual=0
|description=Функция производит поиск строки или части строки в тексте ячеек указанной области таблицы (или во всей таблице), руководствуясь заданными правилами. Если ячейка найдена, функция возвращает ее координату в виде строки <code>"<Столбец>:<Строка>"</code> (пример ''"12:100"'') и перемещает курсор в найденную ячейку, если это необходимо, если ячейка не найдена, функция возвращает пустую строку.
}}
{{function entry
|name=[[Table.FindByValue|FindByValue]]
|form={{Grey|Table.}}'''FindByValue'''(''<Значение для поиска>''{{Optional|,<Установки поиска (INT)>{{Default|{{Eq}}0}},<Область поиска (STRING)>,<Переместить курсор на найденную ячейку (INT)>{{Default|{{Eq}}0}}}}):''<Найденная ячейка (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск строки или части строки в значениях ячеек указанной области таблицы (или во всей таблице), руководствуясь заданными правилами. Если ячейка найдена, функция возвращает ее координату в виде строки <code>"<Столбец>:<Строка>"</code> (пример ''"12:100"'') и перемещает курсор в найденную ячейку, если это необходимо, если ячейка не найдена, функция возвращает пустую строку.
}}
{{function entry
|name=[[Table.Show|Show]]
|form={{Grey|Table.}}'''Show'''({{Optional|<Заголовок формы с таблицей (STRING)>,<Наименования файла по умолчанию при сохранении таблицы (STRING)>,<Выводить окно на передний план (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=1
|description=Функция выводит таблицу на экран в виде самостоятельной формы, подчиненной текущей форме. Окно имеет требуемый заголовок, при сохранении таблицы в виде файла, по умолчанию используется имя файла, которое можно задать в аргументе этой функции.
}}
{{function entry
|name=[[Table.ShowOnParent|ShowOnParent]]
|form={{Grey|Table.}}'''ShowOnParent'''({{Optional|<Заголовок формы с таблицей (STRING)>,<Наименования файла по умолчанию при сохранении таблицы (STRING)>,<Выводить окно на передний план (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=1
|description=Функция выводит таблицу на экран в виде самостоятельной формы, подчиненной верхней родительской форме. Окно имеет требуемый заголовок, при сохранении таблицы в виде файла, по умолчанию используется имя файла, которое можно задать в аргументе этой функции. Если таблица формируется из потока, модуля или функции, не отображаемых на экране в виде формы, либо текущая форма вызывает другую, с тем, чтобы последняя вывела таблицу на экран и закрылась после вывода, эта функция может закрепить выведенную таблицу за верхней родительской формой, вместо текущей, это позволит избежать ситуации запрета исполнения родительской формы до тех пор, пока не будут закрыты все печатные формы, созданные подчиненной. См. также [[Форма]].
}}
{{function entry
|name=[[Table.Hide|Hide]]
|form={{Grey|Table.}}'''Hide'''()
|type=1
|status=0
|visual=1
|description=Функция позволяет закрыть открытую ранее форму таблицы и сделать таблицу невизуальной.
}}
{{function entry
|name=[[Table.HasWindow|HasWindow]]
|form={{Grey|Table.}}'''HasWindow'''():''<Режим вывода таблицы на экран (INT)>''
|type=1
|status=0
|visual=1
|description=Функция возвращает 0, если таблица не выведена на экран, 1 -- если она выведена, как самостоятельная форма, 2 -- если она является частью элемента формы.
}}
{{function entry
|name=[[Table.NavigationState|NavigationState]]
|form={{Grey|Table.}}'''NavigationState'''({{Optional|<Новое состояние навигации (STRING)>}}):''<Текущее состояние навигации (STRING)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает или/и изменяет состояние навигации в таблице. В это понятие включается: первая видимая верхняя левая ячейка, количество закрепленных строк и столбцов, положение курсора в таблице. Сохранение и восстановление состояния, к примеру, удобно использовать при обновлении отчета, чтобы после обновления вернуть курсор в ячейку, в которой он находился до обновления.
}}
{{function entry
|name=[[Table.ShowPreview|ShowPreview]]
|form={{Grey|Table.}}'''ShowPreview'''()
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный диалог предварительного просмотра перед печатью.
}}
{{function entry
|name=[[Table.ShowPrintProperties|ShowPrintProperties]]
|form={{Grey|Table.}}'''ShowPrintProperties'''()
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный диалог установок печати таблицы.
}}
{{function entry
|name=[[Table.RenderToPicture|RenderToPicture]]
|form={{Grey|Table.}}'''RenderToPicture'''(''<Список с настройками для создания рисунков (LIST)>''):''<Картинки в формате BMP (LIST)>''
|type=1
|status=2
|visual=0
|description=Функция подготавливает печать таблицы на принтер (деление на страницы, колонтитулы и пр.), однако, выводит информацию в виде картинок в формате BMP вместо печати. Аргумент задает установки для создания картинок, такие как ширина и высота каждой картинки, глубина ее цвета, дипазон страниц для вывода и пр.
}}
{{function entry
|name=[[Table.Print|Print]]
|form={{Grey|Table.}}'''Print'''({{Optional|<Показать стандартный диалог печати до ее осуществления (INT)>{{Default|{{Eq}}0}},<Наименование задания на принтере (STRING)>,<Режим диалога отмены печати (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция производит печать на принтер, с выводом стандартного диалога печати, если это необходимо. После деления данных на страницы при печати, функция изменяет текст колонтитулов созданных страниц, подставляя вместо выражения <code>#P</code> номер соответствующей страницы, а вместо <code>#Q</code> общее количество страниц при печати.
}}
{{function entry
|name=[[Table.CreatePageIndex|CreatePageIndex]]
|form={{Grey|Table.}}'''CreatePageIndex'''({{Optional|<Максимальное время ожидания освобождения принтера (INT)>{{Default|{{Eq}}5000}}}}):''<Список размеров страниц (LIST)>''
|type=1
|status=2
|visual=0
|description=Функция создает или обновляет список страниц, которые будут выведены на печать, если текущие установки таблицы не изменятся. '''Внимание:''' функция может выполняться достаточно длительное время, из-за того, что установки печати записываются в свойства принтера перед подсчетом, кроме того, функция пересчитывает все параметры ячеек с изменяемыми размерами, поэтому, чем больше таблица по размеру, тем медленнее работает эта функция. Если принтер занят в данный момент печатью, функция также ожидает ее окончания, максимальное время этого ожидания задается в первом аргументе в миллисекундах.
}}
{{function entry
|name=[[Table.Load|Load]]
|form={{Grey|Table.}}'''Load'''(''<Наименование файла (STRING)>''{{Optional|,<Формат (INT,STRING)>,<Индекс или наименование листа (INT,STRING)>}}):''<Наименование загруженного листа или список с листами (STRING,LIST)>''
|type=1
|status=2
|visual=0
|description=Функция производит загрузку текущей таблицы из файла в указанном формате, предыдущие данные, находившиеся в таблице, будут утеряны.
}}
{{function entry
|name=[[Table.Save|Save]]
|form={{Grey|Table.}}'''Save'''(''<Наименование файла (STRING)>''{{Optional|,<Формат (INT,STRING)>,<Список таблиц для сохранения в листы книги (LIST)>}})
|type=1
|status=2
|visual=0
|description=Функция производит сохранение текущей таблицы в файл в указанном формате.
}}
{{function entry
|name=[[Table.LoadFromBuffer|LoadFromBuffer]]
|form={{Grey|Table.}}'''LoadFromBuffer'''(''<Объект буфера или строка (BUFFER,STRING)>''{{Optional|,<Начальная позиция буфера (INT)>{{Default|{{Eq}}0}},<Размер таблицы в буфере (INT)>,<Формат (INT,STRING)>,<Индекс или наименование листа (INT,STRING)>}}):''<Наименование загруженного листа или список с листами (STRING,LIST)>''
|type=1
|status=2
|visual=0
|description=Функция производит загрузку текущей таблицы из буфера в указанном формате, предыдущие данные, находившиеся в таблице, будут утеряны.
}}
{{function entry
|name=[[Table.SaveToBuffer|SaveToBuffer]]
|form={{Grey|Table.}}'''SaveToBuffer'''(''<Объект буфера (BUFFER)>''{{Optional|,<Начальная позиция буфера (INT)>{{Default|{{Eq}}0}},<Формат (INT,STRING)>{{Default|{{Eq}}0}},<Установки (INT)>{{Default|{{Eq}}0}},<Список таблиц для сохранения в листы книги (LIST)>}}):''<Размер в байтах, добавленный в буфер (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит сохранение текущей таблицы в буфер в указанном формате с указанными установками.
}}
{{function entry
|name=[[Table.SetSourceName|SetSourceName]]
|form={{Grey|Table.}}'''SetSourceName'''(''<Наименование таблицы-шаблона (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция задает новое наименование (и путь, если необходимо) таблицы-шаблона из которого функции, типа [[Table.CopyByX|CopyByX]] будут копировать информацию в текущую таблицу. Имя таблицы задается без расширения. Функция не проверяет существование таблицы с заданным именем, таблица будет загружена в момент, когда будет производиться копирование из нее.
}}
{{function entry
|name=[[Table.GetSourceName|GetSourceName]]
|form={{Grey|Table.}}'''GetSourceName'''():''<Наименование таблицы-шаблона (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает текущее наименование таблицы-шаблона из которого функции, типа [[Table.CopyByX|CopyByX]] будут копировать информацию в текущую таблицу.
}}
{{function entry
|name=[[Table.SetSource|SetSource]]
|form={{Grey|Table.}}'''SetSource'''(''<Таблица-шаблон (TABLE)>'')
|type=1
|status=2
|visual=0
|description=Функция задает таблицу-шаблон из которой функции, типа [[Table.CopyByX|CopyByX]] будут копировать информацию в текущую таблицу.
}}
{{function entry
|name=[[Table.Source|Source]]
|form={{Grey|Table.}}'''Source'''():''<Таблица-шаблон (TABLE)>''
|type=1
|status=2
|visual=0
|description=Функция получает текущую таблицу-шаблон. Функция возвращает значение типа ''таблица SFT'' только в случае, когда таблица уже загружена (т.е., работа с ней уже велась). Если таблица не была загружена, функция возвращает пустое значение.
}}
{{function entry
|name=[[Table.CopyTitles|CopyTitles]]
|form={{Grey|Table.}}'''CopyTitles'''()
|type=1
|status=2
|visual=0
|description=Функция выполняет копирование колонтитулов из таблицы-шаблона в текущую таблицу. В момент копирования тексты колонтитулов, являющиеся шаблонами, будут превращены в результаты их вычисления.
}}
{{function entry
|name=[[Table.CopyByX|CopyByX]]
|form={{Grey|Table.}}'''CopyByX'''(''<Указание на область таблицы-шаблона (STRING)>''{{Optional|,<Перейти на новую строку до добавления области (INT)>{{Default|{{Eq}}0}},<Не производить изменения размеров столбцов или строк (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция выполняет копирование указанной области ячеек и объектов, находящихся внутри этой области из таблицы-шаблона в текущую таблицу, начиная с ячейки, заданной атрибутами [[Table.CurPutX|CurPutX]] и [[Table.CurPutY|CurPutY]]. В момент копирования тексты и значения ячеек и объектов, являющиеся шаблонами, будут превращены в результаты их вычисления. Если третий аргумент равен 1, до начала копирования, функция переводит курсор копирования в левый столбик и производит сдвиг курсора по вертикали (размер сдвига по вертикали определяется высотой копируемой области). После окончания копирования функция переводит курсор копирования вправо на ширину области копирования. Если четвертый аргумент равен 1, функция не будет изменять размеры строк или столбцов в соответствии с размерами строк и столбцов копируемой области, однако, при копировании текста в ячейки, автоматически рассчитываемые размеры строк или столбцов по-прежнему будут изменены, если это необходимо. После копирования любого визуального объекта, функция вызывает событие [[OnFinishCopyObject]], если оно существует в текущем или глобальном модуле.
}}
{{function entry
|name=[[Table.CopyByY|CopyByY]]
|form={{Grey|Table.}}'''CopyByY'''(''<Указание на область таблицы-шаблона (STRING)>''{{Optional|,<Перейти на новый столбец до добавления области (INT)>{{Default|{{Eq}}0}},<Не производить изменения размеров столбцов или строк (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция выполняет копирование указанной области ячеек и объектов, находящихся внутри этой области из таблицы-шаблона в текущую таблицу, начиная с ячейки, заданной атрибутами [[Table.CurPutX|CurPutX]] и [[Table.CurPutY|CurPutY]]. В момент копирования тексты и значения ячеек и объектов, являющиеся шаблонами, будут превращены в результаты их вычисления. Если третий аргумент равен 1, до начала копирования, функция переводит курсор копирования на первую строку и производит сдвиг курсора по горизонтали (размер сдвига по горизонтали определяется шириной копируемой области). После окончания копирования функция переводит курсор копирования вниз на высоту области копирования. Если четвертый аргумент равен 1, функция не будет изменять размеры строк или столбцов в соответствии с размерами строк и столбцов копируемой области, однако, при копировании текста в ячейки, автоматически рассчитываемые размеры строк или столбцов по-прежнему будут изменены, если это необходимо. После копирования любого визуального объекта, функция вызывает событие [[OnFinishCopyObject]], если оно существует в текущем или глобальном модуле.
}}
{{function entry
|name=[[Table.RecalcColumnWidth|RecalcColumnWidth]]
|form={{Grey|Table.}}'''RecalcColumnWidth'''(''<Столбец начала пересчета (INT)>''{{Optional|,<Количество пересчитываемых столбцов (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=0
|visual=0
|description=Функция пересчитывает ширину указанных столбцов, если их ширина рассчитывается автоматически.
}}
{{function entry
|name=[[Table.RecalcLineHeight|RecalcLineHeight]]
|form={{Grey|Table.}}'''RecalcLineHeight'''(''<Строка начала пересчета (INT)>''{{Optional|,<Количество пересчитываемых строк (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=0
|visual=0
|description=Функция пересчитывает высоту указанных строк, если их высота рассчитывается автоматически.
}}
{{function footer}}

== Атрибуты и функции вспомогательных объектов (Table.Options, Table.Printing и т.п.) ==
Данный раздел содержит функции, применяемые к подчиненным объектам, связанным с основным объектом таблицы. Данные группа объектов имеет тип ''Table.Options'' и включает следующие объекты:
* Объект визуального выделения ячеек таблицы
* Объект списка выделенных визуальных элементов (объектов) таблицы
* Объект работы с визуальными уровнями таблицы
* Объект общих настроек таблицы
* Объект работы с разбиениями таблицы на отдельные страницы при печати
* Объект настройки параметров печати, полей окружения страницы и колонтитулов
* Объект работы с со строками или столбцами таблицы, выводящимися на каждой странице
{{function header}}
{{function entry
|name=[[Table.Selection|Selection]]
|form={{Grey|Table.}}'''Selection'''():''<Объект выделения таблицы (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает объект текущего выделения ячеек. С объектом можно вызывать функции, типа [[Table.Selection.Add|Add]] и пр.
}}
{{function entry
|name=[[Table.Selection.Count|Count]]
|form={{Grey|Table.Selection.}}'''Count'''():''<Количество областей визуального выделения (INT)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает количество областей визуального выделения в таблице. Выделение не удаляется даже если пользователь выберет визуальный объект. При выделении объекта, выделение ячеек остается, но будет скрыто. Чтобы узнать, что выделено в данный момент, можно использовать атрибут [[Table.SelectionMode|SelectionMode]].
}}
{{function entry
|name=[[Table.Selection.Add|Add]]
|form={{Grey|Table.Selection.}}'''Add'''(''<Левый столбец выделения (INT)>'',''<Верхняя строка выделения (INT)>'',''<Правый столбец выделения (INT)>'',''<Нижняя строка выделения (INT)>'')
|type=1
|status=2
|visual=1
|description=Функция добавляет к визуально выделенным областям еще одну заданную область.
}}
{{function entry
|name=[[Table.Selection.Delete|Delete]]
|form={{Grey|Table.Selection.}}'''Delete'''(''<Индекс области выделения (INT)>'')
|type=1
|status=2
|visual=1
|description=Функция удаляет область визуального выделения с указанным индексом. Первая область выделения имеет индекс 1.
}}
{{function entry
|name=[[Table.Selection.Get|Get]]
|form={{Grey|Table.Selection.}}'''Get'''(''<Индекс области выделения (INT)>'',''<Тип границы выделения (INT)>''):''<Столбец или строка выделения (INT)>''
|type=1
|status=2
|visual=1
|description=Функция получает строку или столбец визуального выделения с указанным индексом.
}}
{{function entry
|name=[[Table.Selection.GetArea|GetArea]]
|form={{Grey|Table.Selection.}}'''GetArea'''(''<Индекс области выделения (INT)>'',{{ByRef|<Левый столбец выделения (INT)>,<Верхняя строка выделения (INT)>,<Правый столбец выделения (INT)>,<Нижняя строка выделения (INT)>}})
|type=1
|status=2
|visual=1
|description=Функция получает координаты визуального выделения с указанным индексом.
}}
{{function entry
|name=[[Table.Selection.Clear|Clear]]
|form={{Grey|Table.Selection.}}'''Clear'''()
|type=1
|status=2
|visual=1
|description=Функция удаляет все области выделения; остается одна область, совпадающая с положением визуального курсора.
}}
{{function entry
|name=[[Table.SelectedObjects|SelectedObjects]]
|form={{Grey|Table.}}'''SelectedObjects'''():''<Выделенные визуальные объекты таблицы (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает объект выделенных визуальных объектов таблицы. С объектом можно вызывать функции, типа [[Table.SelectedObjects.Get|Get]] и пр.
}}
{{function entry
|name=[[Table.SelectedObjects.Count|Count]]
|form={{Grey|Table.SelectedObjects.}}'''Count'''():''<Количество выделенных визуальных объектов (INT)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает количество выделенных визуальных объектов в таблице. Чтобы узнать, что выделено в данный момент, можно использовать атрибут [[Table.SelectionMode|SelectionMode]].
}}
{{function entry
|name=[[Table.SelectedObjects.Add|Add]]
|form={{Grey|Table.SelectedObjects.}}'''Add'''(''<Индекс добавляемого к выделенным объекта (INT)>'')
|type=1
|status=0
|visual=1
|description=Функция добавляет к выделенным в данный момент объектам указанный по индексу объект. Если до момента вызова функции был активен режим выделения ячеек, после вызова функции активируется режим выделения визуальных объектов с единственным выбранным объектом.
}}
{{function entry
|name=[[Table.SelectedObjects.Delete|Delete]]
|form={{Grey|Table.SelectedObjects.}}'''Delete'''(''<Индекс исключаемого из выделения объекта (INT)>'')
|type=1
|status=0
|visual=1
|description=Функция исключает из выделенных в данный момент объектов указанный по индексу объект.
}}
{{function entry
|name=[[Table.SelectedObjects.Get|Get]]
|form={{Grey|Table.SelectedObjects.}}'''Get'''(''<Индекс выделенного объекта (INT)>''):''<Визуальный объект (TABLE.OBJECT>''
|type=1
|status=2
|visual=1
|description=Функция получает визуальный объект таблицы по индексу в массиве выделенных в данный момент объектов
}}
{{function entry
|name=[[Table.SelectedObjects.Clear|Clear]]
|form={{Grey|Table.SelectedObjects.}}'''Clear'''()
|type=1
|status=0
|visual=1
|description=Функция исключает все выделенные объекты из массива выделенных объектов и активирует режим выделения ячеек.
}}
{{function entry
|name=[[Table.Levels|Levels]]
|form={{Grey|Table.}}'''Levels'''({{Optional|<Тип уровня (INT)>{{Default|{{Eq}}0}},<Индекс уровня (INT)>,<Индекс дочернего уровня (INT)>...}}):''<Визуальные уровни таблицы (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает объект визуальных уровней таблицы. Уровни используются для выделения групп столбцов или строк таблицы. Уровни можно закрывать или открыть. Если уровень закрыт, строки или столбцы, входящие в него (кроме основной строки/столбца) будут скрыты. Уровни могут быть вложенными друг в друга. С объектом можно вызывать функции, типа [[Table.Levels.Open|Open]] и пр. Функция содержит указание на конкретный уровень (если заданы индексы), после чего к нему можно добавить дочерние уровни, либо указание на корневой уровень (если индексы не заданы).
}}
{{function entry
|name=[[Table.Levels.Child|Child]]
|form={{Grey|Table.Levels.}}'''Child'''(''<Индекс уровня (INT)>''):''<Объект вложенного уровня по его индексу (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=1
|description=Функция получает объект уровня, вложенного в текущий, по его индексу. Индексация начинается с единицы.
}}
{{function entry
|name=[[Table.Levels.Parent|Parent]]
|form={{Grey|Table.Levels.}}'''Parent'''():''<Объект уровня, в который вложен данный (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=1
|description=Функция получает уровень, в который вложен данный. Если функция вызывается с объектом верхнего уровня, она возвращает пустое значение.
}}
{{function entry
|name=[[Table.Levels.Index|Index]]
|form={{Grey|Table.Levels.}}'''Index'''():''<Индекс текущего уровня внутри родительского (INT)>''
|type=1
|status=2
|visual=1
|description=Функция получает индекс текущего уровня относительно родительского уровня. Индексация начинается с единицы.
}}
{{function entry
|name=[[Table.Levels.Add|Add]]
|form={{Grey|Table.Levels.}}'''Add'''(''<Направление уровня (INT)>'',''<Начальная позиция уровня (INT)>'',''<Конечная позиция уровня (INT)>'')
|type=1
|status=2
|visual=1
|description=Функция добавляет визуальный уровень к текущему, либо к одному из детей текущего уровня, если начальная и конечная позиции располагаются полностью внутри дочернего уровня.
}}
{{function entry
|name=[[Table.Levels.Delete|Delete]]
|form={{Grey|Table.Levels.}}'''Delete'''({{Optional|<Начальная позиция (INT)>,<Конечная позиция (INT)>,<Рекурсивно удалить дочерние уровни (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=1
|description=Функция удаляет указанные с помощью границ визуальные уровни, если необходимо, со всеми подчиненными уровнями. Если текущий объект указывает на существующий, а не корневой уровень, аргументы можно опустить и функция удалит текущей уровень со всеми его подчиненными подуровнями.
}}
{{function entry
|name=[[Table.Levels.Count|Count]]
|form={{Grey|Table.Levels.}}'''Count'''():''<Количество дочерних уровней (INT)>''
|type=1
|status=2
|visual=1
|description=Функция получает общее количество уровней, дочерних по отношению к данному.
}}
{{function entry
|name=[[Table.Levels.Beg|Beg]]
|form={{Grey|Table.Levels.}}'''Beg''':''<Начальная позиция текущего уровня (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает начальную позицию текущего уровня, функция не может применяться для корневого уровня (не имеющего видимый переключатель в таблице)
}}
{{function entry
|name=[[Table.Levels.End|End]]
|form={{Grey|Table.Levels.}}'''End''':''<Конечная позиция текущего уровня (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает конечную позицию текущего уровня, функция не может применяться для корневого уровня (не имеющего видимый переключатель в таблице)
}}
{{function entry
|name=[[Table.Levels.IsClosed|IsClosed]]
|form={{Grey|Table.Levels.}}'''IsClosed''':''<Текущий уровень закрыт (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает статус, открыт ли текущий уровень, функция не может применяться для корневого уровня (не имеющего видимый переключатель в таблице)
}}
{{function entry
|name=[[Table.Levels.Open|Open]]
|form={{Grey|Table.Levels.}}'''Open'''()
|type=1
|status=2
|visual=1
|description=Функция открывает текущий уровень. При применении функции к верхнему уровню, она открывает все уровни таблицы.
}}
{{function entry
|name=[[Table.Levels.Close|Close]]
|form={{Grey|Table.Levels.}}'''Close'''()
|type=1
|status=2
|visual=1
|description=Функция закрывает текущий уровень. При применении функции к верхнему уровню, она закрывает все уровни таблицы.
}}
{{function entry
|name=[[Table.Options|Options]]
|form={{Grey|Table.}}'''Options''':''<Объект установок таблицы (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок таблицы. С объектом можно вызывать функции, типа [[Table.Options.FixedLine|FixedLine]] и пр.
}}
{{function entry
|name=[[Table.Options.ShowGrid|ShowGrid]]
|form={{Grey|Table.Options.}}'''ShowGrid''':''<Показывать сетку редактирования (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет режим отображения сетки редактирования в таблице.
}}
{{function entry
|name=[[Table.Options.ShowCaptions|ShowCaptions]]
|form={{Grey|Table.Options.}}'''ShowCaptions''':''<Показывать заголовки строк и столбцов (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет режим отображения заголовков строк и столбцов в таблице.
}}
{{function entry
|name=[[Table.Options.FixedLine|FixedLine]]
|form={{Grey|Table.Options.}}'''FixedLine''':''<Закрепить на экране указанное количество строк (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет количество строк, закрепленных на экране. При сдвиге отображаемого поля таблицы закрепленные строки останутся видимыми. По умолчанию этот атрибут равен 0 (нет закрепленных строк).
}}
{{function entry
|name=[[Table.Options.FixedColumn|FixedColumn]]
|form={{Grey|Table.Options.}}'''FixedColumn''':''<Закрепить на экране указанное количество столбцов (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет количество столбцов, закрепленных на экране. При сдвиге отображаемого поля таблицы закрепленные столбцы останутся видимыми. По умолчанию этот атрибут равен 0 (нет закрепленных столбцов).
}}
{{function entry
|name=[[Table.Options.GroupsVisible|GroupsVisible]]
|form={{Grey|Table.Options.}}'''GroupsVisible''':''<Видимость группировок таблиц-шаблонов (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет режим отображения наименований группировок, используемых в таблицах-шаблонах для получения областей таблиц по наименованиям.
}}
{{function entry
|name=[[Table.Options.LevelsVisible|LevelsVisible]]
|form={{Grey|Table.Options.}}'''LevelsVisible''':''<Видимость уровней группировок (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет режим отображения уровней группировок таблицы. Уровни используются для группировки строк или столбцов, каждый уровень может быть закрыт (тогда его столбцы или строки не будут отображаться на экране), либо открыт. Уровни могут быть вложенными.
}}
{{function entry
|name=[[Table.Options.Scrollable|Scrollable]]
|form={{Grey|Table.Options.}}'''Scrollable''':''<Разрешить сдвиг отображаемой части таблицы (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет режим разрешения сдвига отображаемой части таблицы. При запрете сдвига на экране будет отображаться только верхняя левая часть таблицы, сдвинуть ее вверх или влево будет невозможно.
}}
{{function entry
|name=[[Table.Options.IsChanged|IsChanged]]
|form={{Grey|Table.Options.}}'''IsChanged''':''<Производились ли изменения в таблице (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет признак того, были ли произведены визуальные изменения в таблице с момента ее предыдущего сохранения. Для таблицы, выведенных на экран, признак виден в заголовке таблицы.
}}
{{function entry
|name=[[Table.PageBreaks|PageBreaks]]
|form={{Grey|Table.}}'''PageBreaks''':''<Объект разбиения на страницы (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект разбиения таблицы на страницы. Таблицу можно разбить на страницы в нужных строках и нужных столбцах, разбитые области будут выводиться отдельными страницами при печати, даже если активна установка печати "помещать на одной странице". С объектом можно вызывать функции, типа [[Table.PageBreaks.Add|Add]] и пр.
}}
{{function entry
|name=[[Table.PageBreaks.Add|Add]]
|form={{Grey|Table.PageBreaks.}}'''Add'''({{Optional|<Строка разбиения (INT)>}})
|type=1
|status=2
|visual=0
|description=Функция позволяет добавить новое разбиение страницы по горизонтали.
}}
{{function entry
|name=[[Table.PageBreaks.AddVertical|AddVertical]]
|form={{Grey|Table.PageBreaks.}}'''AddVertical'''({{Optional|<Столбец разбиения (INT)>''}})
|type=1
|status=2
|visual=0
|description=Функция позволяет добавить новое разбиение страницы по вертикали.
}}
{{function entry
|name=[[Table.PageBreaks.Count|Count]]
|form={{Grey|Table.PageBreaks.}}'''Count'''({{Optional|<Вертикальные разбиения (INT)>{{Eq}}1}}):''<Количество разбиений на страницы (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут отдает количество (горизонтальных или вертикальных) разбиений на страницы в данной таблице.
}}
{{function entry
|name=[[Table.PageBreaks.Delete|Delete]]
|form={{Grey|Table.PageBreaks.}}'''Delete'''(''<Индекс разбиения (INT)>'')
|type=1
|status=0
|visual=0
|description=Функция удаляет разбиение с указанным индексом.
}}
{{function entry
|name=[[Table.PageBreaks.GetPosition|GetPosition]]
|form={{Grey|Table.PageBreaks.}}'''GetPosition'''(''<Индекс разбиения (INT)>''{{Optional|,<Вертикальные разбиения (INT)>{{Eq}}1}}):''<Позиция разбиения (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает столбец (если разбиение горизонтальное) или строку разбиения (если разбиение вертикальное) по индексу разбиения.
}}
{{function entry
|name=[[Table.Printing|Printing]]
|form={{Grey|Table.}}'''Printing''':''<Объект установок печати (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок печати таблицы. С объектом можно вызывать функции, типа [[Table.Printing.Printer|Printer]] и пр.
}}
{{function entry
|name=[[Table.Printing.Orientation|Orientation]]
|form={{Grey|Table.Printing.}}'''Orientation''':''<Ориентация листа при печати (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает ориентацию листа при печати (0 -- в виде портрета, 1 -- в виде ландшафта).
}}
{{function entry
|name=[[Table.Printing.ScaleMode|ScaleMode]]
|form={{Grey|Table.Printing.}}'''ScaleMode''':''<Режим масштабирования при печати (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает режим масштабирования страниц при печати. Возможные значения: 0 -- сжимать таблицу до ширины листа, 1 -- сжимать или увеличивать таблицу до ширины листа, 2 -- использовать заданный масштаб при печати страницы (см. [[Table.Printing.Scale|Scale]]), 3 -- сжимать или увеличивать таблицу, чтобы она умещалась на одном листе. Важно понимать, что в таблицах, где использовано разбиение на страницы (см. [[Table.PageBreaks|PageBreaks]]), сжатие и расширение (в т.ч. размещение на одном листе) происходит для каждой страницы, полученной в результате разбиения.
}}
{{function entry
|name=[[Table.Printing.Scale|Scale]]
|form={{Grey|Table.Printing.}}'''Scale''':''<Масштаб в режиме печати с заданным масштабом (REAL)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает масштаб печати в режиме печати с заданным масштабом. Масштаб устанавливается в процентах и может быть вещественным числом. По умолчанию этот атрибут равен 100.
}}
{{function entry
|name=[[Table.Printing.Printer|Printer]]
|form={{Grey|Table.Printing.}}'''Printer''':''<Наименование текущего принтера (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает наименование текущего принтера для печати таблицы. Если этому атрибуту присваивается пустая строка, будет использован принтер по умолчанию..
}}
{{function entry
|name=[[Table.Printing.Copies|Copies]]
|form={{Grey|Table.Printing.}}'''Copies''':''<Количество копий при печати (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает количество копий при печати таблицы. По умолчанию, этот атрибут равен единице.
}}
{{function entry
|name=[[Table.Printing.PageOptions|PageOptions]]
|form={{Grey|Table.Printing.}}'''PageOptions''':''<Дополнительные установки печати (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает дополнительные установки страницы. Атрибут имеет тип битовой маски, возможные значения перечислены в статье [[Константы#Константы свойств таблиц|Константы]].
}}
{{function entry
|name=[[Table.Printing.Fields|Fields]]
|form={{Grey|Table.Printing.}}'''Fields''':''<Объект установок полей таблицы при печати (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок полей таблицы при печати. С объектом можно вызывать функции, типа [[Table.Printing.Fields.Left|Left]] и пр.
}}
{{function entry
|name=[[Table.Printing.Fields.Left|Left]]
|form={{Grey|Table.Printing.Fields.}}'''Left''':''<Ширина левого поля в мм. (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает ширину пустого левого поля при печати страницы. По умолчанию ширина поля равна 10 мм.
}}
{{function entry
|name=[[Table.Printing.Fields.Right|Right]]
|form={{Grey|Table.Printing.Fields.}}'''Right''':''<Ширина правого поля в мм. (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает ширину пустого правого поля при печати страницы. По умолчанию ширина поля равна 10 мм.
}}
{{function entry
|name=[[Table.Printing.Fields.Up|Up]]
|form={{Grey|Table.Printing.Fields.}}'''Up''':''<Ширина верхнего поля в мм. (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает ширину пустого верхнего поля при печати страницы. По умолчанию ширина поля равна 10 мм. Поле следует до начала верхнего колонтитула и не включается в ширину колонтитула.
}}
{{function entry
|name=[[Table.Printing.Fields.Down|Down]]
|form={{Grey|Table.Printing.Fields.}}'''Down''':''<Ширина нижнего поля в мм. (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает ширину пустого нижнего поля при печати страницы. По умолчанию ширина поля равна 10 мм. Поле следует после нижнего колонтитула и не включается в ширину колонтитула.
}}
{{function entry
|name=[[Table.Printing.Titles|Titles]]
|form={{Grey|Table.Printing.}}'''Titles''':''<Объект установок колонтитулов таблицы при печати (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок колонтитулов таблицы при печати. С объектом можно вызывать функции, типа [[Table.Printing.Titles.Up|Up]] и пр.
}}
{{function entry
|name=[[Table.Printing.Titles.Up|Up]]
|form={{Grey|Table.Printing.Titles.}}'''Up''':''<Объект установок верхнего колонтитула таблицы при печати (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок верхнего колонтитула таблицы при печати. С объектом можно вызывать функции, типа [[Table.Printing.Titles.Text|Text]] и пр.
}}
{{function entry
|name=[[Table.Printing.Titles.Down|Down]]
|form={{Grey|Table.Printing.Titles.}}'''Down''':''<Объект установок нижнего колонтитула таблицы при печати (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок нижнего колонтитула таблицы при печати. С объектом можно вызывать функции, типа [[Table.Printing.Titles.Text|Text]] и пр.
}}
{{function entry
|name=[[Table.Printing.Titles.Size|Size]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''Size''':''<Ширина выбранного колонтитула в мм. (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает ширину выбранного колонтитула при печати таблицы. По умолчанию ширина колонтитула равна 7 мм.
}}
{{function entry
|name=[[Table.Printing.Titles.Text|Text]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''Text''':''<Текст или шаблон колонтитула (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает текст или шаблон выбранного колонтитула при печати таблицы.
}}
{{function entry
|name=[[Table.Printing.Titles.TextOptions|TextOptions]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''TextOptions''':''<Установки форматирования колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает установки форматирования выбранного колонтитула при печати таблицы. Значение является битовой маской и использует сл. биты: биты 0..1: режим выравнивания по горизонтали, биты 2..3: режим выравнивания по вертикали.
}}
{{function entry
|name=[[Table.Printing.Titles.Orientation|Orientation]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''Orientation''':''<Угол направления текста (REAL)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет угол направления прорисовки текста выбранного колонтитула при печати таблицы. По умолчанию это значение равно 0 (горизонтальный текст).
}}
{{function entry
|name=[[Table.Printing.Titles.TitleOptions|TitleOptions]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''TitleOptions''':''<Дополнительные установки колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает дополнительные установки выбранного колонтитула при печати таблицы. Значение является битовой маской и использует сл. биты: бит 0: режим шаблона для текста активен, бит 2: при переносе текста принимать во внимание границы слов.
}}
{{function entry
|name=[[Table.Printing.Titles.PrintFromPage|PrintFromPage]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''PrintFromPage''':''<Начинать печатать колонтитул с указанной страницы (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает номер страницы, с которой будет начитать печататься колонтитул. По умолчанию, этот атрибут равен единице.
}}
{{function entry
|name=[[Table.Printing.Titles.ColorProfile|ColorProfile]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''ColorProfile''':''<Шаблон цвета колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер шаблона цвета выбранного колонтитула таблицы. По умолчанию это значение равно 0 (цвета и стиль форматирования определяется соответствующими атрибутами колонтитула, а не номером шаблона). Номера шаблонов можно найти в [[Номера шаблонов цветов ячеек таблицы|этой статье]].
}}
{{function entry
|name=[[Table.Printing.Titles.BackgroundColor|BackgroundColor]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''BackgroundColor''':''<Номер цвета фона колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета фона выбранного колонтитула таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Printing.Titles.BackgroundColorRGB|BackgroundColorRGB]].
}}
{{function entry
|name=[[Table.Printing.Titles.BackgroundColorRGB|BackgroundColorRGB]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''BackgroundColorRGB''':''<Цвет фона колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет фона выбранного колонтитула таблицы по его 24-битному значению.
}}
{{function entry
|name=[[Table.Printing.Titles.FontColor|FontColor]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''FontColor''':''<Номер цвета текста колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета текста выбранного колонтитула таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Printing.Titles.FontColorRGB|FontColorRGB]].
}}
{{function entry
|name=[[Table.Printing.Titles.FontColorRGB|FontColorRGB]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''FontColorRGB''':''<Цвет текста колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет текста выбранного колонтитула таблицы по его 24-битному значению.
}}
{{function entry
|name=[[Table.Printing.Titles.FontStyle|FontStyle]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''FontStyle''':''<Стиль текста колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет стиль текста выбранного колонтитула таблицы.
}}
{{function entry
|name=[[Table.Printing.Titles.FontSize|FontSize]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''FontSize''':''<Размер шрифта колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет размер шрифта текста выбранного колонтитула таблицы.
}}
{{function entry
|name=[[Table.Printing.Titles.Font|Font]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''Font''':''<Наименование шрифта текста колонтитула (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет наименование шрифта текста выбранного колонтитула таблицы.
}}
{{function entry
|name=[[Table.Printing.ContinualLines|ContinualLines]]
|form={{Grey|Table.Printing.}}'''ContinualLines''':''<Объект установок строк таблицы, печатающихся на каждой странице (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок строк таблицы, выводящихся на печать на каждой странице. К примеру, для таблиц данных, которые занимают несколько страниц при печати, удобно печатать заголовок на каждой новой страницы до момента, когда таблица закончится. С объектом можно вызывать функции, типа [[Table.Printing.ContinualPrinting.From|From]] и пр.
}}
{{function entry
|name=[[Table.Printing.ContinualColumns|ContinualColumns]]
|form={{Grey|Table.Printing.}}'''ContinualColumns''':''<Объект установок столбцов таблицы, печатающихся на каждой странице (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок столбцов таблицы, выводящихся на печать на каждой странице. С объектом можно вызывать функции, типа [[Table.Printing.ContinualPrinting.From|From]] и пр.
}}
{{function entry
|name=[[Table.Printing.ContinualPrinting.From|From]]
|form={{Grey|Table.Printing.<Тип объекта>.}}'''From''':''<Строка или столбец начала области (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или устанавливает строку или столбец, с которой начинается область, печатающаяся на каждой странице.
}}
{{function entry
|name=[[Table.Printing.ContinualPrinting.To|To]]
|form={{Grey|Table.Printing.<Тип объекта>.}}'''To''':''<Строка или столбец окончания области (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или устанавливает строку или столбец, на которой заканчивается область, печатающаяся на каждой странице. Копия области будет выведена на следующей по горизонтали или вертикали странице (в зависимости от типа объекта).
}}
{{function entry
|name=[[Table.Printing.ContinualPrinting.EndCell|EndCell]]
|form={{Grey|Table.Printing.<Тип объекта>.}}'''EndCell''':''<Строка или столбец, после которого, заданная область, печатавшаяся на каждой странице, больше не выводится (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или устанавливает строку или столбец, после вывода на печать которых, заданная область, печатавшаяся на каждой странице, больше не выводится.
}}
{{function footer}}

== Атрибуты и функции объекта области таблицы (Table.Area) ==
Данный раздел содержит функции, применяемые к объекту области таблицы. Объект области позволяет получить или изменять параметры ячеек, входящих в нее. При создании объекта, не производится копирования области в памяти, а создается только ссылка на нее.
{{function header}}
{{function entry
|name=[[Table.Area|Area]]
|form={{Grey|Table.}}'''Area'''(''<Левый столбец области (INT)>'',''<Верхняя строка области (INT)>''{{Optional|,<Правый столбец области (INT)>,<Нижняя строка области (INT)>}}):''<Объект области таблицы (TABLE.AREA)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект области таблицы. С объектом можно вызывать функции, типа [[Table.Area.Text|Text]] и пр.
}}
{{function entry
|name=[[Table.Area.Text|Text]]
|form={{Grey|Table.Area.}}'''Text''':''<Текст ячеек области (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет текст ячеек области таблицы. Текст получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.Value|Value]], '''Formula'''
|form={{Grey|Table.Area.}}'''Value''':''<Значение ячеек таблицы>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет значение, ассоциированное с ячейками области таблицы. Значение получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.ValueTemplate|ValueTemplate]]
|form={{Grey|Table.Area.}}'''ValueTemplate''':''<Формула шаблона ячейки (STRING)>''
|type=0
|status=0
|visual=0
|description=Атрибут возвращает или изменяет текст формулы шаблона, ассоциированной с ячейками области таблицы. Значение получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы. Формула шаблона использует тоже самое место хранения, что и значение ячейки. Для ячейки может быть задана либо формула, либо значение.
}}
{{function entry
|name=[[Table.Area.WrappingMode|WrappingMode]]
|form={{Grey|Table.Area.}}'''WrappingMode''':''<Режим переноса текста (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет значение режима переноса текста ячеек области таблицы. Значение получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы. Значение 0 задает режим переноса с соблюдением границы слов, 1 -- без соблюдения.
}}
{{function entry
|name=[[Table.Area.IsTemplate|IsTemplate]]
|form={{Grey|Table.Area.}}'''IsTemplate''':''<Является ли текст формулой шаблона (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак того, является ли текст ячеек области таблицы шаблоном (шаблон выполняется при копировании области в другую таблицу). Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.IsValueTemplate|IsValueTemplate]]
|form={{Grey|Table.Area.}}'''IsValueTemplate''':''<Является ли значение формулой шаблона (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак того, является ли значения ячеек области таблицы шаблоном (шаблон выполняется при копировании области в другую таблицу). Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.HAlign|HAlign]]
|form={{Grey|Table.Area.}}'''HAlign''':''<Выравнивание по горизонтали (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим выравнивания текста ячеек области таблицы по горизонтали. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.VAlign|VAlign]]
|form={{Grey|Table.Area.}}'''VAlign''':''<Выравнивание по вертикали (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим выравнивания текста ячеек области таблицы по вертикали. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.ClipMode|ClipMode]]
|form={{Grey|Table.Area.}}'''ClipMode''':''<Контроль границы ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим контроля выхода за границу ячейки текста ячеек области таблицы. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.RedNegative|RedNegative]]
|form={{Grey|Table.Area.}}'''RedNegative''':''<Отрицательные красным (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим выделения красным текста ячеек области таблицы, когда они содержат отрицательные числа. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.Protected|Protected]]
|form={{Grey|Table.Area.}}'''Protected''':''<Защита от изменения в режиме просмотра (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим защиты ячеек области таблицы от изменения в режиме просмотра (игнорируется в режиме редактирования и запрета изменений). По умолчанию признак защиты установлен. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.Orientation|Orientation]]
|form={{Grey|Table.Area.}}'''Orientation''':''<Угол направления текста (REAL)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет угол направления прорисовки текста ячеек области таблицы. По умолчанию это значение равно 0 (горизонтальный текст). Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.ParentCell|ParentCell]]
|form={{Grey|Table.Area.}}'''ParentCell''':''<Тип объединения ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает тип объединения, связанный с крайней левой верхней ячейкой области таблицы. Получаемый атрибут может принимать следующие значения: 0 -- ячейка не участвует в объединении ячеек, 1 -- это крайняя левая ячейка области объединения (основная ячейка, из свойств которой используются цвета, шрифт, текст и пр. для всей области), 2 -- эта ячейка участвует в объединении, как подчиненная ячейка.
}}
{{function entry
|name=[[Table.Area.ExtentX|ExtentX]]
|form={{Grey|Table.Area.}}'''ExtentX''':''<Ссылка по горизонтали на основную ячейку объединения (INT)>''
|type=0
|status=2
|visual=0
|description=Для крайней левой верхней ячейкой области атрибут возвращает расстояние в ячейках по горизонтали от текущей ячейки до основной ячейки объединения (отрицательное число); количество ячеек в области объединения по горизонтали, если это основная ячейка (см. [[Table.Area.ParentCell|ParentCell]]); либо 0, если ячейка не участвует в объединении ячеек.
}}
{{function entry
|name=[[Table.Area.ExtentY|ExtentY]]
|form={{Grey|Table.Area.}}'''ExtentY''':''<Ссылка по вертикали на основную ячейку объединения (INT)>''
|type=0
|status=2
|visual=0
|description=Для крайней левой верхней ячейкой области атрибут возвращает расстояние в ячейках по вертикали от текущей ячейки до основной ячейки объединения (отрицательное число); количество ячеек в области объединения по вертикали, если это основная ячейка (см. [[Table.Area.ParentCell|ParentCell]]); либо 0, если ячейка не участвует в объединении ячеек.
}}
{{function entry
|name=[[Table.Area.IndentX|IndentX]], '''Indent'''
|form={{Grey|Table.Area.}}'''IndentX''':''<Отступ текста по горизонтали (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет отступ текста по горизонтали от границы ячеек области таблицы. По умолчанию это значение равно 0 (отступ отсутствует). Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.IndentY|IndentY]]
|form={{Grey|Table.Area.}}'''IndentY''':''<Отступ текста по вертикали (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет отступ текста по вертикали от границы ячеек области таблицы. По умолчанию это значение равно 0 (отступ отсутствует). Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.ColorProfile|ColorProfile]]
|form={{Grey|Table.Area.}}'''ColorProfile''':''<Шаблон цвета ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер шаблона цвета ячеек области таблицы. По умолчанию это значение равно 0 (цвета и стиль форматирования определяется соответствующими атрибутами ячейки, а не номером шаблона). Номера шаблонов можно найти в [[Номера шаблонов цветов ячеек таблицы|этой статье]]. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.BackgroundColor|BackgroundColor]]
|form={{Grey|Table.Area.}}'''BackgroundColor''':''<Номер цвета фона ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета фона ячеек области таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Area.BackgroundColorRGB|BackgroundColorRGB]]. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.BackgroundColorRGB|BackgroundColorRGB]]
|form={{Grey|Table.Area.}}'''BackgroundColorRGB''':''<Цвет фона ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет фона ячеек области таблицы по его RGB значению. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.FontColor|FontColor]]
|form={{Grey|Table.Area.}}'''FontColor''':''<Номер цвета текста ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета текста ячеек области таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Area.FontColorRGB|FontColorRGB]]. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.FontColorRGB|FontColorRGB]]
|form={{Grey|Table.Area.}}'''FontColorRGB''':''<Цвет текста ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет текста ячеек области таблицы по его RGB значению. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.FrameColor|FrameColor]]
|form={{Grey|Table.Area.}}'''FrameColor''':''<Номер цвета границы ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета границы ячеек области таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Area.FrameColorRGB|FrameColorRGB]]. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.FrameColorRGB|FrameColorRGB]]
|form={{Grey|Table.Area.}}'''FrameColorRGB''':''<Цвет границы ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет границы ячеек области таблицы по его RGB значению. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.FontStyle|FontStyle]]
|form={{Grey|Table.Area.}}'''FontStyle''':''<Стиль текста ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет стиль текста ячеек области таблицы. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.FontSize|FontSize]]
|form={{Grey|Table.Area.}}'''FontSize''':''<Размер шрифта текста ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет размер шрифта текста ячеек области таблицы. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.Font|Font]]
|form={{Grey|Table.Area.}}'''Font''':''<Наименование шрифта текста ячейки (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет наименование шрифта текста ячеек области таблицы. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.Frame|Frame]]
|form={{Grey|Table.Area.}}'''Frame''':''<Рисунок и наличие 4-х границ вокруг ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет рисунок и наличие четырех границ вокруг каждой ячейки из области таблицы. Значение представляет собой битовую маску, где на каждую из границ используется по 4 бита. По умолчанию, это значение равно 0 (ячейка не окружена границами). Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.RowAutoSize|RowAutoSize]]
|form={{Grey|Table.Area.}}'''RowAutoSize''':''<Признак автоматического изменения высоты строки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак автоматического изменения высоты строк ячеек области таблицы. Значение признака получается для строки верхних ячеек области, и устанавливается для всех строк области таблицы.
}}
{{function entry
|name=[[Table.Area.ColAutoSize|ColAutoSize]]
|form={{Grey|Table.Area.}}'''ColAutoSize''':''<Признак автоматического изменения ширины столбца (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак автоматического изменения ширины столбцов ячеек области таблицы. Значение признака получается для столбца левых ячеек области, и устанавливается для всех столбцов области таблицы.
}}
{{function entry
|name=[[Table.Area.RowHeight|RowHeight]]
|form={{Grey|Table.Area.}}'''RowHeight''':''<Высота строки в пикселях (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет высоту строк ячеек области таблицы. Значение признака получается для строки верхних ячеек области, и устанавливается для всех строк области таблицы. При установке этого атрибута, атрибут [[Table.Area.RowAutoSize|RowAutoSize]] автоматически принимает нулевое значение.
}}
{{function entry
|name=[[Table.Area.ColWidth|ColWidth]]
|form={{Grey|Table.Area.}}'''ColWidth''':''<Ширина столбца в пикселях (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет ширину столбцов ячеек области таблицы. Значение признака получается для столбца левых ячеек области, и устанавливается для всех столбцов области таблицы. При установке этого атрибута, атрибут [[Table.Area.ColAutoSize|ColAutoSize]] автоматически принимает нулевое значение.
}}
{{function entry
|name=[[Table.Area.ContinuousRegionX|ContinuousRegionX]]
|form={{Grey|Table.Area.}}'''ContinuousRegionX''':''<Признак неразрывности горизонтального региона (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак неразрывности при печати горизонтального региона ячеек области таблицы. При установке признака можно использовать значения 0 (регион теряет все свойства неразрывности) или 1 (регион становится неразрывным). При чтении, возможны следующие значения: 0 -- в регионе отсутствуют неразрывные диапазоны, 1 -- весь регион представляет собой неразрывный диапазон, 2 -- регион содержит определенное количество неразрывных диапазонов или их частей.
}}
{{function entry
|name=[[Table.Area.ContinuousRegionY|ContinuousRegionY]]
|form={{Grey|Table.Area.}}'''ContinuousRegionY''':''<Признак неразрывности вертикального региона (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак неразрывности при печати вертикального региона ячеек области таблицы. При установке признака можно использовать значения 0 (регион теряет все свойства неразрывности) или 1 (регион становится неразрывным). При чтении, возможны следующие значения: 0 -- в регионе отсутствуют неразрывные диапазоны, 1 -- весь регион представляет собой неразрывный диапазон, 2 -- регион содержит определенное количество неразрывных диапазонов или их частей.
}}
{{function entry
|name=[[Table.Area.Merge|Merge]]
|form={{Grey|Table.Area.}}'''Merge'''()
|type=1
|status=2
|visual=0
|description=Функция объединяет ячейки области таблицы в один регион объединения. Если с областью граничили или находились внутри области другие регионы объединения, они будут разъединены до выполнения объединения текущей области.
}}
{{function entry
|name=[[Table.Area.Demerge|Demerge]]
|form={{Grey|Table.Area.}}'''Demerge'''()
|type=1
|status=2
|visual=0
|description=Функция разъединяет ячейки области таблицы, это относится ко всем регионам объединения входящим в или граничащим с текущей областью таблицы.
}}
{{function entry
|name=[[Table.Area.CopyTo|CopyTo]]
|form={{Grey|Table.Area.}}'''CopyTo'''(''<Таблица в которую происходит копирование (TABLE)>'',''<Столбец таблицы для вставки (INT)>'',''<Строка таблицы для вставки (INT)>''{{Optional|,<Копировать также объекты (INT)>{{Default|{{Eq}}1}},<Превращать шаблоны в их значения (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=0
|visual=0
|description=Функция копирует текущую область в указанную таблицу по начиная с указанной ячейки, таблица результат может также быть текущей таблицей.
}}
{{function entry
|name=[[Table.Area.Copy|Copy]]
|form={{Grey|Table.Area.}}'''Copy'''({{Optional|<Копировать также объекты (INT)>{{Default|{{Eq}}1}}}}):''<Копия области в виде новой таблицы (TABLE)>''
|type=1
|status=2
|visual=0
|description=Функция создает новую таблицу и заполняет ее ячейками текущей области. Область копируется в таблицу начиная с первой верхней левой ячейки.
}}
{{function entry
|name=[[Table.Area.Execute|Execute]]
|form={{Grey|Table.Area.}}'''Execute'''({{Optional|<Также находить значения шаблонов для объектов (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=0
|visual=0
|description=Функция превращает все тексты шаблонов ячеек (и объектов) области в их значения.
}}
{{function entry
|name=[[Table.Area.Modify|Modify]]
|form={{Grey|Table.Area.}}'''Modify'''(''<Левый столбец (INT)>'',''<Верхняя строка (INT)>''{{Optional|,<Правый столбец (INT)>,<Нижняя строка (INT)>}})
|type=1
|status=2
|visual=0
|description=Функция изменяет размеры и положение текущей области в соответствующей ей таблице. Т.е., действие функции соответствует вызову [[Table.Area|Area]], только на существующем объекте, который после исполнения функции будет указывать на другую область.
}}
{{function entry
|name=[[Table.Area.Clear|Clear]]
|form={{Grey|Table.Area.}}'''Clear'''()
|type=1
|status=0
|visual=0
|description=Функция разъединяет все объединенные ячейки области, очищает весь текст и значения ячеек, стили, границы, цвета и пр. устанавливает в состояние по умолчанию.
}}
{{function footer}}

== Атрибуты и функции визуальных объектов таблицы (Table.Object) ==
Данный раздел содержит функции, применяемые к совокупности или к одному визуальному элементу (объекту) таблицы. Объект позволяет получить или изменять параметры элементов, которые он адресует. Визуальным элементом (объектом), к примеру, может быть рисунок, или текст, добавленные в произвольное место таблицы и имеющие произвольный размер. Такие элементы выводятся на печать и их содержимое закрывает текст ячеек, находящихся непосредственно под ними.
{{function header}}
{{function entry
|name=[[Table.Objects|Objects]]
|form={{Grey|Table.}}'''Objects'''({{Optional|<Индекс или наименование определенного объекта (INT,STRING)>}}):''<Визуальный объект таблицы или все визуальные объекты (TABLE.OBJECT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект доступа к визуальным объектам таблицы. При указании на определенный визуальный объект, текущим объектом можно пользоваться для изменения его свойств, иначе текущий объект будет указывать на всю совокупность объектов таблицы.
}}
{{function entry
|name=[[Table.Object.Count|Count]]
|form={{Grey|Table.Object.}}'''Count''':''<Общее количество объектов таблицы (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает общее количество объектов в таблице.
}}
{{function entry
|name=[[Table.Object.Type|Type]]
|form={{Grey|Table.Object.}}'''Type''':''<Тип текущего объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает цифровой тип текущего объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Name|Name]]
|form={{Grey|Table.Object.}}'''Name''':''<Наименование текущего объекта (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет наименование текущего объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Text|Text]]
|form={{Grey|Table.Object.}}'''Text''':''<Текст текущего объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет текст, ассоциированный с текущим объектом таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.ValueTemplate|ValueTemplate]]
|form={{Grey|Table.Object.}}'''ValueTemplate''':''<Формула шаблона объекта (STRING)>''
|type=0
|status=0
|visual=0
|description=Атрибут возвращает или изменяет текст формулы шаблона, ассоциированной с текущим объектом таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте. Формула шаблона использует тоже самое место хранения, что и значение объекта. Для объекта может быть задана либо формула, либо значение.
}}
{{function entry
|name=[[Table.Object.Value|Value]], '''Formula'''
|form={{Grey|Table.Object.}}'''Value''':''<Значение объекта>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет произвольное значение, ассоциированной с текущим объектом таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.WrappingMode|WrappingMode]]
|form={{Grey|Table.Object.}}'''WrappingMode''':''<Режим переноса текста (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет значение режима переноса текста текущего объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.IsTemplate|IsTemplate]]
|form={{Grey|Table.Object.}}'''IsTemplate''':''<Является ли текст формулой шаблона (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак того, является ли текст визуального объекта таблицы шаблоном (шаблон выполняется при копировании области в другую таблицу). Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.IsValueTemplate|IsValueTemplate]]
|form={{Grey|Table.Object.}}'''IsValueTemplate''':''<Является ли значение формулой шаблона (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак того, является ли значение визуального объекта таблицы шаблоном (шаблон выполняется при копировании области в другую таблицу). Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.HAlign|HAlign]]
|form={{Grey|Table.Object.}}'''HAlign''':''<Выравнивание по горизонтали (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим выравнивания текста визуального объекта таблицы по горизонтали. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.VAlign|VAlign]]
|form={{Grey|Table.Object.}}'''VAlign''':''<Выравнивание по вертикали (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим выравнивания текста визуального объекта таблицы по вертикали. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.ClipMode|ClipMode]]
|form={{Grey|Table.Object.}}'''ClipMode''':''<Контроль границы для текста объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим контроля выхода за границу текста визуального объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.RedNegative|RedNegative]]
|form={{Grey|Table.Object.}}'''RedNegative''':''<Отрицательные красным (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим выделения красным текста визуального объекта таблицы, когда он содержит отрицательное число. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Protected|Protected]]
|form={{Grey|Table.Object.}}'''Protected''':''<Защита от изменения в режиме просмотра (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим защиты визуального объекта от изменения в режиме просмотра (игнорируется в режиме редактирования и запрета изменений). По умолчанию признак защиты установлен. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Orientation|Orientation]]
|form={{Grey|Table.Object.}}'''Orientation''':''<Угол направления текста объекта (REAL)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет угол направления прорисовки текста визуального объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.IsAnchoredPosition|IsAnchoredPosition]]
|form={{Grey|Table.Object.}}'''IsAnchoredPosition''':''<Изменяется ли положение объекта при изменении размеров ячеек (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак того, изменяется ли положение объекта при изменении размеров ячеек.
}}
{{function entry
|name=[[Table.Object.IsAnchoredSize|IsAnchoredSize]]
|form={{Grey|Table.Object.}}'''IsAnchoredSize''':''<Изменяются ли ширина и высота объекта при изменении размеров ячеек (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак того, изменяются ли ширина и высота объекта при изменении размеров ячеек.
}}
{{function entry
|name=[[Table.Object.AbsoluteCoordinates|AbsoluteCoordinates]]
|form={{Grey|Table.Object.}}'''AbsoluteCoordinates''':''<Абсолютные координаты объекта (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет координаты объекта, заданные в абсолютной величине (в точках) от начала таблицы. Возвращаемое значение представляет собой следующий строку: <code><Координата левой границы>,<Координата верхней границы>,<Координата правой границы>,<Координата нижней границы></code>. При установке атрибута, третью и четвертую координаты можно пропустить, в этом случае, ширина и высота объекта изменяться не будет.
}}
{{function entry
|name=[[Table.Object.RelativeCoordinates|RelativeCoordinates]]
|form={{Grey|Table.Object.}}'''RelativeCoordinates''':''<Относительные координаты объекта (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет координаты объекта, заданные в относительных величинах (смещениях ячеек). Возвращаемое значение представляет собой следующий строку: <code><Столбец левой верхней точки объекта>:<Смещение в столбце>,<Строка левой верхней точки объекта>:<Смещение в строке>,<Столбец правой нижней точки объекта>:<Смещение в столбце>,<Строка правой нижней точки объекта>:<Смещение в строке></code>. Смещения задаются как цифровой индекс от 0 до 65535. 0 означает левый край столбца или верхний край строки, 65535 означает самая правая крайняя точка столбца или самая крайняя нижняя точка строки. Все, что между этими числами пропорционально лежит внутри крайних точек. При установке атрибута, правые и нижние координаты можно пропустить, в этом случае, ширина и высота объекта изменяться не будет.
}}
{{function entry
|name=[[Table.Object.Width|Width]]
|form={{Grey|Table.Object.}}'''Width''':''<Ширина объекта в пикселях (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет ширину объекта в пикселях. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Height|Height]]
|form={{Grey|Table.Object.}}'''Height''':''<Высота объекта в пикселях (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет высоту объекта в пикселях. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.ScaleOption|ScaleOption]]
|form={{Grey|Table.Object.}}'''ScaleOption''':''<Способ масштабирования объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет способ масштабирования объекта. Доступны следующие значения: 0 -- оригинальный размер, 1 -- уменьшать размер, если это необходимо, 2 -- уменьшать или увеличивать размер если необходимо. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Proportional|Proportional]]
|form={{Grey|Table.Object.}}'''Proportional''':''<Пропорциональность при масштабировании объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим соблюдения пропорции при масштабировании содержимого объекта (картинки или OLE-объекта). Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.NotForPrinting|NotForPrinting]]
|form={{Grey|Table.Object.}}'''NotForPrinting''':''<Запрет вывода объекта на печать (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим запрета вывода объекта на печать. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Picture|Picture]]
|form={{Grey|Table.Object.}}'''Picture''':''<Картинка объекта (PICTURE)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает объект картинки в случае, если текущий объект является картинкой. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.OLE|OLE]]
|form={{Grey|Table.Object.}}'''OLE''':''<OLE-объект (OLE)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает ассоциированный OLE-объект в случае, если текущий объект является OLE-объектом. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.ColorProfile|ColorProfile]]
|form={{Grey|Table.Object.}}'''ColorProfile''':''<Шаблон стиля объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер шаблона стиля визуального объекта таблицы. По умолчанию это значение равно 0 (цвета и стиль форматирования определяется соответствующими атрибутами объекта, а не номером шаблона). Номера шаблонов можно найти в [[Номера шаблонов цветов ячеек таблицы|этой статье]]. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.BackgroundColor|BackgroundColor]]
|form={{Grey|Table.Object.}}'''BackgroundColor''':''<Номер цвета фона объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета фона визуального объекта таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Object.BackgroundColorRGB|BackgroundColorRGB]]. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.BackgroundColorRGB|BackgroundColorRGB]]
|form={{Grey|Table.Object.}}'''BackgroundColorRGB''':''<Цвет фона объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет фона визуального объекта таблицы по его RGB значению. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.FontColor|FontColor]]
|form={{Grey|Table.Object.}}'''FontColor''':''<Номер цвета текста объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета текста визуального объекта таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Object.FontColorRGB|FontColorRGB]]. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.FontColorRGB|FontColorRGB]]
|form={{Grey|Table.Object.}}'''FontColorRGB''':''<Цвет текста объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет текста визуального объекта таблицы по его RGB значению. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.FrameColor|FrameColor]]
|form={{Grey|Table.Object.}}'''FrameColor''':''<Номер цвета обрамления объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета обрамления визуального объекта таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Object.FrameColorRGB|FrameColorRGB]]. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.FrameColorRGB|FrameColorRGB]]
|form={{Grey|Table.Object.}}'''FrameColorRGB''':''<Цвет обрамления объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет обрамления визуального объекта таблицы по его RGB значению. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.FontStyle|FontStyle]]
|form={{Grey|Table.Object.}}'''FontStyle''':''<Стиль текста объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет стиль текста визуального объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.FontSize|FontSize]]
|form={{Grey|Table.Object.}}'''FontSize''':''<Размер шрифта текста объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет размер шрифта текста визуального объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Font|Font]]
|form={{Grey|Table.Object.}}'''Font''':''<Наименование шрифта текста объекта (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет наименование шрифта текста визуального объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Frame|Frame]]
|form={{Grey|Table.Object.}}'''Frame''':''<Рисунок и наличие 4-х границ обрамления объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет рисунок и наличие четырех границ обрамления визуального объекта таблицы. Значение представляет собой битовую маску, где на каждую из границ используется по 4 бита. По умолчанию, это значение равно 0 (объект не имеет обрамления). Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.LastLoadedImagePath|LastLoadedImagePath]]
|form={{Grey|Table.Object.}}'''LastLoadedImagePath''':''<Наименование файла последней загруженной картинки (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает наименование файла последней загруженной картинки для визуальных объектов таблицы с типом картинка. Признак сохраняется в объекте, к примеру, для универсальных обработчиков печати, и будет заполнен только если картинка была загружена в виде файла. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Delete|Delete]]
|form={{Grey|Table.Object.}}'''Delete'''()
|type=1
|status=2
|visual=0
|description=Функция удаляет текущий объект из таблицы.
}}
{{function footer}}

{{Объекты}}

Функции общего назначения

2026-04-01T10:01:39Z

Admin: 1 revision imported

{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]}}
Функции общего назначения представляют собой обширную коллекцию совершенно разных по действию и применению функций. Условное деление, представленное здесь, помогает быстрее найти необходимую функцию.

== Общие системные функции ==
Функции, которые нельзя отнести к другим разделам, представлены в этом общем разделе. Сюда входят функции загрузки модулей, магические функции булевой логики, функции для определения типа объекта, функции работы с именами файлов и прочие.

{{function header}}
{{function entry
|name=[[TypeStr]]
|form='''TypeStr'''(''<Аргумент>''):''<Тип аргумента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает строку, соответствующую типу аргумента или типу объекта аргумента. Пример возвращаемых значений: <code>NUMBER</code>, <code>STRING</code>, <code>DATE</code>, <code>LIST</code>, <code>TAB</code>, <code>DB.REF.<Вид справочника></code>, и т.п.
}}
{{function entry
|name=[[TypeNum]]
|form='''TypeNum'''(''<Аргумент>''):''<Тип аргумента (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает число, соответствующую типу аргумента или типу объекта аргумента. Числа является внутренними идентификаторами типов объектов. Пример возвращаемых значений: <code>0</code> (пустое значение), <code>1</code> (целое число), <code>2</code> (вещественное число), <code>50</code> (список), <code>54</code> (таблица), <code>61</code> (объект базы данных), и т.п.
}}
{{function entry
|name=[[NumeralTypeStr]]
|form='''NumeralTypeStr'''(''<Аргумент>''):''<Тип числового аргумента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает строку "REAL", в случае, если числовое представление аргумента является вещественным, иначе будет возвращена строка "INT"
}}
{{function entry
|name=[[StringTypeStr]]
|form='''StringTypeStr'''(''<Аргумент>''):''<Тип строкового аргумента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает строку "ANSI", в случае, если строковое представление аргумента использует однобайтовую кодировку (ANSI), иначе будет возвращена строка "UNICODE"
}}
{{function entry
|name=[[IsEmpty]]
|form='''IsEmpty'''(''<Аргумент>''):''<Является ли аргумент пустым объектом (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает 1, если аргумент является пустым объектом (пустое значение, 0, пустая строка, объект базы данных с невыбранным типом или видом и пр.), иначе будет возвращен 0.
}}
{{function entry
|name=[[Coalesce]]
|form='''Coalesce'''({{Optional|<Аргумент 1>,<Аргумент 2>...}}):''<Первый не пустой или не БД объект>''
|type=2
|status=2
|visual=0
|description=Функция возвращает первый из аргументов, который не является пустым (не выбранным) объектом базы данных, пустым значением, либо не является объектом базы данных. Функция является магической (вычисление следующего аргумента не выполняется, если текущий удовлетворяет условию функции).
}}
{{function entry
|name=[[CoalesceEx]]
|form='''CoalesceEx'''({{Optional|<Режим>{{Default|{{Eq}}1}}}}{{Default|}}{{Optional|,<Аргумент 1>,<Аргумент 2>...}}):''<Первый не пустой объект по правилам, заданым режимом>''
|type=2
|status=2
|visual=0
|description=Функция возвращает первый из аргументов, который не является пустым объектом по правилам, заданным режимом. В режиме ''0'' функция работает аналогично функции [[Coalesce]]. Функция является магической (вычисление следующего аргумента не выполняется, если текущий удовлетворяет условию функции).
}}
{{function entry
|name=[[Sleep]]
|form='''Sleep'''(''<Период в миллисекундах (INT)>'')
|type=1
|status=2
|visual=0
|description=Функция выполняет цикл ожидания в течение указанного в миллисекундах времени.
}}
{{function entry
|name=[[GetNothing]], '''Nothing'''
|form='''GetNothing'''({{Optional|<Тип базы данных (STRING)>{{Default|{{Eq}}""}}}}):''<Пустое значение или пустое значение базы данных>''
|type=1
|status=2
|visual=0
|description=Функция получает пустое значение, если аргумент не указан, либо не выбранный объект базы данных, если аргумент указан.
}}
{{function entry
|name=[[DisableGUIInterrupts]]
|form='''DisableGUIInterrupts'''(''<Защита (INT)>''{{Optional|,<Текст защиты (STRING)>{{Default|{{Eq}}""}}}})
|type=1
|status=2
|visual=0
|description=Функция позволяет запретить прерывание выполнения потока или закрытие программы, если первый аргумент равен 1, до того, как она будет вызвана повторно с первым аргументом, равным 0. Дополнительный текст будет показан пользователю, в момент попытки прерывания или закрытия программы. Функция работает только для визуального режима, и должна использоваться только с блоком <code>Try ... Finally</code>, так как в ином случае существует опасность получить состояние клиента, когда он не отвечает на попытки закрытия корректным образом.
}}
{{function entry
|name=[[FlushMessages]]
|form='''FlushMessages'''()
|type=1
|status=2
|visual=1
|description=Функция выполняет все ожидающие в очереди визуальные сообщения. Функцию можно использовать, к примеру, если необходимо убедиться, что нужные изменения на экране выполнены (закрыто окно, полностью обновлена таблица на форме и пр.).
}}
{{function entry
|name=[[If|_If]], '''?'''
|form='''_If'''(''<Условие>'',''<Результат, если условие выполнено>''{{Optional|,<Результат, если условие не выполнено>{{Default|{{Eq}}<NOTHING>}}}}):''<Результат>''
|type=2
|status=2
|visual=0
|description=Магическая функция позволяет превратить конструкцию '''If''' в вычисляемое выражение.
}}
{{function entry
|name=[[If2|__If]], '''??'''
|form='''__If'''(''<Условие>'',''<Результат, если условие выполнено>''{{Optional|,<Условие 2>,<Результат, если условие 2 выполнено>,...<Результат, если не выполнено ни одно из условий>{{Default|{{Eq}}<NOTHING>}}}}):''<Результат>''
|type=2
|status=2
|visual=0
|description=Магическая функция позволяет превратить несколько последовательных конструкций '''If''' в вычисляемое выражение.
}}
{{function entry
|name=[[And|_And]]
|form='''_And'''(''<Условие 1>''{{Optional|,<Условие 2>,<Условие 3> ...}}):''<Результат 0 или 1 (INT)>''
|type=2
|status=2
|visual=0
|description=Магическая функция позволяет вычислять только требуемые условия, для получения результата -- логического "и".
}}
{{function entry
|name=[[Or|_Or]]
|form='''_Or'''(''<Условие 1>''{{Optional|,<Условие 2>,<Условие 3> ...}}):''<Результат 0 или 1 (INT)>''
|type=2
|status=2
|visual=0
|description=Магическая функция позволяет вычислять только требуемые условия, для получения результата -- логического "или".
}}
{{function entry
|name=[[InSet]]
|form='''InSet'''(''<Значение поиска>''{{Optional|,<Значение множества 1>,<Значение множества 2>...}}):''<Искомое значение присутствует во множестве (INT)>''
|type=2
|status=2
|visual=0
|description=Магическая функция проверяет, присутствует ли значение поиска во множетсве значений для проверки. Может упростить конструкцию ''If''.
}}
{{function entry
|name=[[InRange]]
|form='''InRange'''(''<Значение поиска>''{{Optional|,<Начало диапазона 1>,<Конец диапазона 1>,<Начало диапазона 2>,<Конец диапазона 2>...}}):''<Искомое значение присутствует в диапазоне (диапазонах) (INT)>''
|type=2
|status=2
|visual=0
|description=Магическая функция проверяет, присутствует ли значение поиска в диапазонах значений для проверки. Искомое значение может быть числом, датой или строкой. Функция может упростить конструкцию ''If''. Для проверки используются нестрогие неравенства (<code> >= или =< </code>). Функция возвращает ''1'', если искомое значение присутствует по крайней мере в одном диапазоне.
}}
{{function entry
|name=[[InRangeEx]]
|form='''InRangeEx'''({{Optional|<Режим (INT)>{{Default|{{Eq}}0}}}},''<Значение поиска>''{{Optional|,<Начало диапазона 1>,<Конец диапазона 1>,<Начало диапазона 2>,<Конец диапазона 2>...}}):''<Искомое значение присутствует в диапазоне (диапазонах) (INT)>''
|type=2
|status=2
|visual=0
|description=Магическая функция проверяет, присутствует ли значение поиска в диапазонах значений для проверки. Искомое значение может быть числом, датой или строкой. Функция может упростить конструкцию ''If''. В зависимости от режима (первый аргумент), для проверки используются строгие или нестрогие неравенства. В зависимости от режима, функция возвращает ''1'', если искомое значение присутствует по крайней мере в одном диапазоне или во всех диапазонах.
}}
{{function entry
|name=[[CreateOLE]]
|form='''CreateOLE'''(''<Идентификатор объекта OLE (STRING)>''):''<Новый объект OLE (OLE)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый объект OLE (COM) по строке идентификатора
}}
{{function entry
|name=[[CreateThreadedOLE]]
|form='''CreateThreadedOLE'''(''<Идентификатор объекта OLE (STRING)>''):''<Новый объект OLE (OLE)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый объект OLE (COM) по строке идентификатора. Объект может быть доступен в любом потоке, не только в том, который создал объект. Вызовы к таким объектам осуществляются несколько медленнее.
}}
{{function entry
|name=[[OLE.SetTimeout|SetTimeout]]
|form={{Grey|OLE.}}'''SetTimeout'''({{Optional|<Время ожидания исполнения команд в мс. (INT)>}}):''<Предыдущее время ожидания исполнения команд в мс. (INT)>''
|type=1
|status=0
|visual=0
|description=Функция задает или получает для объекта максимальное время ожидания исполнения команд. По умолчанию при создании объекта, это время равно 0 (не ограничено). При истечении времени ожидания система произведет отсоединение от текущего OLE-объекта и выполнявшаяся функция вызовет исключение.
}}
{{function entry
|name=[[IsMultithreaded]]
|form='''IsMultithreaded'''(''<Аргумент>''):''<Является ли объект многопоточным (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, является ли объект, содержащийся в переменной-аргументе многопоточным или однопоточным (см. статью [[Объекты]])
}}
{{function entry
|name=[[SetMultiThreaded]]
|form='''SetMultiThreaded'''(''<Аргумент>'')
|type=1
|status=2
|visual=0
|description=Функция позволяет безусловно установить флаг многопоточности на объекте, содержащемся в переменной-аргументе. Функция может использоваться при работе с объектами, содержащими ссылки на самого себя (см. статью [[Объекты]])
}}
{{function entry
|name=[[LockObject]]
|form='''LockObject'''(''<Аргумент>'')
|type=1
|status=2
|visual=0
|description=Функция позволяет заблокировать доступ к сложному объекту из других программных потоков. Обычно система выполняет это действие автоматически, однако, если состояние непротиворечивости объекта требует нескольких вызовов функций изменения, эта функция может стать гарантом его непротиворечивости в других потоках. После окончания выполнения кода изменения объекта, необходимо вызвать функцию ''UnlockObject''. Функция не должна применяться к визуальным объектам, кроме того внутри кода изменения существуют ограничения по вызову визуальных функций.
}}
{{function entry
|name=[[UnlockObject]]
|form='''UnlockObject'''(''<Аргумент>'')
|type=1
|status=2
|visual=0
|description=Функция позволяет разблокировать доступ к сложному объекту, заблокированному ранее с помощью функции ''LockObject''.
}}
{{function entry
|name=[[LockCount]]
|form='''LockCount'''(''<Аргумент>''):''<Количество вложенных блокировок (INT)>''
|type=1
|status=2
|visual=0
|description=Функция позволяет получить количество вложенных блокировок объекта (осуществленных с помощью функции [[LockObject]] или системой) даже если объект не удерживается текущим потоком (таким образом ее можно также использовать, как индикатор того, что объект заблокирован другим потоком, если известно, что текущий поток его не блокировал, однако, нужно понимать, что объекты, могут автоматически блокироваться системой на время вызова функций, вероятность обнаружить такую блокировку может быть высока, если объект, используется в потоке, который выполняет какую-то работу в данный момент).
}}
{{function entry
|name=[[Message]]
|form='''Message'''(''<Аргумент>''{{Optional|,<Тип текста (STRING)>{{Default|{{Eq}}""}},<Интерактивный объект 1 для подстановки в текст>,<Интерактивный объект 2 для подстановки в текст>...}})
|type=1
|status=2
|visual=1
|description=Функция выводит строковое представление аргумента в [[Визуальный лог клиента|лог]] клиента, при этом текст может быть выделен, если необходимо, как ошибка или информация.
}}
{{function entry
|name=[[LoadModule]]
|form='''LoadModule'''(''<Способ вызова (INT)>'',''<Путь или имя базы данных (STRING)>''{{OptionalByRef|,<Параметр>,<Опция>}}{{Optional|,<Имя модуля (STRING)>{{Default|{{Eq}}"Module"}},<Имя формы (STRING)>{{Default|{{Eq}}"SelectForm"}}}}{{OptionalByRef|,<Серийный номер потока, в котором происходит исполнение (INT)>}}):''<Результат модального выполнения>''
|type=1
|status=2
|visual=1
|description=Функция позволяет загружать и инициировать выполнение произвольного модуля с произвольной формой. Модуль может быть загружен как модально к текущему потоку (если текущий поток не является корневым), так и создавать новый поток, передавая ему два аргумента. В случае модального исполнения, функция не возвратит результат до тех пор, пока модуль не закончит работы, при этом, модуль может возвратить результат и изменить переданные параметры, если они представляли собой переменные.
}}
{{function entry
|name=[[LoadToolForm]]
|form='''LoadToolForm'''(''<Способ вызова (INT)>'',''<Режим загрузки формы (INT)>'',''<Путь или имя базы данных (STRING)>''{{OptionalByRef|,<Параметр>,<Опция>}}{{Optional|,<Имя формы (STRING)>{{Default|{{Eq}}"Form"}}}}{{OptionalByRef|,<Объект открытой формы (FORM)>}}):''<Результат, возвращенный при инициализации формы>''
|type=1
|status=2
|visual=1
|description=Функция позволяет загружать произвольную форму в режиме инструментария. Формы в таком режиме не имеют модулей и работают в контексте текущего модуля, либо в контексте корневого модуля, в зависимости от параметров загрузки. Функция может возвратить серийный номер открытой формы, чтобы программа могла осуществлять переговоры с ней с помощью отсылки сообщений.
}}
{{function entry
|name=[[ImportFunctionsFromModule]]
|form='''ImportFunctionsFromModule'''(''<Путь или имя базы данных (STRING)>''{{Optional|,<Имя модуля (STRING)>{{Default|{{Eq}}"Module"}},<Пространство имен (STRING)>{{Default|{{Eq}}""}}}})
|type=1
|status=0
|visual=0
|description=Функция позволяет импортировать в текущий выполняющийся модуль функции другого модуля, после импорта функции можно исполнять, как будто они были созданы в текущем модуле. Если при импорте, имя создаваемой функции уже существует, будет вызвано исключение. Часть кода, не находящаяся внутри функций, будет игнорирована. Чтобы увеличить устойчивость загрузки из разных источников, можно использовать дополнительный идентификатор -- пространство имен. Идентификатор не должен содержать знаков, недоступных в наименованиях функций и знаков ".". После импорта новые функции можно будет вызвать с помощью конструкции <code><Идентификатор>.<Имя функции>([...])</code>. Функцию можно использовать для увеличения функциональности, доступной во внешних модулях, к примеру, если модуль производит выгрузку, которая зависит от поключенного устройства, можно импортировать функции модуля, который был создан для конкретного устройства.
}}
{{function entry
|name=[[ImportFunctionsFromText]]
|form='''ImportFunctionsFromText'''(''<Строка с кодом для компиляции (STRING)>''{{Optional|,<Пространство имен (STRING)>{{Default|{{Eq}}""}}}})
|type=1
|status=0
|visual=0
|description=Функция позволяет импортировать в текущий выполняющийся модуль функции из строки текста. Перед началом импорта, текст будет скомпилирован в контексте текущего модуля. Если при импорте, имя создаваемой функции уже существует, будет вызвано исключение. Часть кода, не находящаяся внутри функций, будет игнорирована. Чтобы увеличить устойчивость загрузки из разных источников, можно использовать дополнительный идентификатор -- пространство имен. Идентификатор не должен содержать знаков, недоступных в наименованиях функций и знаков ".". После импорта новые функции можно будет вызвать с помощью конструкции <code><Идентификатор>.<Имя функции>([...])</code>. Функцию можно использовать для увеличения функциональности, доступной во внешних модулях, к примеру, если модуль производит выгрузку, которая зависит от поключенного устройства, можно импортировать функции текста кода, который был создан для конкретного устройства.
}}
{{function entry
|name=[[RemoveImportedFunctions]]
|form='''RemoveImportedFunctions'''()
|type=1
|status=0
|visual=0
|description=Функция удаляет из контекста текущего модуля все функции, импортированные из других модулей или текстовых строк (см. [[ImportFunctionsFromModule]] и [[ImportFunctionsFromText]]).
}}
{{function entry
|name=[[OpenObject]]
|form='''OpenObject'''(''<Объект базы данных (DB)>'',''<Режим просмотра (INT)>'',''<Способ вызова (INT)>''{{OptionalByRef|,<Параметр>,<Опция>}}{{Optional|,<Имя модуля (STRING)>,<Имя формы (STRING)>}}):''<Результат модального выполнения>''
|type=1
|status=2
|visual=1
|description=Функция позволяет загружать и инициировать выполнение модуля и формы, связанных с заданным объектом, при этом сам объект загружается в форму для редактирования или просмотра. Модуль может быть загружен как модально к текущему потоку (если текущий поток не является корневым), так и создавать новый поток, передавая ему два аргумента. В случае модального исполнения, функция не возвратит результат до тех пор, пока модуль не закончит работы, при этом, модуль может возвратить результат и изменить переданные параметры, если они представляли собой переменные. Функция может возвратить особые текстовые результаты, если требуемый объект был заблокирован другим пользователем. Для полной информации см. описание функции.
}}
{{function entry
|name=[[SelectObject]], '''AskObject'''
|form='''SelectObject'''(''<Путь или имя базы данных (STRING)>''{{OptionalByRef|,<Параметр>,<Опция>}}{{Optional|,<Имя модуля (STRING)>{{Default|{{Eq}}"Module"}},<Имя формы (STRING)>{{Default|{{Eq}}"SelectForm"}},<Объект для позиционирования>,<Наименование объекта формы, осуществляющего выбор (STRING)>,<Заголовок формы (STRING)>,<Дополнительные установки (INT)>}}):''<Выбранный объект или пустое значение>''
|type=1
|status=2
|visual=1
|description=Функция позволяет загружать и инициировать выполнение модуля и формы в модальном режиме для выбора объекта базы данных из списка объектов, при этом возможно начальное позиционирование на указанный объект, определение требуемого объекта формы списка объектов (если их несколько), изменение заголовка формы, использование других возможностей. Функция не возвратит результат до тех пор, пока модуль не закончит работы, при этом, модуль может изменить переданные параметры, если они представляли собой переменные.
}}
{{function entry
|name=[[MassSelectObjects]]
|form='''MassSelectObjects'''(''<Имя функции для принятия результата выбора (STRING)>'',''<Путь или имя базы данных (STRING)>''{{OptionalByRef|,<Параметр>,<Опция>}}{{Optional|,<Имя модуля (STRING)>{{Default|{{Eq}}"Module"}},<Имя формы (STRING)>{{Default|{{Eq}}"SelectForm"}},<Объект для позиционирования>,<Наименование объекта формы, осуществляющего выбор (STRING)>,<Заголовок формы (STRING)>,<Параметр функции принятия выбора>,<Дополнительные установки (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=1
|description=Функция позволяет загружать и инициировать выполнение модуля и формы в модальном режиме для выбора множества объектов базы данных из списка объектов, при этом возможно начальное позиционирование на указанный объект, определение требуемого объекта формы списка объектов (если их несколько), изменение заголовка формы, использование других возможностей. В момент выбора очередного объекта пользователем, система вызывает особую функцию выбора (возможно с доп. параметром), имя которой задается в первом аргументе. Функция не возвратится до тех пор, пользователь не закроет исполняемый модуль, при этом, модуль может изменить переданные параметры, если они представляли собой переменные.
}}
{{function entry
|name=[[SendMessageToForm]]
|form='''SendMessageToForm'''(''<Серийный номер формы (INT)>'',''<Код сообщения (INT)>''{{OptionalByRef|,<Параметр>,<Опция>}}{{Optional|,<Гарантировать доставку (INT)>{{Default|{{Eq}}1}},<Имя макроса или страницы объекта формы (STRING)>{{Default|{{Eq}}""}}}}):''<Сообщение не было доставлено 0 или результат выполнения OnMessage>''
|type=1
|status=1
|visual=1
|description=Функция осуществляет доставку пользовательского сообщения с параметрами указанной по серийному номеру форме. Для формы будет вызвано визуальное событие [[Студия/OnMessage|OnMessage]]. Доставка также может быть осуществлена макросу, располагающемуся на форме или указанной по имени странице страничного элемента. Функция возвращается после обработки сообщения формой или ошибке при доставке.
}}
{{function entry
|name=[[PostMessageToForm]]
|form='''PostMessageToForm'''(''<Серийный номер формы (INT)>'',''<Код сообщения (INT)>''{{Optional|,<Параметр>,<Опция>,<Гарантировать доставку (INT)>{{Default|{{Eq}}1}},<Имя макроса или страницы объекта формы (STRING)>{{Default|{{Eq}}""}}}}):''<Сообщение было отправлено 0 или 1 (INT)>''
|type=1
|status=1
|visual=1
|description=Функция осуществляет доставку пользовательского сообщения с параметрами указанной по серийному номеру форме. Для формы будет вызвано визуальное событие [[Студия/OnMessage|OnMessage]]. Доставка также может быть осуществлена макросу, располагающемуся на форме или указанной по имени странице страничного элемента. Функция возвращается сразу после успешной отправки сообщения или ошибке при отправке. Измененные формой параметры не будут переданы назад.
}}
{{function entry
|name=[[BroadcastGlobalMessage]]
|form='''BroadcastGlobalMessage'''(''<Код сообщения (INT)>'',''<Содержимое сообщения (STRING)>''{{Optional|,<Для всех пользователей (INT)>{{Default|{{Eq}}0}}}}):''<Сообщение успешно отправлено (INT)>''
|type=1
|status=2
|visual=1
|description=Функция рассылает пакеты, которые вызывают исполнения событий ''OnMessage'' для всех открытых форм (в момент когда они активны или когда они станут активными), в текущей системе или глобально всем клиентам сервера. В последнем случае, нужно быть осторожным, чтобы не перегружать сервер внезапным большим количеством запросов, даже с учетом того, что серверная часть использует особую систему замедления отправки запросов клиентам.
}}
{{function entry
|name=[[BroadcastMessage]]
|form='''BroadcastMessage'''(''<Код сообщения (INT)>''{{Optional|,<Параметр>,<Опция>,<Тип форм-получателей (INT)>{{Default|{{Eq}}1}},<Имя макроса или страницы объекта формы (STRING)>{{Default|{{Eq}}""}}}}):''<Сообщение было отправлено 0 или 1 (INT)>''
|type=1
|status=0
|visual=1
|description=Функция осуществляет доставку пользовательского сообщения с параметрами всем открытым в данный момент в системе формам с указанным типом. Для форм будет вызвано визуальное событие [[Студия/OnMessage|OnMessage]]. Доставка также может быть осуществлена макросу, располагающемуся на формах или указанной по имени странице страничного элемента. Функция возвращается сразу после успешной отправки сообщений или ошибке при отправке. Измененные формой параметры не будут переданы назад.
}}
{{function entry
|name=[[BroadcastChannelSubscribe]]
|form='''BroadcastChannelSubscribe'''(''<Имя канала (STRING)>''{{Optional|,<Форма-получатель или ее серийный номер (FORM,INT)>{{Default|{{Eq}}0}}}}):''<Числовой идентификатор канала (INT)>''
|type=1
|status=2
|visual=0
|description=Функция подписывается на сообщения глобального канала сообщений, заданного по его имени (первый аргумент). Если указана форма-получатель сообщений, они будут приходить в виде события OnMessage в момент, когда форма ожидает действий пользователя (idle). Если форма не указана, программе необходимо получать сообщения самостоятельно с помощью функции [[BroadcastChannelReceiveMessage]]. Подписка действует для текущего потока, если сообщения не забираются, они будут накапливаться на сервере. Для отказа от подписки, используйте [[BroadcastChannelUnsubscribe]]. Подписка удаляется автоматически, когда поток с подпиской заканчивает работу. Если указана форма и она будет закрыта, но поток продолжит работать, подписка не будет отменена (однако сообщения приходить не будут, так как отсутствует форма). Функция возвращает цифровой идентификатор канала, по которому к нему можно выполнять обращения (чуть быстрее, чем по имени). Идентификатор корректен до момента вызова [[BroadcastChannelUnsubscribe]].
}}
{{function entry
|name=[[BroadcastChannelUnsubscribe]]
|form='''BroadcastChannelUnsubscribe'''(''<Имя или идентификатор канала (INT,STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция отменяет подписку на сообщения глобального канала сообщений, заданного по его имени или идентификатору (первый аргумент). См. описание [[BroadcastChannelSubscribe]].
}}
{{function entry
|name=[[BroadcastChannelSendMessage]]
|form='''BroadcastChannelSendMessage'''(''<Имя или идентификатор канала (INT,STRING)>'',''<Код сообщения (INT)>'',''<Содержимое сообщения (STRING)>''):''<Количество отосланных сообщений (INT)>''
|type=1
|status=2
|visual=0
|description=Функция выполняет отсылку сообщения (состоящего из произвольного числового идентификатора и произвольного текста) всем абонентам, подписанным на канал сообщений, заданный по его имени или идентификатору. Для подписчиков, использующих форму (см. [[BroadcastChannelSubscribe]]), сообщения доставляются сразу же (однако, может пройти долгое время, пока форма закончит текущую работу, и даже когда она ожидает действий пользователя, может пройти до нескольких секунд). Доставка будет осуществляться по такому же принципу, как доставляются сообщения [[BroadcastGlobalMessage]]. Если форма больше не существует, сообщение для таких подписчиков доставлены не будут. Подписчикам без указания формы, подтребуется вызвать функцию [[BroadcastChannelReceiveMessage]], чтобы забрать первое из сообщений из очереди. Разрешается использовать функцию из потоков, которые не подписаны на канал, для которого происходит отправка. Функцию также можно использовать для каналов, на которые не подписан ни один абонент (в этом случае, сообщение будет проигнорировано). Функция возвращает количество отосланных сообщений (которое совпадает с количеством абонентов канала на момент вызова функции).
}}
{{function entry
|name=[[BroadcastChannelReceiveMessage]]
|form='''BroadcastChannelReceiveMessage'''(''<Имя или идентификатор канала (INT,STRING)>''{{Optional|,<Ожидать нового сообщения, мс. (INT)>{{Default|{{Eq}}0}}}}{{OptionalByRef|,<Код сообщения (INT)>,<Содержимое сообщения (STRING)>,<Отправитель (STRING)>}}):''<Получено новое сообщение (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выполняет получение одного сообщения из очереди сообщений для канала сообщений, заданного по его имени или идентификатору. Полученные сообщения удаляются из очереди. Функция используется только для абонентов подписки, для которых при подписке не была указана форма (см. [[BroadcastChannelSubscribe]]). Если сообщение в очереди отсутствует, функция может ожидать его появления некоторое время (заданное вторым аргументом). Функция возвращает '''1''', если сообщение получено и '''0''' в ином случае. Полученное сообщение возвращается в виде трех переменных -- числовой идентификатор сообщение, текст сообщения и текстовый код, определяющий отправителя (состоящий из номера канала клиента и идентификатора потока клиента).
}}
{{function entry
|name=[[ModuleTag]]
|form='''ModuleTag'''({{Optional|<Новое значение>}}):''<Предыдущее значение>''
|type=1
|status=2
|visual=0
|description=Функция получает или изменяет свободную переменную, привязанную к текущему (исполняемому) модулю. Значение может использоваться по усмотрению разработчика.
}}
{{function entry
|name=[[IsKeyComboActive]]
|form='''IsKeyComboActive'''(''<Комбинация клавиш (STRING)>''):''<Комбинация активирована в данный момент, 0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, активирована ли в данный момент пользователем заданная комбинация клавиш (к примеру, <code>"Ctrl+Alt+D"</code>).
}}
{{function entry
|name=[[ObjectToString]]
|form='''ObjectToString'''(''<Значение>''):''<Значение, закодированное в строку (ANSI STRING)>''
|type=1
|status=2
|visual=0
|description=Функция кодирует внутрисистемным образом заданное значение в строку, значение может быть почти любым. К примеру, может представлять собой список, таблицу, объект базы данных, OLE-объект и пр.
}}
{{function entry
|name=[[ObjectFromString]]
|form='''ObjectFromString'''(''<Закодированное значение (STRING)>''):''<Значение>''
|type=1
|status=2
|visual=0
|description=Функция перекодирует строку в значение, закодированное внутрисистемным образом.
}}
{{function entry
|name=[[ObjectToFile]]
|form='''ObjectToFile'''(''<Значение>'',''<Имя файла (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция кодирует внутрисистемным образом заданное значение в строку, значение может быть почти любым. К примеру, может представлять собой список, таблицу, объект базы данных, OLE-объект и пр. Значение, затем, будет сохранено в заданный файл. При наличии ошибки при сохранении в файл, будет вызвано исключение.
}}
{{function entry
|name=[[ObjectFromFile]]
|form='''ObjectFromFile'''(''<Имя файла (STRING)>''):''<Значение>''
|type=1
|status=2
|visual=0
|description=Функция получает строку из указанного файла и перекодирует строку в значение, закодированное внутрисистемным образом.
}}
{{function entry
|name=[[Swap]]
|form='''Swap'''({{ByRef|<Переменная 1>,<Переменная 2>}})
|type=1
|status=2
|visual=0
|description=Функция меняет местами значения переменных.
}}
{{function entry
|name=[[DoesFunctionExist]]
|form='''DoesFunctionExist'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска или компилированная функция (INT, COMPILEDFUNCTION)>{{Default|{{Eq}}0}}}}):''<Существует ли функция (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, существует ли функция с указанным именем в текущем контексте исполнения, способ поиска задается вторым аргументом.
}}
{{function entry
|name=[[ArgumentsNumber]]
|form='''ArgumentsNumber'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска или компилированная функция (INT, COMPILEDFUNCTION)>{{Default|{{Eq}}0}}}}):''<Количество аргументов (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает количество аргументов функции с указанным именем в текущем контексте исполнения, способ поиска задается вторым аргументом. Если искомая функция не существует, будет возвращено значение -1.
}}
{{function entry
|name=[[ExecuteFunction]]
|form='''ExecuteFunction'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска или компилированная функция (INT, COMPILEDFUNCTION)>{{Default|{{Eq}}0}}{{ByRef|,<Аргумент 1>,<Аргумент 2>...}}}}):''<Результат исполнения функции>''
|type=1
|status=2
|visual=0
|description=Функция инициирует исполнение функции с указанным именем в текущем контексте исполнения с заданными аргументами, способ поиска задается вторым аргументом. Если искомая функция не существует, пропущен обязательный аргумент или заданное количество аргументов слишком велико, будет создано исключение. Функция может использоваться как более быстрая альтернатива функции <code>Eval</code> (если необходимо вызвать только одну функцию).
}}
{{function entry
|name=[[AsyncExecuteFunction]]
|form='''AsyncExecuteFunction'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска или компилированная функция (INT, COMPILEDFUNCTION)>{{Default|{{Eq}}0}},<Аргумент 1>,<Аргумент 2>...}}):''<Результат исполнения функции>''
|type=1
|status=0
|visual=0
|description=Функция инициирует исполнение функции с указанным именем в текущем контексте исполнения с заданными аргументами, способ поиска задается вторым аргументом. Если искомая функция не существует, пропущен обязательный аргумент, заданное количество аргументов слишком велико или исполнение в визуальном контексте невозможно, будет создано исключение. Функция будет исполнена в визуальном контексте [[Студия/Визуальные события|асинхронно]], в момент, когда он будет свободен (если это не произойдет в течение некотрого промежутка времени, функция не будет выполнена). Подобный способ исполнения можно использовать, к примеру, в обработчике события OnOpen, с тем, чтобы функция была запущена когда обработчик закончит исполнение и форма будет ожидать действия пользователя. См. также [[Form.InvokeEventAsync]].
}}
{{function entry
|name=[[GlobalBegPeriodDate]]
|form='''GlobalBegPeriodDate'''({{Optional|<Дата начала периода изменения периодических значений (DATE)>}}):''<Предыдущая дата начала периода изменения периодических значений (DATE)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает или/и изменяет дату начала изменения периодических значений при визуальном сохранении элементов с наличием таких значений.
}}
{{function entry
|name=[[GlobalEndPeriodDate]]
|form='''GlobalEndPeriodDate'''({{Optional|<Дата окончания периода изменения периодических значений (DATE)>}}):''<Предыдущая дата окончания периода изменения периодических значений (DATE)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает или/и изменяет дату окончания изменения периодических значений при визуальном сохранении элементов с наличием таких значений. Данная дата совпадает с датой просмотра периодических значений в визуально открытом элементе базы данных или таблице с такими элементами.
}}
{{function entry
|name=[[MinPeriodicalAccessDate]]
|form='''MinPeriodicalAccessDate'''({{Optional|<Новая минимальная дата просмотра периодических реквизитов (DATE)>}}):''<Текущая минимальная дата просмотра периодических реквизитов (DATE)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает и/или изменяет минимальную дату просмотра периодических значений реквизитов в стандартных формах периодических реквизитов. Значения с датой менее данной не будут отображаться при выводе формы просмотра или редактирования, невозможно будет также создать новые записи с датами, ранее указанной. Дата используется для всех потоков клиента, но не влияет на программное получение периодических данных.
}}
{{function entry
|name=[[MinPeriodicalEditDate]]
|form='''MinPeriodicalEditDate'''({{Optional|<Новая минимальная дата редактирования периодических реквизитов (DATE)>}}):''<Текущая минимальная дата редактирования периодических реквизитов (DATE)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает и/или изменяет минимальную дату редактирования периодических значений реквизитов в стандартных формах периодических реквизитов. Значения с датой менее данной не будут доступны для редактирования, невозможно будет также создать новые записи с датами, ранее указанной. Дата используется для всех потоков клиента, но не влияет на программное получение периодических данных.
}}
{{function entry
|name=[[GlobalDefaultSystemFont]]
|form='''GlobalDefaultSystemFont'''({{Optional|<Новое значение шрифта системы по умолчанию (STRING)>}}):''<Предыдущее значение шрифта системы по умолчанию (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает или/и изменяет внутрисистемный шрифт по умолчанию. Будут обновлены значения глобальных коэффициентов масштабирования форм. В зависимости от новых установок, текст и формы будут выглядеть крупнее или мельче. Шрифт умолчания для систем на Windows XP и более ранних "MS Sans Serif, 8" (не поддерживает международные символы), умолчания для более новых систем "Tahoma, 8" (поддерживает международные символы).
}}
{{function entry
|name=[[GlobalFormScaleFactorX]]
|form='''GlobalFormScaleFactorX'''({{Optional|<Новое значение горизонтального коэффициента глобального масштабирования форм (REAL)>}}):''<Предыдущее значение горизонтального коэффициента глобального масштабирования форм (REAL)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает или/и изменяет значение горизонтального коэффициента глобального масштабирования форм. Значение этого коэффициента по умолчанию равно 1. Если значение больше 1, элементы всех форм будут растянуты по горизонтали, если меньше 1, элементы будут сжаты.
}}
{{function entry
|name=[[GlobalFormScaleFactorY]]
|form='''GlobalFormScaleFactorY'''({{Optional|<Новое значение вертикального коэффициента глобального масштабирования форм (REAL)>}}):''<Предыдущее значение вертикального коэффициента глобального масштабирования форм (REAL)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает или/и изменяет значение вертикального коэффициента глобального масштабирования форм. Значение этого коэффициента по умолчанию равно 1. Если значение больше 1, элементы всех форм будут растянуты по вертикали, если меньше 1, элементы будут сжаты.
}}
{{function entry
|name=[[DefaultTablesRestrictMode]]
|form='''DefaultTablesRestrictMode'''({{Optional|<Новое значение режима доступа по умолчанию для новых таблиц (INT)>}}):''<Предыдущее значение режима доступа по умолчанию для новых таблиц (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает или/и изменяет значение режима доступа по умолчанию для новых таблиц. При создании таблицы режим доступа устанавливается в соответствии с режимом по умолчанию. Режим можно изменить с помощью свойства [[Table.Restrict]].
}}
{{function entry
|name=[[DefaultHighlightMode]]
|form='''DefaultHighlightMode'''(''<Режим подсветки таблиц по умолчанию (INT)>''{{Optional|,<Цвет нечетных строк (INT)>,<Процент цвета нечетных строк (INT)>,<Цвет выделения строки или столбца курсора (INT)>,<Процент цвета выделения строки или столбца курсора (INT)>}})
|type=1
|status=2
|visual=1
|description=Функция изменяет глобальный режим подсветки строк всех таблиц. Для изменения подсветки конкретной таблицы см. функцию [[Tab.HighlightMode]].
}}
{{function entry
|name=[[Eval]]
|form='''Eval'''(''<Выражение для вычисления (STRING)>''):''<Результат вычисления выражения>''
|type=1
|status=2
|visual=0
|description=Функция производит компиляцию и вычисление выражения, заданного на внутреннем языке. Выражение исполняется в контексте текущей функции с доступом к именам, совпадающим с доступом из кода, вызвавшего функцию. Функция вызывает прерывание, если аргумент не может быть скомпилирован из-за ошибки, либо он не является вычисляемым выражением. Функция возвращает результат вычисления выражения.
}}
{{function entry
|name=[[Exec]]
|form='''Exec'''(''<Блок для исполнения или компилированная функция (STRING, COMPILEDFUNCTION)>''):''<Исполнение завершено удачно 1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит компиляцию и исполнение блока текста, заданного на внутреннем языке, или компилированной заранее функции. Блок исполняется в контексте текущей функции с доступом к именам, совпадающим с доступом из кода, вызвавшего функцию. Функция вызывает прерывание, если аргумент не может быть скомпилирован из-за ошибки. Исполняемый код обладает свойствами кода внутри новой функции (счетчик циклов равен нулю, создаваемые переменные не будут переданы в вызывавшую функцию), однако, имеет доступ к локальным переменным вызывавшей функции.
}}
{{function entry
|name=[[ExecEx]]
|form='''ExecEx'''(''<Блок для исполнения или компилированная функция (STRING, COMPILEDFUNCTION)>''{{Optional|,<Установки ограничения исполнения (INT)>{{Default|{{Eq}}0}},<Ограничение по времени в мс. (INT)>{{Default|{{Eq}}0}},<Наименование функции, получающей выводимую в лог информацию (STRING)>,<Глубина поиска (INT)>{{Default|{{Eq}}0}},<Ограничение по использованию памяти потоком (INT)>{{Default|{{Eq}}0}}}}):''<Значение переменной Result при исполнении функции>''
|type=1
|status=2
|visual=0
|description=Функция производит компиляцию и исполнение блока текста, заданного на внутреннем языке, или компилированной заранее функции в контролируемой среде исполнения. Аргументы могут ограничить возможности, предоставляемые исполняемому коду, как функционально (некоторые группы функций будут запрещены к использованию), или в заданных пределах доступа к переменным и функциям, так и с ограничением по времени исполнения или по выделяемой памяти. Функция может использоваться для исполнения кода, который может быть опасным или злонамеренным, либо кода из неизвестного источника.
}}
{{function entry
|name=[[Compile]]
|form='''Compile'''(''<Блок для компилирования (STRING)>''{{Optional|,<Степень изолированности (INT)>{{Default|{{Eq}}0}},<Добавочные переменные (STRING)>,<Свойства исходного текста для отладчика (STRING,INT)>}}):''<Компилированная функция в виде объекта (COMPILEDFUNCTION)>''
|type=1
|status=2
|visual=0
|description=Функция производит компиляцию блока текста, заданного на внутреннем языке, и возвращает объект, представляющий результат компиляции. В зависимости от второго аргумента, блок может компилироваться в контексте текущей функции, глобальных модулей или без доступа к внешним переменным и функциям. Функция вызывает прерывание, если компиляция прервана из-за ошибки. Результирующий объект можно использовать многократно с функциями [[Exec]] и [[ExecEx]], это быстрее, чем компилировать блок текста при каждом вызове.
}}
{{function entry
|name=[[LoadFunctionFromBuffer]]
|form='''LoadFunctionFromBuffer'''(''<Экспортированная в память компилированная функция (BUFFER, STRING)>''{{Optional|,<Путь к исходному тексту (STRING),<Исходный текст (STRING)>}}):''<Компилированная функция в виде объекта (COMPILEDFUNCTION)>''
|type=1
|status=2
|visual=0
|description=Функция производит импорт из памяти экспортированной ранее с помощью [[SaveFunctionToBuffer]] компилированной функции. Функция возвращает объект аналогичный результату функции [[Compile]], который можно использовать многократно с функциями [[Exec]] и [[ExecEx]].
}}
{{function entry
|name=[[SaveFunctionToBuffer]]
|form='''SaveFunctionToBuffer'''(''<Компилированная функция (COMPILEDFUNCTION)>''):''<Экспортированная в память компилированная функция (BUFFER)>''
|type=1
|status=2
|visual=0
|description=Функция производит экспорт в память компилированной функции. Функция возвращает буфер с содержимым подобным файлам с компилированными модулями системы.
}}
{{function entry
|name=[[GetModuleFunction]]
|form='''GetModuleFunction'''({{Optional|<Уровень родительской функции от текущей (INT)>{{Default|{{Eq}}0}}}}):''<Требуемая функция в виде объекта (COMPILEDFUNCTION)>''
|type=1
|status=2
|visual=0
|description=Функция отдает объект компилированной функции, находящейся на требуемом уровне над текущей исполняемой функцией (этот объект, если найден, всегда включает текущую исполняемую функцию). В дальнейшем этот объект можно использовать для вызова функций по именам (см. [[ExecuteFunction]]), или экспортирования функции.
}}
{{function entry
|name=[[InfoPanelClose]]
|form='''InfoPanelClose'''({{Optional|<Очистить панель (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=1
|description=Функция закрывает информационную панель (панель логов) визуального клиента, очищая текущий текст в ней при необходимости.
}}
{{function entry
|name=[[InfoPanelClear]]
|form='''InfoPanelClear'''()
|type=1
|status=2
|visual=1
|description=Функция очищает текст в информационной панели (панели логов) визуального клиента.
}}
{{function entry
|name=[[InfoPanelOpen]]
|form='''InfoPanelOpen'''()
|type=1
|status=2
|visual=1
|description=Функция открывает информационную панель (панель логов) визуального клиента.
}}
{{function entry
|name=[[IsInfoPanelOpen]]
|form='''IsInfoPanelOpen'''():''<Результат 0 или 1 (INT)>''
|type=1
|status=2
|visual=1
|description=Функция проверяет, открыта ли в данный момент информационная панель (панель логов) визуального клиента.
}}
{{function entry
|name=[[HideControlPanel]]
|form='''HideControlPanel'''(''<Идентификатор панели инструментов (STRING)>'')
|type=1
|status=2
|visual=1
|description=Функция прячет всех окон указанную панель инструментов. Пользовательские панели инструментов задаются в свойствах проекта, кроме пользовательских панелей, можно использовать специальные следующие идентификаторы для адресации стандартных панелей: '''COMMON''', '''TABLE''', '''TEXT'''. См. также функцию для определенного окна [[Form.HideControlPanel]].
}}
{{function entry
|name=[[ShowControlPanel]]
|form='''ShowControlPanel'''(''<Идентификатор панели инструментов (STRING)>'')
|type=1
|status=2
|visual=1
|description=Функция отображает для всех окон указанную панель инструментов. Пользовательские панели инструментов задаются в свойствах проекта, кроме пользовательских панелей, можно использовать специальные следующие идентификаторы для адресации стандартных панелей: '''COMMON''', '''TABLE''', '''TEXT'''. См. также функцию для определенного окна [[Form.ShowControlPanel]].
}}
{{function entry
|name=[[InterThreadWindowsMode]]
|form='''InterThreadWindowsMode'''({{Optional|<Новый режим отображения окон всех потоков (INT)>}}):''<Текущий режим отображения окон всех потоков (INT)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает и/или изменяет текущий режим отображения окон всех потоков. Для более подробной информации см. описание.
}}
{{function entry
|name=[[StandardOutputHook]]
|form='''StandardOutputHook'''({{Optional|<Тип перехватываемого события (INT)>{{Default|{{Eq}}0}},<Наименование функции, вызываемой при перехвате (STRING)>,<Глубина поиска (INT)>{{Default|{{Eq}}0}},<Параметр для передачи в функцию>}}):''<Наименование предыдущей функции-перехватчика (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция добавляет или удаляет ссылку на функцию-перехватчик визуальных событий (к примеру, вывода информации в лог или панель состояния формы). Может использоваться, к примеру, для получения и вывод на экран информации об обработках, протекающих в скрытом потоке. Крайне желательно использование конструкции <code>Try .. Finally</code>, чтобы гарантированно вернуть предыдущее состояние перехватчика после того, как работа будет завершена.
}}
{{function entry
|name=[[RemoveUnacceptablePathChars]]
|form='''RemoveUnacceptablePathChars'''(''<Имя файла, которое необходимо очистить от недопустимых символов (STRING)>''{{Optional|,<Заменить недопустимые символы на (STRING)>{{Default|{{Eq}}""}}}}):''<Очищенное имя файла (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция очищает имя файла (без имен папок) от непечатных и недопустимых символов (удаляются сл. печатные символы <code><, >, :, ", /, \, |, ?, *</code>). Удаляемые символы могут быть заменены на указанный.
}}
{{function entry
|name=[[GetPath]]
|form='''GetPath'''(''<Имя файла с папками (STRING)>''):''<Имена папок без имени файла (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает из полного имени файла строку пути с папками (пример, строка <code>C:\Folder\My.File.txt</code> будет превращена в <code>C:\Folder\</code>).
}}
{{function entry
|name=[[GetFileName]]
|form='''GetFileName'''(''<Имя файла с папками (STRING)>''):''<Имя файла без папок (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает из полного имени файла с папками, имя файла без папок (пример, строка <code>C:\Folder\My.File.txt</code> будет превращена в <code>My.File.txt</code>).
}}
{{function entry
|name=[[GetExt]]
|form='''GetExt'''(''<Имя файла (STRING)>''):''<Расширение файла (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает из имени файла его расширение (пример, строка <code>C:\Folder\My.File.txt</code> будет превращена в <code>txt</code>).
}}
{{function entry
|name=[[AddBackslash]]
|form='''AddBackslash'''(''<Путь с папками (STRING)>''):''<Преобразованный путь (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция добавляет в конец строки знак <code>\</code>, если он там уже не присутствует. Пустая строка не будет изменена.
}}
{{function entry
|name=[[RemoveBackslash]]
|form='''RemoveBackslash'''(''<Путь с папками (STRING)>''):''<Преобразованный путь (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция удаляет с конца строки знак <code>\</code>, если он там был.
}}
{{function entry
|name=[[RemoveExt]]
|form='''RemoveExt'''(''<Имя файла (STRING)>''):''<Имя файла без расширения (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция удаляет из имени файла его расширение (пример, строка <code>C:\Folder\My.File.txt</code> будет превращена в <code>C:\Folder\My.File</code>).
}}
{{function entry
|name=[[GetAccountNames]]
|form='''GetAccountNames'''():''<Список учетных записей системы (LIST)>''
|type=1
|status=2
|visual=0
|description=Функция получает список текущих учетных записей системы (сервера). Для исполнения функции необходимо наличие административных прав. Значениями списка будут строки с наименованиями учетных записей, имена списка будут представлены в виде строки с флагами соответствующих учетных записей.
}}
{{function entry
|name=[[UserCredentialsLock]]
|form='''UserCredentialsLock'''({{OptionalByRef|<Заблокировано пользователем (STRING)>}},{{OptionalByRef|<Заблокировано на машине (STRING)>}},{{OptionalByRef|<Время блокировки (DATE)>}}):''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция временно блокирует доступ к редактору учетных записей пользователей (для подготовки к изменениям). Для исполнения функции необходимо наличие административных прав. '''Внимание''': после функции должен следовать блок <code><Try> ... <Finally><EndTry></code> для гарантированного вызова функции разблокировки [[UserCredentialsUnlock]]. Если доступ уже был заблокирован ранее, функция возвращает имя пользователя, машины и время, когда он был заблокирован.
}}
{{function entry
|name=[[UserCredentialsUnlock]]
|form='''UserCredentialsUnlock'''():''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция разблокирует доступ к редактору учетных записей пользователей, заблокированному ранее функцией [[UserCredentialsLock]]. Для исполнения функции необходимо наличие административных прав.
}}
{{function entry
|name=[[UserCredentialsLoad]]
|form='''UserCredentialsLoad'''():''<Файл учетных записей сервера в виде строки (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает строку-содежимое файла учетных записей пользователей с сервера. Для исполнения функции необходимо наличие административных прав. Строку можно использовать, к примеру, для заполнения объекта [[Ini-файл|ini-файла]]. Чтение учетных записей пользователей, без их предвариельной блокировки функцией [[UserCredentialsLock]], разрешено, однако если данные будут изменяться, необходимо убедиться, что вы читаете актуальную копию данных, поэтому необходимо использование [[UserCredentialsLock]] до начала чтения.
}}
{{function entry
|name=[[UserCredentialsStore]]
|form='''UserCredentialsStore'''(''<Файл учетных записей сервера в виде строки (STRING)>''):''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция сохраняет строку-содежимое файла учетных записей пользователей на сервер. Для исполнения функции необходимо наличие административных прав. Перед вызовом данной функции строго рекомендуется использовать функцию блокировки доступа к редактору учетных записей [[UserCredentialsLock]].
}}
{{function entry
|name=[[ValidateUserPassword]]
|form='''ValidateUserPassword'''(''<Имя пользователя (STRING)>'',''<Пароль пользователя (STRING)>''{{OptionalByRef|,''<Ошибка или ответ сервера (STRING,INT)>''}}):''<Упешная проверка учетной записи (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет корректность имени пользователя и пароля с точки зрения учетных записей сервера (иначе говоря, проверяет, сможет ли этот пользователь зарегистрироваться на сервере под указанным паролем). Если регистрация невозможна, функция возвращает краткое описание причины третьим аргументом, если регистрация удачна, функция возвращает уровень полномочий пользователя третьим аргументом.
}}
{{function entry
|name=[[SendChatMessage]]
|form='''SendChatMessage'''(''<Получатели через запятую (STRING)>'',''<Текст сообщения (STRING)>''):''<Сообщение успешно отправлено (INT)>''
|type=1
|status=0
|visual=1
|description=Функция отправляет сообщение во встроенный чат клиентов, зарегистрированных под пользователями, которые указаны, как получатели сообщения в первом аргументе.
}}
{{function entry
|name=[[GetStandardIcon]]
|form='''GetStandardIcon'''(''<Объект базы данных (DB)>''{{Optional|,''<Закрепленная строка папок (INT)>''{{Default|{{Eq}}0}}}}):''<Индекс стандартной иконки объекта (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает индекс стандартной иконки указанного объекта базы данных, данные индексы не совпадают с номерами иконок из библиотеки иконок и могут быть использованы только для столбцов визуальных таблиц, имеющих тип "стандартная иконка". Различное состояние объекта (удален, новый и пр.) отображается разными иконками. Возможно также указание на то, что иконка находится для открытой папки справочника.
}}
{{function footer}}

== Функции диалога с пользователем==
В данный раздел входят функции, осуществляющие вывод на экран различных диалогов для получения информации от пользователя. Большинство этих функций не будет работать в консольных клиентах.
{{function header}}
{{function entry
|name=[[Box]], '''MsgBox'''
|form='''Box'''(''<Сообщение (STRING)>''{{Optional|,<Тип диалога (INT)>{{Default|{{Eq}}Q_OK}}}})
|type=1
|status=2
|visual=1
|description=Функция выводит модальное окно с текстом сообщения, при этом стиль окна будет зависеть от второго аргумента.
}}
{{function entry
|name=[[AskQuestion]]
|form='''AskQuestion'''(''<Текст вопроса (STRING)>'',''<Тип диалога и его кнопки (INT)>''{{Optional|,<Индекс кнопки по умолчанию (INT)>{{Default|{{Eq}}1}}}}):''<Идентификатор выбранной кнопки (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит модальное окно с текстом вопроса со стилем и кнопками, заданными вторым аргументом. При необходимости, нужную кнопку можно выделить, как кнопку по умолчанию. Пользователь не может закрыть окно, без выбора одной из кнопок, идентификатор которой будет возвращен в результате функции. Для задания режимов и кнопок диалога рекомендуется использовать [[Константы#Константы диалогов|константы диалогов]].
}}
{{function entry
|name=[[SelectDataType]]
|form='''SelectDataType'''({{Optional|<Список типов объектов для выбора (STRING)>,<Заголовок формы (STRING)>}}):''<Тип и имя выбранного объекта или пустая строка (STRING)>''
|type=1
|status=2
|visual=1
|description=Функция позволяет выбрать тип (включая типы и виды объектов базы данных) из списка типов, ограниченного, если необходимо, первым аргументом. Функция возвращает выбранный пользователем тип или пустую строку, если пользователь отказался от выбора.
}}
{{function entry
|name=[[SelectFormSettingsFile]]
|form='''SelectFormSettingsFile'''(''<Загрузка установок (INT)>'',{{ByRef|<Путь файла установок (STRING)>,<Имя файла установок (STRING)>}}):''<Пользователь осуществил выбор 1 или 0 (INT)>''
|type=1
|status=2
|visual=1
|description=Функция показывает диалог сохранения или загрузки установок формы. Если пользователь выбрал файл установок (для загрузки или сохранения), будут заполнены переменные путь к файлу или имя файла установок, и функция возвратится с результатом 1.
}}
{{function entry
|name=[[OpenFileDialog]]
|form='''OpenFileDialog'''({{ByRef|<Имя файла (STRING)>}}{{Optional|,<Заголовок диалога (STRING)>,<Доступные фильтры файлов (STRING)>,<Тип диалога (INT)>{{Default|{{Eq}}0}},<Расширение по умолчанию (STRING)>}}):''<Пользователь выбрал файл (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный системный диалог открытия файла с заголовком и установками, определяемыми аргументами. Результат выбора возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[SaveFileDialog]]
|form='''SaveFileDialog'''({{ByRef|<Имя файла (STRING)>}}{{Optional|,<Заголовок диалога (STRING)>,<Доступные фильтры файлов (STRING)>,<Тип диалога (INT)>{{Default|{{Eq}}0}},<Расширение по умолчанию (STRING)>}}):''<Пользователь нажал на ОК (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный системный диалог сохранения файла с заголовком и установками, определяемыми аргументами. Выбранное имя файла для сохранения возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[OpenFileDialogServer]]
|form='''OpenFileDialogServer'''({{ByRef|<Имя файла (STRING)>}}{{Optional|,<Заголовок диалога (STRING)>,<Доступные фильтры файлов (STRING)>,<Тип диалога (INT)>{{Default|{{Eq}}0}},<Расширение по умолчанию (STRING)>,<Ограничить доступ этим каталогом (STRING)>}}):''<Пользователь выбрал файл (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный системный диалог открытия файла на стороне сервера с заголовком и установками, определяемыми аргументами. Результат выбора возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[SaveFileDialogServer]]
|form='''SaveFileDialogServer'''({{ByRef|<Имя файла (STRING)>}}{{Optional|,<Заголовок диалога (STRING)>,<Доступные фильтры файлов (STRING)>,<Тип диалога (INT)>{{Default|{{Eq}}0}},<Расширение по умолчанию (STRING)>,<Ограничить доступ этим каталогом (STRING)>}}):''<Пользователь нажал на ОК (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный системный диалог сохранения файла на стороне сервера с заголовком и установками, определяемыми аргументами. Выбранное имя файла для сохранения возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[SelectFontDialog]]
|form='''SelectFontDialog'''({{ByRef|<Наименования шрифта с его свойствами (STRING)>}}{{Optional|,<Запретить выбор стилей (INT)>{{Default|{{Eq}}0}},<Минимальный размер шрифта (INT)>{{Default|{{Eq}}0}},<Максимальный размер шрифта (INT)>{{Default|{{Eq}}0}}}}):''<Пользователь нажал на ОК (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный системный диалог выбора шрифта с установками, определяемыми аргументами. Выбранное имя шрифта и его свойства возвращаются в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[SelectIconDialog]]
|form='''SelectIconDialog'''({{ByRef|<Индекс выбранной иконки или ноль (INT)>}}{{Optional|,<Заголовок диалога (STRING)>}}):''<Пользователь выполнил выбор (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный модальный диалог выбора иконки из библиотеки иконок. Если пользователь выберет какую-либо иконку или пункт "без картинки", функция возвратит 1, иначе 0.
}}
{{function entry
|name=[[SelectFolderDialog]]
|form='''SelectFolderDialog'''({{ByRef|<Имя папки (STRING)>}}{{Optional|,<Заголовок диалога (STRING)>}}):''<Пользователь выбрал папку (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный системный диалог выбора папки с файлами с заголовком, определяемым вторым аргументом. Результат выбора возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[EditScriptDialog]]
|form='''EditScriptDialog'''({{ByRef|<Исходный текст программы (STRING)>}}{{Optional|,<Заголовок диалога (STRING)>,<Внешние переменные ч/з запятые (STRING)>}}):''<Пользователь нажал на ОК (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит модальный диалог редактирования исходного текста программы, заданного первым аргументом. Диалог имеет стандартную подсветку текста и позволяет провести синтаксический контроль при необходимости. Результат редактирования возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[AskString]]
|form='''AskString'''({{ByRef|<Текст для редактирования (STRING)>}}{{Optional|,<Заголовок диалога (STRING)>,<Максимальная длина строки (INT)>{{Default|{{Eq}}256}},<Тип строки (INT)>{{Default|{{Eq}}0}}}}):''<Пользователь нажал на ОК (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит модальный диалог редактирования текста, заданного первым аргументом. Текст может содержать как одну строку, так быть и многострочным. Результат редактирования возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[AskNumber]]
|form='''AskNumber'''({{ByRef|<Число для редактирования (NUMBER)>}}{{Optional|,<Заголовок диалога (STRING)>,<Максимальная длина числа (INT)>{{Default|{{Eq}}30}},<Количество знаков после точки (INT)>{{Default|{{Eq}}0}}}}):''<Пользователь нажал на ОК (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит модальный диалог редактирования числа, заданного первым аргументом. Число может быть как целым, так и вещественным. В диалоге имеется возможность вызова калькулятора. Результат редактирования возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[AskDate]]
|form='''AskDate'''({{Optional|<Дата по умолчанию (DATE)>,<Заголовок диалога (STRING)>,<Режим показа диалога (INT)>{{Default|{{Eq}}0}}}}):''<Выбранная дата или 0 (DATE,INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит диалог в виде поля или календаря для выбора даты. В режиме поля, у пользователя есть возможность вызвать календарь. Функция возвращает результат выбора или ноль, если пользователь отказался от выбора.
}}
{{function entry
|name=[[AskPeriod]]
|form='''AskPeriod'''({{ByRef|<Начальная дата периода (DATE)>,<Конечная дата периода (DATE)>}}{{Optional|,<Заголовок диалога (STRING)>,<Тип ограничения при выборе периода (INT)>{{Default|{{Eq}}0}}}}):''<Пользователь нажал на ОК (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит диалог для выбора периода времени. На возможность выбора могут быть наложены ограничения (к примеру, выбирать только периоды в целый месяц). Результат выбора возвращается в переменных, задающих первые два аргумента.
}}
{{function footer}}

== Функции, связанные с сервером и базой данных==
В данном разделе собраны функции, напрямую или косвенно связанные с сервером базы данных. Если клиент работает в локальном режиме, без подключения к серверу базы данных, многие функции этой группы не будут иметь значения.
{{Общие функции, связанные с БД}}

== Глобальные функции строк-массивов значений ==
Группа функций, позволяющая хранить строки-флаги с префиксами на сервере в виде быстрой небольшой базы данных с двумя столбцами (значение и префикс). Функции можно использовать, когда нужно проверять существует ли группа строк в массиве, добавлять строки в массив или удалять их. Массивы доступны для всех клиентов, так как хранятся в памяти сервера. По этой же причине не рекомендуется использование слишком больших массивов или слишком больших строк, так как на сервере может не остаться памяти на выполнение других запросов. При перезапуске сервера, массивы автоматически не восстанавливаются. Если требуется запомнить их содержимое, чтобы не заполнять их всякий раз при запуске сервера, при создании массива можно указать на бинарный файл, в который массив будет периодически сохраняться после изменений после определенного времени. Такой подход не гарантирует, что текущее изменение будет сохранено, если сервер будет остановлен. Существует также подобная группа функций для клиентской стороны (см. [[Строковые_функции#Функции строк-массивов значений|Функции строк-массивов значений]]), но имеет несколько другой функционал.

{{function header}}
{{function entry
|name=[[GlobalStringsHeaps]]
|form='''GlobalStringsHeaps''':''<Массивы, созданные на сервере (LIST)>''
|type=1
|status=2
|visual=0
|description=Функция получает список всех массивов, созданных на данный момент на сервере. Возвращается список, элементами которого являются идентификаторы массивов (числовые значения), а наименованиями -- имена массивов.
}}
{{function entry
|name=[[GlobalStringsHeapsFind]]
|form='''GlobalStringsHeapsFind'''(''<Имя массива (STRING)>''):''<Идентификатор или ноль (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, существует ли на сервере массив по его наименованию. Если массив существует, будет возвращен его идентификатор, иначе ноль.
}}
{{function entry
|name=[[GlobalStringsHeapsAdd]]
|form='''GlobalStringsHeapsAdd'''(''<Имя массива (STRING)>''{{Optional|,<Строка-разделитель (STRING)>{{Default|{{Eq}}Chr(0)}},<Разделитель префикса (STRING)>{{Default|{{Eq}}""}},<Параметры массива (LIST)>}}):''<Идентификатор массива (INT)>''
|type=1
|status=2
|visual=0
|description=Функция создает на сервере массив по его имени, с указанным разделителем значений и префиксов и указанными параметрами, задающимися в виде списка, и возвращает идентификатор созданного массива. Если массив уже существует, будет возвращен его идентификатор без каких-либо дополнительных изменений.
}}
{{function entry
|name=[[GlobalStringsHeapsRemove]]
|form='''GlobalStringsHeapsRemove'''(''<Имя или идентификатор массива (STRING,INT)>''):''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция удаляет массив с сервера по его наименованию или идентификатору. Если массив удален (найден на сервере), функция возвращает ''1'', иначе ''0''.
}}
{{function entry
|name=[[GlobalStringsAdd]]
|form='''GlobalStringsAdd'''(''<Имя или идентификатор массива (STRING,INT)>'',''<Значения (STRING,LIST)>''{{Optional|,''<Режим (INT)>''{{Default|{{Eq}}0}}}}):''<Статус или результат (INT,LIST)>''
|type=1
|status=2
|visual=0
|description=Функция добавляет произвольное количество строк из списка или одной строки с разделителями в массив, заданный по его наименованию или идентификатору. Режим функции задает условие добавления, а также формат ответа (последний может быть как числовым, так и в виде списка).
}}
{{function entry
|name=[[GlobalStringsRemove]]
|form='''GlobalStringsRemove'''(''<Имя или идентификатор массива (STRING,INT)>'',''<Значения (STRING,LIST)>''{{Optional|,''<Режим (INT)>''{{Default|{{Eq}}0}}}}):''<Статус или результат (INT,LIST)>''
|type=1
|status=2
|visual=0
|description=Функция удаляет произвольное количество строк из списка или одной строки с разделителями из массива, заданного по его наименованию или идентификатору. Режим функции задает условие удаления, а также формат ответа (последний может быть как числовым, так и в виде списка).
}}
{{function entry
|name=[[GlobalStringsFind]]
|form='''GlobalStringsFind'''(''<Имя или идентификатор массива (STRING,INT)>'',''<Значения (STRING,LIST)>''{{Optional|,''<Режим (INT)>''{{Default|{{Eq}}0}}}}):''<Статус или результат (INT,LIST)>''
|type=1
|status=2
|visual=0
|description=Функция выполняет поиск произвольного количества строк, заданных в списке или в одной строке с разделителями, в массиве по его наименованию или идентификатору. Режим функции задает условие поиска, а также формат ответа (последний может быть как числовым, так и в виде списка).
}}
{{function entry
|name=[[GlobalStringsShrink]]
|form='''GlobalStringsShrink'''(''<Имя или идентификатор массива (STRING,INT)>''{{Optional|,''<Порог сжатия в % (INT)>''{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция форсирует процедуру сжатия памяти буферов массива, которая обычно выполняется автоматически после определенного количества удалений из массива.
}}
{{function entry
|name=[[GlobalStringsSaveToFile]]
|form='''GlobalStringsSaveToFile'''(''<Имя или идентификатор массива (STRING,INT)>''{{Optional|,<Имя файла на сервере (STRING)>,<Если время последней записи было не раньше в мс. (INT)>{{Default|{{Eq}}0}}}}):''<1 или 0>''
|type=1
|status=2
|visual=0
|description=Функция выполняет сохранение массива на диск в файловой системе сервера в виде файла. Обычно она выполняется автоматически, если в массиве были изменения после определенного количества времени.
}}
{{function entry
|name=[[GlobalStringsAddFromFile]]
|form='''GlobalStringsAddFromFile'''(''<Имя или идентификатор массива (STRING,INT)>'',''<Имя файла на сервере (STRING)>''{{Optional|,''<Очистить массив перед загрузкой (INT)>''{{Default|{{Eq}}0}}}}):''<1 или 0>''
|type=1
|status=2
|visual=0
|description=Функция выполняет добавление сохраненного ранее массива с диска в файловой системе сервера к массиву, заданному по наименованию или идентификатору. Обычно она выполняется автоматически при создании массива, если указан файл его хранения.
}}
{{function footer}}

== Функции отладки ==
Функции, собранные здесь, используются для изменения параметров и работы со встроенным отладчиком. Отладчик доступен как для визуальных, так и для консольных клиентов.
{{function header}}
{{function entry
|name=[[DebuggingRights]]
|form='''DebuggingRights'''({{Optional|<Режим отладки 0 или 1 (INT)>}}):''<Текущий режим отладки (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает или/и изменяет текущий режим отладки. Если режим отладки не включен, встроенный отладчик не будет выведен в момент появления исключения или нажатия Ctrl+Alt+C.
}}
{{function entry
|name=[[Debugbreak]]
|form='''Debugbreak'''()
|type=1
|status=2
|visual=0
|description=Функция приостанавливает выполнение и открывает окно отладчика на текущей инструкции, если это позволяет текущий режим отладки. Функция не должна быть последней в модуле.
}}
{{function entry
|name=[[ProfilerStart]]
|form='''ProfilerStart'''()
|type=1
|status=2
|visual=0
|description=Функция включает встроенный профайлер, если это позволяет текущий режим отладки. Данные, накопленные профайлером ранее не изменяются. При включенном профайлере программа исполняется несколько медленнее.
}}
{{function entry
|name=[[ProfilerStop]]
|form='''ProfilerStop'''()
|type=1
|status=2
|visual=0
|description=Функция отключает встроенный профайлер. Данные, накопленные профайлером ранее не изменяются.
}}
{{function entry
|name=[[ProfilerClear]]
|form='''ProfilerClear'''()
|type=1
|status=2
|visual=0
|description=Функция очищает данные, накопленные профайлером.
}}
{{function entry
|name=[[Assert]]
|form='''Assert'''(''<Условие утверждения (INT)>''{{Optional|,<Описание ошибки утверждения (STRING)>}})
|type=1
|status=2
|visual=0
|description=Функция проверяет истинность утверждения, заданного первым аргументом, если утверждение ложно, функция вызывает исключение 71 (ERR_ASSERTIONERROR) с требуемым описанием, если необходимо.
}}
{{function entry
|name=[[AssertMode]]
|form='''AssertMode'''(''<Режим ошибок утверждения (INT)>'')
|type=1
|status=2
|visual=0
|description=Функция изменяет способ обработки ошибок утверждения (<code>[[Assert]]</code>). Режим используется для всех потоков клиента.
}}
{{function entry
|name=[[Raise]]
|form='''Raise''' {{Optional|<Описание исключения (STRING)>}}
|type=2
|status=2
|visual=0
|description=Функция вызывает исключение 41 (ERR_USER) с требуемым описанием, если необходимо.
}}
{{function entry
|name=[[Reraise]]
|form='''Reraise'''()
|type=1
|status=0
|visual=0
|description=Функция может использоваться внутри блока <code>Except ... EndTry</code> для того, чтобы снова вызвать подавленное конструкцией <code>Except</code> исключение.
}}
{{function entry
|name=[[PopError]]
|form='''PopError'''({{Optional|<Режим (INT)>{{Default|{{Eq}}15}}}}):''<Описание исключения (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает описание текущего исключения, собирая его из требуемых частей. Информация об исключении удаляется из очереди (но не само исключение). Функцию рекомендуется использовать внутри блока <code>Except ... EndTry</code>
}}
{{function entry
|name=[[PeekError]]
|form='''PeekError'''({{Optional|<Режим (INT)>{{Default|{{Eq}}15}}}}):''<Описание исключения (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает описание текущего исключения, собирая его из требуемых частей. Информация об исключении не удаляется из очереди. Функцию можно использовать внутри блоков <code>Except ... EndTry</code> или <code>Finally ... EndTry</code>
}}
{{function entry
|name=[[SuppressException]]
|form='''SuppressException'''()
|type=1
|status=2
|visual=0
|description=Функция может использоваться только внутри блока <code>Finally ... EndTry</code>. Текущее исключение в очереди исключений будет удалено, оно не будет инициировано после выполнения <code>EndTry</code>. Функция позволяет превратить конструкцию <code>Try ... Finally</code> в аналог конструции <code>Try ... Except</code> программно.
}}
{{function entry
|name=[[Writeln]]
|form='''Writeln'''(''<Аргумент>'')
|type=1
|status=2
|visual=1
|description=Отладочная функция выводит строковое представление аргумента в [[Визуальный лог клиента|лог]] клиента. Функция является упрощенной версией функции [[Message]].
}}
{{function footer}}

=== Внутренние отладочные функции ===
Данная группа функций обычно напрямую не используется в рабочих программах, но может пригодиться для целей отладки и исправления ошибок.
{{function header}}
{{function entry
|name=[[RefCount]]
|form='''RefCount'''(''<Аргумент>''):''<Значения счетчика ссылок объекта (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает значение счетчика внешних ссылок сложного объекта (см. [[Объекты]]), либо -1, если аргумент не является сложным объектом.
}}
{{function entry
|name=[[BusyCount]]
|form='''BusyCount'''(''<Аргумент>''):''<Значения счетчика занятости однопоточных объектов (INT)>''
|type=1
|status=2
|visual=0
|description=Функция отладки позволяет узнать величину свойства "занят" для однопоточных объектов.
}}
{{function entry
|name=[[dbgVarStackSize]]
|form='''dbgVarStackSize'''():''<Количество переменных в стеке (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция возвращает общее количество переменных в стеке переменных текущего потока.
}}
{{function entry
|name=[[dbgVarDump]]
|form='''dbgVarDump'''()
|type=1
|status=2
|visual=0
|description=Отладочная функция выводит в консоль или панель логов визуального клиента отладочную информацию по текущему состоянию стека переменных текущего потока.
}}
{{function entry
|name=[[dbgObjectHeapsNumber]]
|form='''dbgObjectHeapsNumber'''():''<Количество объектных стеков в системе (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает количество стеков объектов, существующих во всех работающих потоках, а также стеков объектов, которые принадлежали закрытым потокам, однако, содержащих адресуемые объекты.
}}
{{function entry
|name=[[dbgEvalObjectsNumber]]
|form='''dbgEvalObjectsNumber'''():''<Количество объектов в стеке исполнения (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает количество объектов в стеке исполнения текущего потока.
}}
{{function entry
|name=[[dbgObjectsNumber]]
|form='''dbgObjectsNumber'''({{Optional|<Объект, стек которого необходимо использовать>}}):''<Количество объектов в стеке объектов (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает количество объектов в стеке объектов текущего потока исполнения, либо потока, в котором был создан объект аргумента.
}}
{{function entry
|name=[[dbgMemoryAllocated]]
|form='''dbgMemoryAllocated'''():''<Объем памяти, выделенный системой (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает текущий объем памяти в байтах, выделенный системой (с учетом всех внутренних переменных, стеков потоков, объектных стеков и пр.)
}}
{{function entry
|name=[[dbgShowAllocInfo]]
|form='''dbgShowAllocInfo'''(''<Включение режима накопления информации по объектам текущего стека объектов (INT)>'')
|type=1
|status=2
|visual=0
|description=Отладочная функция должна использоваться дважды. В первый раз до выполнения операции, которая может произвести утечку объектов с параметром 1 (включить), затем второй раз после операции с параметром 0 (выключить), после чего функция выводит в консоль информацию по всем объектам, созданным за время операции, оставшимся в памяти после ее окончания. Функция может использоваться только в консольном клиенте.
}}
{{function entry
|name=[[dbgOLEMethodsList]]
|form='''dbgOLEMethodsList'''(''<OLE-объект (OLE)>''):''<Дерево методов и свойств объекта (TREE)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция, позволяет получить внутренний список имен методов и свойств OLE-объекта в виде дерева. Может использоваться, чтобы найти имя метода, если документация недоступна или недостаточно подробна.
}}
{{function entry
|name=[[dbgStackTrace]]
|form='''dbgStackTrace'''():''<Стек вызовов текущего потока (STRING)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает языковый стек вызовов текущего исполняемого потока в виде строки.
}}
{{function entry
|name=[[dbgSysStackTrace]]
|form='''dbgSysStackTrace'''():''<Системный стек вызовов текущего потока (STRING)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает системный стек вызовов текущего исполняемого потока в виде строки. Без наличия соответствующего <code>.map</code> файла клиента, стек будет иметь неописательную информацию.
}}
{{function entry
|name=[[dbgSysStackTraceVisual]]
|form='''dbgSysStackTraceVisual'''():''<Системный стек вызовов визуального потока (STRING)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает системный стек вызовов визуального потока в виде строки. Без наличия соответствующего <code>.map</code> файла клиента, стек будет иметь неописательную информацию. Функция может быть вызвана только для визуального клиента.
}}
{{function entry
|name=[[dbgSysLastExceptionStackTrace]]
|form='''dbgSysLastExceptionStackTrace'''():''<Системный стек вызовов последнего системного исключения (STRING)>''
|type=1
|status=0
|visual=0
|description=Отладочная функция получает системный стек вызовов последнего исключения на уровне системы в виде строки. Без наличия соответствующего <code>.map</code> файла клиента, стек будет иметь неописательную информацию.
}}
{{function entry
|name=[[dbgHRPCAvailable]]
|form='''dbgHRPCAvailable'''():''<Можно ли использовать т.в.т. (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция проверяет, включен ли на данной машине таймер высокой точности (обычно включение происходит в BIOS компьютера).
}}
{{function entry
|name=[[dbgHRPCCurrent]]
|form='''dbgHRPCCurrent'''():''<Текущее значение т.в.т. (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает текущее значение таймера высокой точности. Если таймер не включен на системном уровне, функция возвращает 0.
}}
{{function entry
|name=[[dbgHRPCGetPeriod]]
|form='''dbgHRPCGetPeriod'''(''<Предыдущее значение т.в.т. (INT)>''):''<Прошедшее время в наносекундах (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает промежуток времени, прошедший от предыдущего значения таймера высокой точности (заданного аргументом) до текущего момента, выраженное в наносекундах. Если таймер не включен на системном уровне, функция возвращает пустое значение. Перевод периода в секунды можно осуществить по формуле <code><Результат>/1000000000</code>.
}}
{{function entry
|name=[[dbgWriteLog]]
|form='''dbgWriteLog'''(''<Строка лога (STRING)>'')
|type=1
|status=2
|visual=0
|description=Отладочная функция сохраняет информацию в текстовом логе клиента.
}}
{{function entry
|name=[[dbgToFileTime]]
|form='''dbgToFileTime'''(''<Дата (DATE)>''):''<Дата в формате FILETIME (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция превращает дату в 64-битное число в формате FILETIME (формат, в котором система хранит даты).
}}
{{function entry
|name=[[dbgFromFileTime]]
|form='''dbgFromFileTime'''(''<Дата в формате FILETIME (INT)>''):''<Дата (DATE)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция превращает 64-битное число в формате FILETIME (формат, в котором система хранит даты) в дату.
}}
{{function footer}}

=== Объект сторожевого пса ===
Основная характеристика консольных клиентов, работающих в режиме сервера, это их постоянная доступность. Если консольное приложение вызывает внешние функции, есть вероятность зависания, если в этих внешних функциях содержатся ошибки (OLE-объекты могут зависнут, либо, печать на принтер, драйвер которого, может войти в вечный цикл ожидания или вывести сообщение об ошибке на экран, ожидая действия пользователя и пр.). Функции сторожевого пса помогают при появлении зависаний перезапустить программу-клиент. Каждый объект сторожевого пса в активном состоянии работает в отдельном системном потоке, наличие большого количества таких объектов может негативно сказаться на ресурсах системы.
{{function header}}
{{function entry
|name=[[Watchdog.Create|Create]]
|form={{Grey|Watchdog.}}'''Create'''({{Optional|<Режим сторожевого пса (INT)>{{Default|{{Eq}}0}}}}):''<Новый объект сторожевого пса (Watchdog)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый объект сторожевого пса с указанным режимом. Сторожевой пес создается в неактивном состоянии. Для активации необходимо использовать функцию [[Watchdog.Create|Guard]].
}}
{{function entry
|name=[[Watchdog.Guard|Guard]]
|form={{Grey|Watchdog.}}'''Guard'''(''<Количество миллисекунд (INT)>''):''<Сторожевой пес удачно активирован 1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит включение режима сторожевого пса с указанным периодом слежения. Функция может использоваться только в консольном клиенте.
}}
{{function entry
|name=[[Watchdog.Feed|Feed]]
|form={{Grey|Watchdog.}}'''Feed'''()
|type=1
|status=2
|visual=0
|description=Функция обнуляет время ожидания в режиме сторожевого пса. Функция может использоваться только в консольном клиенте. Функция должна исполняться периодически, чтобы пес не инициировал перезагрузку консольного клиента.
}}
{{function entry
|name=[[Watchdog.Sleep|Sleep]]
|form={{Grey|Watchdog.}}'''Sleep'''():''<Сторожевой пес удачно деактивирован 1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит выключение (деактивацию) сторожевого пса. Деактивация будет произведена автоматически в момент удаления объекта из системы, если он был в активном состоянии в момент удаления. Функция может использоваться только в консольном клиенте.
}}
{{function entry
|name=[[Watchdog.Mode|Mode]]
|form={{Grey|Watchdog.}}'''Mode'''
|type=0
|status=2
|visual=0
|description=Атрибут получает или изменяет режим сторожевого пса. Изменения можно производить даже если пес еще не активирован.
}}
{{function entry
|name=[[Watchdog.Active|Active]]
|form={{Grey|Watchdog.}}'''Active'''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает 1, если сторожевой пес активирован, иначе возвращает 0. Атрибут доступен только для чтения.
}}
{{function footer}}

== Функции криптографии ==
Криптографическое функции используются для кодирования информации при пересылке по ненадежным каналам, либо нахождения контрольных сумм или хэшей, используемых в работе с web стандартами.
{{function header}}
{{function entry
|name=[[CreateKeySchedule]]
|form='''CreateKeySchedule'''(''<Стандарт кодирования (STRING)>'',''<Ключ (пароль) (STRING,BUFFER)>''{{Optional|,<Для декодирования (INT)>{{Default|{{Eq}}0}}}}):''<Параметр кодировщика (BUFFER)>''
|type=1
|status=2
|visual=0
|description=Функция позволяет создать из текстового ключа объект, необходимый для кодирования или декодирования информации с помощью этого ключа. В дальнейшем этот объект может использоваться для вызова функций кодирования [[Encrypt]] или декодирования [[Decrypt]]. Первый аргумент задает стандарт кодирования, к примеру, "AES256".
}}
{{function entry
|name=[[Encrypt]]
|form='''Encrypt'''(''<Стандарт кодирования (STRING)>'',''<Информация для кодирования (STRING,BUFFER)>''{{Optional|,''<Параметр кодировщика (расписание кодирования) (BUFFER)>'',<Источник в формате UTF-16 (INT)>{{Default|{{Eq}}0}}}}):''<Закодированная строка или 1>''
|type=1
|status=2
|visual=0
|description=Функция производит кодирование строки или буфера по стандарту, заданному первым аргументом. Размер строки или буфера должен быть кратен определенному количеству байт, заданному стандартом кодирования (к примеру, для AES-256, это число 16); если размер не будет кратен нужному количеству байт, функция вызове исключение. Нужно иметь в виду, что для UTF-16 строк, размер в байтах в два раза больше, чем количество символов в строке. Если первым параметром служит буфер, в результате функция возвратит единицу, а содержимое буфера будет закодировано, если первым параметром была передана строка, функция возвратит ANSI строку.
}}
{{function entry
|name=[[Decrypt]]
|form='''Decrypt'''(''<Стандарт кодирования (STRING)>'',''<Информация для декодирования (STRING,BUFFER)>''{{Optional|,''<Параметр декодировщика (расписание декодирования) (BUFFER)>'',<Результат в формате UTF-16 (INT)>{{Default|{{Eq}}0}}}}):''<Декодированная строка или 1>''
|type=1
|status=2
|visual=0
|description=Функция производит декодирование строки или буфера, закодированных по стандарту, заданному первым аргументом. Размер строки или буфера должен быть кратен количеству байт, заданному стандартом кодирования (к примеру, для AES-256, это число 16); если размер не будет кратен нужному количеству байт, функция вызове исключение. Нужно иметь в виду, что для UTF-16 строк, размер в байтах в два раза больше, чем количество символов в строке. Если первым параметром служит буфер, в результате функция возвратит единицу, а содержимое буфера будет декодировано, если первым параметром была передана строка, функция возвратит ANSI или UTF-16 строку, в зависимости от значения третьего аргумента.
}}
{{function entry
|name=[[CalculateHash]]
|form='''CalculateHash'''(''<Информация для нахождения контрольной суммы (STRING,BUFFER)>''{{Optional|,<Алгоритм (STRING)>{{Default|{{Eq}}"INTERNAL"}},<Завершающий блок (INT)>{{Default|{{Eq}}1}},<Сумма или состояние предыдущего блока (STRING,BUFFER)>,<Дополнительный параметр (STRING)>{{Default|{{Eq}}""}}}}):''<Сумма или текущее состояние (STRING,BUFFER)>''
|type=1
|status=1
|visual=0
|description=Функция подсчет контрольной суммы или хэша буфера или строки по указанному алгоритму, имеется также возможность подсчитать сумму нескольких блоков, как единого целого, вызывая эту функцию для каждого из блоков один раз. В список алгоритмов входят такие, как "MD5", "CRC32", "SHA-1" и пр.
}}
{{function footer}}

== Функции архивации ==
Функции архивации помогают распаковать или упаковать информацию без необходимости использования внешних исполняемых файлов или библиотек. [[StreamCompress]] и [[StreamDecompress]] упаковывают и распаковывают поток данных, не связанный с файлами на диске, позволяя сжимать информацию передаваемую по WEB или создавать сжатые данные произвольного размера.
{{function header}}
{{function entry
|name=[[StreamCompress]]
|form='''StreamCompress'''(''<Данные для упаковки (STRING,BUFFER,TEXT)>''{{Optional|,<Алгоритм (STRING)>{{Default|{{Eq}}"ZLIB"}},<Уровень (INT)>{{Default|{{Eq}}6}},<Завершающий блок (INT)>{{Default|{{Eq}}1}}{{ByRef|,<Словарь упаковки>}}}}):''<Результат упаковки (STRING,BUFFER)>''
|type=1
|status=2
|visual=0
|description=Функция производит упаковку блока данных по заданному алгоритму. Для последовательной упаковки частей одного большого блока данных, функцию необходимо вызвать несколько раз с каждой частью блока данных.
}}
{{function entry
|name=[[StreamDecompress]]
|form='''StreamDecompress'''(''<Данные для распаковки (STRING,BUFFER)>''{{Optional|,<Алгоритм (STRING)>{{Default|{{Eq}}"ZLIB"}},<Завершающий блок (INT)>{{Default|{{Eq}}1}}{{ByRef|,<Словарь распаковки или общий размер упакованного блока (INT,?)>}}}}):''<Результат распаковки (STRING,BUFFER)>''
|type=1
|status=2
|visual=0
|description=Функция производит распаковку блока данных по заданному алгоритму. Для последовательной распаковки частей одного большого блока данных, функцию необходимо вызвать несколько раз с каждой частью блока данных.
}}
{{function footer}}

== Функции штрихкодов и символов ==
Функции штрихкодов и символов позволяют создавать штрихкоды в виду картинок, которые затем можно добавить на форму, напечатать, вывести на web-странице и пр.
{{function header}}
{{function entry
|name=[[Generate1DBarcode]]
|form='''Generate1DBarcode'''(''<Тип штрихкода (STRING)>''{{ByRef|,<Ширина (INT)>,<Высота (INT)>}},''<Кодируемое сообщение (STRING)>''{{Optional|,<Установки (STRING)>}}):''<Результат (PICTURE)>''
|type=1
|status=2
|visual=0
|description=Функция генерирует линейный штрихкод указанного типа с указанными размерами, если необходимо. Параметры генерации настраиваются с помощью дополнительных установок, если необходимо. Функция поддерживает следующие виды штрихкодов: '''Code 128''','''UPC''','''EAN''','''Code 39''','''ISBN''','''Code 93''','''ITF''' (Interleaved 2 of 5),'''MSI''','''Codabar'''.
}}
{{function entry
|name=[[Generate2DBarcode]]
|form='''Generate2DBarcode'''(''<Тип символа (STRING)>''{{ByRef|,<Ширина (INT)>,<Высота (INT)>}},''<Кодируемое сообщение (STRING)>''{{Optional|,<Установки (STRING)>}}):''<Результат (PICTURE)>''
|type=1
|status=1
|visual=0
|description=Функция генерирует двумерный символ указанного типа с указанными размерами, если необходимо. Параметры генерации настраиваются с помощью дополнительных установок, если необходимо. Функция поддерживает следующие виды символов: '''PDF 417''', '''Aztec Code''', '''QR Code''', '''Data Matrix''', '''MaxiCode'''.
}}
{{function entry
|name=[[CountBarcodeCRC]]
|form='''CountBarcodeCRC'''(''<Тип контрольной суммы (STRING)>'',''<Полное кодируемое сообщение (STRING)>''):''<Контрольная сумма (INT,STRING)>''
|type=1
|status=2
|visual=0
|description=Функция используется для случаев, когда кодируемое сообщение разделено на несколько символов (или штрихкодов), при этом необходима контрольная сумма всего сообщения, чтобы программа декодирования смогла проверить корректность результата.
}}
{{function footer}}

== Функции среды исполнения ==
Данная группа функций используется для программного получения информации о разнообразных свойствах среды исполнения, запуска системных приложений и пр.
{{function header}}
{{function entry
|name=[[SysExecNoConsole]]
|form='''SysExecNoConsole'''(''<Командная строка исполнения (STRING)>''{{Optional|,<Не возвращаться до завершения (INT)>{{Default|{{Eq}}0}}}}):''<Код, возвращенный приложением (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит запуск приложения с параметрами в командной строке, подавляя создание консоли при запуске, приложение может находиться на сервере, в этом случае, оно сначала будет перенесено на локальный диск.
}}
{{function entry
|name=[[SysExec]]
|form='''SysExec'''(''<Командная строка исполнения (STRING)>''{{Optional|,<Не возвращаться до завершения (INT)>{{Default|{{Eq}}0}}}}):''<Код, возвращенный приложением (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит запуск приложения с параметрами в командной строке, приложение может находиться на сервере, в этом случае, оно сначала будет перенесено на локальный диск.
}}
{{function entry
|name=[[SysExecNoConsoleLocal]]
|form='''SysExecNoConsoleLocal'''(''<Командная строка исполнения (STRING)>''{{Optional|,<Не возвращаться до завершения (INT)>{{Default|{{Eq}}0}}}}):''<Код, возвращенный приложением (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит запуск приложения с параметрами в командной строке, подавляя создание консоли при запуске, приложение может находиться только на локальном компьютере, разбор командной строки не производится.
}}
{{function entry
|name=[[SysExecLocal]]
|form='''SysExecLocal'''(''<Командная строка исполнения (STRING)>''{{Optional|,<Не возвращаться до завершения (INT)>{{Default|{{Eq}}0}}}}):''<Код, возвращенный приложением (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит запуск приложения с параметрами в командной строке, приложение может находиться только на локальном компьютере, разбор командной строки не производится.
}}
{{function entry
|name=[[SysExecServer]]
|form='''SysExecServer'''(''<Командная строка исполнения (STRING)>''{{Optional|,<Не возвращаться до завершения (INT)>{{Default|{{Eq}}0}}}}):''<Код, возвращенный приложением (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит запуск приложения с параметрами в командной строке на стороне сервера, разбор командной строки не производится. Пользователь должен обладать административными правами для использования этой функции. Также нужно понимать, что запуск с флагом ожидания завершения (второй аргумент) приведет к "зависшей" сессии на сервере, если приложение не будет завершено. Этой функцией следует пользоваться в исключительных обстоятельствах и только когда поведение запускаемого приложения хорошо известно заранее.
}}
{{function entry
|name=[[StdStreamsSysExec]]
|form='''StdStreamsSysExec'''(''<Командная строка исполнения (STRING)>'',{{ByRef|<Буфер с дескрипторами (BUFFER)>}}{{Optional|,<Не возвращаться до завершения (INT)>{{Default|{{Eq}}0}}}}):''<Код, возвращенный приложением (INT)>''
|type=1
|status=0
|visual=0
|description=Функция производит запуск приложения с параметрами в командной строке, подавляя создание консоли при запуске, приложение может находиться на сервере, в этом случае, оно сначала будет перенесено на локальный диск. Переменная, заданная вторым аргументом, получает набор дескрипторов для манипуляции со стандартными потоками и самим приложением. Для закрытия дескрипторов должна быть использована функция [[StdStreamsCloseHandles]]
}}
{{function entry
|name=[[StdStreamsTransfer]]
|form='''StdStreamsTransfer'''(''<Текст для отправки (STRING)>'',''<Буфер с дескрипторами (BUFFER)>'')
|type=1
|status=0
|visual=0
|description=Функция производит выгрузку текста в StdIn потока запущенного ранее приложения.
}}
{{function entry
|name=[[StdStreamsRead]]
|form='''StdStreamsRead'''(''<Буфер с дескрипторами (BUFFER)>''{{Optional|,<StdErr поток (INT)>{{Default|{{Eq}}0}}}}):''<Полученный текст (STRING)>''
|type=1
|status=0
|visual=0
|description=Функция производит получение текста из StdOut или StdErr потоков запущенного ранее приложения.
}}
{{function entry
|name=[[StdStreamsCloseHandles]]
|form='''StdStreamsCloseHandles'''(''<Буфер с дескрипторами (BUFFER)>'')
|type=1
|status=0
|visual=0
|description=Функция закрывает дескрипторы, полученные ранее при запуске приложения. Если не пользоваться этой функцией, в системе будет наблюдаться утечка ресурсов.
}}
{{function entry
|name=[[StdStreamsApplicationExited]]
|form='''StdStreamsApplicationExited'''(''<Буфер с дескрипторами (BUFFER)>''):''<Завершена ли работа приложения (INT)>''
|type=1
|status=0
|visual=0
|description=Функция проверяет, завершена ли работа приложения, идентифицируемого дескрипторами, полученными при его запуске.
}}
{{function entry
|name=[[StdStreamsTerminateApplication]]
|form='''StdStreamsTerminateApplication'''(''<Буфер с дескрипторами (BUFFER)>''):''<Приложение было завершено (INT)>''
|type=1
|status=0
|visual=0
|description=Функция производит попытку завершить работу приложения, идентифицируемого дескрипторами, полученными при его запуске.
}}
{{function entry
|name=[[SysEmulateKeystroke]]
|form='''SysEmulateKeystroke'''(''<Виртуальный код клавиши (INT)>'',''<Произведено нажатие (INT)>'')
|type=1
|status=2
|visual=1
|description=Функция эмулирует нажатие или отпускание клавиши по ее виртуальному коду. Эмуляция производится средствами системы и выполняется даже если окно клиента не является активным окном.
}}
{{function entry
|name=[[SysParamCount]]
|form='''SysParamCount'''():''<Количество параметров командной строки клиента (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает количество параметров, которые были переданы в командной строке при запуске клиента.
}}
{{function entry
|name=[[SysParam]]
|form='''SysParam'''(''<Номер параметра (INT)>''):''<Параметр командной строки (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает параметр командной строки запуска клиента с требуемым номером.
}}
{{function entry
|name=[[SysSetEnvValue]]
|form='''SysSetEnvValue'''(''<Имя переменной (STRING)>'',''<Значение переменной (STRING)>'')
|type=1
|status=0
|visual=0
|description=Функция изменяет переменную системного окружения (environment)
}}
{{function entry
|name=[[SysGetEnvValue]]
|form='''SysGetEnvValue'''(''<Имя переменной (STRING)>''):''<Значение переменной (STRING)>''
|type=1
|status=0
|visual=0
|description=Функция получает значение переменной системного окружения (environment). Если переменная не была установлена, будет возвращена пустая строка.
}}
{{function entry
|name=[[CopyFileToTemp]]
|form='''CopyFileToTemp'''(''<Файл на сервере (STRING)>''):''<Путь и имя файла в локальной временной папке (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция копирует файл во временную папку, отдавая его путь и имя. Исходный файл может находиться на сервере или локальном диске.
}}
{{function entry
|name=[[ClipboardGetText]]
|form='''ClipboardGetText'''({{Optional|<Формат текста буфера (INT)>{{Default|{{Eq}}0}}}}):''<Текст из буфера или пустая строка (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает текст из буфера обмена операционной системы в требуемом формате. При ошибке или отсуствии нужного формата, функция возвращает пустую строку.
}}
{{function entry
|name=[[ClipboardPutText]]
|form='''ClipboardPutText'''(''<Текст (STRING)>''{{Optional|,<Формат текста буфера (INT)>{{Default|{{Eq}}0}}}}):''<Удачно изменен системный буфер (INT)>''
|type=1
|status=2
|visual=0
|description=Функция помещает текст в буфер обмена операционной системы в требуемом формате.
}}
{{function entry
|name=[[ExitProgram]]
|form='''ExitProgram'''({{Optional|<Вопрос о сохранении данных (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=0
|description=Функция позволяет завершить выполнения клиента, по умолчанию, создавая запрос о сохранении текущих форм, требующих сохранения. Все незавершенные транзакции будут либо отменены, либо приняты. Событие [[OnSystemExit]] может отменить действие этой функции.
}}
{{function entry
|name=[[CloseProgram]]
|form='''CloseProgram'''()
|type=1
|status=2
|visual=0
|description=Функция завершает выполнение клиента без каких-либо дополнительных предупреждений и вопросов. Все незавершенные транзации будут отменены в следствии разрыва связи клиентом. Событие [[OnSystemExit]] не будет вызвано.
}}
{{function entry
|name=[[RestartProgram]]
|form='''RestartProgram'''({{Optional|<Мгновенный перезапуск (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=0
|description=Функция может использоваться только для консольного клиента. Если аргумент равен 1, функция завершает выполнение клиента без каких-либо дополнительных предупреждений и вопросов. Все незавершенные транзации будут отменены в следствии разрыва связи клиентом. Событие [[OnSystemExit]] не будет вызвано. В случае, если аргумент равен 0, функция закрывает транзакции корректным образом, событие [[OnSystemExit]] может отменить действие этой функции. После завершения работы клиента, будет произведена попытка его повторного запуска.
}}
{{function entry
|name=[[sysIsTerminalMode]]
|form='''sysIsTerminalMode'''():''<Клиент работает в терминальном режиме (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, запущен ли текущий клиент в терминальном режиме (1), либо в режиме локального компьютера (0).
}}
{{function entry
|name=[[sysTerminalGetComputerName]]
|form='''sysTerminalGetComputerName'''():''<Наименование клиентского компьютера (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция находит наименование клиентского компьютера, с которого он осуществляет работу на терминальном сервере. Если работа не ведется на терминальном сервере, будет возвращена пустая строка.
}}
{{function entry
|name=[[sysLowVideoMemoryMode]]
|form='''sysLowVideoMemoryMode'''({{Optional|<Включить режим экономия видеопамяти (INT)>}}):''<Состояние режима экономии видеопамяти (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает или/и изменяет состояние режима экономии видеопамяти (рекомендуется для терминальных клиентов).
}}
{{function entry
|name=[[MainWindowCaption]]
|form='''MainWindowCaption'''({{Optional|<Заголовок основного окна клиента (STRING)>}}):''<Текущее заголовок основного окна (STRING)>''
|type=1
|status=0
|visual=1
|description=Функция изменяет заголовок основного окна клиента на необходимый.
}}
{{function entry
|name=[[ReturnToForeground]]
|form='''ReturnToForeground'''()
|type=1
|status=0
|visual=1
|description=Функция делает приложение активным и возвращает ему фокус. Функция может пригодиться после модального вызова внешних библиотек или приложений, которые выводят информацию или окна на экран. После завершения такого приложения (в зависимости от его функциональности) окно программы может не быть активировано корректно или вообще быть скрыто.
}}
{{function entry
|name=[[CurrentFormCaption]]
|form='''CurrentFormCaption'''(''<Заголовок текущей формы клиента (STRING)>'')
|type=1
|status=0
|visual=1
|description=Функция изменяет заголовок текущей формы клиента на необходимый. Функция является аналогом функции [[Form.Caption]].
}}
{{function entry
|name=[[ComputerName]]
|form='''ComputerName'''():''<Сетевое имя машины клиента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает сетевое имя машины (компьютера), на которой запущен клиент.
}}
{{function entry
|name=[[UserName]]
|form='''UserName'''():''<Имя учетной записи пользователя на текущей машине (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает имя учетной записи, под которой работает пользователь на текущей машине (компьютере).
}}
{{function entry
|name=[[ServerUserName]], '''LogonName'''
|form='''ServerUserName'''():''<Имя учетной записи сервера базы данных (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает имя учетной записи сервера базы данных под которым работает клиент, если клиент не зарегистрирован на сервере базы данных (локальный клиент), функция может возвратить пустую строку.
}}
{{function entry
|name=[[IsDBAdministrator]]
|form='''IsDBAdministrator'''():''<Уровень административных полномочий клиента (INT)>''
|type=1
|status=2
|visual=0
|description=Функция отдает 0, если клиент зарегистрирован на сервере в режиме обычного пользователя, 1 -- в режиме ограниченного администратора, и 2 -- в режиме администратора (может выполнять привилегированные команды, редактировать учетные записи пользователей и пр.).
}}
{{function entry
|name=[[IsSlowConnection]]
|form='''IsSlowConnection'''():''<Используется медленное соединение (необходима оптимизация) (INT)>''
|type=1
|status=2
|visual=0
|description=Функция отдает 1, если для базы данных активен режим "медленное соединение". В этом режиме клиент будет оптимизировать некоторые запросы к серверу (пытаться уменьшить количество запросов за счет включения нескольких запросов в один), данная функция может служить флагом для программной оптимизации или даже загрузки другого интерфейса для пользователей, работающих по Интернету, а не по локальной сети.
}}
{{function entry
|name=[[ServerName]]
|form='''ServerName'''():''<Внутреннее наименование сервера БД (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает короткое наименование сервера базы данных. Если клиент не зарегистрирован на сервере базы данных (локальный клиент), функция возвратит пустую строку.
}}
{{function entry
|name=[[ServerDescription]]
|form='''ServerDescription'''():''<Внутреннее описание сервера БД (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает описание сервера базы данных. Если клиент не зарегистрирован на сервере базы данных (локальный клиент), функция возвратит пустую строку.
}}
{{function entry
|name=[[DBMSVersion]]
|form='''DBMSVersion'''():''<Версия ПО СУБД сервера базы данных (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает версию ПО СУБД, которая используется сервером базы данных.
}}
{{function entry
|name=[[GetTempDirectory]]
|form='''GetTempDirectory'''():''<Папка временных файлов (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает путь к папке временных файлов. Вне зависимости от прав пользователя в системе, он имеет доступ к чтению и записи внутри такой папки. Папка находится на локальном компьютере.
}}
{{function entry
|name=[[GetDatabaseDirectory]]
|form='''GetDatabaseDirectory'''():''<Путь к файлам текущей локальной конфигурации (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция работает только для локальных клиентов (не связанных с сервером базы данных), и возвращает локальный (или сетевой) путь к файлам текущей конфигурации.
}}
{{function entry
|name=[[GetBinaryDirectory]]
|form='''GetBinaryDirectory'''():''<Путь к папке, из которой запущен исполняемый файл клиента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает путь к папке, из которой запущен исполняемый файл клиента (консольного или визуального).
}}
{{function entry
|name=[[GetUserDirectory]]
|form='''GetUserDirectory'''():''<Путь к личной папке пользователя (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает путь к личной папке пользователя, при наличии подключения к серверу, этот путь указывает на папку на сервере, и выглядит <code>UserSettings\<Имя пользователя>\</code>, если клиент работает без подключения к серверу, этот путь указывает на локальную папку, и будет выглядеть <code><Путь с файлам конфигурации>\UserSettings\<Имя пользователя>\</code>. В данной папке можно хранить установки, предпочтения и другие файлы, связанные с текущим пользователем. Клиент также сохраняет свои установки форм и печати внутри этой папки, поэтому, нельзя рассчитывать, что она будет пустой.
}}
{{function entry
|name=[[CurrentLanguage]]
|form='''CurrentLanguage'''():''<Код текущего языка по умолчанию (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает код текущего языка по умолчанию. Язык по умолчанию используется в функциях прописи и подобных, где есть возможность кодирования на разных языках. Код языка обычно состоит из двух букв (<code>RU,EN...</code>). См. также функцию [[SelectLanguage]].
}}
{{function entry
|name=[[SelectLanguage]]
|form='''SelectLanguage'''(''<Код языка по умолчанию (STRING)>''):''<Код текущего языка по умолчанию (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция изменяет код текущего языка по умолчанию, возвращая предыдущий. Язык по умолчанию используется в функциях прописи и подобных, где есть возможность кодирования на разных языках. Код языка обычно состоит из двух букв (<code>RU,EN...</code>).
}}
{{function entry
|name=[[OSVersion]]
|form='''OSVersion'''():''<Версия операционной системы (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает версию операционной системы, под которой запущен клиент в виде <code><Тип> Version X.X (Build XXXX: <Название пакета обновления>)</code> (к примеру '''Windows Version 6.1 (Build 7601: Service Pack 1)''').
}}
{{function entry
|name=[[ProgramVersion]]
|form='''ProgramVersion'''():''<Версия клиента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает текущую версию клиента в виде <code>X.X (Build: XXXXXX)</code> (к примеру '''1.1 (Build: 190511)'''). Функция работает как для консольных, так и для визуальных клиентов.
}}
{{function entry
|name=[[ProgramMode]]
|form='''ProgramMode'''():''<Тип клиента (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает код типа клиента текущей сессии. 0 -- консольный режим, 1 -- визуальный клиент.
}}
{{function entry
|name=[[ProgramArchitecture]]
|form='''ProgramArchitecture'''():''<Тип архитектуры приложения клиента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает тип архитектуры приложения клиента (к примеру, '''x64''' или '''x86''').
}}
{{function entry
|name=[[PointerSize]]
|form='''PointerSize'''():''<Размер системного указателя в байтах (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает размер системного указателя в байтах. Для x86 размер равен 4, для x64 размер равен 8.
}}
{{function entry
|name=[[ProjectVersion]]
|form='''ProjectVersion'''():''<Номер сборки проекта (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает номер сборки проекта (конфигурации) в виде <code>Build: XXXX</code>.
}}
{{function entry
|name=[[ProjectName]], '''DBCaption'''
|form='''ProjectName'''():''<Наименование проекта (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает наименование проекта (конфигурации), как оно было задано в Студии.
}}
{{function entry
|name=[[DBDescription]]
|form='''DBDescription'''():''<Описание проекта (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает описание проекта (конфигурации), как оно было задано в Студии.
}}
{{function entry
|name=[[ProjectGUID]]
|form='''ProjectGUID'''():''<GUID проекта (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает GUID проекта (конфигурации) в виде <code>{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}</code>
}}
{{function entry
|name=[[UnsupportedServerFeatures]]
|form='''UnsupportedServerFeatures'''():''<Возможности, не поддерживаемые сервером (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает строку с кодами возможностей, не поддерживаемых текущим сервером базы данных. Некоторые серверы могут не поддерживать все возможности, предоставляемые программой, в этом случае, при выполнении запроса к серверу, будет создаваться исключение и запрос не будет выполнен.
}}
{{function entry
|name=[[IsAsyncExecutionMode]]
|form='''IsAsyncExecutionMode'''():''<Текущий контекст асинхронный 1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает 1, если исполнение производится внутри [[Студия/Визуальные события|асинхронного]] визуального события, иначе будет возвращен 0.
}}
{{function entry
|name=[[IsRootThread]]
|form='''IsRootThread'''():''<Результат 0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает 1, если текущая программа исполняется в корневом потоке, иначе будет возвращен 0.
}}
{{function entry
|name=[[IsExecutingInSeparateThread]]
|form='''IsExecutingInSeparateThread'''():''<Результат 0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает 1, если текущая программа исполняется в потоке, созданном функцией [[Mutex.ExecuteFunctionInSeparateThread|ExecuteFunctionInSeparateThread]].
}}
{{function entry
|name=[[IsExecutingInSeparateProcess]]
|form='''IsExecutingInSeparateProcess'''({{OptionalByRef|<Идентификатор процесса (STRING)>}}):''<Результат 0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает 1, если текущая программа исполняется в процессе, созданном функцией [[Mutex.InitializeSeparateProcess|InitializeSeparateProcess]]. Также может получить идентификатор процесса, заданный при его создании.
}}
{{function entry
|name=[[IsExecutingInExternalModule]]
|form='''IsExecutingInExternalModule'''({{OptionalByRef|<Путь и имя файла внешнего объекта (STRING)>}}):''<Результат 0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает 1, если текущая программа исполняется в контексте внешнего объекта (*.sfo). Также функция может получить имя файла объекта, с помощью которого, можно получить сам объект (см. [[ExternalObject.Load]]), если это необходимо.
}}
{{function entry
|name=[[ThreadSerial]]
|form='''ThreadSerial'''():''<Серийный номер (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает уникальный для данной сессии серийный номер потока. Данный серийный номер может использоваться для получения временно-уникального имени семафора или папки для временного хранения данных.
}}
{{function entry
|name=[[ThreadCount]]
|form='''ThreadCount'''():''<Количество программных потоков в текущей сессии (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает количество программных потоков в текущей сессии. После запуска и инициализации клиента, эта функция будет возвращать 1.
}}
{{function entry
|name=[[GetThreadForm]]
|form='''GetThreadForm'''(''<Серийный номер потока (INT)>''):''<Верхнее окно потока (INT)>''
|type=1
|status=2
|visual=1
|description=Функция объект формы для верхнего окна потока, заданного его серийным номером, если поток с указанным серийным номером отсутствует, функция возвращает пустое значение.
}}
{{function entry
|name=[[GetInstalledPrinters]]
|form='''GetInstalledPrinters'''():''<Список принтеров системы (LIST)>''
|type=1
|status=2
|visual=0
|description=Функция получает список текущих принтеров системы. Значениями списка будут строки с наименованиями принтеров, имена списка будут представлены в виде <code><Имя сервера>@<Атрибуты>@<Имя принтера></code>. Подробнее см. описание функции.
}}
{{function entry
|name=[[GetDefaultPrinter]]
|form='''GetDefaultPrinter'''():''<Имя принтера по умолчанию (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает наименование принтера, заданного в системе по умолчанию, либо пустую строку, если такого принтера не существует.
}}
{{function footer}}

== Внешний загружаемый объект ==
Внешние объекты представляют собой файлы с расширением '''sfo''', созданные в [[Общая информация и интерфейс Студии|Студии]]. Файл ''sfo'' является архивом, и содержит набор модулей, форм, таблиц или бинарных файлов, необходимых для выполнения какого-то действия (обработки, отчета и пр.), помещение которого в основном проект по каким-то причинам неудобно или нецелесообразно. Такой внешний объект можно загрузить из главного меню, но иногда необходимо получить программный доступ к файлам объекта, либо запустить модуль и форму объекта из основного проекта. При работе с внешними объектами, полезно знать:
* Файл внешнего объекта находится в памяти системы, пока открыт, по крайней мере, один модуль или одна форма из него, либо существуют переменные, содержащие данный объект. Если объект находится памяти (даже если его открыл пользователь), функция [[ExternalObject.Load]] не будет вызывать его повторной загрузки с диска или сервера, а просто увеличит внутренний счетчик обращений к нему.
* Путь к файлу задается стандартным образом (элементы пути отделяются помощью знаков '''\'''), однако, для элементов пути внутри файла используются уже знаки '''/''' (см. [[Имена файлов]]). К примеру <code>c:\Обработки\Обрабока.sfo/Modules/FreeForms/Таблицы/Table.sft</code>. Для загрузки других модулей и форм объекта из форм самого объекта системный путь к файлу ''sfo'' можно опустить (пример: <code>/Modules/FreeForms/Таблицы/Table.sft</code>), если модуль форма или таблица находятся в той же папке объекта, как и текущий модуль, из которого происходит запрос, достаточно указать знак '''/''', без какого либо дополнительного пути. Стандартную часть <code>/Modules/FreeForms</code> можно пустить, но путь всегда должен начитаться на знак '''/'''.
* См. также функцию [[IsExecutingInExternalModule]], позволяющую определить среду исполнения для внешних объектов.

{{function header}}
{{function entry
|name=[[ExternalObject.FileName|FileName]]
|form={{Grey|ExternalObject.}}'''FileName''':''<Путь и имя файла внешнего объекта (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут позволяет получить путь и имя файла внешнего объекта. Объект должен быть загруженным.
}}
{{function entry
|name=[[ExternalObject.Load|Load]]
|form={{Grey|ExternalObject.}}'''Load'''(''<Путь и имя файла внешнего объекта (STRING)>''):''<Загруженный внешний объект (EXTERNALOBJECT)>''
|type=1
|status=2
|visual=0
|description=Функция загружает (или находит в системе) внешний объект и отдает его, как результат. Если в процессе загрузки произошла ошибка, функция вызывает исключение. Функция может быть вызвана для интерфейса ExternalObject.
}}
{{function entry
|name=[[ExternalObject.DoesFileExist|DoesFileExist]]
|form={{Grey|ExternalObject.}}'''DoesFileExist'''(''<Путь и имя файла внутри объекта (STRING)>''):''<Существует ли указанный файл (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет наличие произвольного файла внутри загруженного внешнего объекта. При указании пути используется разделитель '''/''', начальная часть пути ''Modules/FreeForms'' обязательна к указанию, если файл находится внутри этой ветки (к примеру: <code>Modules/FreeForms/Таблицы/Table.sft</code>).
}}
{{function entry
|name=[[ExternalObject.LoadFileNames|LoadFileNames]]
|form={{Grey|ExternalObject.}}'''LoadFileNames'''(''<Путь и маска для выборки файлов (STRING)>''{{Optional|,<Включать вложенные папки (INT)>{{Default|{{Eq}}0}}}}):''<Список с файлами выборки (LIST)>''
|type=1
|status=2
|visual=0
|description=Функция получает список файлов внутри загруженного внешнего объекта с указанным путем и маской.
}}
{{function entry
|name=[[ExternalObject.FileToString|FileToString]]
|form={{Grey|ExternalObject.}}'''FileToString'''(''<Путь и имя файла файла внутри объекта (STRING)>''{{Optional|,<Кодовая страница (INT)>{{Default|{{Eq}}0}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция загружает указанный файл внешнего объекта в строку, используя указанную кодовую страницу.
}}
{{function entry
|name=[[ExternalObject.FileToBuffer|FileToBuffer]]
|form={{Grey|ExternalObject.}}'''FileToBuffer'''(''<Путь и имя файла файла внутри объекта (STRING)>''):''<Результат (BUFFER)>''
|type=1
|status=2
|visual=0
|description=Функция загружает указанный файл внешнего объекта в буфер.
}}
{{function footer}}

== Объект семафор и многозадачность ==
Семафор -- сложный объект, позволяющий реализовать совокупность методов, для синхронизацию в многозадачном режиме, выполнения частей кода в отдельных потоках и пр. Объект можно применять:
* Как именованный системный объект, позволяющий синхронизировать доступ к файлам и другим внешним ресурсам в пределах одной машины. Пока семафор существует в операционной системе, другая программа, запущенная на той же машине, а также другой программный поток, программы, создавшей семафор, не смогут получить к нему доступ (создать). Такой способ синхронизации позволяет избежать, к примеру, записи в один и тот же временный файл двумя копиями программы. Вторая копия программы, которая не смогла создать семафор с именем файла, может пытаться это сделать с другим именем до тех пор, пока не получится создать семафор.
* Как системное событие, использующееся для синхронизации между потоками в многозадачной среде. Событие имеет два состояния: установлено или сброшено, и позволяет организовать цикл ожидания состояния ''установлено''. Такие циклы используются, чтобы исключить паузу между поступлением команды из другого рабочего потока и началом ее выполнения. Существует также возможность создания цикла ожидания для нескольких семафоров одновременно.
* Как указатель на среду функции, создающийся в момент начала выполнения функции в отдельном потоке. Функции, выполняющиеся в отдельных потоках, являются подчиненными вызвавшему потоку, при завершении основного потока, система автоматически вызывает функцию [[Mutex.TerminateThread|TerminateThread]] для всех работающих в данных момент подчиненных потоков. Поток также завершается автоматически при завершении работы функции.
* Как указатель на среду процесса, создающийся в момент начала выполнения функции в отдельном процессе. Функции, выполняющиеся в отдельных процессах, могут использоваться для изолирования кода исполнения, к примеру когда внешняя библиотека (или OLE объект) работают со сбоями и могут испортить системную память, тем самым вызывая завершение с ошибкой всего процесса клиента. После инициализации режима с помощью функции [[Mutex.InitializeSeparateProcess|InitializeSeparateProcess]], процесс будет находиться в режиме ожидания исполнения, клиент же может периодически вызывать функцию [[Mutex.InterProcessExecuteFunction|InterProcessExecuteFunction]] для исполнения программы в ожидающем процессе. После удаления объекта семафора из системы, подчиненный процесс также будет завершен. Исполнение всегда происходит в синхронном режиме (функция ''InterProcessExecuteFunction'' ожидает окончания исполнения удаленной функции и только после этого возвращает результат), асинхронный режим для большей гибкости при работате планируется в будущем.

{{function header}}
{{function entry
|name=[[Mutex.CreateMutex|CreateMutex]]
|form={{Grey|Mutex.}}'''CreateMutex'''(''<Имя семафора (STRING)>''):''<Ноль или новый объект семафора (INT,MUTEX)>''
|type=1
|status=2
|visual=0
|description=Функция создает именованный семафор с указанным именем, либо возвращает ноль, если семафор с таким именем уже существует в системе. В момент, когда объект будет удален из системы, созданный семафор также удаляется.
}}
{{function entry
|name=[[Mutex.CheckMutex|CheckMutex]]
|form={{Grey|Mutex.}}'''CheckMutex'''(''<Имя семафора (STRING)>''):''<Существует ли семафор (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, существует ли в системе именованный семафор с указанным именем.
}}
{{function entry
|name=[[Mutex.CreateEvent|CreateEvent]]
|form={{Grey|Mutex.}}'''CreateEvent'''({{Optional|<Начальное состояние (INT)>{{Default|{{Eq}}0}}}}):''<Новый объект события (MUTEX)>''
|type=1
|status=2
|visual=0
|description=Функция создает новое системное событие с возможным указанием его начального состояния. Событие может принимать два состояния: ''установлено'' и ''сброшено'', и может использоваться при вызове функций [[Mutex.WaitForEvent|WaitForEvent]] или [[Mutex.WaitForEvents|WaitForEvents]].
}}
{{function entry
|name=[[Mutex.WaitForEvent|WaitForEvent]]
|form={{Grey|Mutex.}}'''WaitForEvent'''({{Optional|<Время ожидания в мс. (INT)>{{Default|{{Eq}}-1}}}}):''<0, если время закончилось, 1, если произошло событие (INT)>''
|type=1
|status=2
|visual=0
|description=Функция выполняет цикл ожидания для текущего события в течение указанного времени (по умолчанию, время не ограничено). Если событие произошло (было ''установлено'' функцией [[Mutex.SignalEvent|SignalEvent]]), функция возвращает 1 и автоматически сбрасывает состояние события.
}}
{{function entry
|name=[[Mutex.WaitForEvents|WaitForEvents]]
|form={{Grey|Mutex.}}'''WaitForEvents'''(''<Список событий (LIST)>''{{Optional|,<Время ожидания в мс. (INT)>{{Default|{{Eq}}-1}}}}):''<0, если время закончилось, иначе индекс произошедшего события (INT)>''
|type=1
|status=2
|visual=0
|description=Функция выполняет цикл ожидания для списка с событиями в течение указанного времени (по умолчанию, время не ограничено). Если одно из событий произошло (было ''установлено'' функцией [[Mutex.SignalEvent|SignalEvent]]), функция возвращает индекс этого события и автоматически сбрасывает его (и только его) состояние. Функция может быть вызвана для интерфейса Mutex.
}}
{{function entry
|name=[[Mutex.SignalEvent|SignalEvent]]
|form={{Grey|Mutex.}}'''SignalEvent'''()
|type=1
|status=2
|visual=0
|description=Функция меняет состояние текущего события на ''установлено''.
}}
{{function entry
|name=[[Mutex.ResetEvent|ResetEvent]]
|form={{Grey|Mutex.}}'''ResetEvent'''()
|type=1
|status=2
|visual=0
|description=Функция меняет состояние текущего события на ''сброшено''. Функция не рекомендуется к использованию (так как есть вероятность потерять одно событие), кроме как внутри конструкции блокировки объекта с помощью [[LockObject]] и проверке [[Mutex.EventState|EventState]] до ее вызова.
}}
{{function entry
|name=[[Mutex.EventState|EventState]]
|form={{Grey|Mutex.}}'''EventState'''():''<0, если сброшено, 1, если установлено (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает текущее состояние события, при этом состояние не изменяется.
}}
{{function entry
|name=[[Mutex.ExecuteFunctionInSeparateThread|ExecuteFunctionInSeparateThread]]
|form={{Grey|Mutex.}}'''ExecuteFunctionInSeparateThread'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска или компилированная функция (INT, COMPILEDFUNCTION)>{{Default|{{Eq}}0}},<Аргумент 1>,<Аргумент 2>...}}):''<Указатель на среду функции (MUTEX)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый поток для указанной функции, поток будет создан, как подчиненный текущему и будет автоматически завершен, если выполнение функции завершится (в т.ч. из-за исключения), либо если основной поток будет завершен. При завершении подчиненного потока, система не ждет полного окончания завершения, так как оно может занять продолжительное время, если функция выполняет внешний вызов OLE и пр., чтобы убедиться, что поток завершен, можно использовать функцию [[Mutex.TerminateThread|TerminateThread]]. Функция может быть вызвана для интерфейса Mutex.
}}
{{function entry
|name=[[Mutex.TerminateThread|TerminateThread]]
|form={{Grey|Mutex.}}'''TerminateThread'''({{Optional|<Без ожидания (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция безусловно завершает выполнение подчиненного потока, с ожиданием окончания завершения, если необходимо. При завершении потока, будут выполнены все вложенные конструкции ''Finally'', как будто поток был завершен по требованию пользователя.
}}
{{function entry
|name=[[Mutex.IsThreadActive|IsThreadActive]]
|form={{Grey|Mutex.}}'''IsThreadActive'''():''<Исполняется ли текущий поток (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, работает ли адресуемый текущим объектом подчиненный поток (1), либо он уже завершен (0).
}}
{{function entry
|name=[[Mutex.InitializeSeparateProcess|InitializeSeparateProcess]]
|form={{Grey|Mutex.}}'''InitializeSeparateProcess'''({{Optional|<Идентификатор процесса (STRING)>,<Скомпилированная функция или текст модуля (STRING, COMPILEDFUNCTION)>}}):''<Указатель на среду процесса (MUTEX)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый процесс для указанного модуля (или текущего, если модуль не указан). Процесс может быть создан как для визуального, так и для консольного клиента. После инициализации, процесс ожидает выполнения функций, доступных для указанного модуля. Процесс завершается автоматически, когда объект семаформа будет удален. Функция может быть вызвана для интерфейса Mutex.
}}
{{function entry
|name=[[Mutex.InterProcessExecuteFunction|InterProcessExecuteFunction]]
|form={{Grey|Mutex.}}'''InterProcessExecuteFunction'''(''<Имя функции (STRING)>''{{OptionalByRef|,<Аргумент 1>,<Аргумент 2>...}}):''<Результат исполнения функции>''
|type=1
|status=2
|visual=0
|description=Функция вызывает исполнение указанной функции в подчиненном процессе, созданном ранее функцией [[Mutex.InitializeSeparateProcess|InitializeSeparateProcess]], и возвращает ошибку или результат ее исполнения. При вызове в функцию разрешено передавать объекты произвольного вида (однако, есть определенные особенности для которых см. описание), изменяемые аргументы-переменные также могут быть обновлены после исполнения.
}}
{{function entry
|name=[[Mutex.InterProcessTimeout|InterProcessTimeout]]
|form={{Grey|Mutex.}}'''InterProcessTimeout'''({{Optional|<Тайм-аут в мс.>}}):''<Предыдущий тайм-аут в мс. (INT)>''
|type=1
|status=2
|visual=0
|description=Функция включает сторожевого пса для контроля зависания подчиненного процесса. Процесс будет считаться неработоспособным, если за указанное время основной поток исполнения ни разу не ответил на запрос о состоянии (основной поток создает такие ответы после исполнения каждой команды, а также в моменты бездействия).
}}
{{function entry
|name=[[InterProcessServerTimeout]]
|form='''InterProcessServerTimeout'''({{Optional|<Тайм-аут в мс.>}}):''<Предыдущий тайм-аут в мс. (INT)>''
|type=1
|status=2
|visual=0
|description=Функция позволяет получать или изменять тайм-аут сторожевого пса родительского процесса на стороне подчиненного процесса. Это позволяет, к примеру, для более длительных операций увеличить тайм-аут или временно отключить его.
}}
{{function entry
|name=[[Mutex.TerminateProcess|TerminateProcess]]
|form={{Grey|Mutex.}}'''TerminateProcess'''({{Optional|<Без ожидания (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция безусловно завершает выполнение подчиненного процесса, с ожиданием окончания завершения, если необходимо.
}}
{{function entry
|name=[[Mutex.IsProcessActive|IsProcessActive]]
|form={{Grey|Mutex.}}'''IsProcessActive'''():''<Активен ли подчиненный процесс (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, активен ли (не завершился ли) адресуемый текущим объектом подчиненный процесс.
}}
{{function footer}}

{{Объекты}}

Таблица

2026-04-01T10:01:35Z

Admin: 1 revision imported

{{infobox object
|image=tab.png
|visual=[[Студия/Таблица значений|Таблица значений]]
|object=Tab
|status=2
|create=[[Tab.Create|Create]]}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]}}
Объект '''таблица''' позволяет хранить большие объемы данных любого типа в виде таблиц, а также сортировать их, объединять таблицы, задавать определенные типы данных столбцам таблицы, хранить информацию о флажках или иконках. Таблицы представлены на формах [[Студия/Таблица значений|таблицами значений]], результаты запросов представлены таблицами, таблицы используются в разнообразных функциях и объектах и являются неотъемлемой частью системы. Функции работы с таблицами имеют ряд оптимизаций, доступных разработчикам.
Таблица имеет три внутренних указателя:
* Текущая строка (''CurLine'') -- внутренний указатель, использующийся при изменении ячеек таблицы по наименованию столбца (к примеру, <code>aTab.<Столбец>:=<Значение></code>). Указатель меняется при добавлении, удалении или сдвиге строк, а также при выборке строк таблицы с помощью функции [[Tab.Select|Select]], поиске значений и пр. Нумерация строк начинается с единицы.
* Выбранная строка (''SelectedLine'') -- внутренний указатель, совпадающий с положением курсора (выделенной ячейки) внутри таблицы, когда она представлена на экране в виде элемента формы. Изменение указателя автоматически перемещает курсор. Использование указателя для невизуальных таблиц не запрещено. Нумерация строк начинается с единицы.
* Выбранный столбец (''SelectedColumn'') -- внутренний указатель, совпадающий с положением курсора (выделенного столбца) внутри таблицы, когда она представлена на экране в виде элемента формы. Изменение указателя автоматически перемещает курсор. Использование указателя для невизуальных таблиц не запрещено. Нумерация столбцов начинается с единицы.

== Атрибуты и функции==
{{function header}}
{{function entry
|name=[[Tab.Array|[<Индекс столбца (INT,STRING)>]]], [[Tab.Array|[<Индекс столбца (INT,STRING)>,<Индекс строки (INT)>]]]
|form={{Grey|Tab}}'''[<Индекс или наименование столбца (INT,STRING)>{{Optional|,<Индекс строки (INT)>}}]''':''<Значение>''
|type=0
|status=2
|visual=0
|description=Использование синтаксиса массивов позволяет получить или изменить значение таблицы по индексу (аргументом является число) или наименованию (аргументом является строка) его столбца для текущей строки таблицы, если не задан второй аргумент, иначе для строки таблицы заданной индексом, указанным во втором аргументе.
}}
{{function entry
|name=[[Tab.ColumnName|<Имя столбца>]]
|form={{Grey|Tab.}}'''<Имя столбца>''':''<Значение ячейки>''
|type=0
|status=2
|visual=0
|description=Получить значение таблицы, находящееся в столбце ''<Имя столбца>'' и строке с индексом CurLine
}}
{{function entry
|name=[[Tab.CurLine|CurLine]]
|form={{Grey|Tab.}}'''CurLine''':''<Индекс текущей строки (INT)>''
|type=0
|status=2
|visual=0
|description=Получить индекс текущей строки таблицы (первая строка=1). Текущая строка и выбранная пользователем строка визуального объекта, привязанного к таблице, могут иметь разные значения. Текущая строка используется в функциях выборки строк таблицы [[Tab.Select|Select]] и пр.
}}
{{function entry
|name=[[Tab.SelectedLine|SelectedLine]]
|form={{Grey|Tab.}}'''SelectedLine''':''<Индекс выбранной строки (INT)>''
|type=0
|status=2
|visual=1
|description=Получить индекс выбранной строки визуального объекта (первая строка=1). Текущая строка и выбранная пользователем строка визуального объекта, привязанного к таблице, могут иметь разные значения.
}}
{{function entry
|name=[[Tab.SelectedColumn|SelectedColumn]]
|form={{Grey|Tab.}}'''SelectedColumn''':''<Индекс выбранного столбца (INT)>''
|type=0
|status=2
|visual=1
|description=Получить индекс выбранного столбца визуального объекта (первый столбец=1). Скрытые в визуальной таблице столбцы также участвуют в подсчете индекса.
}}
{{function entry
|name=[[Tab.SelectedColumnName|SelectedColumnName]]
|form={{Grey|Tab.}}'''SelectedColumnName''':''<Наименование выбранного столбца (STRING)>''
|type=0
|status=2
|visual=1
|description=Получить наименование выбранного столбца визуального объекта, как оно было заданно в Студии. Наименование всегда хранится в верхнем регистре.
}}
{{function entry
|name=[[Tab.MultiSelection|MultiSelection]]
|form={{Grey|Tab.}}'''MultiSelection''':''<Таблица с выбранными регионами (TAB)>''
|type=0
|status=2
|visual=1
|description=Получить таблицу, описывающую все регионы, выделенные пользователем, для визуальных таблиц с возможностью выделения регионов. Таблица не будет содержать ни одной строки, если таблица не привязана к визуальному объекту, либо в объекте не выбрана ни одна строка.
}}
{{function entry
|name=[[Tab.IsEditorActive|IsEditorActive]]
|form={{Grey|Tab.}}'''IsEditorActive''':''<Статус редактора ячейки (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут проверяет, активен ли редактор ячейки таблицы в данный момент.
}}
{{function entry
|name=[[Tab.Create|Create]]
|form={{Grey|Tab.}}'''Create'''({{Optional|<Список столбцов через запятую (STRING)>}}):''<Новый объект (TAB)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает новый объект типа [[Таблица]], создавая столбцы с заданными именами, если необходимо.
}}
{{function entry
|name=[[Tab.Column|Column]]
|form={{Grey|Tab.}}'''Column'''(''<Наименование или индекс столбца (INT,STRING)>''):''<Объект столбца таблицы (TAB)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает подчиненный объект типа [[Таблица#Объект столбца таблицы|столбец таблицы]]. Доступ к свойствам столбцов таким образом опасен для многопоточных объектов. Необходимо использовать функции [[LockObject]] и [[UnlockObject]], когда объект используется в нескольких потоках.
}}
{{function entry
|name=[[Tab.Size|Size]], '''Lines'''
|form={{Grey|Tab.}}'''Size'''({{Optional|<Новое количество строк (INT)>}}):''<Текущее количество строк в таблице (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает или/и изменяет количество строк в таблице.
}}
{{function entry
|name=[[Tab.Columns|Columns]]
|form={{Grey|Tab.}}'''Columns'''({{Optional|<Новое количество столбцов (INT)>}}):''<Текущее количество столбцов в таблице (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает или/и изменяет количество столбцов в таблице.
}}
{{function entry
|name=[[Tab.AddColumn|AddColumn]]
|form={{Grey|Tab.}}'''AddColumn'''({{Optional|<Наименование столбца (STRING)>,<Заголовок столбца (STRING)>,<Тип данных столбца (STRING)>,<Ширина столбца (INT)>,<Режим выравнивания столбца (INT)>,<Видимость столбца (INT)>}})
|type=1
|status=2
|visual=0
|description=Функция добавляет столбец в таблицу, устанавливая его свойства, если необходимо. Если количество строк в таблице больше нуля, ячейки столбца заполняются пустым значением, либо принимают неинициализированное значение в соответствии с типом данных столбца, если последний задан.
}}
{{function entry
|name=[[Tab.InsertColumn|InsertColumn]]
|form={{Grey|Tab.}}'''InsertColumn'''(''<Индекс вставляемого столбца (INT)>''{{Optional|,<Наименование столбца (STRING)>,<Заголовок столбца (STRING)>,<Тип данных столбца (STRING)>,<Ширина столбца (INT)>,<Режим выравнивания столбца (INT)>,<Видимость столбца (INT)>}})
|type=1
|status=2
|visual=0
|description=Функция добавляет столбец в таблицу с указанным индексом, устанавливая его свойства, если необходимо. Если количество строк в таблице больше нуля, ячейки столбца заполняются пустым значением, либо принимают неинициализированное значение в соответствии с типом данных столбца, если последний задан.
}}
{{function entry
|name=[[Tab.RemoveColumn|RemoveColumn]]
|form={{Grey|Tab.}}'''RemoveColumn'''(''<Наименование или индекс столбца (INT,STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция удаляет столбец с указанным индексом или наименованием из таблицы.
}}
{{function entry
|name=[[Tab.SetColumn|SetColumn]]
|form={{Grey|Tab.}}'''SetColumn'''(''<Наименование или индекс столбца (INT,STRING)>''{{Optional|,<Заголовок столбца (STRING)>,<Тип данных столбца (STRING)>,<Ширина столбца (INT)>,<Режим выравнивания столбца (INT)>,<Видимость столбца (INT)>}})
|type=1
|status=2
|visual=0
|description=Функция изменяет свойства столбца с указанным индексом или наименование. Если новый тип данных столбца задан, все существующие ячейки таблицы в данном столбце будут приведены к новому типу данных.
}}
{{function entry
|name=[[Tab.GetColumnIndex|GetColumnIndex]]
|form={{Grey|Tab.}}'''GetColumnIndex'''(''<Наименование столбца (STRING)>''):''<Индекс столбца (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает индекс столбца с заданным наименованием. Если столбец не существует, функция возвращает ноль.
}}
{{function entry
|name=[[Tab.GetColumnName|GetColumnName]]
|form={{Grey|Tab.}}'''GetColumnName'''(''<Индекс столбца (INT)>''):''<Наименование столбца таблицы (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает наименование столбца с заданным индексом. Наименования столбцов всегда хранятся в верхнем регистре.
}}
{{function entry
|name=[[Tab.NewLine|NewLine]]
|form={{Grey|Tab.}}'''NewLine'''({{Optional|<Индекс новой строки (INT)>}})
|type=1
|status=2
|visual=0
|description=Функция добавляет в конец таблицы новую строку и помечает ее как текущую. Строка также может быть вставлена в таблицу по определенному индексу, если он задан.
}}
{{function entry
|name=[[Tab.AddLine|AddLine]]
|form={{Grey|Tab.}}'''AddLine'''(''<Наименования столбцов через запятую (STRING)>''{{Optional|,<Значение столбца 1>,<Значение столбца 2>...}})
|type=1
|status=2
|visual=0
|description=Функция добавляет в конец таблицы новую строку и помечает ее как текущую. Указанные в первом аргументе столбцы таблицы, в добавленной строке будут заполнены значениями, заданными последующими аргументами.
}}
{{function entry
|name=[[Tab.AddLineSorted|AddLineSorted]]
|form={{Grey|Tab.}}'''AddLineSorted'''(''<Наименования столбцов сортировки через запятую (STRING)>'',''<Наименования столбцов добавления через запятую (STRING)>''{{Optional|,<Значение столбца 1>,<Значение столбца 2>...}})
|type=1
|status=2
|visual=0
|description=Функция добавляет новую строку и помечает ее как текущую. Указанные во втором аргументе столбцы таблицы, в добавленной строке будут заполнены значениями, заданными последующими аргументами. Строка вставляется в таблицу таким образом, чтобы не нарушить сортировку, заданную наименованиями столбцов первого аргумента.
}}
{{function entry
|name=[[Tab.UpdateLineEx|UpdateLineEx]]
|form={{Grey|Tab.}}'''UpdateLineEx'''(''<Наименования столбцов поиска через запятую (STRING)>''{{OptionalByRef|,''<Начальный индекс поиска, результирующий индекс (INT)>''}}{{Optional|,<Значение столбца поиска 1>,<Значение столбца поиска 2>...,<Таблица сортирована по столбцам поиска (INT)>,<Наименования столбцов обновления через запятую (STRING)>,<Значение обновления столбца 1>,<Значение обновления столбца 2>...}}):''<0, если строка добавлена, иначе количество обновленных строк (INT)>''
|type=1
|status=2
|visual=0
|description=Функция обновляет строки, заданные аргументами для поиска или добавляет новую строку. Поиск начинается со строки, заданной вторым аргументом. Для всех строк, удовлетворящих условиям поиска, значения в столбцах, заданных аргументов с наименования столбцов обновления, будут изменены на аргументы, идущие за аргументом с наименованиями. Если ни одна строка не найдена, будет добавлена одна новая строка. Если применяется сортированный поиск (аргумент сортироки равен 1), строка вставляется в таблицу таким образом, чтобы не нарушить сортировку, заданную наименованиями столбцов первого аргумента. Если второй аргумент является переменной, в ней будет возвращен индекс добавленной строки или общее количество найденных и измененных строк в соотвествии с результатами поиска. Данная функция не использует текущую строку таблицы, что позволяет ее применять при работе с нескольми потоками (thread-safe).
}}
{{function entry
|name=[[Tab.InsertLine|InsertLine]]
|form={{Grey|Tab.}}'''InsertLine'''(''<Индекс добавляемой строки (INT)>'',''<Наименования столбцов через запятую (STRING)>''{{Optional|,<Значение столбца 1>,<Значение столбца 2>...}})
|type=1
|status=2
|visual=0
|description=Функция вставляет строку в таблицу по указанному индексу и помечает ее как текущую. Указанные в первом аргументе столбцы таблицы, в добавленной строке будут заполнены значениями, заданными последующими аргументами.
}}
{{function entry
|name=[[Tab.CopyLine|CopyLine]]
|form={{Grey|Tab.}}'''CopyLine'''({{Optional|<Индекс копируемой строки (INT)>,<Индекс новой строки (INT)>,<Количество добавляемых строк (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=0
|description=Функция добавляет новую строку по указанному во втором аргументе индексу (или в конец таблицы, если второй аргумент опущен) и заполняет ее значениями из строки, указанной в первом аргументе (или текущей строки, если первый аргумент опущен).
}}
{{function entry
|name=[[Tab.Remove|Remove]]
|form={{Grey|Tab.}}'''Remove'''(''<Индекс удаляемой строки (INT)>''{{Optional|,<Количество удаляемых строк (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=0
|description=Функция удаляет указанное количество строк (либо одну строку, если второй аргумент опущен), начиная с индекса, заданного первым аргументом.
}}
{{function entry
|name=[[Tab.ClearLines|ClearLines]]
|form={{Grey|Tab.}}'''ClearLines'''()
|type=1
|status=2
|visual=0
|description=Функция удаляет все строки из таблицы (при этом количество столбцов не изменяется).
}}
{{function entry
|name=[[Tab.Clear|Clear]]
|form={{Grey|Tab.}}'''Clear'''()
|type=1
|status=2
|visual=0
|description=Функция удаляет все строки и столбцы из таблицы.
}}
{{function entry
|name=[[Tab.Select|Select]]
|form={{Grey|Tab.}}'''Select'''():''<В таблице есть по крайней мере одна строка (INT)>''
|type=1
|status=2
|visual=0
|description=Функция начинает выборку по строкам таблицы (ее действие аналогично фрагменту <code><Таблица>.CurLine:=0</code>). Функция возвращает 1, если в выборке есть по крайней мере одна строка, иначе возвращается ноль. Функция используется в начале цикла по обходу всех строк таблицы.
}}
{{function entry
|name=[[Tab.Next|Next]]
|form={{Grey|Tab.}}'''Next'''():''<Найдена следующая строка (INT)>''
|type=1
|status=2
|visual=0
|description=Функция перемещает указатель текущей строки на следующую строку и возвращает единицу, если следующая строка существует, иначе возвращает ноль. Действие функции аналогично фрагменту <code><Таблица>.CurLine:=?(<Таблица>.CurLine=<Таблица>.Size(),<Таблица>.CurLine,<Таблица>.CurLine+1)</code>. Функция используется внутри цикла по обходу всех строк таблицы.
}}
{{function entry
|name=[[Tab.Prev|Prev]]
|form={{Grey|Tab.}}'''Prev'''():''<Найдена предыдущая строка (INT)>''
|type=1
|status=2
|visual=0
|description=Функция перемещает указатель текущей строки на предыдущую строку, если указатель больше нуля, и возвращает единицу, если предыдущая строка существует, иначе возвращает ноль. Действие функции аналогично фрагменту <code><Таблица>.CurLine:=?(<Таблица>.CurLine=0,<Таблица>.CurLine,<Таблица>.CurLine-1)</code>.
}}
{{function entry
|name=[[Tab.Goto|Goto]]
|form={{Grey|Tab.}}'''Goto'''(''<Индекс строки (INT)>'')
|type=1
|status=2
|visual=0
|description=Функция перемещает указатель текущей строки на строку с указанным индексом. Действие функции аналогично фрагменту <code><Таблица>.CurLine:=<Индекс></code>
}}
{{function entry
|name=[[Tab.Move|Move]]
|form={{Grey|Tab.}}'''Move'''(''<Индекс перемещаемой строки (INT)>'',''<Расстояние перемещения (INT)>'')
|type=1
|status=2
|visual=0
|description=Функция сдвигает строку с индексом, задаваемым первым аргументом, внутри таблицы на указанное количество строк. Расстояние сдвига может быть отрицательным числом. При положительном сдвиге, строка из конца таблицы переходит в ее начало, при отрицательном сдвиге строка с начала таблицы переходит в конец.
}}
{{function entry
|name=[[Tab.Set|Set]]
|form={{Grey|Tab.}}'''Set'''({{Optional|<Индекс строки (INT)>}},''<Наименование или индекс столбца (INT,STRING)>'',''<Устанавливаемое значение>'')
|type=1
|status=2
|visual=0
|description=Функция устанавливает значение ячейки с наименованием или индексом столбца, заданным вторым аргументом, индекс строки ячейки задается первым аргументом или используется текущая строка, если первый аргумент не задан.
}}
{{function entry
|name=[[Tab.Get|Get]]
|form={{Grey|Tab.}}'''Get'''({{Optional|<Индекс строки (INT)>}},''<Наименование или индекс столбца (INT,STRING)>''):''<Значение ячейки таблицы>''
|type=1
|status=2
|visual=0
|description=Функция получает значение ячейки с наименованием или индексом столбца, заданным вторым аргументом, индекс строки ячейки задается первым аргументом или используется текущая строка, если первый аргумент не задан.
}}
{{function entry
|name=[[Tab.Find|Find]]
|form={{Grey|Tab.}}'''Find'''(''<Значение поиска>''{{OptionalByRef|,<Начальный индекс поиска, результирующий индекс (INT)>,<Наименование или индекс столбца поиска, индекс результирующего столбца (STRING,INT)>}}{{Optional|,<Таблица сортирована по столбцу поиска (INT)>}}):''<Значение найдено 1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск значения в таблице, с возможным указанием начального индекса поиска, возможным указанием столбца поиска. Поиск может принимать во внимание факт того, что таблица сортирована по указанному столбцу по неубыванию, что может значительно ускорить нахождение значения. Если значение найдено, индекс строки или/и столбца, где оно было найдено, возвращается в переменных второго и третьего аргументов.
}}
{{function entry
|name=[[Tab.FindAndGoto|FindAndGoto]]
|form={{Grey|Tab.}}'''FindAndGoto'''(''<Значение поиска>''{{OptionalByRef|,<Начальный индекс поиска, результирующий индекс (INT)>,<Наименование или индекс столбца поиска, индекс результирующего столбца (STRING,INT)>}}{{Optional|,<Таблица сортирована по столбцу поиска (INT)>}}):''<Значение найдено 1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск значения в таблице, с возможным указанием начального индекса поиска, возможным указанием столбца поиска. Поиск может принимать во внимание факт того, что таблица сортирована по указанному столбцу по неубыванию, что может значительно ускорить нахождение значения. Если значение найдено, индекс строки или/и столбца, где оно было найдено, возвращается в переменных второго и третьего аргументов, функция также автоматически изменяет индекс текущей строки на индекс строки найденного значения, текущая строка не изменяется, если значение не найдено.
}}
{{function entry
|name=[[Tab.FindAndGet|FindAndGet]]
|form={{Grey|Tab.}}'''FindAndGet'''(''<Наименование или индекс столбца значения результата (STRING,INT)>'',''<Значение поиска>''{{OptionalByRef|,<Начальный индекс поиска, результирующий индекс (INT)>,<Наименование или индекс столбца поиска, индекс результирующего столбца (STRING,INT)>}}{{Optional|,<Таблица сортирована по столбцу поиска (INT)>}}):''<Полученное значение или пустое значение>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск значения в таблице, с возможным указанием начального индекса поиска, возможным указанием столбца поиска. Поиск может принимать во внимание факт того, что таблица сортирована по указанному столбцу по неубыванию, что может значительно ускорить нахождение значения. Если значение найдено, индекс строки или/и столбца, где оно было найдено, возвращается в переменных третьего и четвертого аргументов. Функция возвращает значение в столбце, заданном первым аргументом, из строки, в которой было найдено значение поиска, либо возвращает пустое значение, если поиск не был завершен успешно.
}}
{{function entry
|name=[[Tab.FindInLine|FindInLine]]
|form={{Grey|Tab.}}'''FindInLine'''(''<Значение поиска>''{{Optional|,<Индекс строки поиска (INT)>}}{{OptionalByRef|,<Наименование или индекс начального столбца поиска, индекс результирующего столбца (STRING,INT)>}}):''<Значение найдено 1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск значения в таблице в текущей строке или строке с заданным индексом, возможным указанием начального индекса столбца поиска. Если значение найдено, индекс столбца, где оно было найдено, возвращается в переменной третьего аргумента.
}}
{{function entry
|name=[[Tab.Locate|Locate]]
|form={{Grey|Tab.}}'''Locate'''(''<Список наименований столбцов поиска через запятую (STRING)>''{{Optional|,<Значение поиска столбца 1>,<Значение поиска столбца 2>...,<Таблица сортирована по столбцам поиска (INT)>}}):''<Индекс найденной строки таблицы (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск заданного списком столбцов количества значений в таблице. Поиск всегда начинается с первой строки таблицы. Поиск может принимать во внимание факт того, что таблица сортирована по всем столбцам поиска по неубыванию, что может значительно ускорить нахождение значения. Если значение найдено, индекс строки где оно было найдено, возвращается в результате функции, иначе функция возвращает ноль.
}}
{{function entry
|name=[[Tab.LocateEx|LocateEx]]
|form={{Grey|Tab.}}'''LocateEx'''(''<Список наименований столбцов поиска через запятую (STRING)>''{{OptionalByRef|,<Начальный индекс поиска, результирующий индекс (INT)>}}{{Optional|,<Значение поиска столбца 1>,<Значение поиска столбца 2>...,<Таблица сортирована по столбцам поиска (INT)>}}):''<Индекс найденной строки таблицы (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск заданного списком столбцов количества значений в таблице. Поиск начинается со строки, указанной в переменной второго аргумента или с первой строки, если аргумент пропущен. Поиск может принимать во внимание факт того, что таблица сортирована по всем столбцам поиска по неубыванию, что может значительно ускорить нахождение значения. Если значение найдено, индекс строки где оно было найдено, возвращается в результате функции и в переменной второго аргумента, если она задана. Если значение не было найдено, функция возвращает ноль и переменная не изменяется.
}}
{{function entry
|name=[[Tab.LocateAndGoto|LocateAndGoto]]
|form={{Grey|Tab.}}'''LocateAndGoto'''(''<Список наименований столбцов поиска через запятую (STRING)>''{{Optional|,<Значение поиска столбца 1>,<Значение поиска столбца 2>...,<Таблица сортирована по столбцам поиска (INT)>}}):''<Индекс найденной строки таблицы (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск заданного списком столбцов количества значений в таблице. Поиск всегда начинается со строки таблицы, следующей за текущей строкой (чтобы поиск начинался с начала таблицы, можно выполнить операцию <code><Таблица>.CurLine:=0</code>). Поиск может принимать во внимание факт того, что таблица сортирована по всем столбцам поиска по неубыванию, что может значительно ускорить нахождение значения. Если значение найдено, индекс строки где оно было найдено, возвращается в результате функции и обновляет текущую строку таблицы, иначе функция возвращает ноль.
}}
{{function entry
|name=[[Tab.Sort|Sort]]
|form={{Grey|Tab.}}'''Sort'''(''<Наименование столбцов сортировки с суффиксами через запятую (STRING)>''{{Optional|,<Алгоритм сортировки (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=0
|description=Функция выполняет сортировку строк таблицы по значениям указанных столбцов (направление сортировки может быть выбрано для каждого из столбцов в отдельности).
}}
{{function entry
|name=[[Tab.Sum|Sum]]
|form={{Grey|Tab.}}'''Sum'''(''<Наименование или индекс столбца (INT,STRING)>''{{Optional|,<Строки превращать в числа (INT)>{{Default|{{Eq}}0}},<Индекс начальной строки (INT)>{{Default|{{Eq}}0}},<Индекс конечной строки (INT)>{{Default|{{Eq}}<Последняя строка таблицы>}},<Округление при суммировании (INT)>{{Default|{{Eq}}-1}}}}):''<Результирующая сумма (NUMBER)>''
|type=1
|status=2
|visual=0
|description=Функция находит сумму значений указанного столбца таблицы в указанном диапазоне строк таблицы. Значения, представленные строками, могут быть превращены в числа при сложении, если необходимо. Для исключения накопления неточности при сложении вещественных чисел, можно указать требуемое количество цифр после точки.
}}
{{function entry
|name=[[Tab.Compute|Compute]]
|form={{Grey|Tab.}}'''Compute'''(''<Наименование или индекс столбца (INT,STRING)>''{{Optional|,<Тип операции (STRING)>{{Default|{{Eq}}"SUM"}},<Строки превращать в числа (INT)>{{Default|{{Eq}}0}},<Индекс начальной строки (INT)>{{Default|{{Eq}}0}},<Индекс конечной строки (INT)>{{Default|{{Eq}}<Последняя строка таблицы>}},<Округление при суммировании или нахождении среднего (INT)>{{Default|{{Eq}}-1}}}}):''<Результат вычисления (NUMBER)>''
|type=1
|status=2
|visual=0
|description=Функция выполняет одну из следующих операций на значениях указанного столбца таблицы в указанном диапазоне строк таблицы: сумма, минимум, максимум, среднее, количество значений. Значения, представленные строками, могут быть превращены в числа при сложении, если необходимо. Для исключения накопления неточности при сложении вещественных чисел, можно указать требуемое количество цифр после точки.
}}
{{function entry
|name=[[Tab.SumLine|SumLine]]
|form={{Grey|Tab.}}'''SumLine'''(''<Индекс строки суммирования (INT)>''{{Optional|,<Строки превращать в числа (INT)>{{Default|{{Eq}}0}},<Округление при суммировании (INT)>{{Default|{{Eq}}-1}}}}):''<Результирующая сумма (NUMBER)>''
|type=1
|status=2
|visual=0
|description=Функция находит сумму значений указанной строки таблицы. Значения, представленные строками, могут быть превращены в числа при сложении, если необходимо. Для исключения накопления неточности при сложении вещественных чисел, можно указать требуемое количество цифр после точки.
}}
{{function entry
|name=[[Tab.Fill|Fill]]
|form={{Grey|Tab.}}'''Fill'''(''<Значение для заполнения>''{{Optional|,<Индекс начальной строки (INT)>,<Индекс конечной строки (INT)>,<Индекс или наименование столбца (INT,STRING)>}})
|type=1
|status=2
|visual=0
|description=Функция выполняет заполнение ячеек в указанном столбце таблицы для строк таблицы в указанном диапазоне указанным значением.
}}
{{function entry
|name=[[Tab.Copy|Copy]]
|form={{Grey|Tab.}}'''Copy'''({{Optional|<Только создать столбцы (INT)>{{Default|{{Eq}}0}}}}):''<Новая таблица (TAB)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый объект таблицы и заполняет ее столбцами, строками и значениями из текущей таблицы. Значения скопированы не будут, если первый аргумент равен ''1''.
}}
{{function entry
|name=[[Tab.CopyTo|CopyTo]]
|form={{Grey|Tab.}}'''CopyTo'''({{ByRef|''<Объект в который происходит копирование>''}}{{Optional|,<Индекс начальной строки (INT)>,<Количество строк для копирования (INT)>,<Наименования столбцов копирования через запятую (STRING)>,<Наименования столбцов для фильтрации (STRING)>,<Фильтр столбца 1>,<Фильтр столбца 2>...}})
|type=1
|status=2
|visual=0
|description=Функция позволяет произвести копирование ячеек указанного столбца из текущей таблицы в заданный список, либо ячеек, указанных столбцов из текущей таблицы в заданную таблицу. Строки для копирования могут быть ограничены определенным диапазоном и выбраны с помощью заданного фильтра.
}}
{{function entry
|name=[[Tab.Group|Group]]
|form={{Grey|Tab.}}'''Group'''({{Optional|<Наименования столбцов группировки через запятую (STRING)>,<Наименования столбцов для агрегации с типами операций (STRING)>,<Округление при суммировании (INT)>{{Default|{{Eq}}-1}}}})
|type=1
|status=2
|visual=0
|description=Функция производит группировку таблицы по указанным столбцам, строки, где совокупность значений столбцов группировки повторяется, будут удалены, при этом над столбцами агрегации для всех строк дублей и строки, оставшейся в таблице, будет произведена указанная операция агрегации. Столбцы, не перечисленные в столбцах группировки и столбцах агрегации, будут удалены. Для исключения накопления неточности при сложении вещественных чисел, можно указать требуемое количество цифр после точки при выполнении операций агрегации. После выполнения операции, в таблице сохраняется порядок следования строк, существовавший до операции.
}}
{{function entry
|name=[[Tab.InnerJoin|InnerJoin]], '''Join'''
|form={{Grey|Tab.}}'''InnerJoin'''(''<Таблица, с которой объединяется текущая (TAB)>''{{Optional|,<Наименования столбцов группировки через запятую (STRING)>,<Наименования столбцов для агрегации с типами операций (STRING)>,<Округление при суммировании (INT)>{{Default|{{Eq}}-1}}}})
|type=1
|status=2
|visual=0
|description=Функция оставляет в текущей таблице только строки, для которых присутствуют эквивалентные в указанной таблице (эквивалентной считается строка, для которой значения всех столбцов группировки в обеих таблицах будет одинаковым). При этом ячейки в столбцах агрегации будут представлять результат операции агрегации над оставленными строками исходной таблицы и всеми эквивалентными строками указанной таблицы. Для исключения накопления неточности при сложении вещественных чисел, можно указать требуемое количество цифр после точки при выполнении операций агрегации. После выполнения операции, в таблице сохраняется порядок следования строк, существовавший до операции.
}}
{{function entry
|name=[[Tab.LeftOuterJoin|LeftOuterJoin]], '''LeftJoin'''
|form={{Grey|Tab.}}'''LeftOuterJoin'''(''<Таблица, с которой объединяется текущая (TAB)>''{{Optional|,<Наименования столбцов группировки через запятую (STRING)>,<Наименования столбцов для агрегации с типами операций (STRING)>,<Округление при суммировании (INT)>{{Default|{{Eq}}-1}}}})
|type=1
|status=2
|visual=0
|description=Функция выполняет агрегацию строк текущей таблицы с эквивалентными строками указанной таблицы (эквивалентной считается строка, для которой значения всех столбцов группировки в обеих таблицах будет одинаковым). При этом ячейки в столбцах агрегации будут представлять результат операции агрегации над строками исходной таблицы и всеми эквивалентными строками указанной таблицы. Для исключения накопления неточности при сложении вещественных чисел, можно указать требуемое количество цифр после точки при выполнении операций агрегации. После выполнения операции, в таблице сохраняется порядок следования строк, существовавший до операции.
}}
{{function entry
|name=[[Tab.FullOuterJoin|FullOuterJoin]], '''FullJoin'''
|form={{Grey|Tab.}}'''FullOuterJoin'''(''<Таблица, с которой объединяется текущая (TAB)>''{{Optional|,<Наименования столбцов группировки через запятую (STRING)>,<Наименования столбцов для агрегации с типами операций (STRING)>,<Округление при суммировании (INT)>{{Default|{{Eq}}-1}}}})
|type=1
|status=2
|visual=0
|description=Функция выполняет агрегацию строк текущей таблицы с эквивалентными строками указанной таблицы (эквивалентной считается строка, для которой значения всех столбцов группировки в обеих таблицах будет одинаковым), строки указанной таблицы, для которых нет эквивалента в текущей таблице, будут добавлены в последнюю с конца таблицы. При этом ячейки в столбцах агрегации будут представлять результат операции агрегации над строками исходной таблицы и всеми эквивалентными строками указанной таблицы. Для исключения накопления неточности при сложении вещественных чисел, можно указать требуемое количество цифр после точки при выполнении операций агрегации. После выполнения операции, в таблице сохраняется порядок следования строк, существовавший до операции.
}}
{{function entry
|name=[[Tab.Combine|Combine]]
|form={{Grey|Tab.}}'''Combine'''(''<Таблица для выполнения операции (TAB)>'',''<Наименования или индексы столбцов для сравнения (STRING)>''{{Optional|,<Тип операции (STRING)>{{Default|{{Eq}}"ADD"}},<Таблица сортирована по столбцам поиска (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция выполняет операцию объединения, заданную вторым аргументом, над текущей таблицей и таблицей, заданной первым аргументом. Результат операции сохраняется в текущей таблице. Аргегаьных операций не выполняется. Функцией удобно пользоваться, когда нет необходимости выполнять аргегатные операции, она проще и быстрее чем функции группы ''Join''.
}}
{{function entry
|name=[[Tab.RemoveLocated|RemoveLocated]]
|form={{Grey|Tab.}}'''RemoveLocated'''({{Optional|<Наименования столбцов поиска через запятую (STRING)>,<Значение столбца 1>,<Значение столбца 2>...,<Таблица сортирована по столбцам поиска (INT)>}}):''<Удален по крайней мере один элемент (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск заданного списком столбцов количества значений в таблице. Строки, подходящие под фильтр поиска, будут удалены из таблицы. Поиск начинается со строки таблицы, следующей за текущей. Поиск может принимать во внимание факт того, что таблица сортирована по всем столбцам поиска по неубыванию, что может значительно ускорить операцию.
}}
{{function entry
|name=[[Tab.RemoveLocatedEx|RemoveLocatedEx]]
|form={{Grey|Tab.}}'''RemoveLocatedEx'''({{Optional|<Наименования столбцов поиска через запятую (STRING)>,{{OptionalByRef|<Начальный индекс поиска, результирующий индекс (INT)>}},<Значение столбца 1>,<Значение столбца 2>...,<Таблица сортирована по столбцам поиска (INT)>}}):''<Удален по крайней мере один элемент (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск заданного списком столбцов количества значений в таблице. Строки, подходящие под фильтр поиска, будут удалены из таблицы. Поиск начинается со строки таблицы, заданной вторым аргументом. Поиск может принимать во внимание факт того, что таблица сортирована по всем столбцам поиска по неубыванию, что может значительно ускорить операцию. Строка за последним найденным значением будет возвращена в переменной, заданной вторым аргументом, если таковая присутствует. В отличие от [[Tab.RemoveLocatedEx|RemoveLocatedEx]] функция не использует текущую строку, что позволяет ее применять при работе с нескольми потоками (thread-safe).
}}
{{function entry
|name=[[Tab.Compare|Compare]]
|form={{Grey|Tab.}}'''Compare'''(''<Таблица для сравнения (TAB)>''{{Optional|,<Столбцы для сравнения (STRING)>}}):''<Сравниваемая таблица совпадает с текущей (INT)>''
|type=1
|status=2
|visual=0
|description=Функция сравнивает текущую таблицу с заданной по указанным правилам, и возвращает 1, если таблицы эквивалентны.
}}
{{function entry
|name=[[Tab.RescaleColumns|RescaleColumns]]
|form={{Grey|Tab.}}'''RescaleColumns'''({{Optional|<Процент использования ширины таблицы (INT)>{{Default|{{Eq}}100}}}})
|type=1
|status=2
|visual=1
|description=Функция выполняет изменение размеров видимых столбцов таблицы таким образом, чтобы они занимали всю ширину таблицы на экране, либо ее требуемую часть, если задан первый аргумент.
}}
{{function entry
|name=[[Tab.FixedLines|FixedLines]]
|form={{Grey|Tab.}}'''FixedLines'''({{Optional|<Новое количество закрепленных строк (INT)>}}):''<Текущее количество закрепленных строк (INT)>''
|type=1
|status=2
|visual=1
|description=Функция производит закрепление заданного количества строк в верхней части визуального представления таблицы. Вне зависимости от положения курсора внутри таблицы, выбранные строки всегда будут показаны на экране.
}}
{{function entry
|name=[[Tab.FixedColumns|FixedColumns]]
|form={{Grey|Tab.}}'''FixedColumns'''({{Optional|<Новое количество закрепленных столбцов (INT)>}}):''<Текущее количество закрепленных столбцов (INT)>''
|type=1
|status=0
|visual=1
|description=Функция производит закрепление заданного количества столбцов в верхней части визуального представления таблицы. Вне зависимости от положения курсора внутри таблицы, выбранные столбцы всегда будут показаны на экране.
}}
{{function entry
|name=[[Tab.Check|Check]]
|form={{Grey|Tab.}}'''Check'''(''<Индекс строки галочки (INT)>'',''<Индекс или наименование столбца галочки (INT,STRING)>''{{Optional|,<Новое состояние галочки (INT)>}}):''<Текущее состояние галочки (INT)>''
|type=1
|status=2
|visual=1
|description=Функция считывает или устанавливает значение галочки в указанном столбце таблицы. Функция может использоваться также для невизуальных таблиц.
}}
{{function entry
|name=[[Tab.Icon|Icon]]
|form={{Grey|Tab.}}'''Icon'''(''<Индекс строки иконки (INT)>''{{Optional|,<Индекс или наименование столбца иконки (INT,STRING)>,<Новый индекс иконки (INT)>}}):''<Текущий индекс иконки (INT)>''
|type=1
|status=2
|visual=1
|description=Функция считывает или устанавливает значение индекса иконки в указанном столбце таблицы. Функция может использоваться также для невизуальных таблиц.
}}
{{function entry
|name=[[Tab.BackgroundColor|BackgroundColor]]
|form={{Grey|Tab.}}'''BackgroundColor'''({{Optional|<Индекс строки ячейки (INT)>,<Индекс или наименование столбца ячейки (INT,STRING)>,<Новый цвет фона ячейки (INT)>}}):''<Текущий цвет фона ячейки (INT)>''
|type=1
|status=2
|visual=1
|description=Функция считывает или устанавливает значение цвета фона ячейки в указанном столбце таблицы. Если столбец таблицы не указан цвет меняется для всей строки, если строка не указана для всех строк столбца или для всей таблицы, если не указана ни строка ни столбец. Функция может использоваться также для невизуальных таблиц.
}}
{{function entry
|name=[[Tab.FontColor|FontColor]]
|form={{Grey|Tab.}}'''FontColor'''(''<Индекс строки ячейки (INT)>''{{Optional|,<Индекс или наименование столбца ячейки (INT,STRING)>,<Новый цвет текста ячейки (INT)>}}):''<Текущий цвет текста ячейки (INT)>''
|type=1
|status=2
|visual=1
|description=Функция считывает или устанавливает значение цвета текста в указанном столбце таблицы. Если столбец таблицы не указан цвет меняется для всей строки. Функция может использоваться также для невизуальных таблиц.
}}
{{function entry
|name=[[Tab.FontStyle|FontStyle]]
|form={{Grey|Tab.}}'''FontStyle'''(''<Индекс строки ячейки (INT)>''{{Optional|,<Индекс или наименование столбца ячейки (INT,STRING)>,<Новый стиль текста ячейки (INT)>}}):''<Текущий стиль текста ячейки (INT)>''
|type=1
|status=2
|visual=1
|description=Функция считывает или устанавливает значение стиля текста в указанном столбце таблицы. Если столбец таблицы не указан стиль меняется для всей строки. Функция может использоваться также для невизуальных таблиц.
}}
{{function entry
|name=[[Tab.HighlightMode|HighlightMode]]
|form={{Grey|Tab.}}'''HighlightMode'''(''<Режим подсветки таблиц по умолчанию (INT)>''{{Optional|,<Цвет нечетных строк (INT)>,<Процент цвета нечетных строк (INT)>,<Цвет выделения строки или столбца курсора (INT)>,<Процент цвета выделения строки или столбца курсора (INT)>}})
|type=1
|status=2
|visual=1
|description=Функция изменяет режим подсветки строк текущей таблицы. Для глобального изменения подсветки всех таблиц см. функцию [[DefaultHighlightMode]].
}}
{{function entry
|name=[[Tab.StartEdit|StartEdit]]
|form={{Grey|Tab.}}'''StartEdit'''({{Optional|<Индекс строки ячейки (INT)>,<Индекс или наименование столбца ячейки (INT,STRING)>}}):''<Редактирование инициировано (INT)>''
|type=1
|status=0
|visual=1
|description=Функция производит попытку запустить редактор ячейки таблицы для указанной ячейки таблицы.
}}
{{function entry
|name=[[Tab.FinishEdit|FinishEdit]]
|form={{Grey|Tab.}}'''FinishEdit'''({{Optional|<Режим окончания редактирования (INT)>,<Индекс выделенного столбца после окончания редактирования или ноль (INT,STRING)>}})
|type=1
|status=2
|visual=1
|description=Функция инициирует окончание редактирования ячейки таблицы в указанном режиме.
}}
{{function entry
|name=[[Tab.Lock|Lock]]
|form={{Grey|Tab.}}'''Lock'''()
|type=1
|status=2
|visual=1
|description=Функция запрещает выполнения обновления визуальной таблицы при любом ее изменении до тех пор, пока не будет вызвана функция [[Tab.Unlock|Unlock]]. Функция может использоваться перед большим количеством обновлений или заполнении большой таблицы для получения значительного ускорения операции. Функцию необходимо использовать совместно с конструкцией <code>Try .. Finally</code> для исключения вероятности появления нерабочей таблицы на форме.
}}
{{function entry
|name=[[Tab.Unlock|Unlock]]
|form={{Grey|Tab.}}'''Unlock'''()
|type=1
|status=2
|visual=1
|description=Функция разрешает запрещенное ранее функцией [[Tab.Lock|Lock]] выполнения обновления визуальной таблицы при любом ее изменении. См. функцию [[Tab.Lock|Lock]].
}}
{{function entry
|name=[[Tab.IsLocked|IsLocked]]
|form={{Grey|Tab.}}'''IsLocked'''():''<Обновление запрещено (INT)>''
|type=1
|status=2
|visual=1
|description=Функция проверяет, запрещено ли в данный момент обновление таблицы при ее изменении, запрет инициируется с помощью функции [[Tab.Lock|Lock]].
}}
{{function footer}}

== Объект столбца таблицы ==
Подчиненный объект, ссылающийся на таблицу, используется для доступа к свойствам столбцов таблицы. Так как объект будет ссылаться на определенный столбец таблицы, существует вероятность удаления этого столбца в другом потоке до того, как программа закончит работу с объектом, это может создать ошибочную ситуацию. Чтобы обойти проблему, необходимо либо убедиться, что объект будет использоваться только в одном потоке, столбцы не будут удаляться в других потоках или использовать функции [[LockObject]] и [[UnlockObject]] (однако, их нельзя использовать с визуальными объектами). Функции, типа [[TypeStr]] будут возвращать такие же значения для этого объекта, как и для объекта основной таблицы.

{{function header}}
{{function entry
|name=[[Tab.Column.Name|Name]]
|form={{Grey|Tab.Column.}}'''Name''':''<Имя столбца (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут позволяет получать или изменять имя столбца таблицы. Имена столбцов всегда хранятся в верхнем регистре.
}}
{{function entry
|name=[[Tab.Column.Caption|Caption]]
|form={{Grey|Tab.Column.}}'''Caption''':''<Заголовок столбца (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять заголовок столбца таблицы.
}}
{{function entry
|name=[[Tab.Column.DataType|DataType]]
|form={{Grey|Tab.Column.}}'''DataType''':''<Тип данных столбца (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут позволяет получать или изменять тип данных столбца таблицы. При изменении типа данных всех существующие ячейки таблицы в данном столбце, будут преобразованы в новый тип данных.
}}
{{function entry
|name=[[Tab.Column.Width|Width]]
|form={{Grey|Tab.Column.}}'''Width''':''<Ширина столбца (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять ширину столбца таблицы в пикселях.
}}
{{function entry
|name=[[Tab.Column.Align|Align]]
|form={{Grey|Tab.Column.}}'''Align''':''<Режим выравнивания столбца (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять режим выравнивания при выводе текста в столбце таблицы.
}}
{{function entry
|name=[[Tab.Column.Mask|Mask]]
|form={{Grey|Tab.Column.}}'''Mask''':''<Шаблон редактирования столбца (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять шаблон маски редактирования ячеек столбца таблицы.
}}
{{function entry
|name=[[Tab.Column.IsVisible|IsVisible]]
|form={{Grey|Tab.Column.}}'''IsVisible''':''<Видимость столбца (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать состояние или изменять видимость столбца на экране.
}}
{{function entry
|name=[[Tab.Column.Value|Value]]
|form={{Grey|Tab.Column.}}'''Value''':''<Значение столбца в строке CurLine (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут позволяет получать или изменять значение ячейки столбца в текущей строке таблицы.
}}
{{function entry
|name=[[Tab.Column.ShowCheckboxes|ShowCheckboxes]]
|form={{Grey|Tab.Column.}}'''ShowCheckboxes''':''<Показывать галки в столбце (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать состояние или изменять видимость галочек в столбце таблицы.
}}
{{function entry
|name=[[Tab.Column.ShowIcons|ShowIcons]]
|form={{Grey|Tab.Column.}}'''ShowIcons''':''<Показывать иконки в столбце (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать состояние или изменять видимость иконок в столбце таблицы.
}}
{{function entry
|name=[[Tab.Column.RedNegative|RedNegative]]
|form={{Grey|Tab.Column.}}'''RedNegative''':''<Выделять отрицательные числа красным в столбце (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать состояние или изменять режим выделения красным ячеек таблицы, содержащих отрицательные числа в столбце таблицы.
}}
{{function entry
|name=[[Tab.Column.Hint|Hint]]
|form={{Grey|Tab.Column.}}'''Hint''':''<Всплывающая подсказка для столбца (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять строку подсказки при наведении мышью на заголовок столбца таблицы.
}}
{{function entry
|name=[[Tab.Column.IsEditable|IsEditable]]
|form={{Grey|Tab.Column.}}'''IsEditable''':''<Данные в столбце можно редактировать (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять разрешение редактирования столбца таблицы.
}}
{{function entry
|name=[[Tab.Column.IsSortable|IsSortable]]
|form={{Grey|Tab.Column.}}'''IsSortable''':''<Режим сортировки столбца (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять разрешение визуальной сортировки столбца таблицы.
}}
{{function entry
|name=[[Tab.Column.IsInEnterChain|IsInEnterChain]]
|form={{Grey|Tab.Column.}}'''IsInEnterChain''':''<Столбец находить в Enter-цепочке (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять режим участия ячеек столбца таблицы в визуальной цепочке ввода.
}}
{{function entry
|name=[[Tab.Column.IsReadonly|IsReadonly]]
|form={{Grey|Tab.Column.}}'''IsReadonly''':''<Столбец имеет атрибут только для чтения (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять режим только для чтения при редактировании ячеек столбца таблицы.
}}
{{function entry
|name=[[Tab.Column.MinWidth|MinWidth]]
|form={{Grey|Tab.Column.}}'''MinWidth''':''<Минимальная ширина столбца (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять минимальную ширину столбца таблицы в пикселях.
}}
{{function entry
|name=[[Tab.Column.MaxWidth|MaxWidth]]
|form={{Grey|Tab.Column.}}'''MaxWidth''':''<Максимальная ширина столбца (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять максимальную ширину столбца таблицы в пикселях.
}}
{{function entry
|name=[[Tab.Column.Filter|Filter]]
|form={{Grey|Tab.Column.}}'''Filter''':''<Текущий визуальный фильтр столбца (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать текущий визуальный фильтр столбца таблицы (строку, введенную пользователем в этом столбце, для быстрого фильтрования элементов таблицы).
}}
{{function entry
|name=[[Tab.Column.ForbidMassLoad|ForbidMassLoad]]
|form={{Grey|Tab.Column.}}'''ForbidMassLoad''':''<Запретить загрузку столбца функцией Massload (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут позволяет получать или изменять режим запрета загрузки элементов ячеек столбца таблицы из базы данных при вызове функции [[MassLoadObjects]].
}}
{{function footer}}

{{Объекты}}

Установки сервера

2026-04-01T10:01:35Z

Admin: 1 revision imported

{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общая информация о сервере базы данных]]}}
__TOC__
Сервер хранит настройки в нескольких файлах инициализации, основной из которых по умолчанию называется <code>sfsrv.ini</code> (однако с помощью [[Ключи запуска сервера из командной строки|ключей запуска из командной строки]], можно использовать другой файл для загрузки основных настроек). Обычно файлы настроек являются текстовыми файлами в форматах ANSI или UTF-16. Для формата UTF-16 в файле всегда должен присутствовать соответствующий [[BOM]]. Файл инициализации имеет структуру дерева и делится на ветки и переменные. Каждая ветка содержит полный путь и записывается в квадратных скобках (см. пример ниже). Каждая переменная записывается в виде <code><ИмяПеременной>="<Значение переменной>"</code>. При этом кавычки разрешается опускать. Файлы могут содержать комментарии. Комментарием является строка, начинающаяся на знак ''';''' (точка с запятой). Многие файлы создаются и обновляются автоматически, поэтому, комментарии, введенные вручную, могут быть утеряны. Также нужно понимать, что изменения в файлах инициализации, обычно не становятся рабочими до остановки и запуска сервера (при остановке сервера все пользователи, имеющие соединение с ним в данный момент, форсированно завершат работу и все их несохраненные данные будут утеряны). Пример обычного файла инициализации:
<pre>
;Начало ветки Common
[Common]

;Переменные ветки Common
LogType="0"
Path="c:\files\data\"

;Начало ветки Common\Comm
[Common\Comm]

;Переменные ветки Common\Comm
ExecutablePathAndCmdLine="c:\files\data\file.exe "arg 1" "arg 2" 2"
DllPath="c:\files\data\file.dll"

;Начало ветки Update
[Update]
...
</pre>

Ниже дана информация по всем файлам, связанным с изменением свойств работы сервера:

== Основной файл настроек ''sfsrv.ini'' ==
Файл обычно хранится в бинарном каталоге сервера, и содержит основные настройки сервера, путь к файлам проекта, путь к библиотеке базы данных, а также настройки базы данных, которыми пользуется эта библиотека. Если в командной строке не указано иного, сервер загружает файл <code>sfsrv.ini</code> по умолчанию. Файл представляется собой текстовый файл инициализации в формате ANSI или UTF-16. В случае UTF-16, в файле должен присутствовать заголовок [[BOM]]. Ниже дается список веток и переменных, которые используются сервером в файле. Если ветка или переменная необходимы, они помечены как таковые, большинство же веток и переменных можно опустить. При установке системы с помощью программы-установщика в файле инициализации сервера могут присутствовать не все ветки и переменные, описанные ниже.

* Ветка '''Common''' хранит общие установки сервера.
** Переменная '''ServiceName''' указывает на имя сервиса, используемое данной копией программы сервера. По умолчанию это имя "''sfsrv''". В случае, когда на одной машине используется более одного сервера базы данных, до регистрации сервиса в системе, необходимо указать другое имя сервиса, так как в системе не может существовать более одного сервиса с одним и тем же именем. Регистрацию и удаление сервиса можно произвести непосредственно из командной строки, нет необходимости использовать программы-установщики. К примеру, чтобы изменить имя сервиса текущей базы данных с ''sfsrv'' на ''sfsrv2'', нужно остановить сервер <code>sfsrv.exe stop</code>, отменить регистрацию сервиса <code>sfsrv.exe deinstall</code>, изменить значение этой переменной на ''sfsrv2'' (или добавить переменную, если ее не существовало), зарегистрировать сервис снова <code>sfsrv.exe install</code> и запустить его <code>sfsrv.exe start</code>. Для дополнительной информации, см. статью [[Ключи запуска сервера из командной строки]].
** Переменная '''Loglevel''' задает то, насколько подробной будет информация в логах сервера (обычно это файл <code>sfsrv.log</code>). Значением переменной может быть число от ''0'' до ''2'', при этом при ''0'' логи записываться не будут, ''2'' в логах будет вестись максимально подробная информация. По умолчанию значение этой переменной равно '''1'''.
** Переменная '''LogFile''' задает имя файла для ведения логов сервером. По умолчанию это <code>sfsrv.log</code>, располагающийся в папке исполняемого файла сервера.
** Переменная '''UpdateCataloguesRescanPeriod''' задает время сканирования каталогов обновлений клиентов ''_DeploymentBin_ConsoleClient'' и ''_DeploymentBin_GUIClient'', находящихся в каталоге файлов проекта. Повторное сканирование необходимо для того, чтобы сервер заметил изменения файлов в этом каталоге. Если администратор выложил обновления этих файлов с помощью Студии или вручную, сервер получает из контрольные суммы и передает клиентам при их соединении с сервером, после чего клиент сравнивает их со своими локальными копиями исполняемых файлов и, если значения отличаются, запрашивает на сервере обновление. Переменная задается в секундах и по умолчанию имеет значение ''20''.
** Переменная '''NoExecutableUpdates''' задает режим, когда исполняемые файлы сервера не будут обновляться при получении обновлений из Студии. Этот режим может быть полезен для старых баз, которые могут по-прежнему требовать обновлений проекта, однако, исполняемые файлы при этом обновлять не нужно. Кроме того, эту переменную необходимо установить разработчику, производящему изменения и компиляцию бинарных файлов сервера, это позволит остановить попытку из замены на старые файлы при каждом соединении Студии с локальным сервером разработчика. Переменная может принимать значения ''0'' (по умолчанию) и ''1''.
** Переменная '''AcceptCrashLogs''' задает режим, когда логи отказов и ошибок программы принимаются сервером от клиентов и складываются в подкаталоги каталога ''CrashLogs'', находящегося в папке с бинарными файлами сервера. Для доп. информации, см. [[Общая информация о сервере базы данных]]. По умолчанию, эта переменная равна ''1'' (принимать файлы). Так как на клиентах логи создаются во временной папке компьютера, при отсылке их на сервер, клиент не знает, при соединении с какой базой произошла ошибка. Если данный сервер является старой базой данных, собирать такие логи не имеет смысла, так как они, скорее всего, принадлежат другой базе данных, кроме того, для администраторов удобнее собирать логи в одном месте.
* Ветка '''Connection''' (обязательна). Ветка хранит установки, связанные с регистрацией клиента на сервере. Эта ветка обязательно должна присутствовать.
** Переменная '''Name''' задает имя базы данных. Эта информация является справочной.
** Переменная '''Description''' задает краткое описание базы данных. Эта информация является справочной.
** Переменная '''Source''' (обязательна) задает путь к папке с компилированными файлами проекта. Эта переменная обязательно должна присутствовать.
** Переменная '''TCPPorts''' (обязательна) задает TCP/IP порты по которым сервер будет слушать подключения клиентов или Студии. Каждый порт может иметь номер от ''1'' до ''65535''. Обычно задается один порт, использование более одного порта может потребоваться в более сложных конфигурациях. Все порты при соединении будут равнозначны. В системе обычно невозможно открыть более одного порта с одним и тем же номером, поэтому для сервера старой базы, работающей на этом же компьютере, необходимо использовать другой порт, не совпадающий с портом рабочей базы. Если при запуске сервер не может открыть все порты для прослушивания, запуск будет завершен с ошибкой. По умолчанию, сервер использует порт ''13521'', однако использование этого порта строго не рекомендуется, если порт доступен из Интернета.
** Переменная '''TCPPassword''' (обязательна) задает пароль сервера при TCP/IP соединении. Клиент должен использовать такой же пароль, чтобы иметь возможность регистрации на сервере. '''Внимание''': этот пароль не имеет ничего общего с паролем пользователя при входе в программу клиент. Это внутренний пароль при соединении клиента с сервером до того, как пользователь начинает вводить свое имя и пароль.
** Переменная '''TCPTimeout''' задает тайм-аут ожидания данных сервером до того, как сервер будет считать, что его связь с клиентом была разорвана. Если клиент соединяется с сервером с помощью интернета, из-за проблем со связью, может возникнуть ситуация, когда клиент потерял связь с сервером, но сервер в данный момент не знает этого. Часто клиент блокирует какие-либо объекты или создает транзакцию, и серверу необходимо отключить клиента, если он связь с ним утеряна, чтобы освободить объекты и ресурсы системы. Поэтому, при загрузке или отправке пакетов, после определенного времени "молчания" отсутствия новой информации, сервер отключает клиента автоматически. Здесь задается такой период в миллисекундах. По умолчанию, это значение соответствует числу ''300000'' (5 минут), для локальных сетей рекомендуется устанавливать его в размере ''60000'' (1 минута).
** Переменная '''AllowIPRanges''' позволяет задать диапазоны IP-адресов, подключения с которых будут разрешены. По умолчанию, сервер разрешает подключения с любых IP-адресов, если же эта переменная задана, сервер будет разрывать входящее подключение, если оно производится не с адреса, входящего в заданный диапазон. В данный момент можно задать только IPv4 диапазоны. Используется следующий формат, при задании диапазона адресов: <code><Адрес>/<Маска>[+<Адрес 2>/<Маска 2>...]</code> (к примеру, ''127.0.0.1/255.255.255.0+192.168.0.0/255.255.0.0'').
** Переменная '''CompressionMode''' позволяет задать форсированный режим сжатия пакетов при работе клиентов. Сжатие пакетов увеличивает нагрузку на процессор машины, на которой работает сервер, однако, это увеличение весьма незначительно. Кроме того, для сжатия пакета тратится дополнительное время, поэтому, для подключения по локальной сети, сжатие замедляет получение ответов сервера. Замедление также очень незначительное, поэтому, его влияние можно проигнорировать. В случае если сеть постоянно загружена, либо клиент подключен с сервером с помощью Интернета, сжатие может значительно ускорить работу с сервером, так как пакеты становятся меньше и пересылка их осуществляется быстрее. Даже для локальной сети сжатие может положительно сказаться на общей ее загрузке. Обычно сжатие настраивается на стороне клиента, однако, данная переменная задает форсированный режим сжатия. Переменная может принимать следующие значения:
*** '''0''' (по умолчанию) -- разрешить сжатие (сжатие будет настраиваться на стороне клиента).
*** '''1''' -- запретить сжатие (кроме IP адресов, указанных в переменной ''CompressionRanges'').
*** '''2''' -- форсировать сжатие на любом подключении (кроме IP адресов, указанных в переменной ''NoCompressionRanges'').
** Переменная '''CompressionRanges''' позволяет задать диапазоны IP-адресов, при подключениях с которых сжатие пакетов (см. выше) будет форсировано. В данный момент можно задать только IPv4 диапазоны. Используется следующий формат, при задании диапазона адресов: <code><Адрес>/<Маска>[+<Адрес 2>/<Маска 2>...]</code> (к примеру, ''127.0.0.1/255.255.255.0+192.168.0.0/255.255.0.0'').
** Переменная '''NoCompressionRanges''' позволяет задать диапазоны IP-адресов, при подключениях с которых сжатие пакетов (см. выше) будет запрещено. В данный момент можно задать только IPv4 диапазоны. Используется следующий формат, при задании диапазона адресов: <code><Адрес>/<Маска>[+<Адрес 2>/<Маска 2>...]</code> (к примеру, ''127.0.0.1/255.255.255.0+192.168.0.0/255.255.0.0'').
* Ветка '''DBase''' (обязательна). Ветка хранит установки, связанные с базой данных, с загрузкой библиотеки для работы с базой данных, а также установки самой библиотеки.
** Переменная '''SingleUserModeOnUpdates''' задает режим, когда при обновлении (изменении) структуры базы данных, библиотека будет устанавливать эксклюзивный однопользовательский режим. Изменение структуры обычно производится после обновления из Студии и, если к базе данных подключены внешние программы (к примеру, SQL Server Management Studio), есть вероятность, что обновление будет невозможно выполнить из-за занятости таблицы. Для того, чтобы убедиться, что внешние программы не влияют на обновление, сервер инициирует однопользовательский режим, производит требуемые изменения и возвращает к обычному режиму. Такой подход к обновлениям работает по умолчанию и рекомендуется к использованию. Данная переменная может принимать следующие значения:
*** '''0''' -- не использовать однопользовательский режим при обновлении (не рекомендуется).
*** '''1''' (по умолчанию) -- использовать однопользовательский режим при обновлении.
*** '''2''' (по умолчанию) -- производить попытку перехода в однопользовательский режим при обновлении, если он недоступен, оставлять сообщение в логах сервера, и продолжить выполнять обновление в обычном режиме (не рекомендуется).
** Переменная '''EnsureUptimeBeforeStart''' задает режим ожидания готовности СУБД компьютера сразу после его перезапуска. Переменная имеет значение только если сервер находится на том же компьютере, что и СУБД, к которому он производит подключение. Из-за того, что сразу после запуска компьютера, сервис сервера может быть запущен до запуска ПО СУБД (и даже если ПО СУБД запускается раньше, его готовность к работе может наступить через 1-2 минуты после запуска), может возникнуть ситуация, когда сервер базы данных не сможет подключиться к базе данных, либо подключится к ней, но база данных будет отсутствовать, либо база данных будет найдена, но не будет принимать запросы, так как не будет готова. Это может привести к ошибкам в работе сервера, это представляет особенную проблему при подключении к СУБД в режиме ADO, так как последний представляет очень ограниченную информацию о состоянии СУБД и базы данных в момент подключения. Чтобы избежать проблем при подключении и увеличить устойчивость запуска сервера после перезагрузки машины, переменная задает время ожидания в секундах после запуска машины сервера до того момента, как сервер выполнит попытку подключения к СУБД. По умолчанию это время равно 60 секундам, обычно этого времени достаточно, однако, если база данных очень большая, либо СУБД работает с большим количеством баз данных одновременно, и сервер работает в режиме ADO, можно увеличить это время до 2 и более минут. Не для всех типов СУБД эта переменная актуальна, при работе с СУБД SQLite3, к примеру, ее можно сделать равной нулю без какого-либо риска.
** Переменная '''WorkerDll''' (обязательна) задает относительный или абсолютный путь к библиотеке, которая будет создавать подключения к базе данных. Обычно библиотека находится в той же папке, где располагается исполняемый файл сервера, но она также может находиться в подпапке папки сервера или в другой папке диска. Название файла библиотеки зависит от типа СУБД, к которой она производит подключение. Пример: <code>Dll\MSSQL-ADO\MSSQL_ADO.dll</code>. Большинство переменных ниже зависят от типа библиотеки, для одного типа они могут быть обязательны, для другого типа не иметь значения.
** Переменная '''ADOProvider''' (MSSQL, для ADO подключений) задает наименование поставщика ADO (тип OLE-сервера ADO) при использовании библиотеки работающей с MS SQL с помощью ADO. По умолчанию это значение равно ''SQLOLEDB''.
** Переменная '''ODBCConnectionString''' (для ODBC подключений) задает полную строку подключения к ODBC драйверу. Если эта переменная не задана, библиотека подключения создаст строку самостоятельно из переменных ''ServerAddress'', ''DatabaseName'' и т.п., при этом наименование драйвера ODBC будет задано в зависимости от используемой библиотеки подключения. Если Вы не знаете наименование установленного драйвера, для OS Windows, необходимо запустить администратор ODBC (''odbcad32.exe'') где будет полный список имен драйверов, нужно также понимать, что для 32-битного сервера необходимо запустить 32-битный администратор ODBC, который часто располагается в папке ''SysWOW64'' Windows (32-битные и 64-битные драйверы устанавливаются отдельно!). Ниже заданы умолчания для определенных библиотек:
*** '''MariaDB-ODBC''': <code>DRIVER={MariaDB ODBC 3.0 Driver};SERVER='''ServerAddress''';USER='''ServerLogin''';PASSWORD='''ServerPassword''';DATABASE='''DatabaseName''';NO_PROMPT=1;PORT=3306;OPTION=67108866</code>.
*** '''MySQL-ODBC''': <code>DRIVER={MySQL ODBC 5.3 Unicode Driver};SERVER='''ServerAddress''';USER='''ServerLogin''';PASSWORD='''ServerPassword''';DATABASE='''DatabaseName''';NO_PROMPT=1;PORT=3306;OPTION=67109130</code>
*** '''PostgreSQL-ODBC''': <code>DRIVER={PostgreSQL ODBC Driver(UNICODE)};SERVER='''ServerAddress''';UID='''ServerLogin''';PASSWORD='''ServerPassword''';DATABASE='''DatabaseName''';PORT=5432;</code>
** Переменная '''ServerAddress''' (MSSQL и др., обязательна) задает адрес (или наименование машины) и наименование типа сервера (в режиме ADO), если это необходимо. Переменная записывается в виде <code><Адрес или имя машины>[\<Тип сервера>]</code>. ''Адрес или имя машины'' могут представлять собой как IP-адрес SQL сервера (к примеру, ''127.0.0.1''), так и сетевое имя компьютера сервера (для локального компьютера можно использовать точку (''.'')). ''Тип сервера'' обычно не указывается, но может представлять наименование ''Instance'' MSSQL сервера, если она отличается от умолчания. Для ''Express'' версии MSSQL, ''необходимо'' указать <code>\SQLExpress</code>. Примеры: <code>.\SQLExpress</code>, <code>Server1</code>, <code>192.168.0.3</code> и т.п.
** Переменная '''DatabaseName''' (MSSQL и др., обязательна) задает наименование базы данных, с которой будет происходить работа. '''Важно''': сервер никогда не создает базу данных автоматически, если она отсутствовала в СУБД. Это важно из-за того, что администратор должен точно знать, где находятся файлы базы данных, чтобы они не создались на неверном диске и чтобы иметь быстрый доступ к ним. По умолчанию MSQSL располагает файлы баз данных глубоко в структуре папок диска в общей папке с файлами других базы данных, что не является оптимальным расположением файлов (файлы могут быть утеряны или забыты при переустановке операционной системы на компьютере). Поэтому, при настройке новой базы данных, администратор должен самостоятельно создать и назвать новую базу данных в ПО СУБД и указать в файле инициализации имя существующей БД.
** Переменная '''TempDatabaseName''' (MySQL, MariaDB, PostgreSQL) задает наименование базы данных, используемой для хранения таблиц функций [[Временная таблица базы данных|временных таблиц базы данных]]. Данная база данных всегда очищается при запуске сервера и хранит информацию только в момент выполнения запросов к временным таблицам. Если эта переменная не задана, сервер автоматически создает базу данных с именем, подобным основной базе данных с добавледением суфикса. База данных будет создана в каталоге данных СУБД по умолчанию. См. также переменную ''SQLiteTempDBFile''.
** Переменная '''ServerLogin''' (MSSQL и др., обязательна) задает имя пользователя для подключения к СУБД и базе данных. Обычно это административная учетная запись, для MSSQL часто '''sa'''. Учетная запись должна иметь полные права в СУБД для работы с базой данных. '''Внимание''': учетная запись, задающаяся здесь, обычно не имеет отношения к учетным записям компьютера (для некоторых СУБД, это может быть не так).
** Переменная '''ServerPassword''' (MSSQL и др., обязательна) задает пароль пользователя для подключения к СУБД и базе данных для логина, задающегося переменной ''ServerLogin''.
** Переменная '''QueryTimeout''' задает максимальное время исполнения запроса в СУБД в миллисекундах. Если эта переменная не задана, установка максимального времени выполнения запроса не будет изменена (будет использовано значение по умолчанию конкретной СУБД). Данная установка может помочь в случае взаимной блокировки таблиц (ситуация теоретически маловероятна, так как сервер имеет собственную защиту от таких событий, но при исключительной стечении обстоятельств, либо из-за ошибки в СУБД, такое может произойти). После ожидания окончания выполнения запроса в течение указанного времени, запрос останавливается с ошибкой и сервер передает эту ошибку клиенту, тем самым разрешая ситуацию взаимной блокировки. '''Внимание''': установка этой переменной на слишком маленькое значение может сделать невозможным выполнение длительных запросов. Не рекомендуется устанавливать значение переменной ниже 10 минут.
** Переменная '''LockTimeout''' задает максимальное время ожидания блокировки таблицы в СУБД в миллисекундах. Если эта переменная не задана, установка максимального времени ожидания блокировки не будет изменена (обычно по умолчанию, это время не ограничено). Данная установка отличается от ''QueryTimeout'' тем, что используется только для того, чтобы избежать взаимной блокировки таблиц при записи (ситуация теоретически маловероятна, так как сервер имеет собственную защиту от таких событий, но при исключительной стечении обстоятельств, либо из-за ошибки в СУБД, такое может произойти), тогда как ''QueryTimeout'' может срабатывать также в случаях очень длительных запросов (к примеру, при запросе, оперирующим большим количеством записей, когда СУБД сильно загружена запросами других пользователей). После ожидания блокировки таблицы в течение указанного времени, запрос СУБД останавливается с ошибкой и сервер передает эту ошибку клиенту, тем самым разрешая ситуацию взаимной блокировки. '''Внимание''': установка этой переменной на слишком маленькое значение может вызывать частые ошибки при обработке документов, особенно в момент проведения резервного копирования.
** Переменная '''FTS_configuration''' (PostgreSQL, рекомендуется) задает конфигурацию полнотекстового поиска (для практических целей эта переменная совпадает с языком поиска). По умолчанию, будет использована конфигурация <code>simple</code>. Для русского языка необходимо указать слово <code>russian</code>.
** Переменная '''SQLiteDll''' (SQLite, обязательна) задает относительный или абсолютный путь к библиотеке SQLite3, которая будет выполнять функции СУБД. Обычно библиотека находится в той же папке, где располагается исполняемый файл сервера, но она также может находиться в подпапке папки сервера или в другой папке диска. Обычно библиотека имеет название <code>sqlite3.dll</code>, она доступная для свободного скачивания с официального сайта SQLite. Кроме этой библиотеки, для работы с SQLite не требуется скачивание и установка других файлов. '''Важно''': тип библиотеки (''x86'' или ''x64'') должен совпадать с типом исполняемого файла сервера. '''Важно''': библиотека должна иметь версию не ниже ''3.33.0''.
** Переменная '''SQLiteCacheSize''' (SQLite, желательна) задает количество памяти, выделяемой под буфер таблиц при работе SQlite3. Переменная задается в мегабайтах. Чем больше это число, тем быстрее будут происходить повторные запросы к таблицам базы данных. Однако, так как исполняемый файл сервера и библиотека СУБД в случае SQLite3 находятся в одном процессе и делят адресное пространство, может получиться ситуация, когда библиотека SQLite3 использует большую часть памяти для своих нужд и сервер не сможет нормально работать при обслуживании запросов пользователей. Чтобы избежать такой ситуации для больших базы данных, необходимо использовать ''x64'' версию сервера на машине с большим объемом памяти. Минимально возможное значение устанавливается в размере 2 Мб, максимальное возможное значение для ''x86'' версий сервера устанавливается в размере 1400Мб, максимальное значение для ''x64'' версий сервера не задано. Значение по умолчанию рассчитывается по следующему алгоритму:
*** Для ''x86'' версий: 67% от полного размера физической памяти машины, но не больше 1400Мб и не меньше 2Мб.
*** Для ''x64'' версий: 67% от полного размера физической памяти машины, но не меньше 2Мб.
** Переменная '''SQLiteHeapLimit''' (SQLite) задает ограничение на полное использование памяти библиотекой SQLite. Это значение включает размер буфера, заданного в переменной ''SQLiteCacheSize'' а также временный буфер запросов, переменные и пр. Обычно это значение не установлено (по умолчанию равно нулю), так как ''SQLiteCacheSize'' чаще всего использует львиную долю затраченной памяти. При неверной установке, объемные запросы будут выдавать ошибку нехватки памяти. Значение не рекомендуется к изменению.
** Переменная '''SQLiteCleanFloats''' (SQLite) задает режим граничной очистки (округления) вещественных чисел, получаемых от SQLite. Очистка производится по алгоритму системы (см. [[Числа]], [[NumberToStr]]). Так как SQLite работает с числами средней точности ''Double'', результаты вычислений могут накапливать ошибку в младших дробных знаках числа. Такие результаты могут немного отличаться от обычно получаемые от других СУБД, что может быть нежелательно для работы, поэтому по умолчанию эта переменная равна ''1'', позволяя уменьшить влияние расчетов с такими числами на результат. Переменную рекомендуется оставить включенной, однако, если база данных работает не с финансовой информацией, а с информацией произвольной точности (математические вычисления и пр.), данная переменная может иногда вносить (минимальные) искажения в результаты вычислений, поэтому, в этом случае, ее выгоднее отключить.
** Переменная '''SQLiteDatabaseCollationPage''' (SQLite) задает кодовую страницу, которая будет использоваться при перекодировании текста из UTF-8 в ANSI. По умолчанию это значение равно ''1251'' для кириллической сборки библиотеки сервера. Подобное перекодирование обычно не производится для строковых данных, поэтому, эта переменная не является очень важной.
** Переменная '''DatabaseFile''' (SQLite, обязательна) задает путь и имя файла базы данных SQLite. Кроме этого файла в том же каталоге, где он располагается, SQLite может создавать временные файлы с добавлением префиксов к расширению (к примеру ''-shm'' или ''-wal'' (Внимание! Файл ''<Имя>.<Расширение>-wal'' не является временным, а представляет собой часть базы данных SQLite, см. ниже)), либо временные файлы с расширением ''sftempdb''. При создании новой базы данных, файл может отсутствовать, SQLite3 создаст его самостоятельно, после чего, при проведении аудита, в файле будет создана полная структура базы данных проекта.
** Переменная '''SQLiteTempDBFile''' (SQLite) задает путь и имя файла базы данных, который будет использоваться для работы с функциями [[Временная таблица базы данных|временных таблиц]]. Обычно система сама определяет имя этого файла на основании имени основной базы данных, и помещает его в тот же самый каталог, что и файл базы данных. Однако, если администратору необходимо, он может поместить этот файл в другой каталог или изменить его название по умолчанию. После остановки работы сервера, файл можно удалить, так как он не содержит каких-либо данных, имеющих значение, при запуске сервера, этот файл автоматически очищается. Файл должен располагаться на быстром носителе, иначе работа с функциями временных таблиц может быть замедлена.
** Переменная '''SQLiteSynchronousWriting''' (SQLite) задает режим буферизации записи данных на диск SQLite (см. описание ''PRAGMA synchronous'' в документации SQLite). По умолчанию это значение не устанавливается и используется внутреннее умолчание библиотеки SQLite3.dll. Использование значений меньше 2 строго не рекомендуется. Переменная может принимать следующие значения:
*** '''0''' -- будет разрешен буфер записи операционной системы при записи. В данном режиме запись данных будет производиться гораздо быстрее, однако, существует очень высокая вероятность потерять данные или испортить базу данных при сбое питания на сервере.
*** '''1''' -- запись будет вестись в режиме "нормальный" с меньшей нагрузкой на диск и очень небольшой опасностью потерять данные, чем в режиме 2. В режиме записи ''WAL'' документация SQLite утверждает, что вероятность потерять данные практически отсутствует.
*** '''2''' -- запись будет вестись в режиме "полный" с большей нагрузкой на диск, чем в режиме "нормальный". Этот режим медленнее, чем "нормальный", однако, вероятность потерять данные из-за сбоя питания машине сервера отсутствует. Данный режим рекомендуется к использованию.
*** '''3''' -- запись будет вестись в режиме "дополнительный" с еще большей нагрузкой на диск, чем в режиме "полный". Этот режим может дополнительно повысить безопасность при записи в базу данных.
** Переменная '''KeepTraceLogs''' (SQLite,MariaDB,MySQL) задает режим, когда все запросы к базе данных и время их исполнения будут также фиксироваться в особом логе сервера. Этот режим отключен по умолчанию и может использоваться для отладки разработчиком системы. Так как при работе с SQLite невозможно использование внешнего профайлера, как, примеру, с MSSQL, библиотека сервера может вести собственный лог профайлера, который может потребоваться разработчику для оптимизации или исправления ошибок в запросах.
** Переменная '''JournalMode''' (SQLite) задает режим записи в базу данных SQLite (см. описание ''PRAGMA journal_mode'' в документации SQLite). Режим имеет очень важное значение, так как напрямую влияет на скорость записи данных в базу данных. Переменная может принимать следующие значения:
*** '''DELETE''' -- журнал записи (дополнительный файл на диске) создается в момент транзактной записи и удаляется по ее окончании. Это самый медленный режим, он не рекомендуется к использованию.
*** '''TRUNCATE''' -- журнал записи (дополнительный файл на диске) создается в момент транзактной записи и очищается по ее окончании. Это медленный режим, он не рекомендуется к использованию.
*** '''PERSIST''' -- журнал записи (дополнительный файл на диске) создается в момент транзактной записи и его заголовок заполняется нулями по ее окончании. Это сравнительно медленный режим, он может быть использован, если режим ''WAL'' по какой-либо причине не подходит.
*** '''WAL''' (по умолчанию) -- журнал записи ведется как отдельный файл, данные поступают в него при любой записи и в определенные моменты, данные из него копируются в основной файл базы данных. Этот режим в 3-5 раз быстрее при обработке документов или сложной транзактной записи, чем другие безопасные режимы SQLite. У этого режима, однако, есть две важные особенности: при загрузке базы данных в режиме ''WAL'', ее невозможно в дальнейшем перевести в любой другой режим; файл журнала на диске (обычно имеет расширение с суффиксом ''-wal''), является частью базы данных (при копировании базы данных, в момент, когда сервер отключен, необходимо также скопировать и этот файл). Данный режим рекомендуется к использованию.
*** '''MEMORY''' -- журнал записи создается и ведется в системной памяти, если во время транзакции сервер будет остановлен или пропадет питание, информация в базе данных будет испорчена. Режим не рекомендуется к использованию, и может работать, для тестирования базы данных или ее быстрого заполнения с тем, чтобы потом использовать ее в других режимах.
*** '''OFF''' -- журнал записи не ведется вообще. Данный режим несовместим с работой системы, так как он не позволяет отменить транзакцию при ошибке внутри нее. С практической точки зрения, этот режим превращает базу данных в файл прямой записи без возможности работы с транзакциями.
** Переменная '''MySQL_sql_mode''' (MariaDB,MySQL) задает умолчания для инициализации переменной ''sql_mode'' СУБД MariaDB и MySQL. Используйте документацию соответствующей СУБД для получения информации по возможным значениям переменной ''sql_mode''. '''Внимание''': некорректная установка этой переменной может сделать сервер неработоспособным, есть также вероятность потерять данные! Не изменяйте переменную без того, чтобы внимательно прочитать документацию СУБД. Установка по-умолчанию соответствует строке <code>NO_BACKSLASH_ESCAPES,STRICT_TRANS_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,PIPES_AS_CONCAT,ANSI_QUOTES</code>.
** Переменная '''IsMariaDB''' (MariaDB или MySQL) задает, к какой из СУБД будет осуществлять соединение сервер. '''"1"''' -- MariaDB, '''"0"''' -- MySQL. Если эта переменная не указана, сервер определит тип сервера из наименования драйвера ODBC. Однако, если для СУБД MariaDB используется драйвер ODBC MySQL (это позволяется), необходимо обязательно указать эту переменную.
** Переменная '''SimpleDBases''' задает список имен дополнительных баз данных, к таблицам которым имеет доступ СУБД и к которым может обращаться программа с помощью функций [[Временная таблица базы данных|временных таблиц баз данных]]. Наименования баз данных перечисляются через запятую и должны совпадать с именами баз данных, уже созданных на сервер СУБД. Для SQLite используются имена файлов с полными путями. Все базы данных из этой переменной будут автоматически включены в резервную копию, которая создается сервером (см. переменную ''BackupServer'' ниже).
* Ветка '''EventLogs'''. Ветка хранит установки, связанные с ведением журнала регистрации событий базы данных.
** Переменная '''LogsMode''' задает режим ведения таблицы журнала регистрации событий. Переменная может принимать следующие значения:
*** '''0''' (по умолчанию) -- таблица журнала регистрации событий ведется в текущей базе данных. Такой способ ведения журнала рекомендован. Если запись в журнал ведется внутри транзакции, она будет отменена в момент отмены транзакции совместно с отменой остальных изменений. Минусом такого подхода является увеличение скорости роста базы данных, так как журнал событий может накопить большое количество строк. В отличие от остальных таблиц базы данных, журнал разрешается очищать внешними средствами, если в этом есть необходимость.
*** '''1''' -- таблица журнала регистрации событий ведется в другой базе данных. Такой способ ведения журнала может использоваться, если необходимо заботиться о размере базы данных (к примеру, если используется MSSQL Express). Базу данных с журналом можно заархивировать и создать заново в любой момент, кроме того сервер с базой данных может находиться на другой машине. Однако, для такого способа ведения журнала нужно понимать, что если запись в журнал ведется внутри транзакции, она '''не''' будет отменена в момент отмены транзакции совместно с отменой остальных изменений. Этот минус не затрагивает базы данных в SQLite, для которых записи в журнал, находящийся в отдельной базе данных, входят в одну транзакцию с записями в основную базу данных.
*** '''2''' -- таблица журнала регистрации событий ведется в текстовом файле. События поступают в один файл в течение календарного месяца, после чего, создается новый файл. Файлы создаются в каталоге <code>EventLogs</code> каталога файлов проекта. Такой способ ведения журнала не рекомендуется к использованию, так как, как и для способа ''1'', если запись в журнал ведется внутри транзакции, она '''не''' будет отменена в момент отмены транзакции совместно с отменой остальных изменений, но самое важное, сервер в данный момент не поддерживает запросы к текстовому журналу, поэтому функция [[Logs.Query|Query]] будет недоступна. Файл журнала ведется в формате UTF-16 и в нем могут присутствовать знаки с кодами <32.
*** '''3''' -- таблица журнала регистрации событий не будет вестись вообще.
** Переменная '''ODBCLogsConnectionString''' (для ODBC подключений) задает полную строку подключения к ODBC драйверу для базы данных, в которой будут храниться логи (если значение перменной ''LogsMode'' равно 1). Если эта переменная не задана, библиотека подключения создаст строку самостоятельно из переменных ''LogsServerAddress'', ''LogsDatabaseName'' и т.п., при этом наименование драйвера ODBC будет задано в зависимости от используемой библиотеки подключения. Ниже заданы умолчания для определенных библиотек:
*** '''MariaDB-ODBC''': <code>DRIVER={MariaDB ODBC 3.0 Driver};SERVER='''LogsServerAddress''';USER='''LogsServerLogin''';PASSWORD='''LogsServerPassword''';DATABASE='''LogsDatabaseName''';NO_PROMPT=1;PORT=3306;OPTION=67108865</code>.
*** '''MySQL-ODBC''': <code>DRIVER={MySQL ODBC 5.3 Unicode Driver};SERVER='''LogsServerAddress''';USER='''LogsServerLogin''';PASSWORD='''LogsServerPassword''';DATABASE='''LogsDatabaseName''';NO_PROMPT=1;PORT=3306;OPTION=67109130</code>
*** '''PostgreSQL-ODBC''': <code>DRIVER={PostgreSQL ODBC Driver(UNICODE)};SERVER='''LogsServerAddress''';UID='''LogsServerLogin''';PASSWORD='''LogsServerPassword''';DATABASE='''LogsDatabaseName''';PORT=5432;</code>
** Переменная '''LogsServerAddress''' (MSSQL и др.) задает адрес (или наименование машины) и наименование типа сервера (в режиме ADO), для хранения базы данных журнала регистрации событий. Эта переменная используется только, если переменная ''EventLogs'' равна 1. Переменная записывается в виде <code><Адрес или имя машины>[\<Тип сервера>]</code>. ''Адрес или имя машины'' могут представлять собой как IP-адрес SQL сервера (к примеру, ''127.0.0.1''), так и сетевое имя компьютера сервера (для локального компьютера можно использовать точку (''.'')). ''Тип сервера'' обычно не указывается, но может представлять наименование ''Instance'' MSSQL сервера, если она отличается от умолчания. Для ''Express'' версии MSSQL, ''необходимо'' указать <code>\SQLExpress</code>. Примеры: <code>.\SQLExpress</code>, <code>Server1</code>, <code>192.168.0.3</code> и т.п.
** Переменная '''LogsDatabaseName''' (MSSQL и др.) задает наименование базы данных журнала регистрации событий. Эта переменная используется только, если переменная ''EventLogs'' равна 1. '''Важно''': сервер никогда не создает базу данных автоматически, если она отсутствовала в СУБД. Это важно из-за того, что администратор должен точно знать, где находятся файлы базы данных, чтобы они не создались на неверном диске и чтобы иметь быстрый доступ к ним. По умолчанию MSQSL располагает файлы баз данных глубоко в структуре папок диска в общей папке с файлами других баз данных, что не является оптимальным расположением файлов (файлы могут быть утеряны или забыты при переустановке операционной системы на компьютере). Поэтому, при настройке новой базы данных, администратор должен самостоятельно создать и назвать новую базу данных в ПО СУБД и указать в файле инициализации имя существующей БД.
** Переменная '''LogsServerLogin''' (MSSQL и др.) задает имя пользователя для подключения к СУБД и базе данных журнала регистрации событий. Обычно это административная учетная запись, для MSSQL часто '''sa'''. Эта переменная используется только, если переменная ''EventLogs'' равна 1. Учетная запись должна иметь полные права в СУБД для работы с базой данных. '''Внимание''': учетная запись, задающаяся здесь, обычно не имеет отношения к учетным записям компьютера (для некоторых СУБД, это может быть не так).
** Переменная '''LogsServerPassword''' (MSSQL и др.) задает пароль пользователя для подключения к СУБД и базе данных журнала регистрации событий для логина, задающегося переменной ''ServerLogin''. Эта переменная используется только, если переменная ''EventLogs'' равна 1.
** Переменная '''LogsDatabaseFile''' (SQLite) задает путь и имя файла базы данных журнала регистрации событий SQLite. Эта переменная используется только, если переменная ''EventLogs'' равна 1.
** Переменная '''UserNameFieldSize''' задает размер в символах поля ''UserName'' таблицы журнала регистрации событий. По умолчанию эта переменная равна нулю (поле имеет неограниченную длину и тип ''TEXT'').
** Переменная '''CommentFieldSize''' задает размер в символах поля ''Comment'' таблицы журнала регистрации событий. По умолчанию эта переменная равна нулю (поле имеет неограниченную длину и тип ''TEXT'').
* Ветка '''BackupServer''' хранит установки, связанные созданием резервных копий базы данных по расписанию, либо для возможности инициации создания таких копий с помощью функций [[InitiateBackupCreation]] и [[QueryBackupProgress]]. Ветка содержит произвольное количество подчиненных веток, каждая из которых должна быть названа уникально. Название подчиненных веток должно иметь вид: <code>Task<Уникальное имя протокола копирования></code> (к примеру, ''Task132''). Каждая из таких веток будет являться протоколом (задачей) резервного копирования. Ниже даны все возможные переменные, которые используются для задания алгоритма задачи резервного копирования.
** Общие переменные (внутри ветки ''BackupServer'', но вне веток протоколов копирования):
*** Переменная '''BackupToolCommandline''' (MariaDB, MySQL, PostgreSQL) задает имя исполняемого файла программы, используемой для инициации резервного копирования. Переменная используется для СУБД, у которых отсутствуют возможности инициации резервного копирования непосредственно из текста SQL, поэтому необходимо использование внешней исполняемой утилиты, входящей в комплект СУБД. Особенности переменной следующие:
**** MariaDB и MySQL: По умолчанию используется утилита '''mariabackup.exe''' для MariaDB и '''mysqldump.exe''' для MySQL. При задании переменной, в ней задается имя утилиты со всеми параметрами командной строки. Путь к файлу утилиты задавать не обязательно (будет использован путь к бинарным файлам СУБД). Строка, используемая по умолчанию, выглядит следующим образом: <code>mariabackup.exe --backup --target-dir=%1% --databases="%2%" --host=%3% --port=3306 --user=%4% --password=%5% --no-defaults</code>. '''Важно:''' резервная копия базы данных, создаваемая утилитой состоит из множества файлов, сервер комбинирует эти файлы в один '''.tar''' архив. Файлы, не связанные с базой данных (метаданные, тексты проекта и пр.) копируются обычным образом, как для остальных СУБД.
**** PostgreSQL: По умолчанию используется утилита '''pg_dump.exe'''. При задании переменной, в ней задается имя утилиты со всеми параметрами командной строки. Если папка с данными ''data'' PostgreSQL находится не в пути по-умолчанию, переменная '''должна''' присутствовать, так как иначе сервер не сможет найти положение утилиты ''pg_dump.exe''. Строка, используемая по умолчанию, выглядит следующим образом: <code>pg_dump.exe -Fc --schema=public --file=%1% --host=%3% --port=5432 --username=%4% --no-password %2%</code>. ''pg_dump.exe'' не принимает пароль базы данных в командной строке, поэтому сервер передает пароль в переменных окружения.
**** Строка запуска утилиты резервного копирования может содержать следующие макросы:
***** '''%1%''' -- Папка, в которую утилита будет производить резервное копирование (система поменяет макрос на путь к временной папке в момент запуска утилиты).
***** '''%2%''' -- Заменяется на имя базы данных в момент запуска утилиты.
***** '''%3%''' -- Заменяется на адрес или DNS сервера базы данных в момент запуска утилиты.
***** '''%4%''' -- Заменяется на имя пользователя базы данных (администратора с правами резервного копирования) в момент запуска утилиты. Важно: здесь указывается имя пользователя СУБД, не имя пользователя OS или сервера.
***** '''%5%''' -- Заменяется на пароль пользователя базы данных в момент запуска утилиты.
***** '''%6%''' -- Заменяется на имя базы данных в момент запуска утилиты, для MariaDB и MySQL отличается от ''%2%'' тем, что не содержит имя базы данных ''mysql''.
** Переменная '''TaskName''' (обязательна) используется для задания короткого уникального имени протокола копирования. По этому имени, задача может быть доступна из функции [[InitiateBackupCreation]].
** Переменная '''ExcludedPaths''' хранит список путей каталога данных проекта, которые необходимо исключить из резервного копирования. Пути всегда относительные, и могут содержать более одного наименования папки. К примеру, <code>_DeploymentBin_ConsoleClient,_DeploymentBin_GUIClient,Temp\Касса</code>. Из резервного копирования, к примеру, можно исключить каталог с картинками, если таковой имеется и он очень объемный. Этот каталог можно включить в резервное копирование раз в день, а каждые 2-4 часа производить копирование без этого каталога. '''Внимание''': из резервного копирования необходимо исключать файлы, которые невозможно открыть на чтение, иначе копирование закончится неудачно, поэтому, если файлы базы данных, хранятся в каталоге файлов проекта, папку с этими файлами необходимо исключить с помощью этой переменной.
** Переменная '''BackupTo''' (обязательна) задает путь в который будет выложен результат резервного копирования (копия). Результатом может быть как папка, так и файл архива (если заданы свойства архиватора). Данный путь может находиться в сети, в этом случае, программа выполнит создание резервной копии базы данных во временной папке текущего компьютера, прежде чем переместить его в место назначения.
** Переменная '''TempFolder''' задает путь к папке с временными файлами. Если эта переменная не задана, используется системная папка временных файлов, однако, при создании резервной копии базы данных, если системная папка располагается на том же носителе, что и файлы базы данных, копирование может быть замедлено и будет увеличивать нагрузку на жесткий диск. В этом случае, выгодно указать папку на другом диске.
** Переменная '''MaximalBackupsCount''' задает максимальное количество старых резервных копий, которые будут храниться в папке результата. Если выполнение резервного копирования закончится удачно и по окончании процесса в папке располагается большее количество копий, чем задано в этой переменной, копии сортируются по времени создания и самые старые лишние копии (папки или файлы) будут удалены. По умолчанию эта переменная равно ''10''. Количество хранимых копий зависит от размера одной резервной копии и вместимости жесткого диска папки назначения.
** Переменная '''Schedule''' задает расписание, руководствуясь которым, резервное копирование будет происходить автоматически. Без задания расписания, протокол копирования может быть вызван только с помощью функции [[InitiateBackupCreation]], которая, однако, может исполнять и те протоколы (задачи), для которых задано расписание. Расписание представляет собой список времен событий, отделенных запятыми. Каждое время события может быть задано в одном из следующих видов:
*** <code>MMMM</code> -- событие, заданное числом, будет исполняться каждые MMMM минут. К примеру, ''30'' будет исполняться каждые полчаса.
*** <code>[-][<День недели>:]HH:MM</code> -- событие, состоящее только из чисел, задает день в неделе, час и минуту, когда оно будет инициировано. День недели представляет собой число от 1 до 7. Первым днем считается понедельник, последним воскресенье. Если день недели не задан, событие будет выполняться каждый день в указанный час и минуту. Если при задании события первым символом идет минус (''-''), дата и время этого события будут исключены из расписания. Таким образом можно исключить создание резервной копии, к примеру, в воскресенье, когда изменения в базе данных не производятся (пример такого расписания: ''05:00,-7:05:00''). Если событие по каким-то причинам не состоялось в указанное время (возможно в это время выполнялось другое событие резервного копирования), оно может быть инициировано позже, но не более чем на полчаса после своего расписания.
*** <code>[-]D<День месяца>:HH:MM</code> -- событие, начинающееся с буквы ''D'', задает день в месяце, час и минуту, когда оно будет инициировано. Если рабочий месяц не содержит указанного дня (указано число 30, и текущий месяц февраль), оно будет пропущено. Если при задании события первым символом идет минус (''-''), дата и время этого события будут исключены из расписания. Таким образом можно исключить создание резервной копии, к примеру, в определенные дни месяца, когда копирование будет выполняться по другой задаче в другую папку (пример такого расписания: ''7:05:00,-D1:05:00,-D10:05:00,-D20:05:00'' -- событие будет выполняться каждое воскресенье в пять утра, за исключением 1, 10 и 20 числа каждого месяца). Если событие по каким-то причинам не состоялось в указанное время (возможно в это время выполнялось другое событие резервного копирования), оно может быть инициировано позже, но не более чем на полчаса после своего расписания.
** Переменная '''Archiver''' задает строку выполнения архиватора. Если эта переменная и переменная ''ArchiverExtension'' заданы, результатом работы протокола резервного копирования будут файлы архива, а не папки с файлами-копиями. Можно использовать любой архиватор, работающий из командной строки. Необходимо использовать ключи, которые запретят любые запросы к пользователю, так как на них некому будет отвечать и протокол копирования зависнет в ожидании и никогда не будет выполнен. Пример строки архиватора для ''7zip'': <code>"C:\Program Files\7-Zip\7z.exe" a "%1%\%3%" -mx4 -sse -y -r "%1%\%2%\*.*"</code> (заметьте, что в строке используются макросы, а использование кавычек обусловлено тем, что путь может содержать пробелы). При создании строки выполнения, можно использовать следующие макросы:
*** '''%1%''' -- полный путь к папке, в которой находится папка с файлами для архивации (она может находиться в папке временных файлов или временной папке в папке назначения, но она всегда находится на локальном диске, и не в сети).
*** '''%2%''' -- имя папки, в которой располагаются файлы архивации (обычно эта папка входит в архив).
*** '''%3%''' -- имя архивного файла в расширением, который требуется создать. Это имя может включать временный суффикс, который будет удален сервером при успешном окончании процесса архивации. Имя архива должно полностью совпадать с заданным в этом макросе, так как серверу необходимо точно знать, какой файл был создан.
** Переменная '''ArchiverExtension''' задает расширение файла архиватора (для ''7zip'', к примеру, эта переменная должна быть задана как ''7z''). Если эта переменная и переменная ''Archiver'' заданы, результатом работы протокола резервного копирования будут файлы архива, а не папки с файлами-копиями.
** Переменная '''ShrinkLogs''' задает режим, когда после выполнения резервного копирования базы данных, сервер выполнит процедуру резервного копирования и сжатия логов базы данных. Для некоторых типов СУБД (к примеру, SQLite), такая процедура не имеет значения. В этом случае, переменная будет игнорирована. По умолчанию эта переменная не задана. Для MSSQL важно выполнять периодическое сжатие логов базы данных, иначе, через определенное время, логи станут больше по размеру, чем сама база данных, и, если не следить за ними, могут заполнить носитель на котором содержится база данных, и тем самым вызвать остановку работы с базой данных.
* Ветка '''ProxyServer''' хранит разрешения для использования серверного соединения, как TCP прокси. Такое прокси соединение можно выполнить на клиенте, использовав функцию [[IPConnection.UseProxy|UseProxy]] при соединении. Ветка может содержать до трех переменных:
** Переменные '''AdministratorProxy''', '''PowerUserProxy''' и '''UserProxy''' содержат разрешенные диапазоны адресов (на данный момент только IPv4 {{Planned}}), разрешающие соединение для пользователей с соответствующими правами. При этом для администраторов будут разрешены соединения, описанные во врсех трех переменных, для опытных пользователей, -- описанные в переменных ''PowerUserProxy'' и ''UserProxy'', и для обычных пользователей -- только в переменной ''UserProxy''. Адреса и порты, не описанные в этих переменных, будут запрещены для использования сервером. Любую из переменных можно не указывать. Если не указать ни одной переменной, любые прокси соединения через сервер будут запрещены. Все три переменные имеют один и тот же формат, описанный в следующем пункте.
** Переменные имеют формат <code><Разрешенные диапазоны адресов прокси>[:,=]<Разрешенный диапазон портов></code>. Разрешенные диапазоны адресов имеют такой же формат, как и переменная ''AllowIPRanges''. Разрешенный диапазон портов, имеет следующий формат: <code><Начальный порт 1>[-<Конечный порт 1>[,<Начальный порт 2>...]]</code>. Примеры содержимого переменных:
*** '''0.0.0.0/0.0.0.0:80''' -- разрешает соединения на порт 80 на любые адреса, доступные серверу.
*** '''192.168.0.0/255.255.0.0=21-22,5000-6000''' -- разрешает соединения на порты 21,22 и от 5000 до 6000 на любые адреса, из диапазона 192.168.0.0 - 192.168.255.255. Разделитель порта можно записывать как в виде двоеточия, так и в виде знака равно.
* Ветка '''UpdateServer''' устарела и больше не используется.

=== Сводная таблица настроек и их применимости к разным СУБД ===

{|class="wikitable sortable" style="border-collapse:collapse;font-size:80%;width=95%;"
! width=10%|Ветка Ini-файла
! width=15%|Имя установки
! width=10%|Обязательна
! width=17%|Применимость к СУБД
! Краткое описание
|-
|-align="left"
|Common
|ServiceName
|Нет
| -
|Указывает на имя сервиса
|-align="left"
|Common
|Loglevel
|Нет
| -
|Задает уровень информации, помещаемой в лог сервера
|-align="left"
|Common
|LogFile
|Нет
| -
|Задает имя файла лога сервера
|-align="left"
|Common
|UpdateCataloguesRescanPeriod
|Нет
| -
|Задает время сканирования каталогов обновлений клиентов
|-align="left"
|Common
|NoExecutableUpdates
|Нет
| -
|Задает режим, когда исполняемые файлы сервера не будут обновляться при получении обновлений из Студии
|-align="left"
|Common
|AcceptCrashLogs
|Нет
| -
|Задает режим, когда логи отказов и ошибок программы принимаются сервером от клиентов в каталог на сервере
|-align="left"
|Connection
|Name
|Нет
| -
|Задает имя базы данных (описательное)
|-align="left"
|Connection
|Description
|Нет
| -
|Задает краткое описание базы данных
|-align="left"
|Connection
|Source
|'''Да'''
| -
|Задает путь к папке с компилированными файлами проекта
|-align="left"
|Connection
|TCPPorts
|'''Да'''
| -
|Задает TCP/IP порты по которым сервер будет слушать подключения клиентов или Студии
|-align="left"
|Connection
|TCPPassword
|'''Да'''
| -
|Задает пароль сервера при TCP/IP соединении
|-align="left"
|Connection
|TCPTimeout
|Нет
| -
|Задает тайм-аут ожидания данных сервером до того, как сервер будет считать, что его связь с клиентом была разорвана
|-align="left"
|Connection
|AllowIPRanges
|Нет
| -
|Задает диапазоны IP-адресов, подключения с которых будут разрешены
|-align="left"
|Connection
|CompressionMode
|Нет
| -
|Задает форсированный режим сжатия пакетов при работе клиентов
|-align="left"
|Connection
|CompressionRanges
|Нет
| -
|Задает диапазоны IP-адресов, при подключениях с которых сжатие пакетов будет форсировано
|-align="left"
|Connection
|NoCompressionRanges
|Нет
| -
|Задает диапазоны IP-адресов, при подключениях с которых сжатие пакетов будет запрещено
|-align="left"
|DBase
|SingleUserModeOnUpdates
|Нет
|MS SQL, SQLite3, MySQL (MariaDB), PostgreSQL
|Задает режим, когда при обновлении (изменении) структуры базы данных, библиотека будет устанавливать эксклюзивный однопользовательский режим. PostgreSQL не имеет возможности эксклюзивного режима, поэтому, перед началом изменения структуры, при работе с PostgreSQL, библиотека будет ожидать, пока в базе не останется других пользователей.
|-align="left"
|DBase
|EnsureUptimeBeforeStart
|Нет
| -
|Задает режим ожидания готовности СУБД компьютера сразу после его перезапуска.
|-align="left"
|DBase
|WorkerDll
|'''Да'''
| -
|Задает относительный или абсолютный путь к библиотеке, которая будет создавать подключения к базе данных
|-align="left"
|DBase
|ADOProvider
|Нет
|MS SQL, подключения по ADO
|Задает наименование поставщика ADO
|-align="left"
|DBase
|ODBCConnectionString
|Нет
|MySQL (MariaDB), PostgreSQL, подключения по ODBC
|Задает полную строку подключения к ODBC драйверу
|-align="left"
|DBase
|ServerAddress
|'''Да'''
|MS SQL, MySQL (MariaDB), PostgreSQL
|Задает адрес (или наименование машины) и наименование типа сервера (в режиме ADO), если это необходимо
|-align="left"
|DBase
|DatabaseName
|'''Да'''
|MS SQL, MySQL (MariaDB), PostgreSQL
|Задает наименование базы данных, с которой будет происходить работа
|-align="left"
|DBase
|TempDatabaseName
|Нет
|MySQL (MariaDB), PostgreSQL
|Задает наименование базы данных, используемой для хранения таблиц функций [[Временная таблица базы данных|временных таблиц базы данных]]. Так как в PostgreSQL невозможна адресация разных баз данных в одном запросе, вместо базы данных, будет создана другая схема (''Schema'') с указанным именем.
|-align="left"
|DBase
|ServerLogin
|'''Да'''
|MS SQL, MySQL (MariaDB), PostgreSQL
|Задает имя пользователя для подключения к СУБД и базе данных
|-align="left"
|DBase
|ServerPassword
|'''Да'''
|MS SQL, MySQL (MariaDB), PostgreSQL
|Задает пароль пользователя для подключения к СУБД
|-align="left"
|DBase
|QueryTimeout
|Нет
|MS SQL, SQLite3, MySQL (MariaDB), PostgreSQL
|Задает максимальное время исполнения запроса в СУБД в миллисекундах
|-align="left"
|DBase
|LockTimeout
|Нет
|PostgreSQL, SQLite3
|Задает максимальное время ожидания блокировки таблицы в СУБД в миллисекундах
|-align="left"
|DBase
|FTS_configuration
|Нет
|PostgreSQL
|Задает конфигурацию (язык) полнотекстового поиска
|-align="left"
|DBase
|SQLiteDll
|'''Да'''
|SQLite3
|Задает относительный или абсолютный путь к библиотеке SQLite3, которая будет выполнять функции СУБД
|-align="left"
|DBase
|SQLiteCacheSize
|Нет
|SQLite3
|Задает количество памяти, выделяемой под буфер таблиц при работе SQlite3
|-align="left"
|DBase
|SQLiteHeapLimit
|Нет
|SQLite3
|Задает ограничение на полное использование памяти библиотекой SQLite
|-align="left"
|DBase
|SQLiteCleanFloats
|Нет
|SQLite3
|Задает режим граничной очистки (округления) вещественных чисел, получаемых от SQLite
|-align="left"
|DBase
|SQLiteDatabaseCollationPage
|Нет
|SQLite3
|Задает кодовую страницу, которая будет использоваться при перекодировании текста из UTF-8 в ANSI
|-align="left"
|DBase
|DatabaseFile
|'''Да'''
|SQLite3
|Задает путь и имя файла базы данных SQLite
|-align="left"
|DBase
|SQLiteTempDBFile
|Нет
|SQLite3
|Задает путь и имя файла базы данных, который будет использоваться для работы с функциями [[Временная таблица базы данных|временных таблиц]]
|-align="left"
|DBase
|SQLiteSynchronousWriting
|Нет
|SQLite3
|Задает режим буферизации записи данных на диск SQLite
|-align="left"
|DBase
|KeepTraceLogs
|Нет
|SQLite3, MySQL (MariaDB)
|Задает режим, когда все запросы к базе данных и время их исполнения будут также фиксироваться в особом логе сервера
|-align="left"
|DBase
|JournalMode
|Нет
|SQLite3
|Задает режим записи в базу данных SQLite
|-align="left"
|DBase
|MySQL_sql_mode
|Нет
|MySQL (MariaDB)
|Задает умолчания для инициализации переменной sql_mode СУБД MariaDB и MySQL
|-align="left"
|DBase
|IsMariaDB
|Нет
|MySQL (MariaDB)
|Задает, к какой из СУБД будет осуществлять соединение сервер
|-align="left"
|EventLogs
|LogsMode
|Нет
| -
|Задает режим ведения таблицы журнала регистрации событий
|-align="left"
|EventLogs
|ODBCLogsConnectionString
|Нет
|MySQL (MariaDB), PostgreSQL, подключения по ODBC
|Задает полную строку подключения к ODBC драйверу для базы данных, в которой будут храниться логи
|-align="left"
|EventLogs
|LogsServerAddress
|'''Да''', если логи ведутся в отдельной базе
|MS SQL, MySQL (MariaDB), PostgreSQL
|Задает адрес (или наименование машины) и наименование типа сервера (в режиме ADO), для хранения базы данных журнала регистрации событий
|-align="left"
|EventLogs
|LogsDatabaseName
|'''Да''', если логи ведутся в отдельной базе
|MS SQL, MySQL (MariaDB), PostgreSQL
|Задает наименование базы данных журнала регистрации событий
|-align="left"
|EventLogs
|LogsServerLogin
|'''Да''', если логи ведутся в отдельной базе
|MS SQL, MySQL (MariaDB), PostgreSQL
|Задает имя пользователя для подключения к СУБД и базе данных журнала регистрации событий.
|-align="left"
|EventLogs
|LogsServerPassword
|'''Да''', если логи ведутся в отдельной базе
|MS SQL, MySQL (MariaDB), PostgreSQL
|Задает пароль пользователя для подключения к СУБД и базе данных журнала регистрации событий
|-align="left"
|EventLogs
|LogsDatabaseFile
|'''Да''', если логи ведутся в отдельной базе
|SQLite3
|Задает путь и имя файла базы данных журнала регистрации событий SQLite
|-align="left"
|EventLogs
|UserNameFieldSize
|Нет
|MS SQL, SQLite3, MySQL (MariaDB), PostgreSQL
|Задает размер в символах поля UserName таблицы журнала регистрации событий
|-align="left"
|EventLogs
|CommentFieldSize
|Нет
|MS SQL, SQLite3, MySQL (MariaDB), PostgreSQL
|Задает размер в символах поля Comment таблицы журнала регистрации событий
|-align="left"
|BackupServer
|BackupToolCommandline
|Нет
|MySQL (MariaDB), PostgreSQL
|Задает имя исполняемого файла программы, используемой для инициации резервного копирования
|-align="left"
|BackupServer\<Имя задачи>
|TaskName
|Нет ('''Да''', для задач резервного копирования)
|MS SQL, SQLite3, MySQL (MariaDB), PostgreSQL
|Используется для задания короткого уникального имени протокола копирования
|-align="left"
|BackupServer\<Имя задачи>
|ExcludedPaths
|Нет
|MS SQL, SQLite3, MySQL (MariaDB), PostgreSQL
|Хранит список путей каталога данных проекта, которые необходимо исключить из резервного копирования
|-align="left"
|BackupServer\<Имя задачи>
|BackupTo
|Нет ('''Да''', для задач резервного копирования)
|MS SQL, SQLite3, MySQL (MariaDB), PostgreSQL
|Задает путь в который будет выложен результат резервного копирования (копия).
|-align="left"
|BackupServer\<Имя задачи>
|TempFolder
|Нет
|MS SQL, SQLite3, MySQL (MariaDB), PostgreSQL
|Задает путь к папке с временными файлами
|-align="left"
|BackupServer\<Имя задачи>
|MaximalBackupsCount
|Нет
|MS SQL, SQLite3, MySQL (MariaDB), PostgreSQL
|Задает максимальное количество старых резервных копий, которые будут храниться в папке результата
|-align="left"
|BackupServer\<Имя задачи>
|Schedule
|Нет
|MS SQL, SQLite3, MySQL (MariaDB), PostgreSQL
|Задает расписание, руководствуясь которым, резервное копирование будет происходить автоматически
|-align="left"
|BackupServer\<Имя задачи>
|Archiver
|Нет
|MS SQL, SQLite3, MySQL (MariaDB), PostgreSQL
|Задает строку с шаблоном исполнения архиватора
|-align="left"
|BackupServer\<Имя задачи>
|ArchiverExtension
|Нет
|MS SQL, SQLite3, MySQL (MariaDB), PostgreSQL
|Задает расширение файла архиватора
|-align="left"
|BackupServer\<Имя задачи>
|ShrinkLogs
|Нет
|MS SQL
|Задает режим, когда после выполнения резервного копирования базы данных, сервер выполнит процедуру резервного копирования и сжатия логов базы данных
|-align="left"
|ProxyServer
|AdministratorProxy, PowerUserProxy, UserProxy
|Нет
| -
|Разрешает диапазоны адресов и портов (в разрезе групп пользователей), для которых можно использовать прокси соединение через сервер (см. функцию [[IPConnection.UseProxy|UseProxy]]).
|}

== Файлы настроек, располагающиеся в папке LocalConfig папки проекта ==

Кроме основного файла инициализации, сервер также использует установки из файлов инициализации, хранящихся в папке ''LocalConfig'' папки файлов проекта. В отличие от основного файла инициализации, установки в этих файлах обычно связаны с файлами проекта, это настройки доступа пользователей в систему и настройки проекта, используемые клиентами. Ниже рассматриваются некоторые из этих файлов:
* Файл '''loginoptions.ini''' используется для настроек подключения клиентов к системе. Он представляет собой файл инициализации описанного выше формата (в формате ANSI или UTF-16). В файле присутствуют следующие ветки:
** Ветка '''Common''' используется для задания общих установок входа.
*** Переменная '''StoreHashesOnly''' позволяет включать режим, когда пароли, введенные пользователями, не сохраняются в файле учетных записей, вместо паролей будут сохраняться хэши MD5. Это позволяет не открывать пароли пользователей администраторам системы. По умолчанию эта переменная равна нулю.
*** Переменные, связанные с формированием минимальной и максимальной длины паролей, а также их уровнем сложности также планируются для использования в данной ветке.
** Ветка '''NTLM''' задает режим использования аутентификации с помощью NTLM для регистрации пользователей. Не наличия такой ветки, новые учетные записи пользователей могут быть введены только с помощью редактора учетных записей в клиенте или непосредственно с помощью текстового редактора в файл ''usercreds.ini''.
*** Переменная '''UseNTLM''' задает режим, когда NTLM будет использован (значение должно быть равно 1). По умолчанию значение переменной равно нулю.
*** Переменная '''NTLMDomain''' задает домен или имя компьютера, к которому будут переадресовываться запросы по аутентификации пользователей. Если значение не задано, при запуске, сервер попытается найти это значение автоматически, и будет использовать имя домена, в который включен компьютер на котором быть запущен сервер.
*** Переменная '''UsersGroups''' задает группы пользователей (как они заданы в панели управления компьютера или в ''Active Directory'' домена), имеющих доступ к серверу. Группы пользователей должны перечисляться через запятые. Если эта переменная не задана, любые пользователи, имеющие учетную запись в домене, или учетные запись в файле ''usercreds.ini'' (некоторые учетные записи могут быть не связаны с NTLM и заданы вручную из редактора учетных записей в клиенте). будут иметь возможность работать на сервере. Если переменная задан, только пользователи, принадлежащие указанным группам (или группам последующих двух переменных) смогут регистрироваться на сервере. Рекомендуется задавать эту переменную, так как это повышает безопасность в сети.
*** Переменная '''PowerUsersGroups''' задает группы пользователей (как они заданы в панели управления компьютера или в ''Active Directory'' домена), которые будут обладать правами ограниченных администраторов (см. [[Общая информация о сервере базы данных]]). Группы пользователей должны перечисляться через запятые.
*** Переменная '''AdministratorsGroups''' задает группы пользователей (как они заданы в панели управления компьютера или в ''Active Directory'' домена), которые будут обладать полными правами администраторов (см. [[Общая информация о сервере базы данных]]). Группы пользователей должны перечисляться через запятые. Эту переменную рекомендуется задавать, если администраторов достаточно много, если же в программе работает две один-два администратора, безопаснее, установить свойства их учетных записей, как административные и отвязать их от аутентификации NTLM.
* Файл '''usercreds.ini''' создается и ведется сервером автоматически, редактирование его с помощью текстового редактора возможно, но не рекомендуется. При редактировании файла с помощью редактора, сервер должен быть выключен. Файл обычно создается в формате UTF-16 с BOM и представляет собой стандартный файл инициализации, описанный выше. При редактировании учетных записей в визуальном клиенте (см. [[Общая информация о консольном и визуальном клиентах]]), сервер получает изменения и сохраняется их в этом файле. Файл также хранит дату и время первого и последнего входа каждого пользователя, поэтому, файл будет обновляться достаточно часто. Наряду с оригинальной версией файла, сервер хранит его предыдущую версию '''usercreds.bak''', которая может пригодиться, если оригинальный файл был испорчен из-за сбоя или по каким-то другим причинам.
* Файл '''dbaseLocal.ini''' обычно создается администратором вручную с помощью текстового редактора и может содержать те же переменные, что и файл ''dbase.ini'', хранящийся в корневой папке файлов проекта и создаваемый непосредственно в Студии. Любая переменная локального файла заменяет значение файла, пришедшего с обменом из Студии. Это актуально и может использоваться для клиентов, если необходимо задать для текущей базы данных другое название, отображаемое в заголовке программы и в диалоге входа пользователя, чтобы пользователи не перепутали разные базы данных. Для редактирования этого файла из Студии см. [[Студия/Установки проекта|Установки проекта]]. Локальный файл установок базы данных может содержать следующие переменные:
** '''Name''' -- позволяет задать наименование проекта (в данном случае, может использоваться для задания наименования локальной базы данных).
** '''BuildNumber''', '''VersionName''' -- задает программные свойства проекта, доступные как из диалогов клиента, так и программно.
** '''ExcludedFolders''' -- задает папки, исключенные из обмена при получении обновлений из Студии.

== Резервное копирование с помощью сервера базы данных и восстановление резервной копии базы данных ==
Резервное копирование важный процесс, помогающий избежать утери базы данных, которая могла бы обернуться неделями работы и финансовыми потерями для предприятия. При использовании системы рекомендуется проводить регулярное резервное копирование на дисковый накопитель, физически отличающийся от накопителя, на котором находится база данных. Кроме того, желательно осуществлять резервное копирование на другое устройство в сети. Даже если в Вашей организации используется raid массив или другие защитные технологии, резервное копирование необходимо осуществлять на регулярной основе. См. также статью [[Общая информация о сервере базы данных]].

Резервное копирование можно осуществлять из командной строки, либо доверить эту работу серверу, настроив в его файле инициализации автоматическое резервное копирование (см. выше). Настройка резервного копирования с помощью сервера базы данных рекомендуется. Резервное копирование с помощью возможностей сервера базы данных обладает следующими возможностями:
* В файле инициализации можно задать произвольное количество задач для резервного копирования, с разным расписанием или для программного запуска. Каждая задача может осуществлять копию в свой каталог резервного копирования.
* Сервер датирует копии и может хранить определенное количество, удаляя более старые копии по мере появления новых.
* Сервер может осуществлять резервное копирование на сетевые диски. '''Внимание''': в системе Windows при работе сервера базы данных в виде сервиса системы (режим по умолчанию) для доступа сервера на сетевые диски, необходимо настроить вход сервиса с учетной записью отличной от "Локальной системы", так как последняя не будет иметь доступ к сети.
* Сервер следит за корректностью и полнотой резервной копии, если резервное копирование было прервано в результате внезапного выключения сервера или отключения его от сети, в будущем, неверная копия будет автоматически удалена из набора резервных копий.
* В резервную копию попадает не только копия базы данных, но и все файлы проекта сервера, а также отдельная копия базы данных журнала регистрации событий, если последний хранится в базе данных, отличной от основной базы данных.
* Сервер может автоматически архивировать копии базы данных, для их более компактного размещения в каталоге резервных копий в виде одного файла на резервную копию.
* Для СУБД типа MySQL и MariaDB, которые создают резервную копию базы данных как множество файлов и каталогов, сервер автоматически объединяет файлы копии базы данных в один файл в формате ''tar'' без использования компрессии.
* Используя возможности сервера, администратор может не опасаться, что сервер не сможет запуститься из-за того, что во время обновления проекта из Студии и перезапуска сервера, он не смог войти в эксклюзивный режим базы данных, так как в этот момент работала внешняя программа резервного копирования. Тем самым исключается необходимость в дополнительных действиях на сервере и повторной инициации обновления.

Инициировать резервное копирование с помощью сервера базы данных можно тремя способами:
* Сервер инициирует процесс копирования по расписанию заданному в установках задачи резервного копирования (см. выше).
* С помощью функций [[InitiateBackupCreation]] и [[QueryBackupProgress]] можно запускать задачи резервного копирования программно и следить за их выполнением.
* С помощью командной строки исполняемого файла сервера (процесс сервера при этом должен быть запущен) в формате <code>sfsrv.exe "BACKUP <Имя задачи резервного копирования>"</code> можно инициировать резервное копирование и отследить его выполнение (см. статью [[Ключи запуска сервера из командной строки]]).

Восстановление резервной копии всегда зависит от конкретного вида СУБД. Обычно алгоритм восстановления резервной копии следующий:
* Остановка сервера базы данных.
* Удаление каталога файлов проекта.
* Копирование каталога файлов проекта из резервной копии.
* Удаление или отключение текущей базы данных.
* Восстановление базы данных из резервной копии базы данных. Для разных СУБД, этот процесс может несколько отличаться:
** Для MS SQL резервная копия может быть восстановлена с помощью графического интерфейса СУБД.
** Для SQLite3 резервная копия представляет собой рабочий файл базы данных, который можно скопировать в рабочий каталог.
** Для PostgreSQL резервная копия по умолчанию представляет собой бинарный сжатый файл, который можно восстановить в рабочую базу данных с помощью утилиты '''pg_restore'''.
** Для MySQL или MariaDB см. статью ниже.
* Запуск сервера.

=== Резервное копирование и восстановление базы данных для СУБД MariaDB и MySQL ===
В отличие от MS SQL, где базу данных можно восстановить из резервной копии с помощью графического интерфейса или SQLite3, который создает резервную копию в виде рабочего файла данных, который можно использовать как базу данных сразу после резервного копирования, восстановление базы данных MariaDB и MySQL может быть связано с определенными сложностями.

Для осуществлении резервного копирования ''online'' (т.е., при работающих пользователях), необходимо использовать утилиту '''mariabackup''', входящую в состав файлов установки СУБД MariaDB, для MySQL можно использовать совместимую утилиту '''Xtrabackup''', либо потенциально более медленную '''mysqldump'''.

По умолчанию подразумевается использование утилит ''mariabackup'' или ''Xtrabackup'', а не утилиты ''mysqldump'', так как последняя делает логическую текстовую резервную копию, создание которой может занимать более продолжительное время. В процессе резервного копирования блокируются таблицы и увеличивается активностью диска и длительный процесс копирования для больших баз данных может очень негативно сказаться на работе пользователей. Обычно простое копирование файлов (''mariabackup'') должно осуществляться быстрее, чем создание файлов путем получения информации из базы данных (''mysqldump''), однако, дамп, полученный с помощью ''mysqldump'' более компактный по размеру (часто в 2.5-3 раза), поэтому, для определенных серверов ''mysqldump'' может работать быстрее и меньше увеличивать активность диска.

При использовании утилиты ''mysqldump'' вместо ''mariabackup'', в переменной ''BackupToolCommandline'' можно указать следующую строку: <code>[Путь к бинарным файлам СУБД\]mysqldump --allow-keywords --complete-insert --hex-blob --host=%3% --user=%4% --password=%5% --port=3306 --single-transaction --databases %6%</code> (макрос '''%6%''' тут используется для указания на список баз данных без базы данных ''mysql'', которая не требуется при таком резервном копировании). Так как утилита ''mysqldump'' выгружает дамп в стандартный поток вывода (stdout) и перенаправить его в файл при запуске процесса из приложения используя только командную строку невозможно, сервер будет определять необходимость в получении данных из стандартного потока по наименованию утилиты. Если используется другая утилита с выгрузкой в стандартный поток, имя которой не соответствует ''mysqldump'', необходимо запускать ее через какую-либо программу, которая сама перенаправит стандартный поток в файл (макрос ''%1%'').

Дальнейшая информация параграфа относится только к ''mariabackup''.

Резервное копирование рекомендуется осуществлять строго возможностями сервера базы данных (по причинам сложности и капризности резервного копирования данных СУБД), если все-таки оно выполняется сторонней утилитой, для его осуществления с помощью ''mariabackup'' должна используется командная строка <code>mariabackup --backup --target-dir=<Папка, в которую происходит копирование> --databases="mysql <Имя базы данных>" --host=<Адрес сервера> --port=<Порт сервера> --user=<Имя администратора сервера> --password=<Пароль администратора> --no-defaults</code>. Обратите внимание: папка резервного копирования должна иметь обратные косые знаки '''/''' вместо прямых, даже если рабочей средой является система Windows (к примеру, <code>G:/Temp/Backup/</code>), папка также не должна содержать специальных символов длинного пути (''\\?\'') или сетевого пути (''\\''). Также обратите внимание: имя базы данных всегда указывается в нижнем регистре, кроме имени базы данных указывается также база данных ''mysql'', которая хранит информацию по всем метаданным СУБД, иначе резервную копию не удастся восстановить простым способом. Если резервное копирование осуществляется средствами сервера базы данных, командную строку и расположение утилиты он подберет автоматически.

Перед восстановлением резервной копии базы данных, необходимо принять во внимания следующие ограничения и особенности процесса восстановления:
* При восстановлении все другие базы данных на сервере СУБД будут удалены. После успешного процесса восстановления в СУБД останутся только две рабочие базы данных: ''mysql'' (сервисная база данных) и восстановленная база данных. Это может стать проблемой в случае, если в СУБД используются другие базы данных. Обойти это ограничение не так просто. Но так как восстановление резервной копии -- процесс очень редкий и связанный с катастрофическими событиями, можно, к примеру, восстановить базу данных на другой машине с СУБД, сделать ее резервную копию с помощью утилиты ''mysqldump'', затем восстановить ее в рабочую копию СУБД из полученного текстового дампа. В Интернете есть информация по другим способам восстановления.
* При описанном здесь процессе восстановления невозможно изменить имя восстанавливаемой базы данных. Восстановленная база данных всегда будет иметь такое же имя, как и оригинальная, для которой создавалась резервная копия.
* Восстанавливать базу данных необходимо той же версией СУБД, которая создавала резервную копию.

Общий процесс восстановления резервной копии описан выше в параграфе о резервном копировании, здесь описывается обычный и самый простой процесс восстановления базы данных в СУБД из резервной копии, созданной утилитой ''mariabackup'':
* Остановите СУБД.
* Удалите или переместите папку ''Data'', в которой хранятся все базы данных СУБД. Создайте снова эту папку, с тем, чтобы она не содержала никаких файлов. Сохраните файл my.ini из удаляемого каталога (только для MariaDB, MySQL хранит этот файл в другой папке). Для Windows папка ''Data'' для MariaDB обычно находится в каталоге установочных файлов MariaDB (в ''Program Files''), для MySQL в папке ''ProgramData\MySQL\...''.
* Распакуйте ''tar'' архив, в котором содержатся файлы резервной копии базы данных в формате СУБД. Скажем, содержимое файла было распаковано в папку ''c:\backup\''.
* В каталоге с бинарными файлами СУБД выполните следующую команду <code>mariabackup --prepare --target-dir="c:/backup/"</code> (здесь указан путь, куда мы распаковали ''tar'' архив). Этот шаг позволяет подготовить резервную копию к восстановлению.
* В каталоге с бинарными файлами СУБД выполните следующую команду <code>mariabackup --copy-back --target-dir="c:/backup/"</code> (здесь указан путь, куда мы распаковали ''tar'' архив). Этот шаг выполняет копирование файлов восстановления в каталог ''Data'' СУБД.
* Добавьте сохраненный файл my.ini в заполненный каталог ''Data'' (только для MariaDB).
* Добавьте разрешения полного доступа для всех пользователей ко всем файлам и подкаталогам каталога ''Data''. '''Важно''': не пропускайте этот шаг, СУБД активно использует системные разрешения и не будет работать корректно, если сервису не дать разрешения на запись к файлам восстановленного каталога с данными ''Data''. Если Вы знаете, под каким пользователем запускается сервис СУБД, достаточно добавить разрешения только для учетной записи, под которой он работает.
* Запустите СУБД и сервер базы данных. Резервная копия успешно восстановлена.

При восстановлении резервной копии, особенно если это делается в первый раз, можно испортить установку MariaDB и MySQL. Ниже даются возможные случаи, когда СУБД становится неработоспособной и способы исправления аварийной ситуации:
* '''Q''': Сервис СУБД не запускается, однако, СУБД запускается из командной строки. '''A''': Вероятнее всего, сервис не может получить доступ записи в каталог ''data'' СУБД. Для исправления, необходимо изменить разрешения на каталоге ''Data'' и всех его подкаталогах и файлах, к примеру, добавив полный доступ всем пользователям.
* '''Q''': СУБД запускается, но восстановленные таблицы базы данных недоступны (ошибка: "таблица не существует на данном сервере"). '''A''': Сервисная база данных ''mysql'', в которой содержится информация по метаданным базы данных, не была восстановлена вместе с базой данных. Необходимо восстановить резервную копию еще раз. Если в резервной копии не содержится копии БД ''mysql'', восстановление приобретает нетривиальных характер, и его обсуждение выходит за пределы этой документации. В Интернете есть информация, позволяющая выполнить такую задачу.
* '''Q''': Восстановленная или рабочая база данных содержит повреждения или ошибки, что не позволяет удалить ее из СУБД. '''A''': Для сброса СУБД и удаления всех ее баз данных, необходимо остановить СУБД, удалить каталог ''Data'' и запустить утилиту '''mysql_install_db''', находящуюся в каталоге бинарных файлов СУБД. Данная утилита создаст и заполнит каталог ''Data'' заново и позволит избежать необходимости переустановки СУБД.

Для дополнительной информации, см. внешнюю статью [https://mariadb.com/kb/en/full-backup-and-restore-with-mariabackup/ full-backup-and-restore-with-mariabackup] на mariadb.com.

Проект Розница

2026-04-01T10:01:28Z

Admin: 1 revision imported

{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Проект Розница|Общее описание розницы]]
* [[Установка проекта Розница|Пошаговая установка проекта розница]]}}
__NOTOC__
Проект "розница" является абсолютно '''бесплатной''' альтернативой коммерческим кассовым и учетным системам для розничной торговли. Проект может использоваться как на рабочем месте кассира, так и как учетная программа для розничной компании. Эта статья пытается дать исчерпывающую информацию о том, какими ограничениями обладает данная версия, что она уже умеет и какие предполагаются дальнейшие шаги по ее развитию, а также о том, каким образом начать с ней работать.

Проект появился для того, чтобы каким-то образом облегчить положение мелких розничных точек на рынке. Существующие программы слишком сложные в настройке, не обладают достаточной гибкостью, медленные в работе или заставляют торговые точки платить немалые деньги, в условиях, когда прибыль небольших магазинов постоянно сокращается из-за увеличения конкуренции с федеральными сетями. Мы представляем бесплатное решение, которое не только не требует какого-либо лицензирования, но и может быть модифицировано Вашими специалистами или сторонними организациями. В программе не используется реклама, нет ограничений по времени, скрытых платежей и пр. Если Ваша модель кассового или периферийного оборудования пока не поддерживается текстами драйверов проекта, Вы можете оставить заявку для создания драйвера (на github) или создать его самостоятельно. Данный Wiki-портал содержит описание всех программных возможностей системы, на которой работает проект, все статьи, связанные с описанием программных функций, имеют примеры. Любой человек, немного разбирающийся в программировании, сможет модифицировать текст проекта для изменения или увеличения функциональности. Также для пошаговой информации по установке проекта в магазине, смотрите статью '''[[Установка проекта Розница]]'''.

==== Лицензионное соглашение на использование проекта ====

Для того, чтобы скачивать, устанавливать, работать с проектом или модифицировать его с помощью исполняемых файлов проекта, Вам необходимо согласиться с лицензионным соглашением на использование исполняемых файлов проекта. Соглашение имеет определенные ограничения в использовании, для того, чтобы проект мог применяться только небольшими и средними организациями. Соглашение не относится к исходным текстам проекта, распространяемым на сервере github (или подобном), тексты проекта могут быть использованы в любых целях без ограничения.

* [http://{{SERVERNAME}}/download/EULASOFT.txt <big>'''Полный текст соглашения для использования исполняемых файлов (программного обеспечения) проекта.'''</big>]. Исполняемые файлы доступны для скачивания с данного портала (см. ниже ссылки для скачивания).
* [http://{{SERVERNAME}}/download/EULASRC.txt <big>'''Полный текст соглашения для использования исходных текстов проекта.'''</big>]. Свежую версию исходных текстов проекта можно скачать со страницы проекта на [https://github.com/sfsys132/project-free-Russian-retail github].

Ниже дается краткий свод ограничений соглашения на использование исполняемых файлов проекта (для понимания общей картины):
* Соглашение запрещает скачивать '''исполняемые файлы''', устанавливать их, или использовать их в коммерческих целях (в работе коммерческой организации) в случаях:
** Если проект будет использоваться в любой другой организации, кроме торговой розничной организации. Использование проекта для случаев, когда точка продает только через сеть Интернет, также не допускается.
** Если в розничной организации, использующей проект, зарегистрировано более десяти торговых точек на одном юридическом лице, за исключением юридических лиц, которые получили на это соответствующее разрешение у организации, распространяющей проект. Таким юридическим лицам будут предоставлены другие (коммерческие) исполняемые файлы системы.
** Если десять или более розничных точек используют одну контролирующую организацию или связанную группу организаций, им необходимо получить дополнительное разрешение у организации, распространяющей проект. Таким организациям будут предоставлены другие (коммерческие) исполняемые файлы системы.
** Организациям, производящим внедрение и обслуживание проекта, на более чем десяти торговых точках с целью продвижения своего продукта в эти торговые точки, необходимо получить дополнительное разрешение у организации, распространяющей проект. Таким организациям будут предоставлены другие (коммерческие) исполняемые файлы системы.
* Однако соглашение не запрещает использовать любые части '''исходных текстов проекта''', находящихся на сервере github (или подобном), в коммерческих или других целях, в других системах программного обеспечения или в системе SunFlurry.
* Организация, распространяющая проект, может в любой момент без предварительного оповещения изменить текст лицензионного соглашения, однако:
** Последняя версия исходных текстов проекта, распространяемая на сервере github (или подобном), а также любые исходные тексты, созданные сторонними разработчиками в рамках лицензионного соглашения до момента его изменения, ни при каких условиях не потеряют бесплатный статус.
** Последние версии исполняемых файлов, распространявшихся до момента изменения лицензионного соглашения, ни при каких условиях не потеряют бесплатный статус, эти старые версии можно будет использовать в рамках текста лицензионного соглашения до момента его изменения.
* Проект распространяется без какой-либо гарантии со стороны распространяющей организации ("как есть"). Организация не несет ответственности за возможный ущерб, причиненный программой, ее сбоями, возможностью или невозможностью ее использования (включая убытки и потерю информации).

Если Вы не можете использовать проект, так как деятельность или величина Вашей организация не удовлетворяет условиям лицензионного соглашения, однако у Вас есть интерес к системе или какие-либо коммерческие предложения, вы можете связаться с нами с помощью электронной почты, используя следующий адрес: '''<nowiki>sf@sfsys.ru</nowiki>'''. Мы читаем всю почту, но можем задержаться с ответом из-за высокой загруженности. Если Вы не получили ответ в течение недели, возможно дежурный сотрудник находится в отпуске. Из-за большого количества спама, приходящего на почту, наш почтовый сервер использует спам-фильтры. Если наш сервер отвергает Ваше письмо, попробуйте отослать его с бесплатных почтовых серверов.

==== Возможности проекта розница ====

Бесплатный проект розница состоит серверной части, клиентской части и файлов проекта.

Серверная часть хранит базу данных и обслуживает запросы к ней. Для одного магазина должна быть установлена одна серверная часть, даже если работа с базой данных будет происходить с нескольких машин одновременно. Некоммерческий проект розница использует '''x86''' '''SQLite3''' сервер ([[Общая информация о сервере базы данных#Доступные СУБД и особенности их использования|См. статью]]). Это ограничивает масштабируемость одной базы данных, и слишком большое количество пользователей может замедлить работу в ней. 32-битная версия сервера также накладывает некоторое ограничение на размер базы данных, так как слишком большие базы данных могут работать медленнее из-за невозможности использования буфера запросов больше предела в ~2Гб. Однако для розничных точек это не должно стать проблемой, так как базы данных в них обычно небольшие. Нужно добавить, что сама база данных не имеет никаких искусственных ограничений по размеру (максимальный размер определяется возможностями SQLite3). Для небольших магазинов, серверная часть обычно устанавливается на компьютер с кассовым оборудованием, где клиентская часть выступает как кассовый терминал.

[[Общая информация о консольном и визуальном клиентах|Клиентская часть]] проекта розница использует '''x86''' бинарный файл. Клиентская часть может использоваться как кассовый терминал, так и как учетная система и может быть установлена на любое количество компьютеров для работы с одним сервером магазина. Возможности клиентской части определяются исходными текстами проекта, поэтому, они постоянно дополняются и изменяются. Любой человек, разбирающийся в программировании, может изменить текст проекта и добавить в него новые возможности. На момент написания статьи, проект умеет:

* При использовании проекта, как учетной системы:
** Ведение любого количества юридических лиц и магазинов в одной базе.
** Анализы продаж и закупок, ABC, XYZ-анализы, анализы наценки и прибыли, прогнозирование закупки товаров.
** Система ценообразования и формирования цен, распечатка ценников.
** Ведение бухгалтерского учета, ручные проводки, ведение учета по основным средствам.
*** Книга покупок и книга продаж, книга доходов и расходов, бух. баланс и отчет по прибыли.
** Ведение финансового учета, ведение затрат, затраты по оплате и начислению.
*** Операционный капитал, отчет по прибылям и убыткам, маржинальная прибыль.
** Ведение и учет маркетинга поставщиков (начисление и закрытие скидок и т.д.).
** Ведение и анализы взаиморасчетов с поставщиками, платежная ведомость.
** Ведение кассовых и банковских остатков. Ведение подотчета.
** Ведение складских остатков в разрезе партий, марочный учет ЕГАИС и ГИС МТ.
** Обрезание, объединение и перенос базы данных.
** Обмен между базами данных, возможность выгрузки документов из периферийных баз данных в центральную.
** Система прав отдельных пользователей.
** Возможности обмена с другими информационными базами:
*** При разрелении центральной базы и локальных баз магазинов, возможность использования простого обмена по протоколу Фронтол.
*** Возможно выгрузки и зарузки из баз 1С по проколу EnterpriseData.
*** Возможность использования внутреннего протокола обмена с центральной базой.
* При использовании проекта, как кассового терминала:
** Драйверы для популярных ККМ (Атол, Штрих-М, Вики Принт, другие драйверы будут добавлены позже).
*** Продажа марочного товара ЕГАИС (алкоголь) и ГИС МТ (сигареты, молочная продукция и пр.). Работа с ФФД 1.2.
*** Продажа на несколько касс одновременно (если, к примеру, торговля алкоголем ведется от одного юр. лица, а все остальное продается от другого).
** Приемка поступлений ЕГАИС, автоматическое создание партий, работа с регистром 2, отчеты по сравнению с реальными остатками и прочее. Полный учет ЕГАИС.
*** Доступ к УТМ ЕГАИС через сервер позволяет принимать документы в ЕГАИС, работая с базой через Интернет без необходимости перенаправления соединения с УТМ.
*** Формирование декларации об объемах продаж алкоголя.
** Прием поступлений от поставщиков марочной продукции ГИС МТ.
** Использование концепции "рабочее место" и "магазин", что позволяет настроить оборудование в ККТ магазина нужным образом и исключить проблемы с путаницей между оборудованием и пользователями.
** Возможность выгружать и загружать информацию по протоколу Фронтол (к примеру, если центральная база будет использовать другую учетную систему). Другие способы обмена могут быть созданы Вашими или сторонними IT-специалистами.
** Возможность программировать запреты на продажу алкоголя.
** Вскрывать тару ЕГАИС непосредственно в интерфейсе продавца.
** Блок макетинга покупателей:
*** Использование торговых акций с скидкой на позиции, скидкой от суммы документа, акции типа 2+1, возможность добавления исходного кода для реализации более сложных акций.
*** Работа со скидочными картами, работа с подарочными картами, работа с депозитами.
*** Учет маркетинговых акций и скидок покупателям.
** Удобная и простая самомасштабируемая форма рабочего места продавца.
*** Операции типа: отложить чек, продолжить чек, возврат, аванс, кредит, временная замена прав для выполнения нужной операции и т.д.
*** Возможности подбора товаров в чек, в т.ч. с помощью терминала сбора данных.
*** Быстрое закрытие чека, быстрая работа с комбинированными оплатами.
*** Добавление часто выбираемых товаров в интерфейс рабочего места продавца, частые кнопки могут содержать исходный код для произвольных операций.
*** Возможность перехвата специальным исходным кодом управления в любой момент или при нажатии на стандартные кнопки. Примеры кода для кафе с номерами столов и депозитами.
* Возможности сервера базы данных:
** Автоматическое создание резервных копий базы данных.
* Возможность получения самых свежих обновлений из официального репозитория.

Требования к оборудованию для работы серверной и клиентской части проекта:
* Операционная система: Windows 2000, XP, 7, 8, 10 или 11
* Процессор: 1.1ГГц и выше (также поддерживаются младшие модели Celeron и Atom)
* Оперативная память: 2Гб и выше (4Гб и выше для Windows 10 и 11)
Проект будет работать практически на любом оборудовании. Помните, что если вся Ваша оперативная память используется, работа с компьютером будет замедлена, и это может негативно сказаться на кассовых продажах. Убедитесь, что у Вас достаточно оперативной памяти. Для баз данных, обычного размера, сервер не требует много дополнительной памяти, однако, если база данных будет очень большой (2Гб и более), сервер также будет использовать значительное количество памяти.

В проект также входит специальная версия [[Общая информация и интерфейс Студии|Студии]], программы, которая позволяет изменять исходный код проекта и его визуальные формы, а также, разворачивать эти изменения на существующих торговых точках простым нажатием нескольких клавиш. Студия используется в работе техническими специалистами и обычно не устанавливается в самих магазинах. Данный портал содержит исчерпывающую документацию для начала работы со Студией для изменения исходного кода проекта.

Для пошаговой информации по установке проекта в магазине, смотрите статью '''[[Установка проекта Розница]]'''.

==== Изменения, планируемые в будущем ====

На данный момент не все планируемые возможности проекта реализованы. Изменения в его исходном коде будут загружаться на [https://github.com/sfsys132/project-free-Russian-retail официальную страницу github] и бета-версии всегда доступы в официальном репозитории (см. параграф ниже), их можно будет скачать, и обновить рабочие базы данных магазинов. Среди планируемых изменений и добавлений, можно выделить следующие:
* Особый и более удобный инферфейс для кафе и ресторанов (сейчас есть возможность работы с номерами столов и пр. с помощью перехвата функций из интерфейса кассира).
* Расширение возможностей системы (внешние модули, создание собственных объектов в язывке (пользовательское ООП) и т.д.)
* Дополнительные функции редактора исходных Студии (выделенные уровни блоков текста, переходы к функциям, т.п.)
* Добавление новых драйверов для ККМ, банковских терминалов, т.с.д., электронных весов и дисплеев покупателей
* Работа над исправлением найденных ошибок

==== Официальный репозиторий исходных текстов проекта ====

Ссылка на официальный репозиторий исходных текстов проекта находится в списке серверов при установки Студии из комплекта бесплатного проекта Розница. Официальный репозиторий содержит самые свежие изменения в проекте и самые свежие исполняемые файлы. Изменения можно скачать выборочно при синхронизации с репозиторием из Студии (пункт меню "развертывание" - "развернуть проект" - галочка на репозитории). Пользователи проекта не могут изменить исходные тексты репозитория, им предоставляется доступ только для чтения. Важно понимать, что репозиторий может содержать непроверенные или мало проверенные изменения, скачивание которых в рабочий проект и затем развертывание в рабочие базы, может привести к ошибкам. Вы можете использовать репозиторий на свой страх и риск, в случаях, к примеру, если новое изменение еще не появилось в новом выпуске или на github, однако, оно необходимо. Проверяйте работу магазина после каждого обновления из репозитория!

==== Ссылки для скачивания бинарных файлов проекта ====

Приведенная здесь ссылка содержит текущую версию программы установки. Программа позволяет установить как клиентскую и серверную части, так и систему разработки Студия. Несмотря на то, что исходные файлы проекта в этой программе установки достаточно свежие, вероятно, они не содержат всех недавних изменений, которые доступны на сервере [https://github.com/sfsys132/project-free-Russian-retail github]. Если Вам необходимо обновить исходные тексты до самой свежей версии, Вы можете скачать их в виде архива или с помощью специальных инструментов (типа [https://tortoisegit.org/ tortoisegit]). Для подобной операции могут потребоваться дополнительные знания. Для пошаговой информации по установке проекта в магазине, смотрите статью '''[[Установка проекта Розница]]'''.

Программа установки, а также бинарные файлы проекта не содержат вирусов, однако при скачивании любых исполняемых файлов из Интернета, всегда рекомендуется использовать антивирус со свежими базами обновлений!

[http://{{SERVERNAME}}/download/sf_retail_x86_20260401_install.exe <big>'''Скачать файл установки проекта Розница.'''</big>]

==== Ссылка для скачивания простой демонстрации графических возможностей системы -- tetris.sfo ====

Для простой демонстрации графических возможностей системы был создан внешний объект системы ([[Функции общего назначения#Внешний загружаемый объект|Внешний загружаемый объект]]) '''Tetris'''. Вы можете скачать файл объекта и открыть его в визуальном клиенте. Для работы необходимы установленные драйверы видеокарты и OpenGL не ниже 2.1 (любая современная видеокарта, в т.ч. встроенные). Внешний объект также содержит исходный текст, его можно редактировать и изменять по желанию, если открыть в [[Общая информация и интерфейс Студии|Студии]]. Объект в свободном распространении. Копия, данная на скачивание здесь, возможно, будет в дальнейшем немного изменяться, чтобы улучшить читаемость. Ниже дана ссылка на скачивание:

[http://{{SERVERNAME}}/download/tetris.sfo '''Скачать демонстрацию графического объекта Tetris.''']

====Контактная информация====

Вы можете связаться с нами, используя следующий почтовый адрес: <big>'''<nowiki>sf@sfsys.ru</nowiki>'''</big>. Нам интересно будет услышать любые Ваши предложения. Мы читаем всю почту, но можем задержаться с ответом из-за высокой загруженности. Если Вы не получили ответ в течение недели, возможно дежурный сотрудник находится в отпуске. Из-за большого количества спама, приходящего на почту, наш почтовый сервер использует спам-фильтры. Если наш сервер отвергает Ваше письмо, попробуйте отослать его с бесплатных почтовых серверов.

Объект запрос базы данных

2026-04-01T10:01:26Z

Admin: 1 revision imported

{{infobox object
|object=Query
|status=2
|create=[[Query.Create|Create]],[[Query.CreateFromTable|CreateFromTable]]}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]}}
__TOC__
Запрос базы данных является объектом, имеющим свой внутренний язык, позволяющий описать к какой таблице или таблицам базы данных будет произведен запрос и по каким правилам он будет выполнен. После выполнения запроса объект позволяет возвратить его результат в виде таблицы значений, автоматически подсчитать промежуточные итоги, сгруппировать строки таблицы в уровни для удобного вывода в виде отчета, добавить в таблицу структуру папок справочника и подсчитать промежуточные итоги по каждой из папок, если это необходимо. Объект запроса имеет тенденцию использованию большого количества памяти, особенно, когда в запрос входит объекты БД, имеющие множество реквизитов. Для уменьшения потребности к памяти, имеется ряд оптимизаций, некоторые из них позволяют также ускорить выполнение запроса. Для дополнительной информации по работе с базой данных, смотрите также другие разделы документации: [[Объект базы данных|объект базы данных]], [[Объект структуры базы данных|объект структуры базы данных]], [[Временная таблица базы данных|объект временной таблицы базы данных]].

==Структура языка запроса базы данных==
Большинство запросов к базе данных имеют текст, описывающий правила, по которым необходимо выполнить запрос. Этот текст задается на языке, не совпадающем (но похожем) с основным языком программ системы. Данный язык далее будем называть языком запросов. Основная функция языка запросов, это задать источник данных для одного или нескольких запросов, связать эти запросы требуемыми операциями объединения, в каждом из запросов задать условия отбора информации, реквизиты группировки информации, реквизиты сортировки информации, правила агрегации числовой информации. Кроме того, язык позволяет задать правила постобработки информации. В общем виде, текст запроса выглядит следующим образом:
<pre>
<Группа запросов>;

[Postprocessing (
<Установка постобработки 1>;
<Установка постобработки 2>;
...)]
</pre>

Где <code><Группа запросов></code> может быть представлена в следующем виде:
<pre>
([Name <Наименование запроса>]
[<Задание периода работы с остатками накопителя>;]
[<Необязательные опции запроса>;]
<Задание переменной запроса 1>;
<Задание переменной запроса 2>;
...
[Condition <Условия отбора записей 1>;
Condition <Условия отбора записей 2>;
...]
[<Порядок группировки или/и сортировки>;])

[<Операция объединения запросов 1>
(<Запрос 2>) On (<Условие объединения запросов>)

[<Операция объединения запросов 2>
... ]]
</pre>

Описание основных свойств, операторов, переменных и полей текста запроса:
* Каждый запрос имеет определенный ''источник запроса''. Источником называют указание на объект базы данных: справочник, вид документов или накопитель. Внутри запроса могут быть заданы ссылки на другие справочники, виды документов или табличные части, но эти ссылки всегда связаны с источником запроса через его реквизиты. К примеру, запрос осуществляется к справочнику ''Адреса'', который является подчиненным справочника ''Контрагенты''. Чтобы произвести отбор получаемых в запросе адресов с помощью списка контрагентов, достаточно применить фильтр к ссылке на справочник контрагенты, полученной из источника запроса справочника адреса как <code>Ref.Адреса.@Parent</code>.
* Каждый запрос оперирует ''переменными запроса''. Переменная запроса, это именованное указание на реквизит или объект, либо вычисляемое выражение, включающее другие переменные, функции и арифметические или логические операторы. Все заданные переменные по умолчанию возвращаются в результате выполнения запроса. Программа, получившая результат запроса, имеет доступ ко всем таким переменным. Если переменную не требуется возвращать в результате, для уменьшения таблицы запроса, ускорения получения ее с сервера и обработки локальной системой, можно использовать условие постобработки ''SkipVariables'' (см. ниже). Имена переменных должны быть уникальными в теле одного запроса и должны подчиняться обычным правилам задания имен переменным. Если группа запросов содержит более одного запроса, важно понимать, что при объединении этих запросов в один результат, система трактует переменные, имеющие одинаковые имена в разных запросах, как одну переменную в результате запроса, то есть в разных запросах переменные с одинаковыми именами должны указывать на данные одного вида. Задание переменной имеет вид: <code><Имя переменной>:=<Значение переменной>;</code>. При этом ''значение переменной'', может быть произвольной формулой или указанием на определенный реквизит или объект (полный путь, начинающийся с источника запроса). Используя пример предыдущего пункта, можно создать переменную ''зКонтрагент'': <code>зКонтрагент:=Ref.Адреса.@Parent;</code>.
* Кроме переменных, в запросе также могут содержаться ''условия запроса''. Условия являются логическими выражениями с использованием заданных ранее переменных запроса, констант, переменных внешней программы, функций, арифметических или логических операторов, и позволяют отобрать записи, попадающие в результат запроса. При отборе записей базы данных, каждое из условий выполняется для каждой из записей и, если все условия вычисляются как ''правда'', проверяемая запись попадает в результат запроса. Задание условия имеет вид: <code>Condition(<Выражение>);</code>. Используя пример предыдущих пунктов, можно задать условие, по которому в результат запроса войдут только адреса, контрагенты которых содержатся в списке ''спКонтрагенты'': <code>Condition(зКонтрагент IN спКонтрагенты);</code>.
* Запрос может выполняться с использованием агрегации получаемых данных или без оной. При наличии агрегации данные группируются по одной или нескольким группам и числовые переменные находятся в результате суммы отдельных полей записей, полученных из базы данных. Запрос, выполняемый таким образом, должен содержать операторы группировки ''Group'', ''HorGroup'' или ''VerGroup''. Операторов группировки может быть более одного, в этом случае, запрос будет последовательно группироваться по каждой из переменной, указанной в операторе группировки. Переменные также можно указывать через запятые. Общий вид оператора группировки выглядит сл. образом: <code><Оператор группировки> <Переменная группировки 1>[{+,-}][ with folders][,<Переменная группировки 2>...];</code>. После каждой переменной можно указать направление сортировки после выполнения группировки. По умолчанию будет использоваться сортировка по невозрастанию (''+''). Для переменных, указывающих на объекты справочников, имеющих папки, можно также указать суффикс ''with folders''. Этот суффикс будет обработан в момент постобработки таблицы запроса (см. ''этапы выполнения запроса базы данных'' ниже), в таблицу будут добавлены особые группировки по папкам справочника, на который указывала переменная запроса. Строки таблицы будут отсортированы таким образом, что элементы справочников будут следовать за папками справочников, в которые они входят в самом справочнике, тоже самое правило сортировки будет соблюдаться и для самих папок. Внутри же одной папки, элементы будут отсортированы в соответствии с указанным порядком сортировки. При подсчете переменных агрегации, строки с папками справочника будут вычислены на основе строк элементов, входящих в эти папки. Для аналогии с группировкой таблиц значений, см. статью [[Tab.Group|Group]].
** Обычный оператор группировки <code>Group</code> или <code>VerGroup</code> не добавляет записи в таблицу-результат запроса. Оператор горизонтальной группировки <code>HorGroup</code> используется для формирования отчетов с горизонтальными группировками. В процессе постобработки в таблицу запроса добавляются записи таким образом, чтобы для под каждой из верхних группировок, было одинаковое количество записей текущей горизонтальной группировки. Это достигается путем добавления недостающих записей в таблицу результата, таблица, полученная таким образом, может быть выведена в отчет по строкам и столбцам, используя для обхода обычный оператор [[Query.Next|Next]]. Все горизонтальные группировки должны следовать после обычных (вертикальных).
** Кроме операторов группировки может использоваться оператор сортировки <code>Sort <Переменная сортировки 1>[{+,-}][,<Переменная сортировки 2>...];</code>. Оператор осуществляет сортировку сгруппированных и отсортированных строк предыдущих группировок. Если после оператора сортировки следует оператор группировки, он должен использовать такой же путь или являться частью пути, который был использован для сортировки. К примеру, справочник ''Номенклатура'' имеет реквизит ''Тип'', являющийся ссылкой на справочник ''Типы номенклатуры''. При выполнении запроса необходимо группировать результат по элементам справочника номенклатура, однако, необходимо также отсортировать полученную номенклатуру по типу. Текст запроса будет выглядеть следующим образом: <code>зН:=Ref.Номенклатура;зТип:=Ref.Номенклатура.Тип;Sort зТип;Group зН;</code>. Так как группировка зН использует путь, являющийся частью пути сортировки зТип, такой запрос будет выполнен и результирующая таблица будет отсортирована сначала по реквизиту Тип элементов справочника Номенклатура, потом уже по самим элементам справочника. Для параллелей сортировки таблиц значений, см. статью [[Tab.Sort|Sort]].
** Если запрос не имеет операторов группировки, он называется простым запросом по элементам (документам) источника запроса, переменные такого запроса не должны содержать функций агрегации (см. ниже). Однако, признак агрегации запроса можно форсировать с помощью особого оператора <code>ForceAggregate;</code>, размещенного в теле запроса. В этом случае, запрос возвратит только одну строку, и использованные функции агрегации будут применены ко всем записям запроса.
** Переменные, использующиеся в запросе агрегации, чаще всего содержат функции агрегации (см. ниже), но даже если переменная не содержит функцию агрегации, она будет возвращена в результате выполнения запроса, однако, содержание такой переменной не будет определено (она может содержать любое из значений, поглощенных при агрегации), поэтому для переменных, которые будут использованы в программе, создавшей запрос, необходимо использовать функции агрегации.
* Если источником запроса служит накопитель, имеющий таблицу остатков (см. [[Объект базы данных]]), кроме обычных функций агрегации, можно использовать особые функции агрегации, для нахождения начального или конечного остатка активов накопителя (к примеру, <code>BegTotals</code>, <code>EndTotals</code>). При запросе к таким накопителям, в теле запроса также необходимо указать период выполнения запроса. Период задается в следующем виде: <code>Period from <Начальная дата> to <Конечная дата>;</code>. Где ''начальная дата'' и ''конечная дата'' -- константы или выражения для нахождения начальной и конечной даты запроса.
* ''Операция объединения запросов'' и ''Условие объединения запросов'' задают метод объединения двух последовательных запросов в один. По аналогии с объединением таблиц значений (см., к примеру, [[Tab.InnerJoin|Join]]). Условие запроса представляет собой произвольное логическое выражение, в котором можно использовать операции, функции локальный переменные программы и переменные обоих запросов. Условие обычно используется в виде <code><Переменная первого запроса>=<Переменная второго запроса></code>, при этом переменные указывают на одинаковый тип данных и часто являются ссылками на источник запроса. Пример см. ниже. Таблица результата после объединения включает переменные первого и второго запроса, если переменная имеет одинаковое имя и в первом и во втором запросе, в таблице результата она будет присутствовать как одна переменная, в зависимости от операции объединения, могут быть использованы значения как из первого, так и из второго запроса. Следующие операции доступны при объединении запросов:
** '''Inner Join''' или '''Join''': В таблицу результата будут входить только записи, для которых выполняется условие объединения.
** '''Left Join''' или '''Left Outer Join''': В таблицу результата будут входить все записи первого запроса, из второго запроса будут использованы значения переменных, отсутствовавших в первом запросе, если для записи выполняется условие объединения.
** '''Right Join''' или '''Right Outer Join''': В таблицу результата будут входить все записи второго запроса, из первого запроса будут использованы значения переменных, отсутствовавших во втором запросе, если для записи выполняется условие объединения.
** '''Full Join''' или '''Full Outer Join''': В таблицу результата будут входить все записи обоих запросов, для которых выполняется условие объединения. '''Внимание''': SQL сервера базы данных проверяют выполнение условия для каждой из пары записей двух запросов (т.е., выполнение условия для первой записи первого запроса проверяется на выполнение с каждой записью второй запроса, затем та же самая процедура выполняется для второй записи первого запроса и т.д. Для каждого выполнения условия добавляется новая запись в результат, таким образом записи могут иметь множество дублей, что в подавляющем большинстве случаев нежелательно), сервер будет пытаться добавить определенные выражения в условие объединения запроса, чтобы минимизировать эту проблему, однако, к такому типу объединения нужно подходить с осторожностью (рекомендовано использование операции ''Union All'' вместо ''Full Join'').
** '''Union All''': В таблицу будут входить все записи первого и второго запросов, конструкция ''условие объединения запросов'' не нужна, так как никаких проверок при объединении не производится. После выполнения постобработки запроса, результаты подобного вида чаще всего аналогичны выполнению ''Full Join'', так как при постобработке дублирующиеся записи будут помещены в одинаковые блоки нулевого уровня группировки (см. ниже), однако, операции агрегации будут давать суммы обоих записей, поэтому наименования переменных агрегации в обоих запросах должны быть разными. Пример см. ниже.
* Наименование запроса является необязательных элементом и служит для улучшения читабельности текста запроса, когда группа запросов содержит более одного запроса. Наименование не должно содержать знаков и пробелов. Вне запроса переменные из запроса могут использоваться только в формулах условий объединения запросов. Если переменные условия из обоих объединяемых запросов имеют одинаковые имена, системе необходимо каким-то образом отличать переменную одного запроса от другого, поэтому для переменных вне запроса к имени переменных всегда добавляется префиксы. Допускается использование следующих префиксов:
** '''#<Имя запроса>.<Наименование переменной>''' -- указание на переменную запроса с использованием наименования запроса.
** '''##Q<Порядковый номер запроса>.<Наименование переменной>''' -- указание на переменную запроса с использованием порядкового номера запроса. Данная конструкция может быть использована, если запросы не имеют наименования.
* ''Необязательные опции запроса'' -- общее название набора дополнительных опций запроса (к примеру, <code>ForceAggregate;</code> или <code>Limit <Количество возвращаемых записей>;</code>), которые могут использоваться в тексте запроса. Для полного списка доступных опций, см. [[Объект запрос базы данных#Список операторов и функций языка запроса|Список операторов и функций языка запроса]].

===Выражения и задание переменной в виде пути к реквизиту===
Переменные в запросе задаются в виде <code><Имя переменной>:=<Значение переменной>;</code>. Каждое наименование переменной должно быть уникальным внутри одного запроса. Дублирование наименований не допускается. Наименование не должно содержать пробелов и знаков пунктуации, но может содержать любые международные символы. Переменная может быть задана как полный путь к требуемому реквизиту, либо как выражение. Условия запроса всегда содержат только выражения. Для дополнительной информации по созданию выражений, см. статью [[Стандартные фильтры]]. Рассмотрим задание переменных в виде пути и использование выражений для переменных или условий:
* При задании переменной, как '''пути''' к требуемому реквизиту, необходимо придерживаться правила, что путь всегда должен начинаться с указания на источник запроса, все переменные должны быть адресуемыми посредством источника (см. описание выше). В случае задания переменной, как пути, синтаксис выглядит следующим образом: <code><Имя переменной>:=<Тип данных>.<Вид данных>[[.<Наименование строчной части>].<Наименование реквизита или особого реквизита>[(<Дата значения периодического реквизита>)][[..<Тип данных приведения типа>.<Вид данных приведения типа>].<Наименование реквизита или особого реквизита>...]]</code>. Рассмотрим некоторые части такого пути:
** ''Дата значения периодического реквизита'' -- выражение или константа, задающая дату реквизита. Данное выражение должно следовать за наименованием периодического реквизита. Пример: <code>зЦена:=Ref.Номенклатура.Цена(CurDate());</code>.
** ''Наименование строчной части'' -- используется для доступа к реквизитам строчной части объекта источника запроса. Пример: <code>зСумма:=Doc.Реализация.НоменклатураИЦены.Сумма;</code>.
** ''Доступ к реквизитам других объектов'' -- путь к данным может иметь неограниченную длину, если, к примеру, адресуемый в пути реквизит имеет тип объекта базы данных, можно продолжить путь, указав наименование реквизита этого объекта, для которого, в свою очередь путь может быть продолжен. При выполнении запроса, если адресуемый реквизит в объекте не определен (выбран), переменная получит пустой тип базы данных (''NULL''), который после окончания выполнения запроса будет преобразован в пустое значение.
** ''Выражения преобразования типа'' -- иногда при адресации различных реквизитов объектов встречается ситуация, когда реквизит может иметь несколько типов данных БД или вообще иметь произвольный тип базы данных. Получение дальнейших ссылок к реквизитам таких объектов невозможно без прямого указания типа и вида требуемого объекта (приведения или преобразования типа). Преобразование типа может также применяться к особым реквизитам (к примеру, ''@Parent'', когда объект может быть подчинен более чем одному справочнику-родителю). Как и с обычными реквизитами, в случаях, если реквизит объекта содержит ссылку на объект с типом, не совпадающим с указанным при преобразовании, значение переменной этого объекта будет пустым. Преобразование типов может быть записано в виде <code>... <Реквизит>..<Тип данных приведения типа>.<Вид данных приведения типа> ...</code>, либо <code>... <Реквизит> AS <Тип данных приведения типа>.<Вид данных приведения типа> ...</code>.
** Особые реквизиты объектов, которые можно использовать при создании пути переменной:
*** '''@ELEMENT''' или '''@HEADER''' -- реквизит, дающий ссылку на сам элемент или документ из реквизита строчной части документов или справочников.
*** '''@LINK''' -- реквизит, дающий ссылку на объект, поместивший запись в журнал, при запросе к объекту журналу (см. [[DB.LinkedObject|LinkedObject]]), либо объект, создавший запись в накопителе, при запросе к последнему.
*** '''@ISFOLDER''' -- Задает числовое значение, является ли текущий объект справочника папкой (''1'') или обычным элементом (''0''), также может использоваться для записей строчных частей справочников.
*** '''@FOLDER''' -- Задает ссылку на объект папки, в которой находится текущий объект справочника, также может использоваться для записей строчных частей справочников.
*** '''@PARENT''' -- Задает ссылку на объект родителя, которому подчинен текущий объект справочника.
*** '''@STATUS''' -- Задает числовое значение статуса текущего объекта. Для справочников и элементов журналов справочников это значение может быть ''0'' -- для обычного элемента, ''1'' -- для удаленного элемента. Для документов и элементов журналов документов это значение может быть ''0'' -- для обычного объекта, ''1'' -- для удаленного объекта, ''2''..''200'' -- для обработанного объекта с указанным индексом обработки (см. [[DB.PublishedMark|PublishedMark]]).
*** '''@LINE''', '''@LINEID''' -- Задает номер строки строчной части или номер записи в накопителе.
*** '''@EXPENSE''' -- Задает флаг расхода для накопителей, имеющих такой флаг.
*** '''@PARENTDOC''' -- Задает ссылку на таблицу документов, которым подчинен текущий документ.
*** '''@CHILDDOC''' -- Задает ссылку на таблицу документов, которые подчинены текущему документу.
*** '''@TRIGGER''' -- Задает значение триггера изменения для элементов справочников или документов, для которых такой триггер задан.
*** '''@DATE''' -- Задает дату записи для накопителей, записи которых датированы.
*** '''@SECOND''' -- Задает дату записи для накопителей, записи которых датированы. Время даты корректируется на начало секунды. Позволяет производить группировку движений накопителя в разрезе секунд. Внимание: большой период формирования может сильно замедлить формирование и вернуть очень большую таблицу результата.
*** '''@MINUTE''' -- Задает дату записи для накопителей, записи которых датированы. Время даты корректируется на начало минуты. Позволяет производить группировку движений накопителя в разрезе минут. Внимание: большой период формирования может сильно замедлить формирование и вернуть очень большую таблицу результата.
*** '''@HOUR''' -- Задает дату записи для накопителей, записи которых датированы. Время даты корректируется на начало часа. Позволяет производить группировку движений накопителя в разрезе часов. Внимание: большой период формирования может сильно замедлить формирование и вернуть очень большую таблицу результата.
*** '''@DAY''' -- Задает дату записи для накопителей, записи которых датированы. Время даты корректируется на начало дней. Позволяет производить группировку движений накопителя в разрезе дней.
*** '''@WEEK''' -- Задает дату записи для накопителей, записи которых датированы. Время даты корректируется на начало недель. Позволяет производить группировку движений накопителя в разрезе недель.
*** '''@MONTH''' -- Задает дату записи для накопителей, записи которых датированы. Время даты корректируется на начало месяцев. Позволяет производить группировку движений накопителя в разрезе месяцев.
*** '''@QUARTER''' -- Задает дату записи для накопителей, записи которых датированы. Время даты корректируется на начало кварталов. Позволяет производить группировку движений накопителя в разрезе кварталов.
*** '''@YEAR''' -- Задает дату записи для накопителей, записи которых датированы. Время даты корректируется на начало года. Позволяет производить группировку движений накопителя в разрезе лет.
* При задании переменной или условия запроса, как '''выражения''', можно использовать следующие части выражения (порядок их описания здесь соответствует порядку их поиска при компиляции выражений, поэтому, к примеру, функция ''Date'' означает внутреннюю функцию языка запросов, а не начало внешнего выражения языка):
** Скобки '''(''', ''')''';
** Особый оператор конкатенации строк '''||'''. Обычно для конкатенации строк используется оператор ''+'', однако, некоторые серверы базы данных (к примеру, SQLite) не поддерживают конкатенацию строк с помощью этого оператора, и при переводе выражений на язык используемого сервера баз данных, системе очень трудно определить тип операции -- математическое сложение или конкатенация строк. Поэтому, для того, чтобы запросы были совместимы со всеми серверами баз данных, рекомендуется использование оператора конкатенации ''||'' вместо оператора сложения ''+''.
** Математические операторы: '''+''', '''-''', '''/''', '''\''' ('''DIV''') -- целочисленное деление, '''*''', '''%''' ('''MOD''') -- остаток от деления, '''&''' -- математическое ''и'', '''|''' -- математическое ''или'', '''^''' -- математическая операция ''исключающее или'', '''~''' -- математическое обращение. К сожалению, использование ''And'' и ''Or'' как для логических выражений, так и для математических, которое практикуется внутри языка системы, не поддерживается многими серверами баз данных, и, при переводе выражений на язык сервера, система не сможет определить, какого рода оператор используется, поэтому для математических операций были введены дополнительные операторы ''&'', ''|'' (не используйте в начале строки!) и ''~''. Нужно также заметить, что, в отличие от операций с датами и временем в выражениях, используемых в языке системы, язык запросов не позволяет прибавлять числа к датам. Чтобы изменить дату на требуемое число дней, необходимо использовать функцию ''AddDay''.
** Логические операторы: '''<''', '''>''', '''=''', '''<=''', '''=>''', '''<>''', '''!''' ('''NOT''') -- логическое обращение, '''AND''', '''OR'''
** Особые логические операторы:
*** '''IN''' -- операция проверяет присутствие значения в списке, другом запросе или папке справочника. Операция записывается в виде <code><Имя переменной> IN <Таблица проверки></code>, где ''Таблица проверки'' может принимать значения:
**** переменная внешней программы со '''списком объектов''', '''объектом папки''' или '''элементом справочника''', для проверки вхождения проверяемого элемента в структуру объекта или структуру объектов списка;
**** переменная внешней программы, содержащая ссылку на '''[[Временная таблица базы данных|временную таблицу БД]]''' в виде <code><Переменная временной таблицы>.<Наименование столбца временной таблицы></code>, для проверки наличия записи во внешней таблице, значение указанного столбца которой совпадает с проверяемым объектом;
**** '''переменная подзапроса''' в виде <code><Наименование переменной подзапроса> From (<Подзапрос>)</code>, для проверки вхождения текущего объекта в результат выполнения подзапроса, подзапрос является обычным запросов языка запросов, который может использовать все его возможности, однако, в подзапросах не разрешено использование группировок.
*** '''NOT IN''' -- операция обратная операции ''IN''. См. выше.
** Внутренние функции языка запросов, транслируемые для исполнения на сервере (см. ниже в параграфе ''Список операторов и функций языка запроса''). Каждая из функций имеет свой синтаксис, в аргументах функции также могут использоваться '''выражения'''.
** Внутренние переменные запроса, в том числе переменные другого запроса группы запросов с указанием на номер запроса (см. выше), если выражение принадлежит условию объединения запросов.
** Свободное указание на путь к реквизиту, не описывавшийся ранее в какой-либо переменной.
** Внешние константы (к примеру, <code>_NEWLINE</code>) или переменные языка. Значение внешних переменных передается на сервер и используется как константа в запросе.
** Числовые, строковое или временные константы, записанные в тексте запроса. Запись констант осуществляется в соответствии с их записью в теле обычных программ языка (см. [[Общее описание языка#Константы в исходных текстах|Общее описание языка]]):
*** Числа записываются без ограничителей. Разделителем дробной части является десятичная точка. В математической записи чисел можно использовать признак экспоненты ('''E'''). Кроме десятичной нотации, можно использовать шестнадцатеричную (<code>$FFFF0000</code> или <code>0xFF00</code>), восьмеричную (<code>0o177400</code>) или двоичную (<code>0b1111111100000000</code>).
*** Строки отделяется кавычками: '''"'''.
*** Дата и время отделяется апострофами: '''<nowiki>'</nowiki>'''.
** Свободные выражения в формате внешней программы языка, которые будут исполнены, и результат их исполнения будет преобразован в константу при выполнении запроса. Выражения заканчиваются знаками ''')''', ''';''' или ''',''', могут содержать функции, их аргументы, математические выражения и пр..

===Примеры запросов и групп запросов===

Пример группы запросов, состоящей из двух запросов, позволяющих объединить все элементы справочника Номенклатура, отобранные по полю ''Тип'', с запросом по остаткам к накопителю ''Остатки'' на требуемую дату:
<pre>
(Name зНоменклатура;
зН:=Ref.Номенклатура;
зТип:=Ref.Номенклатура.Тип;
Condition(зТип=Enum.ТипыНоменклатуры.Товар);
Group зН;)
Left Join
(Name зОстатки;
Period From '01.01.2024' to '01.01.2024';
зН:=Stor.Остатки.Номенклатура;
зТип:=Stor.Остатки.Номенклатура.Тип;
зОстаток:=EndTotals(Количество);
Condition(зТип=Enum.ТипыНоменклатуры.Товар);
Group зН;) On (#зНоменклатура.зН=#зОстатки.зН)
</pre>

Пример группы запросов, состоящей из двух запросов, позволяющих получить в одном запросе значения ''остатков'' и ''резервов'' ''номенклатуры'', которые хранятся в разных накопителях на требуемую дату. В таблице результата запроса будут доступны три переменные ''зН'' -- ссылка на элементы справочника номенклатура, ''зОстаток'' -- сальдо остатка на указанную дату, ''зРезерв'' -- сальдо резерва на указанную дату.
<pre>
(Period From '01.01.2024' to '01.01.2024';
зН:=Stor.Остатки.Номенклатура;
зОстаток:=EndTotals(Количество);
Group зН;)
Union All
(Period From '01.01.2024' to '01.01.2024';
зН:=Stor.Резервы.Номенклатура;
зРезерв:=EndTotals(Количество);
Group зН;)
</pre>

Пример выполнения и обхода простого запроса, этапы выполнения которого не разделяются:
<pre>
//Находим сальдо по накопителю РезервыТМЦ на момент текущего документа, при этом
//aEl -- текущий документ
//aTab -- визуальная таблица, в которую будет выведен результат
КонДата:=aEl.DocDate;
ТЗ:="PeriodT From КонДата to КонДата;
|зД:=Storage.РезервыТМЦ.Договор;
|зН:=Storage.РезервыТМЦ.Номенклатура;
|зСк:=Storage.РезервыТМЦ.Склад;
|зКл:=EndTotals(Количество);
|зСм:=EndTotals(Сумма);
|Condition(зСк=aEl.Склад);
|Group зСк,зД,зН;";

З:=Query.Create();
З.Execute(ТЗ);

//Запрос выполнен, произведем обход результата по всем трем вложенным группировкам, используемым здесь для сортировки таблицы
aTab.ClearLines();
While З.Next(1) Do
While З.Next(2) Do
While З.Next(3) Do
If (З.зКл<>0)or(З.зСм<>0) Then
//Добавим в таблицу одну строку З.зКл и З.зСм -- переменные агрегации, остальные переменные являются переменными группировок
aTab.AddLine("Номенклатура,Договор,Склад,Количество,Сумма",З.зН,З.зД,З.зСк,З.зКл,З.зСм);
EndIf;
EndDo;
EndDo;
EndDo;
</pre>

Прошлый пример с добавлением нескольких условий и блока постобработки:
<pre>
КонДата:=aEl.DocDate;
ТЗ:="(PeriodT From КонДата to КонДата;
|зД:=Storage.РезервыТМЦ.Договор;
|зН:=Storage.РезервыТМЦ.Номенклатура;
|зТип:=Storage.РезервыТМЦ.Номенклатура.ТипНоменклатуры;
|Condition(зТип=0);
|зСк:=Storage.РезервыТМЦ.Склад;
|зАктив:=Storage.РезервыТМЦ.Склад.Активность;
|Condition(зАктив=0);
|зКл:=EndTotals(Количество);
|зСм:=EndTotals(Сумма);
|Condition(зСк=aEl.Склад);
|Group зСк,зД,зН;)
|Postprocessing (
|RemoveLev0Lines 1;
|SkipVariables зТип,зАктив;)";

З:=Query.Create();
З.Execute(ТЗ);
</pre>

Пример выполнения и обхода сложного запроса, этапы выполнения которого разделены и таблица изменяется перед постобработкой (см. ниже ''Этапы выполнения запроса базы данных''):
<pre>
//Пример заполняет визуальную таблицу MainTab документами списания и оприходования, строки которых пересчитаны по требуемым ценам.
//Пример может использоваться для вывода таблицы в табличный процессор с универсальными группировками, однако, здесь он используется
// с тремя группировками для упрощения понимания.
//Документ РегистрацияТМЦ может быть как списанием, так и оприходованием в зависимости от его реквизита КодОперации.
// Документ имеет срочную часть с именем Номенклатура к которой происходит обращение.
//При выводе в таблицу склады группируются по папкам справочника складов
//Группировка по номенклатуре используется для нахождения внутренних цен номенклатуры, но в таблицу не выводится
//зСм:=SUM(0) -- используется для простого указания на то, что зСм должна находиться методом агрегации, однако, начальное заполнение этой переменной не требуется
// Альтернативно можно было бы использовать опции постобработки.
//зКл будет положительным или отрицательным в зависимости от типа документа
// Doc.РегистрацияТМЦ.КодОперации не превращен в переменную и используется в формуле "на лету".
ТЗ:="зДата:=BegOfDay(Doc.РегистрацияТМЦ.DocDate);Condition((зДата>=НачДата)And(зДата<=КонДата));
|зСтатус:=Doc.РегистрацияТМЦ.@Status;Condition(зСтатус>1);
|зСк:=Doc.РегистрацияТМЦ.Склад;
|зДок:=Doc.РегистрацияТМЦ;
|зН:=Doc.РегистрацияТМЦ.Номенклатура.Номенклатура;
|зКл0:=Doc.РегистрацияТМЦ.Номенклатура.Количество;
|зСм:=SUM(0);
|зКл:=SUM(?(Doc.РегистрацияТМЦ.КодОперации=Enum.коРегистрацияТМЦ.СписаниеТМЦ,-зКл0,зКл0));
|Group зСк with folders,зДок,зН;";
З:=Query.Create();
//Выполнение останавливается после первого этапа
З.Execute(ТЗ,0);
//Заполним столбец зСм таблицы запроса расчетными значениями, зависящими от Номенклатуры, Склада и даты документа.
aTab:=З.ResultTable;
aTab.Select();
While aTab.Next() Do
//На данном этапе можно не только заполнять таблицу, но и удалять и добавлять в нее нужные строки
aTab.зСм:=ПолучитьНужнуюЦену(aTab.зН,aTab.зСк,aTab.зДата)*aTab.зКл;
EndDo;
//Выполним постобработку, которая автоматически создаст группировки, добавит папки складов и подсчитает переменные зСм и зКл.
З.Postprocess();

//Заполним таблицу MainTab
MainTab.ClearLines();
While З.Next(1) Do
While З.Next(2) Do
If not З.зСк.IsFolder() Then
aTab.AddLine("Документ,Склад,Сумма",З.зДок,З.зСк,З.зСм);
Else
//Для папок складов нет смысла выводить документ, а только общую сумму документов по папке
aTab.AddLine("Склад,Сумма",З.зСк,З.зСм);
EndIf;
EndDo;
EndDo;
</pre>

==Этапы выполнения запроса базы данных, постобработка запроса==
Обычно запрос выполняется в два больших этапа, которые могут быть разделены по времени, и любой из которых может отсутствовать. Каждый из этапов делится на более простые подэтапы. В общем случае, картина выполнения запроса выглядит следующим образом:
* Этап компиляции и выполнения запроса.
** Производится компиляция запроса на локальной машине, если при компиляции были выявлены ошибки, выполнение запроса будет остановлено. В процессе компиляции выполняются локальные функции и выражения, функции и выражения запроса переносятся в бинарный файл компиляции.
** Скомпилированный запрос передается на сервер
** Скомпилированный запрос превращается на сервере в запрос к базе данных и исполняется, если в процессе исполнения произошли ошибки, сервер возвращает ошибку клиенту, который создает соответствующее исключение.
** Результат запроса передается с сервера на клиент, где система создает локальную таблицу значения, содержащую результат запроса. Таблица на этом этапе не содержит группировок и называется ''необработанной таблицей запроса'' (см. ниже "Формат таблицы значений результата запроса"), программа имеет доступ к такой таблице и может изменять ее до начала второго этапа запроса.
* Этап постобработки запроса.
** Система производит загрузку объектов таблицы запроса с помощью функции [[MassLoadObjects]] по правилам, заданным в свойствах запроса и при вызове функции выполнения запроса.
** Производится сортировка таблицы запроса. Таблица, полученная с сервера, чаще всего уже отсортирована, однако, установки сортировки сервера могут отличаться от установок сортировки системы, кроме того, таблица могла быть изменена программой до начала этого этапа. Если запрос выполняется в линейном режиме (см. [[Query.Execute|Execute]]), этап постобработки будет завершен в этот момент.
** В таблице запроса создается столбец <code>@LEVEL</code>, после чего в таблицу добавляются строки группировки, для которых заполняется новый столбец уровня группировки, в строки также будут скопированы значения соответствующих столбцов группировки и заполнены столбцы, не вычисляемые с помощью функций агрегации.
** Если определенные группировки по элементам справочников имеют суффикс ''with folders'', в таблицу запроса будет добавлен еще один столбец <code>@FLEVEL</code>, для каждой из группировок будет произведен запрос на сервер для получения структуры папок этих справочников, после чего, в таблицу будут добавлены строки с папками справочника с учетом предыдущих группировок и типа этих группировок (горизонтальных или вертикальных).
** Система производит подсчет столбцов агрегации для добавленных строк с учетом столбцов уровня группировки (''@LEVEL'') и столбцов уровня вложения папок (''@FLEVEL''), столбцы с простыми функциями агрегации находятся путем сложения столбцов нижних группировок, для столбцов со сложными функциями агрегации система создает, компилирует и выполняет выражения, для нахождения результатов агрегации.
** Если установки запроса позволяют, система удаляет оригинальные строки запроса (с уровнем ''@LEVEL'' равным 0), для экономии памяти, так как новые строки содержат все необходимые данные.
* Программа может использовать результат запроса в режиме выборки ([[Query.Next|Next]]) и получать значения переменных запроса на каждом из его уровней. Программа также может использовать ''обработанную таблицу запроса'' напрямую.

===Замечания по оптимизации выполнения запроса===
Полная загрузка всех объектов в таблицу запроса может происходить достаточно долго, большое количество объектов использует много памяти, может даже получиться ситуация, когда для выполнения запроса программе не хватает памяти. Выполнение запроса можно оптимизировать. Ниже даны обычные способы оптимизации запросов:
* Для запросов, не использующих данные оригинальных строк запроса, -- самой нижней группировки запроса, можно использовать функцию постобработки <code>RemoveLev0Lines</code> для удаления этих строк после окончания выполнения запроса, что освобождает некоторое количество памяти после выполнения запроса.
* Если запрос оперирует большим числом объектов, можно производить загрузку объектов в режиме только заголовков (см. [[Query.Execute|Execute]]). В запросе с полной постобработкой невозможно оставить объекты в столбцах группировки полностью незагруженными, так как в момент сортировки таблицы запроса для таких объектов необходимо присутствие реквизитов по которым происходит сортировка. Нужно также иметь в виду при обходе таблицы запроса с помощью функции [[Query.Next|Next]], что объекты из таблицы необходимо получать копированием (<code><Запрос>.<Имя переменной>.Copy()</code>), либо использовать [[Сборщик объектов]], иначе эти объекты будут полностью загружены из базы данных в процессе выполнения обработки и останутся в памяти до удаления запроса (так как они будут присутствовать в таблице запроса), что нивелирует попытку оптимизации.
* После выполнения первого этапа запроса, можно осуществить загрузку только тех объектов, которые участвуют в группировке и требуются при обработке запроса, остальные столбцы можно удалить, либо использовать функцию постобработки <code>SkipVariables</code> для того, чтобы пропустить создание определенных столбцов в таблице результата. Если же какие-то столбцы по-прежнему требуются в таблице запроса, однако, их загрузка не имеет смысла, можно использовать функцию постобработки <code>DoNotMassLoadBeforeAggregation</code>, чтобы в момент выполнения второго этапа исключить загрузку объектов (нужно помнить, однако, что объекты в столбцах сортировки должны быть уже загружены в полном или частичном режимах, иначе в момент сортировки каждый из объектов будет загружаться при его добавлении в сортированную таблицу, что замедлит выполнение сортировки).
* Если нет необходимости в использовании горизонтальных группировок или группировок по папкам справочником, а также, если столбцы агрегации не содержат сложных функций агрегации, можно выполнить запрос в линейном режиме. Это позволит остановить второй этап выполнения запроса на моменте сортировки таблицы, после чего результат запроса можно обходить с помощью функции [[Query.Next|Next]] и получить значения переменных, в том числе переменных агрегации (для последних применяются особые функции запроса [[Query.Compute|Compute]], [[Query.BegTotals|BegTotals]] и [[Query.EndTotals|EndTotals]]). Так как в таблицу запроса не будут добавлены дополнительные строки группировки, ее размер может существенно уменьшиться (особенно для запросов с большим количеством группировок), однако, системе придется вычислять значения агрегации "на лету", что может замедлить вывод результата запроса на экран, кроме того функция [[Query.Next|Next]] будет работать медленнее.
* Если при выводе результата запроса на экран будут применяться дополнительные условия, отбирающие отдельные записи запроса, эти условия можно выполнить после окончания первого этапа выполнения запроса, до начала выполнения второго этапа, при этом ненужные строки можно удалять непосредственно из необработанной таблицы запроса. Уменьшение размера таблицы запроса уменьшит количество загружаемых объектов, что уменьшит потребность в памяти.
* Если результат запроса выгружается во внешний источник в виде линейной таблицы, нет необходимости в выполнении второго этапа запроса вообще. Программа может использовать необработанную таблицу запроса, получая из нее данные по своему усмотрению, однако, не нужно забывать, что для экономии памяти, объекты из таблицы нужно получать с помощью копирования (см. выше) или с использованием [[Сборщик объектов|сборщика объектов]].
* Если, даже после всех оптимизаций, запрос получается настолько большим, что не вмещается в память, можно рассмотреть либо вариант работы с запросом в среде 64-битного клиента на машине с увеличенным объемом памяти, либо использование [[Временная таблица базы данных|временных таблиц базы данных]], которые перекладывают бремя хранения данных запроса на сервер базы данных.

===Формат таблицы значений результата запроса===
Доступ к таблице результата запроса можно получить с помощью атрибута объекта запроса [[Query.ResultTable|ResultTable]]. Таблица запроса будет содержать следующие столбцы:
* '''<Наименование переменной>''' -- столбец, наименование которого совпадает с наименованием переменных запроса, в таких столбцах хранятся значения (в т.ч. значения агрегации) соответствующих переменных запроса.
* '''@LEVEL''' -- столбец, добавляемый на втором этапе выполнения запроса (который, однако, программа может добавить сама в конце первого этапа выполнения). Столбец содержит значение уровня группировки строки таблицы запроса. При этом, для оригинальных строк запроса, значение это столбца равно нулю, для строк запроса, являющихся записями первой, самой нижней группировки запроса, значение равно 1, последующие значения столбца для верхних группировок будут увеличиваться. Строки с верхними группировками запроса следуют до строк с низкими (вложенными) группировками. В обработанной таблице запроса первой строкой следует первая запись самой верхней ''n''-ной группировки запроса (где ''n'' -- количество группировок запроса), за ней следует запись более низкой ''n-1''-ой группировки запроса, и т.д. до оригинальной записи запроса с уровнем 0 (таких записей может быть более одной). Далее вся структура записей повторяется начиная с определенных уровней в зависимости от данных таблицы запроса. Строки, для которых значение в столбце ''@LEVEL'' равно '''-1''', будут пропущены при обработке запроса на втором этапе, таким образом можно исключить строки из запроса, не удаляя их. '''Внимание:''' индексы группировки в этом столбце противоположны индексам, использующимся в функциях [[Query.First|First]], [[Query.Last|Last]], [[Query.Next|Next]] и [[Query.Prev|Prev]]!
* '''@FLEVEL''' -- столбец, добавляемый на втором этапе выполнения запроса, для запросов имеющих столбцы с группировкой по папкам справочников. Столбец содержит уровни вложения папок для строки с текущей группировкой (столбец ''@LEVEL''). Для оригинальных элементов группировки значение этого столбца будет равным нулю или пустым значением, для папок самого верхнего уровня значение этого столбца будет равным '''1''', для вложенных папок второго уровня, значение этого столбца будет равным '''2''' и т.д. Нужно понимать, что значения столбца уровня группировки папок имеют значение только для строк таблицу с соответствующей группировкой, вне этих строк значение столбца не определено или соответствует значениям уровня папок других группировок, если они тоже группируются по своей структуре папок.

==Список операторов и функций языка запроса==
{|class="wikitable sortable" style="border-collapse:collapse;font-size:80%;width=95%;"
! width=10%|Тип оператора или функции
! width=10%|Идентификатор
! width=10%|Применимость
! width=20%|Вид
! Описание
|-
|-align="left"
|Опции запроса
|'''Name'''
|Тело запроса
|<code>Name <Имя запроса>;</code>
|Задает наименование запроса
|-align="left"
|Опции запроса
|'''Period'''
|Тело запроса
|<code>Period From <Начальная дата> to <Конечная дата>;</code>
|Задает период нахождения остатков накопителей с точностью до дня (период находится в диапазоне >= BegOfDay(''Начальная дата''),< BegOfDay(''Конечная дата'')+1)
|-align="left"
|Опции запроса
|'''PeriodT'''
|Тело запроса
|<code>PeriodT From <Начальная дата> to <Конечная дата>;</code>
|Задает период нахождения остатков накопителей с точностью до миллисекунды (период находится в диапазоне >= ''Начальная дата'',< ''Конечная дата'')
|-align="left"
|Опции запроса
|'''Limit''', '''Top'''
|Тело запроса
|<code>Limit <Количество записей>;</code>
|Ограничивает результат запроса указанным количеством записей. По умолчанию ограничение отсутствует.
|-align="left"
|Опции запроса
|'''ForceAggregate'''
|Тело запроса
|<code>ForceAggregate;</code>
|Форсирует использование режима агрегации для запроса без группировок. В этом режиме такой запрос вернет не более одной записи.
|-align="left"
|Директивы запроса
|'''<Назначение переменной>'''
|Тело запроса
|<code><Имя переменной>:=<Путь или выражение>;</code>
|Создает именованную переменную, которую можно использовать в условиях и назначении других переменных запроса. Переменная будет возвращена, как столбец в таблице результата запроса.
|-align="left"
|Директивы запроса
|'''Condition''', '''Where'''
|Тело запроса
|<code>Condition <Условие>;</code>
|Задает условие для отбора записей запроса.
|-align="left"
|Директивы запроса
|'''Sort'''
|Тело запроса
|<code>Sort <Переменная>[{+,-}][,<Переменная 2>[{+,-}]...];</code>
|Задает директиву сортировки записей запроса. Может использоваться совместно и вперемешку с директивами ''Group'', ''HorGroup'', ''VerGroup''.
|-align="left"
|Директивы запроса
|'''Group''', '''VerGroup'''
|Тело запроса
|<code>Group <Переменная>[{+,-}][ With Folders][,<Переменная 2>[{+,-}][ With Folders]...];</code>
|Задает директиву вертикальной группировки записей запроса. Может использоваться совместно и вперемешку с директивами ''Sort'', ''HorGroup''.
|-align="left"
|Директивы запроса
|'''HorGroup'''
|Тело запроса
|<code>HorGroup <Переменная>[{+,-}][ With Folders][,<Переменная 2>[{+,-}][ With Folders]...];</code>
|Задает директиву горизонтальной группировки записей запроса. Может использоваться совместно и вперемешку с директивой ''Sort'', и следовать за директивами ''Group'', ''VerGroup''.
|-align="left"
|Операции объединения запросов
|'''Union All'''
|Между запросами в группе запросов
|<code>(<Запрос 1>) Union All (<Запрос 2>)</code>
|Задает операцию объединения записей двух запросов без дополнительных условий
|-align="left"
|Операции объединения запросов
|'''Inner Join''', '''Join'''
|Между запросами в группе запросов
|<code>(<Запрос 1>) Join (<Запрос 2>) On (<Условие объединения запросов>)</code>
|Задает операцию объединения записей двух запросов с помощью конъюнкции по условию
|-align="left"
|Операции объединения запросов
|'''Full Join''', '''Full Outer Join'''
|Между запросами в группе запросов
|<code>(<Запрос 1>) Full Join (<Запрос 2>) On (<Условие объединения запросов>)</code>
|Задает операцию объединения записей двух запросов с помощью дизъюнкции по условию
|-align="left"
|Операции объединения запросов
|'''Left Join''', '''Left Outer Join'''
|Между запросами в группе запросов
|<code>(<Запрос 1>) Left Join (<Запрос 2>) On (<Условие объединения запросов>)</code>
|Задает операцию дополнения записей первого запроса переменными из второго запроса, идентификация записей происходит по условию
|-align="left"
|Операции объединения запросов
|'''Right Join''', '''Right Outer Join'''
|Между запросами в группе запросов
|<code>(<Запрос 1>) Right Join (<Запрос 2>) On (<Условие объединения запросов>)</code>
|Задает операцию дополнения записей второго запроса переменными из первого запроса, идентификация записей происходит по условию
|-align="left"
|Директивы группы запросов
|'''Postprocessing'''
|Между запросами в группе запросов
|<code>Postprocessing (<Тело текста постобработки>)</code>
|Задает директиву начала текста постобработки
|-align="left"
|Опции постобработки
|'''Sort'''
|В теле текста постобработки
|<code>Sort <Переменная>[{+,-}][,<Переменная 2>[{+,-}]...];</code>
|Задает директиву сортировки записей результата запроса во время выполнения постобработки. Может использоваться совместно и вперемешку с директивами ''Group'', ''HorGroup'', ''VerGroup''. Использование по крайней мере одной из директив сортировки или группировки в теле текста постобработки полностью игнорирует директивы сортировки или группировки из текстов запросов в момент выполнения постобработки и использует директивы из этого текста.
|-align="left"
|Опции постобработки
|'''Group''', '''VerGroup'''
|В теле текста постобработки
|<code>Group <Переменная>[{+,-}][ With Folders][,<Переменная 2>[{+,-}][ With Folders]...];</code>
|Задает директиву вертикальной группировки записей запроса во время выполнения постобработки. Может использоваться совместно и вперемешку с директивами ''Sort'', ''HorGroup''. Использование по крайней мере одной из директив сортировки или группировки в теле текста постобработки полностью игнорирует директивы сортировки или группировки из текстов запросов в момент выполнения постобработки и использует директивы из этого текста.
|-align="left"
|Опции постобработки
|'''HorGroup'''
|В теле текста постобработки
|<code>HorGroup <Переменная>[{+,-}][ With Folders][,<Переменная 2>[{+,-}][ With Folders]...];</code>
|Задает директиву горизонтальной группировки записей запроса во время выполнения постобработки. Может использоваться совместно и вперемешку с директивой ''Sort'', и следовать за директивами ''Group'', ''VerGroup''. Использование по крайней мере одной из директив сортировки или группировки в теле текста постобработки полностью игнорирует директивы сортировки или группировки из текстов запросов в момент выполнения постобработки и использует директивы из этого текста.
|-align="left"
|Опции постобработки
|'''No Grouping'''
|В теле текста постобработки
|<code>No Grouping;</code>
|Задает директиву запрета выполнения группировки на этапе постобработки. Таблица запроса, после ее получения с сервера, будет представлена как результат выполнения линейного запроса по элементам без агрегации
|-align="left"
|Опции постобработки
|'''Aggregate'''
|В теле текста постобработки
|<code>Aggregate <Имя переменной> As <Выражение>;</code>
|Задает способ агрегации переменной на этапе выполнения постобработки. По умолчанию формула агрегации переменных берутся из тела запроса, однако, это поведение можно изменить. Заданные формулы будут использоваться для агрегации переменных для любых уровней группировки запроса. Выражение имеют некоторые ограничения по сравнения с выражениями запросов, а именно:
* Невозможно использование свободного пути к реквизиту (на этапе постобработки система работает только с данными таблицы результата)
* Функции агрегации ''BegTotals'', ''EndTotals'', ''Income'', ''Expense'' эмулируют поведение соответствующих функций на сервере, но в отличие от серверных функций могут использовать обычные выражения, как свои аргументы, и не могут использовать наименование актива. В этом режиме функции отличаются от функции суммы только при наличии группировок по времени (день, неделя, месяц, год).
* Некоторые функции могут выполняться несколько иначе (функции сервера базы данных могут немного отличаться по действию от функций локальной системы)
* Возможно использование внешних функций программы не только для нахождения констант, но и как элементов выражений.
|-align="left"
|Опции постобработки
|'''Aggregate1'''
|В теле текста постобработки
|<code>Aggregate1 <Имя переменной> As <Выражение>;</code>
|Задает способ агрегации переменной на этапе выполнения постобработки. По умолчанию формула агрегации переменных берутся из тела запроса, однако, это поведение можно изменить. Заданные формулы будут использоваться для агрегации переменных только для нижнего (первого) уровня группировки запроса, для уровней выше первого будут использованы формулы из тела запроса или указанные в директиве постобработки ''Aggregate''. См. также директиву ''Aggregate'' для описания ограничений выражения.
|-align="left"
|Опции постобработки
|'''No Aggregation'''
|В теле текста постобработки
|<code>No Aggregation For <Имя переменной>;</code>
|Запрещает выполнение агрегации для указанной переменной. Переменные будут трактоваться, как переменные без агрегации, и их значение будет копироваться на все уровни группировки запроса без выполнения формул агрегации.
|-align="left"
|Опции постобработки
|'''ForceAggregateSingleLineLev1'''
|В теле текста постобработки
|<code>ForceAggregateSingleLineLev1 <1 или 0>;</code> (по умолчанию '''0''')
|Форсирует выполнения формул агрегации для нахождения значения переменной для первого уровня группировки. По умолчанию система будет осуществлять более быструю операцию копирования значений без выполнения формулы агрегации в случае, когда агрегация выполняется простой функцией сложения и когда на нулевом уровне группировки содержится всего одна строка, соответствующая текущему первому уровню группировки.
|-align="left"
|Опции постобработки
|'''ForceAggregateSingleLine'''
|В теле текста постобработки
|<code>ForceAggregateSingleLine <1 или 0>;</code> (по умолчанию '''0''')
|Форсирует выполнения формул агрегации для нахождения значения переменной для любого уровня группировки. По умолчанию система будет осуществлять более быструю операцию копирования значений без выполнения формулы агрегации в случае, когда агрегация выполняется простой функцией сложения и когда на предыдущем уровне группировки содержится всего одна строка, соответствующая текущему уровню группировки.
|-align="left"
|Опции постобработки
|'''DoNotAggregate'''
|В теле текста постобработки
|<code>DoNotAggregate <1 или 0>;</code> (по умолчанию '''0''')
|Опция запрещает выполнение агрегации для всех переменных запроса. Все переменные будут трактоваться, как переменные без агрегации, и их значения будут копироваться на все уровни группировки запроса без выполнения формул агрегации.
|-align="left"
|Опции постобработки
|'''DoNotMassLoadBeforeAggregation'''
|В теле текста постобработки
|<code>DoNotMassLoadBeforeAggregation <1 или 0>;</code> (по умолчанию '''0''')
|Опция запрещает выполнение функции [[MassLoadObjects]] до начала сортировки в момент выполнения этапа постобработки. Программа должна самостоятельно выполнить функцию ''MassLoadObjects'' для требуемых столбцов таблицы в требуемом режиме до вызова второго этапа запроса, иначе сортировка таблицы запроса будет выполняться медленнее.
|-align="left"
|Опции постобработки
|'''RemoveLev0Lines'''
|В теле текста постобработки
|<code>RemoveLev0Lines <1 или 0>;</code> (по умолчанию '''0''')
|Опция удаляет оригинальные записи запроса после выполнения постобработки. Данные записи уже не имеют значения, если обработка результата запроса осуществляется стандартными средствами запроса (''Next'' и пр.). Опция не работает для линейных запросов. Опция может освободить некоторое количество памяти для запросов с большими таблицами результатов, также она полезна для групп запросов, состоящих из более чем одного запроса.
|-align="left"
|Опции постобработки
|'''AllowIncompatibleSortPaths'''
|Тело запроса, тело текста постобработки
|<code>AllowIncompatibleSortPaths <1 или 0>;</code> (по умолчанию '''0''')
|Опция отключает проверку совместимости путей сортировки и группировки в процессе постобработки. Функция может использоваться, если переменные заполняются программно до этапа постобработки, и они совместимы с последующими переменными группировки, но программа не может знать об этом. Опция должна следовать до директив сортировки или группировки. Для примера, см. статью [[Query.AllowIncompatibleSortPaths|AllowIncompatibleSortPaths]].
|-align="left"
|Опции постобработки
|'''SkipVariables'''
|В теле текста постобработки
|<code>SkipVariables <Переменная 1>[, <Переменная 2>...];</code>
|Опция позволяет исключить ненужные переменные из таблицы результата запроса, что экономит память.
|-align="left"
|Опции постобработки
|'''Copy''', '''CopyTo'''
|В теле текста постобработки
|<code>Copy <Переменная с временной таблицей базы данных>[:<Переменная 1>, <Переменная 2> ...];</code>
|Опция позволяет не возвращать результат запроса в виде таблицы результата, а копировать его записи в указанную временную таблицу базы данных. Так как временные таблицы базы данных хранятся в базе данных, такой подход позволит выполнять запросы, не помещающиеся в память в обычном режиме. Копируемые переменные запроса должны иметь имена, совпадающие с именами временной таблицы. Если не указывать список переменных, будут скопированы все переменные, для которых в таблице присутствуют соответствующие имена.
|-align="left"
|Опции постобработки
|'''ExactSumVariables''' {{Planned}}
|В теле текста постобработки
|<code>ExactSumVariables <Имя переменной>:<Количество знаков>[,<Имя переменной 2>:<Количество знаков>...];</code>
|Опция позволяет использовать точное сложение для функции сложения при агрегации указанных переменных. См. статью [[Tab.Sum|Sum]] для дополнительного описания.
|-align="left"
|Функции языка запросов
|'''?''', '''_If'''
|В выражениях
|<code>?(<Выражение-условие>,<Выражение-результат функции, если условие выполняется>,<Выражение-результат функции, если условие не выполняется>)</code>
|Функция возвращает результат выражения, заданного во втором аргументе, если логическое выражение, заданное в первом аргументе возвращает правду, иначе функция возвращает результат выражения, заданного во третьем аргументе
|-align="left"
|Функции языка запросов
|'''_Case'''
|В выражениях
|<code>_Case(<Выражение>,<Значение 1>,<Выражение-результат 1>[,<Значение 2>,<Выражение-результат 2>...])</code>
|Функция возвращает результат выражения, заданного третьим аргументом, если результат вычисления первого выражения равен результату вычисления выражения, заданного вторым аргументом, иначе проверка соответствия результата первого вычисления выражения происходит последовательно для четвертого, шестого и т.п. аргументов, если они заданы и функция возврати соответствующее значение выражения-результата. Если ни одно из условий не выполняется, функция возвращает NULL (пустое значение сервера базы данных).
|-align="left"
|Функции языка запросов
|'''CASE'''
|В выражениях
|<code>CASE <Выражение> WHEN <Значение 1> THEN <Выражение-результат 1> [WHEN <Значение 2> THEN <Выражение-результат 2>][ELSE <Выражение-результат по умолчанию>] END</code>
|Функция является альтернативной записью функции ''_Case'', включающей также выражение по умолчанию, возвращаемое вместо NULL, когда ни одного из условий функции не выполнено.
|-align="left"
|Функции агрегации языка запросов
|'''Sum'''
|В выражениях
|<code>Sum(<Выражение>)</code>
|Функция агрегации, находящая сумму выражений каждой из записей базы данных, поглощенных в результат агрегации
|-align="left"
|Функции агрегации языка запросов
|'''Min'''
|В выражениях
|<code>Min(<Выражение>)</code>
|Функция агрегации, находящая минимальное из всех значений выражения для каждой из записей базы данных, поглощенных в результат агрегации. Результатом выражения могут быть не только числовые значения.
|-align="left"
|Функции агрегации языка запросов
|'''Max'''
|В выражениях
|<code>Max(<Выражение>)</code>
|Функция агрегации, находящая максимальное из всех значений выражения для каждой из записей базы данных, поглощенных в результат агрегации. Результатом выражения могут быть не только числовые значения.
|-align="left"
|Функции агрегации языка запросов
|'''Avg'''
|В выражениях
|<code>Avg(<Выражение>)</code>
|Функция агрегации, находящая среднее из всех значений выражения для каждой из записей базы данных, поглощенных в результат агрегации
|-align="left"
|Функции агрегации языка запросов
|'''Count'''
|В выражениях
|<code>Count()</code>
|Функция агрегации, количество записей базы данных, поглощенных в результат агрегации
|-align="left"
|Функции агрегации языка запросов
|'''BegTotals'''
|В выражениях
|<code>BegTotals(<Наименование актива накопителя>[,<Дата нахождения сальдо>])</code>
|Функция агрегации, позволяющая найти начальное сальдо актива накопителя на начальную дату запроса, либо дату, указанную вторым аргументом. Сальдо находит с точностью до дня даты.
|-align="left"
|Функции агрегации языка запросов
|'''BegTotalsT'''
|В выражениях
|<code>BegTotalsT(<Наименование актива накопителя>[,<Дата нахождения сальдо>])</code>
|Функция агрегации, позволяющая найти начальное сальдо актива накопителя на начальную дату запроса, либо дату, указанную вторым аргументом. Сальдо находит с точностью до секунды даты.
|-align="left"
|Функции агрегации языка запросов
|'''EndTotals'''
|В выражениях
|<code>EndTotals(<Наименование актива накопителя>[,<Дата нахождения сальдо>])</code>
|Функция агрегации, позволяющая найти конечное сальдо актива накопителя на конечную дату запроса, либо дату, указанную вторым аргументом. Сальдо находит с точностью до дня даты (включает весь день даты).
|-align="left"
|Функции агрегации языка запросов
|'''EndTotalsT'''
|В выражениях
|<code>EndTotalsT(<Наименование актива накопителя>[,<Дата нахождения сальдо>])</code>
|Функция агрегации, позволяющая найти конечное сальдо актива накопителя на конечную дату запроса, либо дату, указанную вторым аргументом. Сальдо находит с точностью до секунды даты (включает все записи до и включая указанную секунду даты).
|-align="left"
|Функции агрегации языка запросов
|'''Debit''', '''Expense'''
|В выражениях
|<code>Expense(<Наименование актива накопителя>)</code>
|Функция агрегации, позволяющая найти расход актива накопителя за период запроса с точностью до дня периода (конец период включает весь день конечной даты). Для накопителей, имеющих признак записей "приход" или "расход", данная функция будет находить только сумму записей с признаком "расход", для остальных накопителей, функция будет находить сумму записей со значением актива меньше нуля.
|-align="left"
|Функции агрегации языка запросов
|'''Credit''', '''Income'''
|В выражениях
|<code>Income(<Наименование актива накопителя>)</code>
|Функция агрегации, позволяющая найти приход актива накопителя за период запроса с точностью до дня периода (конец период включает весь день конечной даты). Для накопителей, имеющих признак записей "приход" или "расход", данная функция будет находить только сумму записей с признаком "приход", для остальных накопителей, функция будет находить сумму записей со значением актива больше нуля.
|-align="left"
|Функции языка запросов
|'''FilterProperty'''
|В выражениях
|<code>FilterProperty(<Выражение>,<Тип базы данных для проверки>)</code>
|Функция возвращает значение выражения, указанного в первом аргументе, если это значение является объектом с типом, заданным вторым аргументом, иначе функция возвращает NULL (пустое значение). Пример: <code>FilterProperty(Ref.Номенклатура.СкладИлиАвтомашина,Ref.Склады)<code>.
|-align="left"
|Функции языка запросов
|'''CaseGetProperty'''
|В выражениях
|<code>CaseGetProperty(<Выражение>,<Тип базы данных для проверки>,<Путь к реквизиту>[,<Тип базы данных для проверки 2>,<Путь к реквизиту 2>...])</code>
|Функция возвращает значение реквизита, указанного с помощью пути в третьем аргументе, это значение выражения первого аргумента является объектом с типом, заданным вторым аргументом, иначе функция сравнивает тип выражения первого аргумента с типом 4-го аргумента, и возвращает значение реквизита, заданного пятым аргументом и т.д. Если ни одно из условий не выполняется, функция возвращает NULL (пустое значение).
|-align="left"
|Функции языка запросов
|'''Coalesce'''
|В выражениях
|<code>Coalesce(<Выражение 1>[,<Выражение 2>...])</code>
|Функция первое из непустых (NULL) аргументов. Может применяться, к примеру, после объединений запросов (особенно для объединений типа ''Full Join'')
|-align="left"
|Функции языка запросов
|'''IsNULL'''
|В выражениях
|<code>IsNULL(<Выражение>)</code>
|Функция возвращает правду, если выражение является пустым значением (NULL), иначе функция возвращает ложь. Может применяться, к примеру, после объединений запросов (особенно для объединений типа ''Full Join'')
|-align="left"
|Функции языка запросов
|'''IsEmpty'''
|В выражениях
|<code>IsEmpty(<Выражение>)</code>
|Функция возвращает правду, если выражение является пустым объектом базы данных, иначе функция возвращает ложь. ''Внимание'': функция работает только с объектами, она будет неверно работать со строками, числами или датами (в отличие от функции системы [[IsEmpty]])
|-align="left"
|Функции языка запросов
|'''IsType'''
|В выражениях
|<code>IsType(<Выражение>,<Тип БД 1>[,<Тип БД 2>...])</code>
|Функция возвращает правду, если выражение является объектом с типом, заданным любым из последующих аргументов, иначе функция возвращает ложь. Пример: <code>IsType(зПеременная,Ref.Номенклатура,Ref.ОсновныеСредства)</code>. Кроме полного типа и вида данных, разрешается также задавать только тип данных. Пример: <code>IsType(зПеременная,Ref)</code>.
|-align="left"
|Функции языка запросов
|'''Str'''
|В выражениях
|<code>Str(<Выражение>)</code>
|Функция превращает значение выражения в строку
|-align="left"
|Функции языка запросов
|'''Length'''
|В выражениях
|<code>Length(<Выражение>)</code>
|Функция возвращает длину строки выражения
|-align="left"
|Функции языка запросов
|'''Left'''
|В выражениях
|<code>Left(<Выражение>,<Выражение, число символов>)</code>
|Функция возвращает левую подстроку с указанным числом символов из исходной строки
|-align="left"
|Функции языка запросов
|'''Right'''
|В выражениях
|<code>Right(<Выражение>,<Выражение, число символов>)</code>
|Функция возвращает правую подстроку с указанным числом символов из исходной строки
|-align="left"
|Функции языка запросов
|'''Mid'''
|В выражениях
|<code>Mid(<Выражение>,<Выражение, начальный символ>[,<Выражение, число символов>])</code>
|Функция возвращает подстроку с указанным начальным символом и длиной, если длина не указана, функция возвращает подстроку с начальным символом и до конца строки
|-align="left"
|Функции языка запросов
|'''Pos'''
|В выражениях
|<code>Pos(<Выражение, подстрока>,<Выражение, строка поиска>[,<Выражение, начинать поиск с символа>])</code>
|Функция возвращает позицию найденной подстроки в указанной строке (если требуется, поиск будет происходить начиная с указанного символа), либо 0, если подстрока не найдена. Даже при наличии третьего аргумента, будет возвращена позиция в оригинальной строке поиска (с учетом числа пропущенных с начала строки символов).
|-align="left"
|Функции языка запросов
|'''UpperCase'''
|В выражениях
|<code>UpperCase(<Выражение>)</code>
|Функция возвращает строковое выражение, переведенное в верхний регистр
|-align="left"
|Функции языка запросов
|'''LowerCase'''
|В выражениях
|<code>LowerCase(<Выражение>)</code>
|Функция возвращает строковое выражение, переведенное в нижний регистр
|-align="left"
|Функции языка запросов
|'''Asc'''
|В выражениях
|<code>Asc(<Выражение>)</code>
|Функция возвращает код первого символа строкового выражения
|-align="left"
|Функции языка запросов
|'''Chr'''
|В выражениях
|<code>Chr(<Выражение>)</code>
|Функция возвращает символ с кодом, заданным аргументом
|-align="left"
|Функции языка запросов
|'''Replace'''
|В выражениях
|<code>Replace(<Выражение, строка поиска>,<Выражение, подстрока>,<Выражение, строка замены>)</code>
|Функция возвращает строку, заданную первым аргументом, в которой все вхождения подстроки, заданной вторым аргументом, заменены на подстроку, заданную третьим аргументом
|-align="left"
|Функции языка запросов
|'''RepeatStr'''
|В выражениях
|<code>RepeatStr(<Выражение, подстрока>,<Выражение, количество повторов>)</code>
|Функция возвращает строку созданную из подстроки, заданной первым аргументом, повторенной количество раз, заданное вторым аргументом
|-align="left"
|Функции языка запросов
|'''Reverse'''
|В выражениях
|<code>Reverse(<Выражение>)</code>
|Функция возвращает строку, обращенную посимвольно из строки, заданной в первом аргументе
|-align="left"
|Функции языка запросов
|'''TrimL'''
|В выражениях
|<code>TrimL(<Выражение>)</code>
|Функция возвращает строку, полученную из первого аргумента путем удаления пробелов с начала строки (в отличие от функции языка [[TrimL]], функция запроса удаляет только пробелы)
|-align="left"
|Функции языка запросов
|'''TrimR'''
|В выражениях
|<code>TrimR(<Выражение>)</code>
|Функция возвращает строку, полученную из первого аргумента путем удаления пробелов с конца строки (в отличие от функции языка [[TrimR]], функция запроса удаляет только пробелы)
|-align="left"
|Функции языка запросов
|'''Trim'''
|В выражениях
|<code>Trim(<Выражение>)</code>
|Функция возвращает строку, полученную из первого аргумента путем удаления пробелов с начала и с конца строки (в отличие от функции языка [[Trim]], функция запроса удаляет только пробелы)
|-align="left"
|Функции языка запросов
|'''Abs'''
|В выражениях
|<code>Abs(<Выражение>)</code>
|Функция абсолютное (не отрицательное) значение числа, заданного первым аргументом
|-align="left"
|Функции языка запросов
|'''Degrees'''
|В выражениях
|<code>Degrees(<Выражение>)</code>
|Функция переводит число, заданное первым аргументом, из радианов в градусы
|-align="left"
|Функции языка запросов
|'''Radians'''
|В выражениях
|<code>Radians(<Выражение>)</code>
|Функция переводит число, заданное первым аргументом, из градусов в радианы
|-align="left"
|Функции языка запросов
|'''Round'''
|В выражениях
|<code>Round(<Выражение>,[<Выражение для количества знаков>])</code>
|Функция находит округленное значение первого аргумента до количества знаков после точки, определяемое вторым аргументом.
|-align="left"
|Функции языка запросов
|'''_PI'''
|В выражениях
|<code>_PI()</code>
|Функция возвращает число π (пи)
|-align="left"
|Функции языка запросов
|'''_E'''
|В выражениях
|<code>_E()</code>
|Функция возвращает число e (основание натурального логарифма)
|-align="left"
|Функции языка запросов
|'''Log'''
|В выражениях
|<code>Log(<Выражение>,<Выражение для основания>)</code>
|Функция возвращает логарифм числа, заданного первым аргументом по основанию, заданному вторым аргументом
|-align="left"
|Функции языка запросов
|'''Log10'''
|В выражениях
|<code>Log10(<Выражение>)</code>
|Функция возвращает десятичный логарифм числа, заданного первым аргументом
|-align="left"
|Функции языка запросов
|'''Ln'''
|В выражениях
|<code>Ln(<Выражение>)</code>
|Функция возвращает натуральный логарифм числа, заданного первым аргументом
|-align="left"
|Функции языка запросов
|'''Arccos'''
|В выражениях
|<code>Arccos(<Выражение>)</code>
|Функция находит арккосинус числа, заданного первым аргументом
|-align="left"
|Функции языка запросов
|'''Arcsin'''
|В выражениях
|<code>Arcsin(<Выражение>)</code>
|Функция находит арксинус числа, заданного первым аргументом
|-align="left"
|Функции языка запросов
|'''Arctg'''
|В выражениях
|<code>Arctg(<Выражение>)</code>
|Функция находит арктангенс числа, заданного первым аргументом
|-align="left"
|Функции языка запросов
|'''Arcctg'''
|В выражениях
|<code>Arcctg(<Выражение>)</code>
|Функция находит арккотангенс числа, заданного первым аргументом
|-align="left"
|Функции языка запросов
|'''Cos'''
|В выражениях
|<code>Cos(<Выражение>)</code>
|Функция находит косинус числа, заданного в радианах первым аргументом
|-align="left"
|Функции языка запросов
|'''Sin'''
|В выражениях
|<code>Sin(<Выражение>)</code>
|Функция находит синус числа, заданного в радианах первым аргументом
|-align="left"
|Функции языка запросов
|'''Tg'''
|В выражениях
|<code>Tg(<Выражение>)</code>
|Функция находит тангенс числа, заданного первым аргументом
|-align="left"
|Функции языка запросов
|'''Ctg'''
|В выражениях
|<code>Ctg(<Выражение>)</code>
|Функция находит котангенс числа, заданного первым аргументом
|-align="left"
|Функции языка запросов
|'''Sqrt'''
|В выражениях
|<code>Sqrt(<Выражение>)</code>
|Функция находит квадратный корень числа, заданного первым аргументом
|-align="left"
|Функции языка запросов
|'''Exp'''
|В выражениях
|<code>Exp(<Выражение>)</code>
|Функция находит экспоненту числа, заданного первым аргументом (т.е. результат возведения основания натурального логарифма в степень, заданную аргументом)
|-align="left"
|Функции языка запросов
|'''Pow'''
|В выражениях
|<code>Pow(<Выражение>,<Выражение, показатель степени>)</code>
|Функция находит результат возведения первого аргумента в степень, определяемую вторым аргументом
|-align="left"
|Функции языка запросов
|'''Sqr'''
|В выражениях
|<code>Sqr(<Выражение>)</code>
|Функция находит квадрат числа, заданного первым аргументом
|-align="left"
|Функции языка запросов
|'''Sign'''
|В выражениях
|<code>Sign(<Выражение>)</code>
|Функция возвращает знак числа, заданного первым аргументом. Для положительных значений функция возвратит 1, для отрицательных -1, для нулевых, ноль
|-align="left"
|Функции языка запросов
|'''Floor'''
|В выражениях
|<code>Floor(<Выражение>)</code>
|Функция возвращает аргумент, округленный до целого в меньшую сторону
|-align="left"
|Функции языка запросов
|'''Ceiling'''
|В выражениях
|<code>Ceiling(<Выражение>)</code>
|Функция возвращает аргумент, округленный до целого в большую сторону
|-align="left"
|Функции языка запросов
|'''Trunc''', '''Int'''
|В выражениях
|<code>Trunc(<Выражение>)</code>
|Функция возвращает целую часть аргумента а также может использоваться для превращения строки в целое число
|-align="left"
|Функции языка запросов
|'''Frac'''
|В выражениях
|<code>Frac(<Выражение>)</code>
|Функция возвращает вещественную (дробную) часть аргумента
|-align="left"
|Функции языка запросов
|'''Number'''
|В выражениях
|<code>Number(<Выражение>)</code>
|Функция превращает строковой аргумент в число
|-align="left"
|Функции языка запросов
|'''Date'''
|В выражениях
|<code>Date(<Выражение>)</code>
|Функция конвертирует строковой аргумент в дату. Строка должна быть задана в виде <code>YYYY-MM-DD[ HH:MM:SS[.sss]]</code>
|-align="left"
|Функции языка запросов
|'''AddMonth'''
|В выражениях
|<code>AddMonth(<Выражение>[,<Выражение для количества месяцев>])</code>
|Функция добавляет к аргументу-дате заданное вторым аргументом количество месяцев. Добавляемое количество может быть отрицательным
|-align="left"
|Функции языка запросов
|'''AddDay'''
|В выражениях
|<code>AddDay(<Выражение>[,<Выражение для количества дней>])</code>
|Функция добавляет к аргументу-дате заданное вторым аргументом количество дней. Добавляемое количество может быть отрицательным
|-align="left"
|Функции языка запросов
|'''BegOfDay'''
|В выражениях
|<code>BegOfDay(<Выражение>)</code>
|Функция возвращает дату, заданную первым аргументом, измененную на начало дня
|-align="left"
|Функции языка запросов
|'''EndOfDay'''
|В выражениях
|<code>EndOfDay(<Выражение>)</code>
|Функция возвращает дату, заданную первым аргументом, время которой изменено на 23:59:59.999
|-align="left"
|Функции языка запросов
|'''BegOfMonth'''
|В выражениях
|<code>BegOfMonth(<Выражение>)</code>
|Функция возвращает дату, заданную первым аргументом, измененную на начало месяца
|-align="left"
|Функции языка запросов
|'''EndOfMonth'''
|В выражениях
|<code>EndOfMonth(<Выражение>)</code>
|Функция возвращает дату, заданную первым аргументом, измененную на начало последнего дня месяца
|-align="left"
|Функции языка запросов
|'''EndOfMonthT'''
|В выражениях
|<code>EndOfMonthT(<Выражение>)</code>
|Функция возвращает дату, заданную первым аргументом, измененную на последний день месяца, при этом время изменено на 23:59:59.999
|-align="left"
|Функции языка запросов
|'''BegOfQuarter'''
|В выражениях
|<code>BegOfQuarter(<Выражение>)</code>
|Функция возвращает дату, заданную первым аргументом, измененную на начало квартала
|-align="left"
|Функции языка запросов
|'''EndOfQuarter'''
|В выражениях
|<code>EndOfQuarter(<Выражение>)</code>
|Функция возвращает дату, заданную первым аргументом, измененную на начало последнего дня квартала
|-align="left"
|Функции языка запросов
|'''EndOfQuarterT'''
|В выражениях
|<code>EndOfQuarterT(<Выражение>)</code>
|Функция возвращает дату, заданную первым аргументом, измененную на последний день квартала, при этом время изменено на 23:59:59.999
|-align="left"
|Функции языка запросов
|'''BegOfYear'''
|В выражениях
|<code>BegOfYear(<Выражение>)</code>
|Функция возвращает дату, заданную первым аргументом, измененную на начало года
|-align="left"
|Функции языка запросов
|'''EndOfYear'''
|В выражениях
|<code>EndOfYear(<Выражение>)</code>
|Функция возвращает дату, заданную первым аргументом, измененную на начало последнего дня года
|-align="left"
|Функции языка запросов
|'''EndOfYearT'''
|В выражениях
|<code>EndOfYearT(<Выражение>)</code>
|Функция возвращает дату, заданную первым аргументом, измененную на последний день года, при этом время изменено на 23:59:59.999
|-align="left"
|Функции языка запросов
|'''BegOfWeek'''
|В выражениях
|<code>BegOfWeek(<Выражение>)</code>
|Функция возвращает дату, заданную первым аргументом, измененную на начало недели
|-align="left"
|Функции языка запросов
|'''EndOfWeek'''
|В выражениях
|<code>EndOfWeek(<Выражение>)</code>
|Функция возвращает дату, заданную первым аргументом, измененную на начало последнего дня недели
|-align="left"
|Функции языка запросов
|'''EndOfWeekT'''
|В выражениях
|<code>EndOfWeekT(<Выражение>)</code>
|Функция возвращает дату, заданную первым аргументом, измененную на последний день недели, при этом время изменено на 23:59:59.999
|-align="left"
|Функции языка запросов
|'''GetYear'''
|В выражениях
|<code>GetYear(<Выражение>)</code>
|Функция возвращает номер года даты-аргумента. Год возвращается в полном формате (YYYY)
|-align="left"
|Функции языка запросов
|'''GetMonth'''
|В выражениях
|<code>GetMonth(<Выражение>)</code>
|Функция возвращает номер месяца года даты-аргумента
|-align="left"
|Функции языка запросов
|'''GetDay'''
|В выражениях
|<code>GetDay(<Выражение>)</code>
|Функция возвращает номер дня месяца даты-аргумента
|-align="left"
|Функции языка запросов
|'''GetHour'''
|В выражениях
|<code>GetHour(<Выражение>)</code>
|Функция возвращает номер часа времени даты-аргумента
|-align="left"
|Функции языка запросов
|'''GetMinute'''
|В выражениях
|<code>GetMinute(<Выражение>)</code>
|Функция возвращает номер минуты времени даты-аргумента
|-align="left"
|Функции языка запросов
|'''GetSecond'''
|В выражениях
|<code>GetSecond(<Выражение>)</code>
|Функция возвращает номер секунды времени даты-аргумента
|-align="left"
|Функции языка запросов
|'''GetMSecond'''
|В выражениях
|<code>GetMSecond(<Выражение>)</code>
|Функция возвращает номер миллисекунды времени даты-аргумента
|-align="left"
|Функции языка запросов
|'''WeekOfYear'''
|В выражениях
|<code>WeekOfYear(<Выражение>)</code>
|Функция возвращает номер недели года даты-аргумента
|-align="left"
|Функции языка запросов
|'''DayOfYear'''
|В выражениях
|<code>DayOfYear(<Выражение>)</code>
|Функция возвращает номер дня года даты-аргумента
|-align="left"
|Функции языка запросов
|'''DayOfWeek'''
|В выражениях
|<code>DayOfWeek(<Выражение>)</code>
|Функция возвращает номер дня недели даты-аргумента
|}

==Функции и атрибуты объекта запроса==
{{function header}}
{{function entry
|name=[[Query.ResultTable|ResultTable]]
|form={{Grey|Query.}}'''ResultTable''':''<Таблица результата запроса (TAB)>''
|type=0
|status=2
|visual=0
|description=Получить таблицу результата запроса. Запрос должен быть выполненным.
}}
{{function entry
|name=[[Query.ForceAggregateSingleLineLev1|ForceAggregateSingleLineLev1]]
|form={{Grey|Query.}}'''ForceAggregateSingleLineLev1''':''<Значение режима форсирования суммирования срок первого уровня группировки (INT)>''
|type=0
|status=2
|visual=0
|description=Получить или установить значение режима форсирования суммирования строк первого уровня группировки при постобработке запроса. Атрибут соответствует опции постобработки ''ForceAggregateSingleLineLev1''. Атрибут имеет смысл изменять после первого этапа выполнения запроса до начала второго.
}}
{{function entry
|name=[[Query.ForceAggregateSingleLine|ForceAggregateSingleLine]]
|form={{Grey|Query.}}'''ForceAggregateSingleLine''':''<Значение режима форсирования суммирования срок любого уровня группировки (INT)>''
|type=0
|status=2
|visual=0
|description=Получить или установить значение режима форсирования суммирования строк любого уровня группировки при постобработке запроса. Атрибут соответствует опции постобработки ''ForceAggregateSingleLine''. Атрибут имеет смысл изменять после первого этапа выполнения запроса до начала второго.
}}
{{function entry
|name=[[Query.DoNotAggregate|DoNotAggregate]]
|form={{Grey|Query.}}'''DoNotAggregate''':''<Значение запрета режима агрегации (INT)>''
|type=0
|status=2
|visual=0
|description=Получить или установить значение запрета режима агрегации при постобработке запроса. Атрибут соответствует опции постобработки ''DoNotAggregate''. Атрибут имеет смысл изменять после первого этапа выполнения запроса до начала второго.
}}
{{function entry
|name=[[Query.DoNotMassLoadBeforeAggregation|DoNotMassLoadBeforeAggregation]]
|form={{Grey|Query.}}'''DoNotMassLoadBeforeAggregation''':''<Значение запрета режима загрузки (INT)>''
|type=0
|status=2
|visual=0
|description=Получить или установить значение запрета режима загрузки при постобработке запроса. Атрибут соответствует опции постобработки ''DoNotMassLoadBeforeAggregation''. Атрибут имеет смысл изменять после первого этапа выполнения запроса до начала второго.
}}
{{function entry
|name=[[Query.RemoveLev0Lines|RemoveLev0Lines]]
|form={{Grey|Query.}}'''RemoveLev0Lines''':''<Значение режима удаления оригинальных строк таблицы запроса (INT)>''
|type=0
|status=2
|visual=0
|description=Получить или установить значение режима удаления оригинальных строк таблицы запроса. Атрибут соответствует опции постобработки ''RemoveLev0Lines''. Атрибут имеет смысл изменять после первого этапа выполнения запроса до начала второго.
}}
{{function entry
|name=[[Query.AllowIncompatibleSortPaths|AllowIncompatibleSortPaths]]
|form={{Grey|Query.}}'''AllowIncompatibleSortPaths''':''<Значение режима отключения в постобработке проверки несовместимых директив сортировки (INT)>''
|type=0
|status=2
|visual=0
|description=Получить или установить значение режима отключения в постобработке проверки несовместимых директив сортировки. Атрибут соответствует опции постобработки ''AllowIncompatibleSortPaths''. Атрибут имеет смысл изменять после первого этапа выполнения запроса до начала второго.
}}
{{function entry
|name=[[Query.ColumnName|<Имя столбца>]]
|form={{Grey|Query.}}'''<Имя столбца>''':''<Значение ячейки>''
|type=0
|status=2
|visual=0
|description=Получить или установить значение столбца текущей строки таблицы результата запроса, для линейных запросов вычислений значений столбцов агрегации не производится. Запрос должен быть выполненным.
}}
{{function entry
|name=[[Query.Get|Get]]
|form={{Grey|Query.}}'''Get''':(''<Наименование или индекс столбца (INT,STRING)>''):''<Значение ячейки столбца (TAB)>''
|type=1
|status=2
|visual=0
|description=Получить значение столбца текущей строки таблицы результата запроса по наименованию или индексу столбца, для линейных запросов вычислений значений столбцов агрегации не производится. Запрос должен быть выполненным. Выполнение этой функции соответствует выражению <code><Запрос>.ResultTable.Get(,<Наименование или индекс столбца>)</code>
}}
{{function entry
|name=[[Query.LinearLevelPos|LinearLevelPos]]
|form={{Grey|Query.}}'''LinearLevelPos''':''<Текущий уровень группировки линейного запроса (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает текущий уровень группировки при прохождении строк таблицы запроса в режиме линейного запроса. Нижний уровень группировки соответствует значению ''1'', верхний -- общему количеству группировок в запросе. Запрос должен быть выполненным.
}}
{{function entry
|name=[[Query.GroupCount|GroupCount]]
|form={{Grey|Query.}}'''GroupCount'''():''<Общее количество группировок в запросе (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает общее количество группировок в запросе. Запрос должен быть выполненным.
}}
{{function entry
|name=[[Query.Groups|Groups]]
|form={{Grey|Query.}}'''Groups'''(''<Индекс группировки (INT)>''):''<Наименование группировки (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает наименование группировки запроса по ее индексу. Запрос должен быть выполненным.
}}
{{function entry
|name=[[Query.Create|Create]]
|form={{Grey|Query.}}'''Create'''():''<Новый объект запроса (QUERY)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый объект запроса. Функция может быть вызвана с интерфейсом запроса.
}}
{{function entry
|name=[[Query.Check|Check]]
|form={{Grey|Query.}}'''Check'''(''<Текст запроса (STRING)>''{{Optional|,<Проверить постобработку (INT)>{{Default|{{Eq}}1}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет текст запроса и постобработки на наличие ошибок при компиляции, однако, выполнения запроса не производится. В результате отдается пустая строка, если ошибок не найдено, иначе отдается строка с сообщением об ошибке в виде <code>(<Номер ошибки> at <Номер строки>:<Позиция>) <Описание ошибки></code>.
}}
{{function entry
|name=[[Query.Execute|Execute]]
|form={{Grey|Query.}}'''Execute'''(''<Текст запроса (STRING)>''{{Optional|,<Режим запроса (INT)>{{Default|{{Eq}}1}},<Выполнять агрегацию столбцов (INT)>{{Default|{{Eq}}1}},<Столбцы с объектами, загружаемыми в режиме заголовка (STRING)>{{Default|{{Eq}}""}}}}):''<Таблица результата запроса (TAB)>''
|type=1
|status=2
|visual=0
|description=Функция выполняет запрос, заданный текстом в нужном режиме с необходимыми свойствами. Функция отдает таблицу результата запроса, если это необходимо. Если в процессе запроса будет найдена ошибка, функция вызовет исключение.
}}
{{function entry
|name=[[Query.CreateFromTable|CreateFromTable]]
|form={{Grey|Query.}}'''CreateFromTable'''(''<Таблица для создания результата запроса (TAB)>'',''<Столбцы группировки с настройками (STRING)>'',''<Столбцы агрегации с операциями (STRING)>''{{Optional|,<Режим запроса (INT)>{{Default|{{Eq}}1}}}}):''<Новый объект запроса (QUERY)>''
|type=1
|status=1
|visual=0
|description=Функция создает объект запроса из существующей линейной таблицы значений. Таким образом полностью будет пропущен первый этап выполнения запроса. Запрос создается с заданными группировками и столбцами агрегации.
}}
{{function entry
|name=[[Query.Postprocess|Postprocess]]
|form={{Grey|Query.}}'''Postprocess'''({{Optional|<Выполнять агрегацию столбцов (INT)>{{Default|{{Eq}}1}},<Столбцы с объектами, загружаемыми в режиме заголовка (STRING)>{{Default|{{Eq}}""}}}}):''<Таблица результата запроса (TAB)>''
|type=1
|status=2
|visual=0
|description=Функция запускает второй этап выполнения запроса, и должна выполняться после функции [[Query.Execute|Execute]] с параметром ''Режим запроса'' равным нулю. Функция отдает таблицу результата запроса, если это необходимо. Если в процессе выполнения будет найдена ошибка, функция вызовет исключение.
}}
{{function entry
|name=[[Query.PostprocessLinear|PostprocessLinear]]
|form={{Grey|Query.}}'''PostprocessLinear'''({{Optional|<Столбцы с объектами, загружаемыми в режиме заголовка (STRING)>{{Default|{{Eq}}""}}}}):''<Таблица результата запроса (TAB)>''
|type=1
|status=2
|visual=0
|description=Функция запускает второй этап выполнения запроса в линейном режиме, и должна выполняться после функции [[Query.Execute|Execute]] с параметром ''Режим запроса'' равным нулю. Функция отдает таблицу результата запроса, если это необходимо. Если в процессе выполнения будет найдена ошибка, функция вызовет исключение.
}}
{{function entry
|name=[[Query.RemovePostprocessing|RemovePostprocessing]]
|form={{Grey|Query.}}'''RemovePostprocessing'''()
|type=1
|status=2
|visual=0
|description=Функция удаляет из таблицы запроса строки с уровнем больше 0, а также удаляет столбцы ''@LEVEL'' и ''@FLEVEL'', возвращая таблицу результата в состояние, в котором она находилась после выполнения первого этапа запроса.
}}
{{function entry
|name=[[Query.First|First]]
|form={{Grey|Query.}}'''First'''({{Optional|<Индекс или наименование группировки запроса (INT,STRING)>{{Default|{{Eq}}0}}}}):''<Результат запроса имеет хотя бы одну запись на этом уровне (INT)>''
|type=1
|status=2
|visual=0
|description=Функция устанавливает текущую строку таблицы запроса на начало указанного уровня группировки, после чего можно начинать обход записей запроса с начала уровня.
}}
{{function entry
|name=[[Query.Next|Next]]
|form={{Grey|Query.}}'''Next'''(''<Индекс или наименование группировки запроса (INT,STRING)>''):''<Найдена следующая запись на указанном уровне группировки (INT)>''
|type=1
|status=2
|visual=0
|description=Функция выполняет шаг внутри указанной группировки запроса при обходе таблицы запроса в прямом направлении. Если следующая запись найдена, функция возвращает 1, иначе 0.
}}
{{function entry
|name=[[Query.Prev|Prev]]
|form={{Grey|Query.}}'''Prev'''(''<Индекс или наименование группировки запроса (INT,STRING)>''):''<Найдена следующая запись на указанном уровне группировки (INT)>''
|type=1
|status=2
|visual=0
|description=Функция выполняет шаг внутри указанной группировки запроса при обходе таблицы запроса в обратном направлении. Если предыдущая запись найдена, функция возвращает 1, иначе 0.
}}
{{function entry
|name=[[Query.Last|Last]]
|form={{Grey|Query.}}'''Last'''({{Optional|<Индекс или наименование группировки запроса (INT,STRING)>{{Default|{{Eq}}0}}}}):''<Результат запроса имеет хотя бы одну запись на этом уровне (INT)>''
|type=1
|status=2
|visual=0
|description=Функция устанавливает текущую строку таблицы запроса на конец указанного уровня группировки, после чего можно начинать обход записей запроса с помощью функции [[Query.Prev|Prev]].
}}
{{function entry
|name=[[Query.Level|Level]]
|form={{Grey|Query.}}'''Level'''():''<Текущий уровень группировки (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает индекс уровня группировки, текущей строки таблицы запроса.
}}
{{function entry
|name=[[Query.FolderLevel|FolderLevel]]
|form={{Grey|Query.}}'''FolderLevel'''():''<Текущий уровень папок (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает индекс уровня папок, текущей строки таблицы запроса для текущей группировки. Если текущая строка не указывает на папку, функция возвращает ноль, иначе возвращает 1 для самого высокого уровня вложения (корневых папок), 2 для папок, вложенных в корневые папки и т.д. Функция может выполняться только не для линейных запросов.
}}
{{function entry
|name=[[Query.Compute|Compute]]
|form={{Grey|Query.}}'''Compute'''(''<Наименование переменной запроса (STRING)>''{{Optional|,<Операция агрегации (STRING)>{{Default|{{Eq}}"SUM"}},<Строки превращать в числа (INT)>{{Default|{{Eq}}0}},<Вычислять для уровня (INT)>{{Default|{{Eq}}<Текущий линейный уровень обхода>}}}}):''<Результат вычисления (NUMBER)>''
|type=1
|status=2
|visual=0
|description=Функция позволяет получить значение столбца агрегации для запроса в линейном режиме (однако, функция может выполняться и для запроса в обычном режиме, но для ее корректной работы в режимах, отличных от суммы, необходимо наличие оригинальных строк с уровнем группировки ноль). По умолчанию, для агрегации используется суммирование значений. Для обычных запросов функция используется только для нахождения итогов по всей таблице значений.
}}
{{function entry
|name=[[Query.BegTotals|BegTotals]]
|form={{Grey|Query.}}'''BegTotals'''(''<Наименование переменной запроса (STRING)>''):''<Результат вычисления (NUMBER)>''
|type=1
|status=2
|visual=0
|description=Функция позволяет получить значение столбца агрегации для запроса в линейном режиме (однако, функция может выполняться и для запроса в обычном режиме, к примеру, для нахождения итого по всей таблице запроса). Агрегация выполняется в режиме начальных остатков для текущего уровня группировки таблицы, т.е. находится сумма всех записей уровня ноль, связанных с первой записью текущего уровня группировки в текущей строке таблицы.
}}
{{function entry
|name=[[Query.EndTotals|EndTotals]]
|form={{Grey|Query.}}'''EndTotals'''(''<Наименование переменной запроса (STRING)>''):''<Результат вычисления (NUMBER)>''
|type=1
|status=2
|visual=0
|description=Функция позволяет получить значение столбца агрегации для запроса в линейном режиме (однако, функция может выполняться и для запроса в обычном режиме, к примеру, для нахождения итого по всей таблице запроса). Агрегация выполняется в режиме конечных остатков для текущего уровня группировки таблицы, т.е. находится сумма всех записей уровня ноль, связанных с последней записью текущего уровня группировки в текущей строке таблицы.
}}
{{function footer}}

{{Объекты}}

Объект MM

2026-04-01T10:01:24Z

Admin: 1 revision imported

{{infobox object
|object=Мультимедиа
|status=2
|create=[[MM.SndCreateMixer|SndCreateMixer]], [[MM.SndLoadSound|SndLoadSound]] и пр.}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]}}

Объект мультимедиа на данный момент поддерживает только работу с декодированием и выводом звука. В будущем планируется добавление других функций (к примеру, работу с микрофоном). Двумя основными внутренними объектами мультимедиа являются объект микшера (Mixer) и объект звука (Sound). Микшер, используя объекты звука, выводит данные с помощью определенного API на устройства вывода (наушники, колонки и пр.). Микшер используется, как устройство, которое может сложить множество звуков в один с помощью определенного алгоритма. Одновременно может существовать несколько объектов микшера, однако, определенные API (к примеру, WinMM) могут работать с проблемами, если этих объектов будет слишком много. Каждый из объектов микшера в отдельно взятое время может складывать произвольное количество звуков.

Объекты микшера и звука обладают важными характеристиками: частота дискретизации звука (samples per second), размер образца звука в битах (bits per sample) и количество каналов звука (channels). Для объекта микшера эти характеристики задаются при его создании и не могут быть изменены. Не все возможные комбинации характеристик могут быть приняты операционной системой, в зависимости от API вывода, функция создания микшера может завершиться ошибкой для некоторых комбинаций. Рекомендуется использовать более или менее стандартные значения. Обычными значениями ''samples per second'' являются 48000 или 44100 и их вариации (32000, 24000, 22050, 16000, 12000, 11025, 8000) образцов в секунду. Обычными значениями ''bits per sample'' являются 16 или 32 бит (при создании микшера другие значения пока не поддерживаются). Количество каналов зависит от аппаратной звуковой системы конкретного компьютера. Любой компьютер может использовать одноканальный (моно) или двухканальный (стерео) вывод звука. Некоторые системы могут также выводить звуки в режимах 3+1 (4 канала), 5+1 (6 каналов) и 7+1 (8 каналов). Для более высокой частоты дискретизации звука (''samples per second''), может потребоваться больше ресурсов процессора.

Каждый звук также обладает такими же характеристиками, как и объект микшера, однако, эти характеристики зависят от содержимого файла звука, а не выбираются при его загрузке в систему. Если характеристики звука отличаются от характеристик микшера, система автоматически произведет конвертирование звука (resampling) при его использовании в микшере. Обычно это недорогой с точки зрения ресурсов процесс, но если звуков очень много, он может использовать какое-то количество оперативной памяти и времени центрального процессора. К примеру, конвертирование между частотами 44100 и 48000 достаточно дорогое, так как эти частоты имеют малое количество общих множителей, однако, конвертирование из 44100 в 22050 очень быстрое и дешевое. Обычно рекомендуется использовать звуки, наиболее совместимые с создаваемым микшером, это уменьшит количество требуемых ресурсов, если звуков будет много.

Особой характеристикой при создании микшера является латентность (задержка вывода) звука. Эта величина зависит от внутреннего буфера микшера, API (интерфейса вывода) и драйвера вывода. Пользователь услышит звук, выводимый программой, не мгновенно, а только через какой-то небольшой промежуток времени. При слишком низкой латентности, внутренний буфер опустошается быстрее, чем система успевает его наполнять (наполнение обычно происходит кусками), поэтому звук слышен как совокупность прерывающихся частей. Латентности в 30-50 мс. должно быть достаточно практически для любых целей при выводе звука.

При панорамировании (смещении звука между каналами по определенным правилам) звука в системах с большим количеством колонок, можно создать эффект объемности, когда положение героя относительно источника звука перемещает его от одной колонки к другой или делает его тише или громче. Для работы с многоканальным звуком, перед созданием микшера желательно задать конфигурацию колонок с помощью функции [[MM.SndChannels|SndChannels]], после чего для каждого из проигрываемых звуков в отдельности можно использовать функции [[MMSound.Pan|Pan]] или [[MMSound.Pan2D|Pan2D]].

При проигрывании иногда необходимо знать текущую позицию звука, играющуюся в данный момент, к примеру, чтобы обновить индикатор проигрывания. Для таких случаев, можно использовать функции [[MMSound.Status|Status]] или [[MMSound.Position|Position]] (последняя также может изменить текущую позицию). Функции позиции проигрывания оперируют количеством образцов или сэмплов (samples), а не временем, чтобы иметь максимальную точность. Номер проигрываемого образца можно превратить во время проигрывания с помощью функции [[MMSound.SampleToSecond|SampleToSecond]], и обратно с помощью функции [[MMSound.SecondToSample|SecondToSample]]. Получить размер звука в образцах можно с помощью функции [[MMSound.GetTotalSamples|GetTotalSamples]]. Важно также заметить, что номер образца (сэмпла) будет зависеть от характеристик микшера. При перекодировании звука под определенный микшер, его частота дискретизации может быть изменена, таким образом изменится количество дискретных образцов в нем, поэтому, использовать эти функции для звука, проигрывающегося в данный момент, нужно с указанием микшера. К примеру, звук с частотой дискретизации 11025 и длительностью ровно в 60 секунд содержит 661500 образцов (сэмплов), если проигрывать этот звук на микшере с частотой дискретизации в 44100, количество образов в проигрываемом звуке будет автоматически увеличено в 4 раза (до 2646000).

При создании микшера и загрузке звука есть также возможность выбрать API (интерфейс или стандарт) из поддерживаемых системой, и хотя обычно в этом нет необходимости, разные интерфейсы обладают разными возможностями. Система позволяет создавать микшеры со следующими характеристиками:
* Частота дискретизации образцов звука (samples per second): произвольная, но операционная система не поддерживает все частоты, рекомендуется использовать: 44100, 48000, 32000, 24000, 22050, 16000, 12000, 11025, 8000.
* Размер образца звука (bits per sample): 16 или 32.
* Количество каналов звука (channels): произвольное, но аппаратное обеспечение может поддерживать только определенное количество. Чтобы выяснить количество акустических колонок (каналов звука) в системе, можно использовать функцию [[MM.DeviceList|DeviceList]].
* При выводе звука используются следующие API:
** ''WinMM''/''MME'' (Windows Multimedia API / Microsoft Multimedia Environment). Старый стандарт, доступный в любой версии Windows. Начиная с Windows Vista, для его реализации используется эмуляция на основании других API, что добавляет латентности. Ограничения и возможности API:
*** Латентность не ниже 30 мс (рекомендуется 50 мс)
*** Создание микшеров с "экзотическими" частотами дискретизации и другими характеристиками будет вызывать ошибку (поддерживается только то, что поддерживает драйвер звука операционной системы).
*** При изменении уровня (громкости) системного звука (см. [[MM.SndSetVolume|SndSetVolume]]) может только изменить громкость приложения (не общесистемную громкость). При изменении громкости используются только два канала. Общую громкость отдельных каналов многоканального звука изменить нельзя (система позволяет изменять громкость отдельных звуков и микшеров, вне зависимости от API вывода).
*** Имеет дополнительные возможности, к примеру [[MMixer.Pitch|Pitch]] или [[MMixer.PlaybackRate|PlaybackRate]].
** ''WASAPI'' / ''Core Audio'' (Windows Audio Session API / Core Audio API). Стандарт доступен, начиная с Windows Vista. Работает в двух режимах: в режиме общей сессии и в эксклюзивном режиме. Эксклюзивный режим не позволяет другим программам операционной системы иметь доступ к устройству вывода. В этом режиме можно создать единственный микшер и драйвер будет пытаться подстроиться под характеристики создаваемого микшера, и при попытке использования "экзотических" характеристик будет возвращать ошибку. Однако, в этом режиме можно добиться минимальной латентности. Ограничения и возможности API:
*** В режиме общей сессии латентность до 30 мс. (она и рекомендуется). В эксклюзивном режиме латентность до 5-15 мс.
*** В режиме общей сессии поддерживаются практически любые частоты дискретизации и количество каналов. Перекодировка будет автоматически производиться ''WASAPI'' или системой.
*** В режиме общей сессии при изменении уровня (громкости) системного звука (см. [[MM.SndSetVolume|SndSetVolume]]), может изменить общесистемную громкость, громкость приложения (без разреза каналов) и громкость сессии в разрезе каналов.
*** Не поддерживает функции, типа [[MMixer.Pitch|Pitch]] или [[MMixer.PlaybackRate|PlaybackRate]].
** ''XAudio2'' (Windows 7+). Планируется к добавлению в будущем.

Система позволяет загружать звуки следующих форматов (и характеристик):
* '''WAV''' без компрессии (PCM): произвольная частота дискретизации (samples per second), произвольное количество каналов, размер образца: 8, 16, 24, 32 бита. Система выполняет автоматически перекодировку (resampling) между звуками без компрессии с разными характеристиками, также можно использовать функцию [[MMSound.ConvertTo|ConvertTo]].
* '''WAV''' с компрессией: декодируются форматы '''GSM6.10''', '''u-law''', '''A-law''', '''MS ADPCM'''. Декодирование выполняется с помощью API ''ACM'' (Audio Compression Manager).
* '''MP3'''. Декодирование выполняется с помощью API ''ACM'' (Audio Compression Manager) или ''WMF'' (Windows Media Format, Windows XP+). Рекомендуется использовать декодер ''WMF'', однако, он может добавить некоторое количество тишины в конце звука.
* '''WMA'''. Декодирование выполняется с помощью API ''WMF'' (Windows Media Format, Windows XP+). Рекомендуется использовать ''MP3'' вместо этого формата.
* '''AC3''', '''AAC''', '''OGG''' -- Планируется к добавлению в будущем.

== Простые примеры создания микшера и загрузки и проигрывания звука ==
Внешний демонстрационный объект [http://{{SERVERNAME}}/download/sound.sfo sound.sfo] является примитивным проигрывателем звуковых файлов, поддерживаемых системой. Его можно открыть в Студии и изучить код. Кроме того, ниже предлагается простой пример создания микшера, загрузки и проигрывания звука:

<pre>
//Создадим микшер с частотой дискретизации 44100, 16-битным, стерео звуком для устройства вывода по умолчанию.
aMixer:=MM.SndCreateMixer(,"44100,16,2",2);

//Загрузим в память звук с диска.
Try
aSound:=MM.SndLoadSound("c:\sounds\sound.mp3");
Except
Box("Невозможно загрузить файл: "+PopError(),Q_STOP);
Exit;
EndTry;

//Начать проигрывание звука на микшере aMixer.
aSound.Play(aMixer);

//Ждать, пока звук не будет полностью проигран (Status()=0).
Repeat
Sleep(100);
Until aSound.Status()=0;
</pre>

== Основные атрибуты и функции ==
=== Атрибуты и функции объекта мультимедиа и микшера ===

{{function header}}
{{function entry
|name=[[MM.API|API]]
|form={{Grey|MM.}}'''API'''(''<Тип стандарта (STRING)>''{{Optional|,<Стандарт (STRING)>,<Параметры>}}):''<Предыдущее значение стандарта (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция вызывается из интерфейса ''MM'' и задает использование API (стандартов) для определенных процессов.
}}
{{function entry
|name=[[MM.DeviceList|DeviceList]]
|form={{Grey|MM.}}'''DeviceList'''({{Optional|<Тип устройств (STRING,INT)>{{Default|{{Eq}}"SOUND"}}}}):''<Список доступных устройств с их свойствами (LIST)>''
|type=1
|status=2
|visual=0
|description=Функция вызывается из интерфейса ''MM'' и возвращает список доступных устройств со свойствами по их типу. К примеру, список устройств для вывода звука. Возвращаемые свойства и даже сами устройства могут зависеть от используемого стандарта при запросе. Стандарт можно задать перед вызовом функции с помощью функции [[MM.API|API]].
}}
{{function entry
|name=[[MM.SndSetVolume|SndSetVolume]]
|form={{Grey|MM.}}'''SndSetVolume'''(''<Код устройства или микшер (MIXER,STRING,INT)>''{{Optional|,<Уровень канала 1 (REAL)>,<Уровень канала 2 (REAL)>...}})
|type=1
|status=2
|visual=0
|description=Функция вызывается из интерфейса ''MM'' и задает уровень глобальной громкости, громкость, применительно к приложению или текущей сессии в разрезе колонок. Уровень задается в виде вещественных чисел от 0 (тишина) до 100 (макс. громкость). Работа функции сильно зависит от используемого стандарта (API). Для дополнительной информации, см. описание.
}}
{{function entry
|name=[[MM.SndChannels|SndChannels]], '''SndSpeakers'''
|form={{Grey|MM.}}'''SndChannels'''({{Optional|,<Шаблон используемых колонок или код шаблона по умолчанию (STRING,INT)>}}):''<Предыдущий шаблон (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция вызывается из интерфейса ''MM'' и задает шаблон использующихся колонок для вывода звука. Также можно задать один из кодов шаблонов по умолчанию. Для дополнительной информации, см. описание.
}}
{{function entry
|name=[[MM.SndCreateMixer|SndCreateMixer]]
|form={{Grey|MM.}}'''SndCreateMixer'''({{Optional|<Код устройства (STRING,INT)>,<Параметры звука (STRING)>{{Default|{{Eq}}"44100,16"}},<Метод миксации (INT)>{{Default|{{Eq}}2}},<Желаемая латентность (INT)>,<Режим или маска конвертирования каналов (INT,STRING)>}}):''<Объект созданного микшера (MIXER)>''
|type=1
|status=2
|visual=0
|description=Функция вызывается из интерфейса ''MM'' и позволяет создать новый микшер. По умолчанию микшер использует предпочтительный из доступных стандарт (API), однако, стандарт может быть выбран с помощью функции [[MM.API|API]]. Если код устройства не указан, микшер будет создан на устройстве по умолчанию. Желаемая латентность может быть уменьшена до минимально возможной, либо будет использовано умолчание, если аргумент не задан. Для получения результирующей латентности, используйте атрибут [[MMixer.Latency|Latency]]. При проигрывании звуков с другим количеством каналов используется особая маска (или режим) конвертации каналов, задаваемая пятым аргументом.
}}
{{function entry
|name=[[MMixer.MixMethod|MixMethod]]
|form={{Grey|MMixer.}}'''MixMethod''':''<Метод миксации (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает метод миксации звуков для текущего микшера.
}}
{{function entry
|name=[[MMixer.Latency|Latency]]
|form={{Grey|MMixer.}}'''Latency''':''<Текущая латентность (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает текущую латентность для текущего микшера. Обычно это значение не изменяется в процессе работы микшера, и оно может отличаться от требуемого в момент создания микшера функцией [[MM.SndCreateMixer|SndCreateMixer]].
}}
{{function entry
|name=[[MMixer.BufferHealth|BufferHealth]]
|form={{Grey|MMixer.}}'''BufferHealth''':''<Заполненность буфера вывода (REAL)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает заполненность буфера миксования на данный момент в процентах. Если это число близко к нулю, это означает, что латентность слишком низкая и буфер не успевает заполняться данными в достаточной степени, чтобы обеспечить бесперебойное проигрывание звука.
}}
{{function entry
|name=[[MM.SndLoadSound|SndLoadSound]]
|form={{Grey|MM.}}'''SndLoadSound'''(''<Источник (STRING,BUFFER)>''{{Optional|,<Тип источника (INT)>{{Default|{{Eq}}0}},<Параметры для конвертирования (STRING,MIXER)>{{Default|{{Eq}}"" (без конвертирования)}},<Режим или маска конвертирования каналов (INT,STRING)>,<Формат конвертирования (STRING)>}}):''<Объект загруженного звука (SOUND)>''
|type=1
|status=2
|visual=0
|description=Функция загружает звук с диска из буфера или из строки с бинарными данными. Звук может быть сконвертирован при загрузке (поддержвается указание микшера для автоматического подбора параметров конвертирования). После загрузки, звук может быть проигран на микшере ([[MMSound.Play|Play]]), либо сохранен ([[MMSound.Save|Save]]). Один объект звука может проигрываться только на одном микшере в отдельно взятый момент, однако, если необходимо проигрывать множество копий одного звука, объект звука можно дублировать с помощью функции [[MMSound.Copy|Copy]], при этом сами загруженные в память бинарные данные не будут продублированы. Принимаются звуки разных форматов. Для дополнительной информации, смотрите описание функции.
}}
{{function entry
|name=[[MMixer.Stop|Stop]]
|form={{Grey|MMixer.}}'''Stop'''({{Optional|<Время затухания звуков в мс. (fade-out) (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=0
|visual=0
|description=Функция останавливает проигрывание всех звуков текущего микшера. Возможно использование затухания для более гладкой ощущаемой остановки. Запуск для проигрывания новых звуков на микшере по-прежнему разрешен, останаливается проигрывание только звуков, которые играются в данный момент.
}}
{{function entry
|name=[[MMixer.SetVolume|SetVolume]]
|form={{Grey|MMixer.}}'''SetVolume'''({{Optional|<Уровень канала 1 (REAL)>,<Уровень канала 2 (REAL)>...}})
|type=1
|status=2
|visual=0
|description=Функция изменяет уровень звука для текущего микшера. Уровень задается в виде вещественных чисел от 0 (тишина) до 400 (в 4 раза громче оригинальной громкости). При значении 100, уровень проигрываемых звуков не будет изменяться (индивидуальные уровни громкости доступны для каждого объекта звука). При значении больше 100, уровень всех звуков будет пропорционально увеличен, при этом могут произойти искажения, если звук был достаточно громким из без этого увеличения. Используется линейный уровень (не логарифмический, как он обычно воспринимается человеческим ухом). При указании всего одного аргумента, уровень будет установлен для всех каналов. Если в микшере больше каналов, чем задано аргументов для функции, для остальных каналов будет использован уровень, заданный последним аргументом. Если аргументов не задано, уровень не изменяется.
}}
{{function entry
|name=[[MMixer.GetVolume|GetVolume]]
|form={{Grey|MMixer.}}'''GetVolume'''():''<Список уровней звуков (LIST)>''
|type=1
|status=0
|visual=0
|description=Функция возвращает список уровней звуков для текущего микшера.
}}
{{function entry
|name=[[MMixer.Pitch|Pitch]]
|form={{Grey|MMixer.}}'''Pitch'''({{Optional|<Высота звука (REAL)>}}):''<Текущая высота звука (REAL)>''
|type=1
|status=0
|visual=0
|description=Функция изменяет высоту звуков для всего микшера. Может использоваться только для определенных API (WinMM). Рекомендуется использовать функции DPS вместо данной.
}}
{{function entry
|name=[[MMixer.PlaybackRate|PlaybackRate]]
|form={{Grey|MMixer.}}'''PlaybackRate'''({{Optional|<Скорость проигрывания (REAL)>}}):''<Текущая скорость проигрывания (REAL)>''
|type=1
|status=0
|visual=0
|description=Функция изменяет скорость проигрывания звуков для всего микшера. Может использоваться только для определенных API (WinMM). Рекомендуется использовать функции DPS вместо данной.
}}
{{function entry
|name=[[MMixer.GetFormat|GetFormat]]
|form={{Grey|MMixer.}}'''GetFormat'''({{OptionalByRef|<Частота дискретизации микшера (INT)>,<Размер образца звука микшера (INT)>,<Количество каналов микшера (INT)>}}):''<Формат строкой (STRING)>''
|type=1
|status=0
|visual=0
|description=Функция получает звуковые характеристики для текущего микшера.
}}
{{function entry
|name=[[MMixer.AddDSP|AddDSP]]
|form={{Grey|MMixer.}}'''AddDSP'''()
|type=1
|status=0
|visual=0
|description=Функция добавляет процессор цифровой обработки звука для данного микшера.
}}
{{function entry
|name=[[MMixer.RemoveDSP|RemoveDSP]]
|form={{Grey|MMixer.}}'''RemoveDSP'''()
|type=1
|status=0
|visual=0
|description=Функция удаляет процессор цифровой обработки звука для данного микшера.
}}
{{function footer}}

=== Атрибуты и функции объекта звука ===

{{function header}}
{{function entry
|name=[[MMSound.Play|Play]]
|form={{Grey|MMSound.}}'''Play'''(''<Микшер для проигрывания (MIXER)>''{{Optional|,<Начинать с образца (INT)>{{Default|{{Eq}}0}},<Количество повторений (INT)>{{Default|{{Eq}}1}},<Время увеличения громкости до рабочей, мс. (fade-in) (INT)>{{Default|{{Eq}}0}},<Режим или маска конвертирования каналов (INT,STRING)>}})
|type=1
|status=2
|visual=0
|description=Функция инициирует проигрывание звука на заданном микшере, если звук уже находился в состоянии проигрывания, оно будет сначала остановлено. Звук может начинать проигрывание с заданного образца (сэмпла) с учетом частоты дискретизации текущего микшера (т.е., после конвертирования звука, если таковое происходит). Проигрывание звука может повторяться указанное количество раз (при указании значения ''-1'', звук будет повторяться неограниченное количество раз). Также возможно задать время увеличения громкости звука до рабочей (fade-in), т.е. начальная громкость звука будет увеливаться плавно до рабочей после чего проигрываться с рабочей громкостью до конца. Может быть задана особая маска (или режим) конвертации каналов, если количество каналов в звуке отличается от такового в микшере, если аргумент конвертирования каналов не задан, будет использован способ конвертирования, указанный при создании микшера. Один объект звука может проигрываться только на одном микшере в отдельно взятый момент, однако, если необходимо проигрывать множество копий одного звука, объект звука можно дублировать с помощью функции [[MMSound.Copy|Copy]], при этом сами загруженные в память бинарные данные не будут продублированы.
}}
{{function entry
|name=[[MMSound.SetVolume|SetVolume]]
|form={{Grey|MMSound.}}'''SetVolume'''({{Optional|<Уровень канала 1 (REAL)>,<Уровень канала 2 (REAL)>...}})
|type=1
|status=2
|visual=0
|description=Функция изменяет уровень звука для текущего звука. Функцию можно вызывать как для звука, который проигрывается в данный момент, так и для звука, который не проигрывается. Уровень задается в виде вещественных чисел от 0 (тишина) до 400 (в 4 раза громче оригинальной громкости). При значении 100, уровень проигрываемого звука не будет изменяться. При значении больше 100, уровень звука будет пропорционально увеличен, при этом могут произойти искажения, если звук был достаточно громким из без этого увеличения. Используется линейный уровень (не логарифмический, как он обычно воспринимается человеческим ухом). При указании всего одного аргумента, уровень будет установлен для всех каналов. Если в микшере больше каналов, чем задано аргументов для функции, для остальных каналов будет использован уровень, заданный последним аргументом. Если аргументов не задано, уровень не изменяется.
}}
{{function entry
|name=[[MMSound.GetVolume|GetVolume]]
|form={{Grey|MMSound.}}'''GetVolume'''():''<Список уровней громкости (LIST)>''
|type=1
|status=0
|visual=0
|description=Функция возвращает список уровней громкости для текущего звука.
}}
{{function entry
|name=[[MMSound.Pan|Pan]]
|form={{Grey|MMSound.}}'''Pan'''(''<Формула панорамирования (STRING,BUFFER)>''{{Optional|,<Для микшера (MIXER)>}})
|type=1
|status=2
|visual=0
|description=Функция задает формулу панорамирования для звука (изменения громкости звука по разным каналам в зависимости от канала). Звук может проигрываться в данный момент. Если звук не проигрывается, необходимо указать также микшер (вторым аргументом), из установок которого будет использована конфигурация каналов. Данная функция универсальна, настроить ее для 2D или 3D положения звука сложно, для упрощения можно использовать функции [[MMSound.Pan2D|Pan2D]] и [[MMSound.Pan3D|Pan3D]], которые автоматически подбирают формулу панорамирования.
}}
{{function entry
|name=[[MMSound.Pan2D|Pan2D]]
|form={{Grey|MMSound.}}'''Pan2D'''(''<Позиция X источника звука (REAL)>'',''<Позиция Y источника звука (REAL)>''{{Optional|,<Интенсивность звука в точке 0,0 (REAL)>{{Default|{{Eq}}1.0}},<Для микшера (MIXER)>}}):''<>''
|type=1
|status=2
|visual=0
|description=Функция вычисляет формулу панорамирования, когда источник звука находится в точке X,Y в плоской системе координат (шкала Y направлена от наблюдателя на колонку FC (front center)), а слушатель находится в точке 0,0. Для многоколоночной конфигурации, разные колонки будут выводить звук с разной громкостью. Если источник звука будет находиться в точке 0,0, оригинальные громкости всех колонок будут умножены на коэффициент третьего аргумента, но их положение в колонках изменено не будет. Звук может проигрываться в данный момент. Если звук не проигрывается, необходимо указать также микшер (четвертым аргументом), из установок которого будет использована конфигурация каналов. Для прямого указания формулы панорамирования, используется более универсальная функция [[MMSound.Pan|Pan]].
}}
{{function entry
|name=[[MMSound.Pan3D|Pan3D]]
|form={{Grey|MMSound.}}'''Pan3D'''():''<>''
|type=1
|status=2
|visual=0
|description=
}}
{{function entry
|name=[[MMSound.GetFormat|GetFormat]]
|form={{Grey|MMSound.}}'''GetFormat'''():''<>''
|type=1
|status=2
|visual=0
|description=
}}
{{function entry
|name=[[MMSound.GetTotalSamples|GetTotalSamples]]
|form={{Grey|MMSound.}}'''GetTotalSamples'''():''<>''
|type=1
|status=2
|visual=0
|description=
}}
{{function entry
|name=[[MMSound.Status|Status]]
|form={{Grey|MMSound.}}'''Status'''():''<>''
|type=1
|status=2
|visual=0
|description=
}}
{{function entry
|name=[[MMSound.Position|Position]]
|form={{Grey|MMSound.}}'''Position'''():''<>''
|type=1
|status=2
|visual=0
|description=
}}
{{function entry
|name=[[MMSound.SampleToSecond|SampleToSecond]]
|form={{Grey|MMSound.}}'''SampleToSecond'''():''<>''
|type=1
|status=2
|visual=0
|description=
}}
{{function entry
|name=[[MMSound.SecondToSample|SecondToSample]]
|form={{Grey|MMSound.}}'''SecondToSample'''():''<>''
|type=1
|status=2
|visual=0
|description=
}}
{{function entry
|name=[[MMSound.Stop|Stop]]
|form={{Grey|MMSound.}}'''Stop'''():''<>''
|type=1
|status=2
|visual=0
|description=
}}
{{function entry
|name=[[MMSound.Copy|Copy]]
|form={{Grey|MMSound.}}'''Copy'''():''<>''
|type=1
|status=2
|visual=0
|description=
}}
{{function entry
|name=[[MMSound.Resample|Resample]]
|form={{Grey|MMSound.}}'''Resample'''():''<>''
|type=1
|status=2
|visual=0
|description=
}}
{{function entry
|name=[[MMSound.ConvertTo|ConvertTo]]
|form={{Grey|MMSound.}}'''ConvertTo'''():''<>''
|type=1
|status=2
|visual=0
|description=
}}
{{function entry
|name=[[MMSound.Save|Save]]
|form={{Grey|MMSound.}}'''Save'''():''<>''
|type=1
|status=2
|visual=0
|description=
}}
{{function footer}}

{{Объекты}}

Общее описание языка

2026-04-01T10:01:23Z

Admin: 1 revision imported

{{HeadLinks|
* [[Main_Page|Начальная страница]]}}
== Вводная информация ==
Встроенный язык (скрипт) системы является интерпретатором, компилирующим (переводящим) тексты, написанные по определенным правилам, в байтовый код для ускорения выполнения программы. Перевод из байтового кода в машинный код не осуществляется (таким образом сохраняя сравнительную независимость от платформы исполнения). Такой способ сродни общеизвестным языкам, типа Java или C#. Являясь императивным языком (т.е., языком, использующим инструкции), он поддерживает процедурное и объектно-ориентированное программирование (однако, в данный момент не создано возможности определения новых объектов непосредственно из кода).
Являясь также специализированным языком для поддержки работы программной среды, он обладает рядом особенностей, таких как [[Типизация|слабая типизация]] (необходимая для упрощения написания текстов и адресации данных более удобным способом), многопоточность, асинхронные и прерывающие события. Компилированные тексты программы могут находиться, как в особых файлах исполнения (модулях), так и быть привязанными к визуальным объектам или метаданным (работая, к примеру, как триггеры), пунктам меню и пр. Язык обладает широкой бибилиотекой встроенных функций и объектов, позволяющих осуществлять ввод и вывод информации в разных файловых форматах, обращение и работу с базой данных, манипуляцию данными, визуальное представление данных с помощью форм и электронных таблиц.
При создании языка делался упор как на удобство программирования, уменьшения количества возможных ошибок при написании программ и полноту предоставляемого инструментария, так и на скорость исполнения и оптимизацию функций.

== Иерархия текстов программ ==
При запуске системы, некоторые программы выполняются до того, как пользователь получает возможность управления системой или ввода информации в нее. Эти стартовые программы называются глобальными и после исполнения находятся в памяти для того, чтобы другие программы имели возможность вызывать созданные ими функции и работать с определенными ими переменными. Каждая программа подобного рода располагается в отдельном файле. Такие файлы называются модулями. Кроме глобальных модулей, любой объект системы, будь то объект метаданных или внешняя обработка и пр. (см. [[Студия/Конфигурация данных проекта|Конфигурация данных проекта]]) имеет свой набор подобных модулей. Программы хранятся не только в модулях, но и привязаны к визуальным объектам (обработчики визуальных событий), к объектам метаданных (триггеры событий метаданных), к пунктам меню (обработчики событий меню), к ячейкам и объектам электронных таблиц (однако, вызов не происходит напрямую) и в других контейнерах по усмотрению создателя конфигурации.
При инициализации и старте системы, глобальные модули исполняются последовательно по следующему принципу:
# Первым всегда исполняется модуль с именем '''Module'''.
# Последующие модули всегда исполняются в алфавитном порядке их наименований.
Любые функции или переменные, определенные в этих модулях с постфиксом '''Export''', будут доступны во всех других модулях и функциях, вызываемых из них (см. ниже описание переменных и функций).
Система позволяет использовать многозадачность при исполнении программ, для этого при запуске программы создается один рабочий поток -- ''корневой поток'' (root thread). Для визуальных клиентов этот поток обслуживает работу пользователя при исполнении пунктов главного меню, окон, загруженных в глобальном режиме, и пр. Программы, исполняемые в данном потоке, могут создать новые потоки (к примеру, с помощью вызова '''[[LoadModule]]'''). Количество рабочих потоков в среде ограничено только ресурсами операционной системы. Вызовы нового модуля из текущего могут также не создавать новый поток, в этом случае, создается вложенный вызов модуля и предыдущий модуль остается в памяти, пока работа последующего не завершена. Во вложенном модуле доступны не только переменные и функции глобальных модулей, но и переменные и функции модуля, из которого произошел вызов (см. также [[#Вложенность функций и модулей, уровни вложенности|Вложенность функций и модулей, уровни вложенности]]). Переменные созданные в одном потоке (или в корневом потоке), могут быть использованы в других потоках, блокировки доступа к переменным в многозадачной среде выполняются системой автоматически (см. также доп. [[Объекты#Многопоточные и однопоточные объекты, внутренний механизм блокировки|информацию по блокировкам]]).

== Построение текста программ с помощью инструкций ==
Любая программа в языке состоит из блоков. Каждый блок делится на некоторое количество инструкций (команд), разделенных знаком ";". Знак перевода строки после каждой инструкции необязателен, но помогает улучшить читаемость программы, позволяя, тем самым избежать ошибок:

<pre>
<Начало блока 1>
Инструкция 1;
Инструкция 2;
...
<Окончание блока 1>;

<Начало блока 2>
Инструкция 1;Инструкция 2;Инструкция 3; ...
...
<Окончание блока 2>;
</pre>

Блоки могут быть как объявлениями функций, так, к примеру, и наборами инструкций при выполнении какого либо условия (см. конструкцию ''If''). После объявления начала блока не требуется знак разделителя инструкций (;), однако, его наличие не будет приводить к ошибкам. Пустые инструкции, состоящие только из знака ";" допустимы и не являются ошибкой.
Комментарии (свободный текст, не подлежащий интерпретации и компилированию) могут быть использованы в любом месте программы. Комментарии можно задать двумя способами: с помощью двух знаков "/", при этом, любой текст после этого набора знаков до окончания текущей строки будет пропущен при компиляции. Также комментарии задаются, как блок текста, начинающийся знаком "{" и заканчивающийся знаком "}". Символы перевода строки внутри этого блока будут принадлежать части комментария и пропускаются при компиляции. После начала комментария одного типа, и до его окончания, невозможно создать комментарий другого типа, так как текст внутри комментария не подлежит интерпретации. Пример использования комментариев дан ниже:

<pre>
Инструкция 1;			//Комментарий 1
Инструкция 2;
//Комментарий 2
...
Инструкция 100;
//Инструкция 101;		//Инструкция не будет компилироваться (принадлежит комментарию)

{
Инструкция 102;
Инструкция 103;}		//Инструкции 102 и 103 принадлежат комментарию
Инструкция 104{Комментарии внутри инструкции допустимы};
...
{Инструкция 200;
Инструкция 201;			//Неверный комментарий,} данный текст будет считаться частью программы и вызовет ошибку компиляции
</pre>

При написании программы рекомендуется каждую инструкцию помещать в отдельную строку и для каждого логического блока инструкций использовать отступ, если блок находится внутри другого блока, отступ рекомендуется увеличивать. Такой подход улучшит читаемость текста программ. Размер единицы отступа обычно совпадает с шириной знака табуляции. Последнюю можно задать в свойствах редактора текста, однако по умолчанию рекомендованное значение равно двум знакоместам. Символ табуляции в редакторе текста программ не используется, а заменяется на необходимое количество пробелов, это сделано для удобства редактирования текстов и обычно не мешает написанию программ, устраняя невидимый и неудобный в работе символ. Для добавления к строковым выражениям символа табуляции, можно использовать либо константу _TAB, либо конструкцию Chr(9). Пример использования отступов:

<pre>
If a=1 Then
Message("a равно 1");			//Инструкция внутри логического блока конструкции If имеет отступ в 2 пробела
Else
Message("a не равно 1");		//Инструкции (эта и далее) внутри логического блока конструкции If имеет отступ в 2 пробела
If a>0 Then
Message("Однако, a больше нуля");	//Инструкция внутри вложенного логического блока конструкции If имеет отступ в 4 пробела
EndIf;
EndIf;
</pre>

== Особые конструкции языка ==
Особыми называются конструкции языка, не являющиеся функциями (но могут быть магическими функциями), процедурами или частями вычисляемых выражений. Такие конструкции могут включать в себя один или более логических блоков, которые могут состоять из любого количества инструкций. Регистр не имеет значения при указании составных частей конструкций (<code>begin</code> и <code>BEgin</code> будут восприняты компилятором одинаково). Определения, используемые в этих конструкциях, являются зарезервированными словами, создание переменных или функций с зарезервированным именем запрещено (к примеру строка <code>If:=1;</code> вызовет ошибку при компиляции). На данный момент в языке существуют следующие конструкции и магические функции (далее по тексту <логический блок> заменяет любое количество инструкций языка, внутри квадратных скобок <nowiki>[...]</nowiki> находятся необязательные части конструкций, внутри фигурных скобок <nowiki>{...}</nowiki> перечислены две или более части конструкций, одна из которых должна обязательно присутствовать):
==== Конструкция объявления переменной ====
::<code>Var <переменная> [Export][, <переменная> [Export]];</code>
Переменные обычно создаются автоматически при первом присваивании и удаляются при выходе за [[Границы видимости переменных‏‎|границы существования]], однако при объявлении переменных с постфиксом Export, они становятся видимыми для функций и модулей более низкого уровня (вызываемых внутри данной функции или модуля). Пример см. ниже:
<pre>
Var a1 Export, a2;

Function ВложеннаяФункция()
a1:=1;				//Обращение к a1 внутри функции возможно
a2:=2;				//При обращении к a2 создается новая переменная с границами видимости функции ВложеннаяФункция()
EndFunction

a1:=0;
a2:=0;
ВложеннаяФункция();
Message(a1);				//Выводит 1
Message(a2);				//Выводит 0, так как оригинальная переменная a2 не была изменена
</pre>
Кроме того, объявление переменных можно использовать для небольшого ускорения, когда к переменной происходит очень много вызовов, так как поиск переменных, при обращении к ним, осуществляется по имени (в текущей реализации), это занимает определенное время, поэтому случаи, когда переменная была найдена в стеке сразу же, и когда она была найдена после пропуска нескольких неподходящих, занимают несколько разное время. Иными словами, переменные, объявленные позже, будут найдены при обращении быстрее. Разница во времени достаточно мала, однако в синтетическом тесте, показанном ниже, она весьма заметна:
[[image:Var_Example.png|thumb|right|Пример выполнения кода с результатами [[Встроенный профайлер|профилирования]]]]
<pre>
Var a1,a2,a3,a4,a5,a6,a7,a8,a9,a10;

ProfilerClear();
ProfilerStart();
For i:=1 to 1000000 Do
a1:=0;
EndDo;
For i:=1 to 1000000 Do
a10:=0;
EndDo;
ProfilerStop();
DebugBreak;
Message("Done!");
</pre>

==== Конструкция логического блока ====
::<code>Begin</code>
::<code>  <логический блок></code>
::<code>End;</code>
Конструкция имеет декоративную функцию.

==== Конструкция проверки выражения ====
::<code>If <выражение> Then</code>
::<code>  <логический блок></code>
::<code>[ElseIf <выражение> Then</code>
::<code>  <логический блок>]</code>
::<code>[Else</code>
::<code>  <логический блок>]</code>
::<code>EndIf;</code>
Конструкция служит для логического выполнения инструкций в зависимости от результатов вычисления выражений. Если выполнение выражения возвращает логическую единицу (см. ниже), будет исполнен блок, идущий после оператора <code>Then</code>, иначе будет осуществлена новая проверка (если используется оператор <code>ElseIf</code>, который может повторяться требуемое количество раз), будет произведено безусловное исполнение блока (если используется оператор <code>Else</code>), либо интерпретатор перейдет к последующим инструкциям программы (если используется оператор <code>EndIf</code>). Наличие оператора <code>EndIf</code> обязательно, как метки окончания конструкции.
==== Конструкция переключателя (case) ====
{{planned}}

==== Конструкция цикла с предусловием ====
::<code>While <выражение> Do</code>
::<code>  <логический блок></code>
::<code>EndDo;</code>
Конструкция создает цикл, выполняя блок инструкций, пока выражение возвращает правду. Если выражение возвратит ложь при первом вызове, блок инструкций не будет выполнен ни разу.

==== Конструкция цикла "пока" с постусловием ====
::<code>Repeat</code>
::<code>  <логический блок></code>
::<code>DoWhile <выражение>;</code>
Конструкция создает цикл, выполняя блок инструкций, пока выражение возвращает правду. Проверка выражения осуществляется после выполнения блока инструкций, поэтому последний будет выполнен по крайней мере один раз.

==== Конструкция цикла "пока не" с постусловием ====
::<code>Repeat</code>
::<code>  <логический блок></code>
::<code>Until <выражение>;</code>
Конструкция создает цикл, выполняя блок инструкций до тех пор, пока выражение не возвратит правду, после чего выполнение прекратится. Проверка выражения осуществляется после выполнения блока инструкций, поэтому последний будет выполнен по крайней мере один раз.

==== Конструкция цикла с перечислением ====
::<code>For <переменная>:=<выражение> {To,Downto} <выражение> Do</code>
::<code>  <логический блок></code>
::<code>EndDo;</code>
Конструкция создает цикл, инициализируя переменную вычисленным значением первого выражения. В зависимости от использования ключевого слова '''To''' или ключевого слова '''DownTo''':
* (ключевое слово '''To''') Блок инструкций выполняется до тех пор, пока значение переменной не будет больше вычисленного значения второго выражения. После выполнения блока инструкций, переменная увеличивается на единицу.
* (ключевое слово '''DownTo''') Блок инструкций выполняется до тех пор, пока значение переменной не будет меньше вычисленного значения второго выражения. После выполнения блока инструкций, переменная уменьшается на единицу.
Если значение переменной, при вычислении ее начального значения, сразу же будет удовлетворять условию окончания цикла, блок инструкций не будет выполнен ни разу. Такие циклы выполняются быстрее, чем циклы ''While'' или ''Repeat'', когда необходимо выполнить цикл известное заранее число раз, так как система не вычисляет значение второго выражение после каждого оборота цикла.

==== Конструкция прерывания цикла ====
::<code>Break [<выражение>];</code>
Конструкция прерывает выполнение любого из циклов любого уровня вложенности и продолжает его с первой инструкции вне прерываемого цикла. Каждый цикл имеет блок (набор) инструкций, выполняющийся внутри него определенное количество раз. Эти инструкции выполняются в цикле первого уровня. Если внутри цикла имеется второй цикл (любого вида, будь-то '''For''' или '''While''', в этом случае не имеет значения), инструкции внутри его выполняются в цикле второго уровня. Вложенность циклов неограниченна. Иногда требуется прервать выполнение цикла на определенном этапе и продолжить выполнение программы, как будто цикл был завершен. Для этого существует конструкция '''Break'''. Дополнительный необязательный аргумент конструкции позволяет прервать определенное количество уровней цикла (т.е., буквально выйти из ''n'' уровня цикла на ''p''), встречаются ситуации, когда подобный подход сильно сокращает сложность программы. Пример использования '''Break <Аргумент>''':
<pre>
Сокет:=0;
ПопыткиМин:=60*1000;					//Максимальное время, которое можно затратить на попытки соединения (60 с.)
НачВремя:=Date();
While GetPeriodMs(НачВремя)<=ПопыткиМин Do
СрвНом:=0;
While СрвНом<СпСервер.Size() Do			//Осуществляется проход по всем серверам из списка и попытка соединения последовательно с каждым
СрвНом:=СрвНом+1;
Сервер:=СпСервер.Get(СрвНом);
Сокет:=TCPConnection.ConnectRaw(Сервер);
If Сокет.isConnected() Then				//Когда соединение установлено успешно, продолжим работу, прервав оба цикла
Break 2;
EndIf;
EndDo;
EndDo;
...
</pre>

==== Конструкция прерывания цикла с продолжением ====
::<code>Continue [<выражение>];</code>
Конструкция прерывает выполнение любого из циклов любого уровня вложенности и продолжает его с первой инструкции самого внешнего цикла (см. описание '''Break''' для понимания терминов, типа уровня цикла). Иногда требуется прервать выполнение цикла на определенном этапе и перейти в его начало, как будто цикл совершил целый оборот. Для этого существует конструкция '''Continue'''. Дополнительный необязательный аргумент конструкции позволяет прервать определенное количество уровней цикла (т.е., буквально выйти из ''n'' уровня цикла на ''p'') и "продолжить" выполнение на самом внешнем уровне. Таким образом '''Continue''' без аргументов просто переходит в начало цикла. Для циклов '''For''' и '''While''' конструкция переходит к условию, которое может прервать выполнение цикла, для циклов '''Repeat''', у которых условие находится в конце цикла, будет гарантировано начато новое выполнение цикла. Пример использования '''Continue''':
<pre>
//Тб -- таблица с документами для выгрузки
Тб.Select();
While Тб.Next() Do
If Тб.Статус=1 Then
Continue;						//Пропускаем строки таблицы со столбиком Статус, равным 1
EndIf;
зДок:=Тб.Документ;					//Получаем документ из таблицы
aTab:=зДок.LineParts("Номенклатура");
aTab.Select();
While aTab.Next() Do					//Производим проверку строк документа
зН:=aTab.Номенклатура;
If зН.флАлкогольнаяПродукция=0 Then			//Проверяем только строки с алкогольной продукцией
Continue;						//Если это продукция другого типа, переходим к следующей строке
EndIf;
If aTab.Партия.Selected()=0 Then			//Во всех проверяемых строках, должен быть заполнен реквизит "Партия"
Message("В документе "+зДок+" не указана партия для номенклатуры "+зН+" ("+зН.Code+")!","!");
Continue 2;					//Данный документ содержит неверные строки, пропустим его и перейдем к следующему документу (в начало первого цикла While)
EndIf;
EndDo;

...							//Выполним необходимую работу по выгрузке документа зДок

EndDo;
</pre>

==== Конструкция выхода с параметрами ====
::<code>Exit [<выражение результата>[,<выражение количества уровней>]];</code>
Конструкция прерывает выполнение любой [[#Функции и процедуры|функции]] любого уровня вложенности и, выборочно изменяет значение '''Result''' (переменная значения возврата из функции). По окончании прерывания выполнение программы продолжается непосредственно после вызова функции, используя значение, которое она возвращает или игнорируя его, если функция вызывается, как обычная инструкция. При вызове любой функции, в начале выполнения ее кода, к внутреннему счетчику вложенности функции добавляется единица. Счетчик, однако, всегда равен нулю в начале загрузки нового модуля (см. '''[[LoadModule]]'''). Важная функция Exit не только в окончании выполнения функции в нужный момент, но и в возвращении ее значения. Для каждой функции возвращаемое значение хранится в переменной ''Result'', которая доступна как для записи, так и для чтения в любой момент в пределах текущего уровня функции. Изменение этой переменной перед окончанием функции или выходом из нее возможно, но '''Exit <выражение>''' позволяет это сделать быстрее, и при этом упростить исходный код. Иногда встречаются ситуации, когда удобно выйти сразу из нескольких функций (в таких случаях, обычно в системах без возможностей, которыми обладает '''Exit''' в данной системе, создаются исключения '''Raise''' с тем, чтобы отловить их на нужном уровне, однако, такой подход может быть неудобен из-за вероятности реальных исключений), для этого и необходим второй аргумент, определяющий количество функций, из которых необходимо выйти. Нужно иметь в виду, однако, что за пределы загруженного модуля конструкция '''Exit''' выйти не сможет. В роли функции могут выступать не только обычные определяемые функции, но и контейнеры событий форм или триггеры метаданных и пр. Пример использования '''Exit''':
<pre>
//Функция возвращает 0, если заполнение выполнено не полностью, текст ошибки в стрОшибка
Function ПроверитьПолнотуЗаполнения(зК,ByRef стрОшибка)
Function ПроверитьРеквизит(Стр,Имя)
If IsEmpty(Стр) Then
стрОшибка:="Не заполнен реквизит "+Имя+"!";
Exit 0,2;
EndIf;
EndFunction

стрОшибка:="";
Result:=0;						//Мы не сможем изменить Result этого уровня из вложенной функции
ПроверитьРеквизит(зК.Name,"наименование");
ПроверитьРеквизит(зК.ИНН,"ИНН");
ПроверитьРеквизит(зК.ЮрАдрес,"юридический адрес");
ПроверитьРеквизит(зК.ФактАдрес,"фактический адрес");
Result:=1;
EndFunction
</pre>

==== Конструкция отлова исключения ====
::<code>Try</code>
::<code>  <логический блок></code>
::<code>Except</code>
::<code>  <логический блок></code>
::<code>EndTry;</code>
Конструкция позволяет обнаружить и подавить возникновение [[#Исключения|исключения]] внутри первого блока инструкций, при возникновении исключения, будет выполнен второй блок инструкций. Если же исключение не возникло, второй блок инструкций будет пропущен. Исключение будет подавлено после выполнения второго блока инструкций, дальнейшее исполнение будет продолжаться, как будто исключительная ситуация никогда не возникала. При возникновении исключения, внутри второго блока инструкций можно использовать функции типа '''[[PopError]]''' или '''[[PeekError]]''', чтобы выяснить, какого рода исключение было отловлено, также, при необходимости, можно вызвать новое исключение (к примеру, с помощью конструкции '''Raise'''. Выполнение второго блока инструкций также разрешается прерывать с помощью конструкций типа '''Break''', '''Continue''' или '''Exit'''. Конструкция будет выполнена даже если пользователь [[Общая информация о консольном и визуальном клиентах#Интерфейс и визуальных клиентов|прервал]] выполнение программы, однако, конструкция не сможет подавить исключение, созданное при попытке пользователя прервать выполнение (сразу после выполнения блока ''Except'' данное исключение будет вызвано снова, таким образом гарантируется, что рано или поздно исполнение программы будет прервано, однако, также гарантируется выполнение необходимых действий до завершения выполнения).

==== Конструкция гарантированного выполнения ====
::<code>Try</code>
::<code>  <логический блок></code>
::<code>Finally</code>
::<code>  <логический блок></code>
::<code>EndTry;</code>
Конструкция позволяет выполнить второй блок инструкций вне зависимости от того, произошло ли исключение в первом блоке инструкций, также гарантируется исполнение, если в первом блоке были вызваны команды прерывания '''Continue''', '''Break''' или команда возврата '''Exit'''. При наличии, исключение не будет подавлено после выполнения второго блока инструкций, и дальнейшее исполнение будет прервано, как будто исключение возникло сразу же за последней инструкцией второго блока (это поведение можно изменить, если вызвать функцию '''[[SuppressException]]''' внутри блока ''Finally''). При возникновении исключения, внутри второго блока инструкций можно использовать функции типа '''[[PopError]]''' или '''[[PeekError]]''', чтобы выяснить, какого рода исключение было отловлено, однако, при использовании '''PopError''', информация об исключении будет удалена из стека исключений, и исключение возникнет без какой-либо информации к нему, поэтому, рекомендуется использовать только функцию '''PeekError'''. Конструкция будет выполнена даже если пользователь [[Общая информация о консольном и визуальном клиентах#Интерфейс и визуальных клиентов|прервал]] выполнение программы. Пример использования конструкции дан ниже:
<pre>
//aEl -- документ, который необходимо обработать
аПольз:="";аМаш:="";аВремя:="";
If aEl.Lock(аПольз,аМаш,аВремя)=0 Then
Message("Невозможно заблокировать документ, так как в данный момент с ним работает пользователь "+аПольз+" на "+аМаш+" в "+аВремя+"!","!");
Exit;
EndIf;
Фл:=0;
Try
aEl.Reload();						//Необходимо обновить содержимое aEl после блокирования, чтобы исключить вероятность устаревания информации
aEl.Publish();
Finally							//Вне зависимости, произошло ли исключение в строке aEl.Publish(), необходимо разблокировать документ.
If not isEmpty(PeekError(6)) Then
Message("Документ "+aEl+" невозможно обработать, причина: "+PopError(6),"!");//SuppressException() подавит исключение, поэтому, мы можем удалить информацию о нем из стека исключений
SuppressException();				//Подавить созданное исключение, Finally работает здесь частично, как Except
Фл:=1;						//Флаг того, что исключение произошло
EndIf;
aEl.Unlock();
EndTry;
If Фл Then
...							//Блок инструкций, исполняемый, если документ невозможно было обработать
EndIf;
</pre>
Синтетический пример, показывающий, что блок инструкций ''Finally'' выполняется даже при использовании прерывания исполнения или команды выхода.
<pre>
For i:=1 to 10 Do
Try
If i>7 Then
Exit;						//Для значения счетчика 8 будет произведен выход из цикла, цикл для значений 9 и 10 продолжен не будет
ElseIf i>3 Then
Continue;						//Для значений счетчика 4,5,6,7 тело цикла будет пропущено
EndIf;

Message("Тело цикла, счетчик="+i);

Finally
Message("Блок обяз. исполнения, счетчик="+i);
EndTry;
EndDo;
</pre>
Результатом исполнения будет вывод (обратите внимание, что несмотря на конструкции ''Continue'' и ''Exit'', блок ''Finally'' все равно выполняется, при значении счетчика 8 цикл будет окончен):
<pre>
Тело цикла, счетчик=1
Блок обяз. исполнения, счетчик=1
Тело цикла, счетчик=2
Блок обяз. исполнения, счетчик=2
Тело цикла, счетчик=3
Блок обяз. исполнения, счетчик=3
Блок обяз. исполнения, счетчик=4
Блок обяз. исполнения, счетчик=5
Блок обяз. исполнения, счетчик=6
Блок обяз. исполнения, счетчик=7
Блок обяз. исполнения, счетчик=8
</pre>

==== Конструкция создания исключения ====
::<code>Raise [<выражение>];</code>
Конструкция позволяет создать пользовательское исключение с описанием '''<выражение>'''. Поведение созданного исключения будет аналогичным обычному исключению. Общая информация об исключении будет представлена строкой '''"User defined error"''' (см. описание функции '''[[PopError]]'''). Иногда необходимо создать исключение, чтобы прервать выполнение после получения для этого веского основания. К примеру, если запись документа подразумевает обработку нескольких подчиненных документов и обработать их не удалось из-за того, что один из них был заблокирован другим пользователем, можно создать исключение, чтобы гарантированно прервать исполнение, как будто оно произошло на программном уровне при записи (см. пример). ''Raise'' также можно использовать, чтобы создать исключение заново внутри блока '''Except''' (к примеру: <Code>Raise PopError();</Code>).
<pre>
//Мы находимся в функции OnSave, которая вызывается при записи документа (aEl), процедура должна осуществить вызов aEl.Save(); самостоятельно
//aList -- список документов, которые необходимо обработать при записи текущего (aEl)
Try
СтрОш:="";
For i:=1 To aList.Size() Do
зДок:=aList.Get(i);
аПольз:="";аМаш:="";аВремя:="";
If зДок.Lock(аПольз,аМаш,аВремя)=0 Then
СтрОш:="Невозможно заблокировать документ "+зДок+", так как в данный момент с ним работает пользователь "+аПольз+" на "+аМаш+" в "+аВремя+"!","!");
Break;
EndIf;
EndDo;
If СтрОш<>"" Then
Raise СтрОш;
EndIf;
...							//Обработка заблокированных документов (блок опущен для читабельности)
aEl.Save();						//Вызов этой функции также может создать исключение, поэтому предыдущий Raise будет обработан таким же образом,
							//как было бы обработано такое исключение
Finally
aList.MassUnlock();
EndTry;
</pre>

==== Конструкция объявления функции ====
::<code>Function <имя>([[<способ адресации> ]<имя аргумента>[=<выражение>][,..]]) [Export] {Forward,</code>
::<code>  <логический блок></code>
::<code>EndFunction};</code>
Конструкция позволяет определить функцию с именем <имя> и заданным количеством аргументов, а также закрепляет за ней логический блок инструкций. В этом блоке инструкций допускается определения вложенных функций, таким образом создается иерархия функций с разным уровнем вложения. В некоторых случаях вложенные функции позволяют упростить написание программы и сделать ее более читабельной и понятной.
Имя функции не зависит от регистра написания, при его написании могут быть использованы международные символы (к примеру ''関数''), но должно подчиняться следующим правилам:
* не должно совпадать с именем другой функции, находящейся на том же уровне вложенности в блоке инструкций одной функции или одного модуля, либо функции, имеющей префикс '''Export''', находящейся на верхних уровнях вложенности.
* не должно совпадать с именем переменной, если она была задана до определения функции на том же самом уровне вложенности в блоке инструкций одной функции или одного модуля, либо переменной, имеющей префикс '''Export''', находящейся на верхних уровнях вложенности.
* не должно совпадать с определениями, используемыми в особых конструкциях (к примеру, запрещено создавать функции с именем '''To''' или '''Function''') и вычисляемых выражениях (к примеру, '''And''').
* не должно содержать нелитерных и нецифровых знаков. Знаки, которые могут быть использованы в имени функций: "0".."9", "?", "A".."Z", "_", "a".."z", все символы с кодами >=128.
===== Аргументы функции =====
Функция может иметь неограниченное количество аргументов. Свойствами каждого из аргументов являются его имя, способ его адресации и наличие выражения по умолчанию. Имена аргументов подчиняются таким же правилам, как и имена функций. В момент исполнения блока инструкций функции каждый из аргументов может быть адресован по имени, как обычная переменная. Имена аргументов попадают в стек имен последними, при исполнении функции, поэтому, если какое-то имя совпадает с именем переменной с префиксом '''Export''', более высокого уровня вложенности, при обращение к имени будет использован аргумент, а не указанная переменная. Во время вызова функции, к аргументам можно обращаться в функциях более низкого уровня вложенности того же самого модуля (т.е. функция, вызываемая, к примеру, из глобального модуля, не будет видеть аргумент вызывающей функции, находящейся в другом модуле). Иными словами, аргументы функции более высокого уровня вложенности будут доступны только в функциях, вложенных в нее. Агрументы функций можно сделать видимыми из вызываемых функций любого уровня вложенности и любого модуля, если использовать префикс '''Export'''. В этом отношении, они будут подобны переменным с таким префиксом.
Способ адресации аргумента определяет возможность изменения внешней переменной или метода объекта из тела самой функции, а также видимость этого аргумента в вызываемых функциях. Существует два вида адресации аргументов. Оба можно использовать при задании аргументов одновременно (т.е. разрешены комбинации <code>ByRef Export</code>, <code>Export ByVal</code> и т.п.):
* Правила изменения аргумента-переменной. Можно использовать один из указанных префиксов:
** '''ByVal''', используемый по умолчанию, когда при изменении аргументов внутри функции, внешние переменные не будут изменены (однако, нужно учесть, что, если переменная содержит объект, то аргумент будет содержать тот же самый объект и изменения, производимые в объекте при его адресации с помощью аргумента, будут также видны при его адресации с помощью внешней переменной, пример см. ниже).
** '''ByRef''', при задании адресации таким способом, после окончания выполнения функции, переменная, использовавшаяся при вызове функции, будет обновлена значением аргумента. Важно понимать, что обновление значения переменных не происходит при каждом изменении аргумента, а только один раз после окончания выполнения функции (пример см. ниже)
* Видимость аргумента. По умолчанию аргумент будет обычным, если не задан префикс ''Export'':
** '''Export''' -- при поиске, к этому аргументу будут применяться такие же правила, как и к переменным с префиксом ''Export''.

При определении аргумента можно также использовать дополнительное выражение, называемое выражением по умолчанию. Если выражение по умолчанию определено, аргумент считается необязательным, его указание при вызове функции не требуется, к примеру для функции <code>Func</code> с аргументами <code>Func(a,b=1,c=2)</code> аргументы b и с можно опустить, при пропуске только переменной ''b'', можно осуществить вызов функции в виде, к примеру, <code>Func(1,,3)</code>, при пропуске только переменной ''c'', функцию можно вызвать, к примеру, <code>Func(1,2)</code>, при пропуске же обоих аргументов функцию можно вызвать просто как <code>Func(2)</code>. Выражение, указываемое при определении аргумента, будет использоваться для его инициализации при вызове функции без указания аргумента. Выражения могут быть как простыми константами, так как сложными выражениями с использованием математических, логических функций и даже вызовов других функций объявленных в тексте программы. В случаях сложных выражений их вычисление происходит в момент вызова функции при помещении аргументов в стек переменных до исполнения блока инструкций самой функции.
Синтетический пример, показывающий инициализацию и работу с функциями, содержащими разные типы аргументов:
<pre>
var ПерА export, ПерА2 export;

Function Функ1(ByRef ПерА,ByRef ПерБ=Sin(ПерА),ПерВ)

Function Функ2()					//Вложенная функция без аргументов
ПерА:=1;						//Здесь адресуется аргумент Функ1, а не внешняя переменная ПерА, заданная в начале текста
ПерА2:=2;						//Здесь адресуется внешняя переменная ПерА2, заданная с постфиксом Export
ПерБ:=3;						//Адресуется аргумент Функ1
ПерВ:=4;						//Адресуется аргумент Функ1
EndFunction

Message("Вызов осуществлен с аргументами: "+ПерА+", "+ПерБ+", "+ПерВ);
Функ2();
EndFunction;

ПерА:=1;
Функ1(0,0,0);						//Произойдет вывод "Вызов осуществлен с аргументами: 0, 0, 0"
Message(ПерА);						//Будет выведено число 1 (функция не изменяла эту переменную)
Message(ПерА2);						//Будет выведено число 2 (функция изменила эту переменную)
Пер1:=0;Пер2:=0;Пер3:=0;
Функ1(Пер1,Пер2,Пер3);					//Произойдет вывод "Вызов осуществлен с аргументами: 0, 0, 0"
Message(Пер1);						//Будет выведено число 1 (функция изменила эту переменную, при изменении аргумента)
Message(Пер2);						//Будет выведено число 3 (функция изменила эту переменную, при изменении аргумента)
Message(Пер3);						//Будет выведено число 0 (способ адресации аргумента не позволил транслировать его изменение на внешнюю переменную)
Функ1(1,,2);						//Произойдет вывод "Вызов осуществлен с аргументами: 1, 0.841470984807896508, 2"
//Замечание: аргумент ПерБ был инициализирован значением по умолчанию Sin(ПерА) (т.е. Sin(1))

aTab:=Tab.Create("Имя,Значение");			//Создание таблицы со столбцами "Имя" и "Значение"
aTab.AddLine("Имя,Значение","Первый",0);
Пер2:=0;
Функ1(aTab.Значение,(Пер2),0);				//Произойдет вывод "Вызов осуществлен с аргументами: 0, 0, 0"
Message(Пер2);						//Будет выведено число 0, так аргументом вызова функции была не переменная, а выражение "(Пер2)"
Message(aTab.Значение);					//Будет выведено число 0
//Изменения внутри функции транслируются только на переменные, но не на свойства объектов, так как это может создавать скрытые ошибки, которые тяжело будет найти:
// Изменение свойства, это не всегда просто сохранение значения, в случае с объектами базы данных это может быть нежелательно
</pre>

===== Результат функции =====
При вызове любой функции, после создания и заполнения ее аргументов, создается также особая переменная '''Result''', заполняемая пустым значением. Эта переменная будет возвращена как результат функции, однако, ее поведение соответствует поведению обычной переменной, ее можно изменять и использовать ее значение в любых выражениях. Если в результате выполнения функции нет необходимости, нет смысла использовать эту переменную. Значение этой переменной можно также изменить при использовании конструкции выхода '''Exit''', если у конструкции указан первый аргумент, он будет вычислен, и полученное значение будет помещено в переменную '''Result'''. Так как ''Result'' создается при вызове любой функции, у вложенной функции нет возможности обратиться напрямую к результату функции более высокого порядка вложенности. Пример использования '''Result''' см. ниже:
<pre>
Function Функ1(ПерА)
Result:=0;
If ПерА>1 Then
Result:=ПерА*2;
ElseIf ПерА<0 Then
Exit _Pi();
EndIf;
EndFunction;

Message(Функ1(-2));					//Возвращает 3.14159265358979325
Message(Функ1(2));					//Возвращает 4
Message(Функ1(1));					//Возвращает 0
</pre>

===== Вложенность функций и модулей, уровни вложенности =====
При создании нового потока, после его вызова (к примеру, с помощью '''[[LoadModule]]'''), счетчик вложенности циклов обнуляется, а счетчик вложенности функций приравнивается единице (см. выше, к примеру, конструкции ''Break'' и ''Exit''). Поэтому конструкция ''Exit'' не сможет завершить исполнение программ в предыдущем модуле, а конструкции ''Break'' и ''Continue'' не смогут передать управление программе, находящейся в другом модуле, даже если поток создавался из тела цикла. При вызове функции, счетчик вложенности циклов также обнуляется и, после возврата из функции, восстанавливается его предыдущее значение. Защита подобного рода помогает исключить ошибки, нахождение которых было бы затруднительно.
При объявлении функции в блоке исполнения другой функции, такая функция называется вложенной. В данной документации понятие ''функция более низкого уровня вложенности'' означает функцию, вложенную внутрь текущей, а ''функция более высокого уровня вложенности'', функцию, в которую была вложена текущая. Вложенные функции имеют доступ к локальным переменным и своим аргументам, к аргументам функций в которые они были вложены, а также к переменным и функциям более высокого уровня вложенности, если они определены с постфиксом '''Export''' (см. аргументы функции).
Следует понимать различие между термином уровни вложенности применительно к исходным текстам программы и к вызову функций из блоков инструкций других функций в процессе исполнения. В последнем случае, функция, к примеру, может вызывать сама себя определенное количество раз, создавая рекурсию. Правила доступности и адресуемости переменных и других функций, однако, применимы для процесса исполнения таким же образом, как и для процесса компиляции.
Ниже даны правила доступности переменных, аргументов и имен функций:
{|class="wikitable" width="100%"
|- style="background: #e0e0e0"
|rowspan=2 width=55% |'''Положение проверяемой функции (или модуля)'''
|colspan=3 |'''Доступность из блока инструкций исполняемой'''
|- style="background: #e0e0e0"
|width=15% |'''Аргументы'''
|width=15% |'''Переменные'''
|width=15% |'''Вложенные функции'''
|-
|Проверяемая функция вложена в исполняемую (с любым уровнем вложенности)
|Нет
|Нет
|Нет
|-
|Проверяемая функция является исполняемой
|Да
|Да
|Да
|-
|Исполняемая функция вложена в проверяемую (с любым уровнем вложенности).
|Да
|С постфиксом ''Export''
|На том же уровне вложенности, что и исполняемая, объявлены до исполняемой
|-
|Исполняемая функция вложена в функцию (с любым уровнем вложенности), в которую также вложена проверяемая (с любым уровнем вложенности). Исполняемая функция, однако, не вложена в проверяемую (с любым уровнем вложенности). См. пример ниже.
|Нет
|Нет
|Нет
|-
|Исполняемая функция вложена непосредственно в проверяемый модуль.
|Да
|С постфиксом ''Export''
|Объявлены до исполняемой, верхний уровень вложенности
|-
|Исполняемая функция вложена в модуль, который был вызван из проверяемого (с любым уровнем вложенности).
|Нет
|С постфиксом ''Export''
|С постфиксом ''Export'', верхний уровень вложенности
|-
|Проверяемый модуль является глобальным.
|Недоступно
|С постфиксом ''Export''
|С постфиксом ''Export'', верхний уровень вложенности
|}
<pre>
//Пример для случая №4:
Function ВерхнийУровень()
Function Проверяемая(АргументыПр)
Var ПеременныеПр Export;
Function ПроверяемаяПр() Export
EndFunction;
EndFunction;

Function Исполняемая()
//АргументыПр, ПеременныеПр и функция ПроверяемаяПр() не будут доступны из этого исполняемого блока
EndFunction;
EndFunction;
</pre>

===== Объявление заголовков функций =====
Иногда в процессе написания программы из определенной функции требуется вызвать функцию, которая была описана ниже по тексту, это может происходить, при создании сложной рекурсивной конструкции, либо, чтобы избежать переносов функций внутри модуля, особенно, когда они уже сгруппированы по определенному принципу. С точки зрения исполнения, такой вызов не должен представлять проблему, так как к началу исполнения все функции в модуле определены и известны системе. Однако, что касается компиляции программных текстов, возникает проблема того, что в момент вызова, компилятор еще не знает о существовании (определении) вызываемой функции, что вызовет ошибку компиляции (такой подход позволяет также избежать определенных ошибок при написании программ). Выходом из положения, в данном случае, является возможность объявления заголовка функции заранее без ее блока описания, после чего, в нужном месте модуля, функция будет описана полностью. При объявлении заголовка функции, после перечисления ее аргументов и возможного префикса '''Export''' следует зарезервированное слово '''Forward''', после чего объявление заголовка заканчивается. Сама функция, объявленная "в кредит" таким образом, должна присутствовать позже в том же самом модуле, иначе система вернет ошибку при компиляции. Пример использования '''Forward''':
<pre>
//Кусок кода, показывающий необходимость в сложной рекурсии. Элементы разных справочников ищутся по внешнему коду стрКод, в справочнике "СопоставленныеЭлементы"
//Функция ВыбратьЭлемент должна дать возможность пользователю визуально выбрать нужный элемент с учетом возможных родителей (см. описание справочников БД)

//Здесь описывает только заголовок рекурсивной функции
Function НайтиРодителя(ВидСпр,Префикс,стрКод,БезВыбора=0) Forward;

//Функция визуально выбирает элемент справочника ВидСпр, который и отдается, как результат
// Если пользователь не выбрал элемент, функция возвращает 0.
//стрКод -- код в промежуточном справочнике сопоставления "СопоставленныеЭлементы", имеет вид "<КодЭлемента>@<ВидРодителя>#<КодРодителяЭлемента>@<ВидРодителяРодителя>#<КодРодителяРодителяЭлемента>..."
Function ВыбратьЭлемент(ВидСпр,стрКод)
аРод:=0;				//Элемент родителя, если он необходим
if Struct.Ref(ВидСпр).Parents.Count()>0 Then
//Справочник имеет родителей, необходимо сначала осуществить выбор родителя
аРод:=НайтиРодителя(ВидСпр,стрКод);
If аРод=0 Then
Exit 0;
EndIf;
EndIf;

//Вызываем функцию визуального выбора и отдаем ей в первом параметре найденного родителя или 0, если родитель не требуется
аЭл:=SelectObject("Ref."+ВидСпр,аРод,0,"Module","SelectForm",,,"Выберите требуемый элемент справочника:",0);
Exit ?(not isEmpty(аЭл),аЭл,0);
EndFunction

Function НайтиРодителя(ВидСпр,стрКод,БезВыбора=0)
аЭл:=Ref.СопоставленныеЭлементы;	//Создаем объект элемента справочника СопоставленныеЭлементы
TearStr(стрКод,"@");			//Удаляем код текущего элемента, оставляем внешний код родителя и его вид
ВидРод:=TearStr(стрКод,"#");		//Находим вид родителя и оставляем только внешний код элемента-родителя
If аЭл.Find("ВидСправочника,ВнешнийКод",ВидРод,стрКод) Then
Exit аЭл.Элемент;			//Родитель уже сопоставлен, нет необходимости выбирать что-то визуально
ElseIf БезВыбора Then
Exit 0;				//Родитель не сопоставлен, но визуальный выбор запрещен
EndIf;
бЭл:=ВыбратьЭлемент(ВидРод,стрКод);	//Вызываем ВыбратьЭлемент уже для родителя
Exit бЭл;				//Если оператор отказался от выбора возвратится 0, иначе выбранный элемент
EndFunction

//Другая функция ниже по модулю, подбирающая возможные варианты выбора
Function ПодобратьВарианты(ВидСпр,Эл)
СпВар:=List.Create();
...
If ВидСпр="ПартииНоменклатуры" Then
аЭл:=НайтиРодителя(ВидСпр,Trim(Эл.ВнешнийКод),1);
If аЭл=0 Then
Exit СпВар;
EndIf;
...					//Заполняется СпВар с учетом выбранного родителя
EndIf;
...
EndFunction

</pre>

==== Использование синтаксиса массивов для доступа к значениям объектов ====
Система не имеет выделенной структуры массивов, так как существуют объекты (списки, таблицы, деревья), которые в полной мере могут заменить подобную структуру. Однако, доступ к элементам массивов с помощью квадратных скобок хорошо понятен, читабелен и может упростить код программы. Система использует подобный доступ к значениям избранных объектов, как будто доступ производится к элементам массивов. Так же, как и с обычными массивами, доступны как чтение, так и запись, вложенность индексов и текстовые индексы для определенных объектов. Получение значения с помощью синтаксиса массива выполняется в следующем виде: <code><Объект>[<Индекс 1>,...]</code>, конструкцию вызова массива можно повторять сколько угодно раз (пример, <code>aObj[1,2]["foo",1]</code>), изменение значения можно выполнить с помощью команды: <code><Объект>[<Индекс 1>,...]:=<Значение></code>. Если с помощью первого индекса в массиве программа получает элемент из списка значений по его индексу или наименованию, второй и последующий индексы массива будут применены к полученному элементу (и, если этот элемент не является подходящим объектом, к которому можно применить синтаксис массива, будет вызвано исключение). На данный момент синтаксис массивов применим к следующим объектам системы:
* Для '''строковых значений''' (переменная, содержащая [[Строки|строку]] в ANSI или UTF-16 кодировках) используется один индекс, указывающий на определенный символ строки. Нумерация символов начинается с единицы. Операция получения символа, аналогична выполнению функции [[Mid]]. При изменении символа, кроме строкового значения, можно также указывать числовое значение, оно будет использовано как код присваиваемого символа, это немного быстрее и может использоваться в случае, когда строка хранит бинарные данные.
* '''Список значений''' (List) использует один индекс массива, который может быть текстовым (в этом случае, выполняется операция аналогичная вызовам функций [[List.GetByName|GetByName]] или [[List.SetByName|SetByName]]), либо числовым (в этом случае, выполняется операция аналогичная вызовам функций [[List.Get|Get]] или [[List.Set|Set]]).
* '''Таблица значений''' (Tab) использует один или два индекса массива. Если задан всего один индекс массива, он используется как индекс или наименование столбца для получения или изменения значения ячейки таблицы в ее текущей строке (операции <code><Таблица>.<Имя столбца></code> или <code><Таблица>.Get(,<Индекс столбца>)</code>). Если задано более одного индекса массива, первый из индексов используется для указания на столбец таблицы, второй на ее строку (второй индекс может быть только числовым), т.е. выполняется операции <code><Таблица>.Get(<Индекс 2>,<Индекс 1>)</code> или <code><Таблица>.Set(<Индекс 2>,<Индекс 1>,<Значение>)</code>.
* '''Дерево значений''' (Tree) использует один или более индексов массива, индекс может быть текстовым (в этом случае, выполняется операция аналогичная вызовам функций [[Tree.GetByName|GetByName]] или [[Tree.SetByName|SetByName]]), либо числовым (в этом случае, выполняется операция аналогичная вызовам функций [[Tree.Get|Get]] или [[Tree.Set|Set]]). Если даны несколько индексов, все операции, кроме последней, получают не значение, а ветку (т.е., для промежуточных индексов используются операции, аналогичные функциям [[Tree.ByIndex|ByIndex]] или [[Tree.FindByName|FindByName]]).
* '''Текст''' (Text) использует один числовой индекс массива, который указывает на номер строки объекта текста (то есть, выполняется операция аналогичная вызовам функций [[Text.GetLine|GetLine]] или [[Text.SetString|SetString]]).
* '''Буфер''' (Buffer) использует один или два индекса массива. Первый индекс массива используется как позиция в буфере (первый байт буфера адресуется с нуля), второй аргумент массива, если указан, задает величину данных (доступны значения 1 (по умолчанию, байт без знака), 2 (слово без знака), 4 (двойное слово без знака), 8 или -8 (64-битное числовое значение со знаком), -1 (байт со знаком), -2 (слово со знаком), -4 (двойное слово со знаком)).
* '''Запись данных''' (MemoryRecord) использует индекс массива для доступа к полям, являющимся массивами. Индексирование начинается с нуля.

Скорость доступа к значениям объектов с помощью синтаксиса массивов обычно не отличается от скорости доступа с помощью обычных функций. Однако, если для доступа используется несколько индексов, адресующих разные объекты, массивы будут работать несколько быстрее.

==== Магические функции ====
Магическими называются функции, нестандартная работа с аргументами которых, не позволяет создать их обычными средствами языка. Для обычных функций каждый из аргументов вычисляется до того, как будет произведено обращение к функции, тогда как магические функции работают как конструкции языка с блоками инструкций, и вычисления аргументов производятся только когда это необходимо. В отличие от конструкций языка, однако, магические функции не могут представлять самостоятельные инструкции или содержать блоки инструкций, а используются только в выражениях и могут содержать только выражения в своих аргументах. Кроме описанных здесь магических функций, существуют и другие (к примеру, [[Coalesce]], [[InSet]], [[InRange]], [[If2|??]] и т.д.), они помечены как магические в описании и в списке функций. Эти функции, в отличие от описанных здесь, могут использоваться не только в выражениях, но и как самостоятельные инструкции (к примеру, <code>?(pos("code",Стр)>0,TearStr(Стр,"code"),TearStr(Стр,","));</code> вызовет ошибку без оператора присваивания, однако использование <code>??(pos("code",Стр)>0,TearStr(Стр,"code"),TearStr(Стр,","));</code> допустимо). {{Planned}} Все функции, описанные здесь, в будущем можно будет использовать, как самостоятельные инструкции.

===== Магическая функция логическое "и" =====
::<code>_And(<выражение>[,<выражение>[,...]])</code>
Функция возвращает результат логической конъюнкции своих аргументов. Вычисление аргументов останавливается, после того как встретится первый аргумент возвративший "ложь". В отличие от конструкции <code>(<выражение>)And(<выражение>)And...</code>, для которой всегда выполняются все выражения, так как она может являться как логической, так и математической, '''_And''' прекращает исполнение аргументов, как только встречается "ложь", это позволяет как оптимизировать по скорости условия конструкций типа '''If''', так и пройти каскадное условие доступности, для которого необходимо бы было использовать несколько вложенных функций '''If''', чтобы избежать исключения. Пример разницы между '''And''' и '''_And''' см. ниже:

<pre>
Function ВывестиАргумент(Арг)				//Функция возвращает переданный ей аргумент и выводит его в лог
Message(Арг);
Exit Арг;
EndFunction

//В лог будет выведено 1, 2 и 3. "Проверка пройдена!" выведена не будет.
If (ВывестиАргумент(1)<2)And(ВывестиАргумент(2)<2)And(ВывестиАргумент(3)<2) Then
Message("Проверка пройдена!");
EndIf;

//В лог будет выведено 1, 2. "Проверка пройдена!" выведена не будет. Функция ВывестиАргумент(3) не была вызвана
If _And(ВывестиАргумент(1)<2,ВывестиАргумент(2)<2,ВывестиАргумент(3)<2) Then
Message("Проверка пройдена!");
EndIf;

...

//аОбъект -- переменная, содержащая объект неопределенного вида или строковое выражение
//Нам необходимо проверить, является ли объект элементом справочника "Номенклатура" и, если его реквизит Тип равен единице, вывести в лог его код (реквизит Code)
аОбъект:="Не объект";

//Конструкция каскадной проверки, основанная на _And, не вызовет исключений
If _And(not isEmpty(аОбъект),IsDBObject(аОбъект),аОбъект.DBName()="Номенклатура",аОбъект.Тип=1) Then
Message(аОбъект.Code);
EndIf;

//Конструкция с аналогичным использованием And вызовет исключение при вычислении выражения аОбъект.DBName(), так как аОбъект не является объектом
If (not isEmpty(аОбъект))And(IsDBObject(аОбъект))And(аОбъект.DBName()="Номенклатура")And(аОбъект.Тип=1) Then
Message(аОбъект.Code);
EndIf;

//Конструкция каскадной проверки, логически совпадающая с первой, однако не использующая _And, тоже не будет вызывать исключений.
//Данная конструкция, однако, выполняется медленнее чем первая и более сложна для понимания.
If (not isEmpty(аОбъект))And(IsDBObject(аОбъект)) Then
If аОбъект.DBName()="Номенклатура" Then
If аОбъект.Тип=1 Then
Message(аОбъект.Code);
EndIf;
EndIf;
EndIf;
</pre>

===== Магическая функция логическое "или" =====
::<code>_Or(<выражение>[,<выражение>[,...]])</code>


Функция возвращает результат логической дизъюнкции своих аргументов. Вычисление аргументов останавливается, после того как встретится первый аргумент возвративший "правда". В отличие от конструкции <code>(<выражение>)Or(<выражение>)Or...</code>, для которой всегда выполняются все выражения, так как она может являться как логической, так и математической, '''_Or''' прекращает исполнение аргументов, как только встречается "правда", это позволяет как оптимизировать по скорости условия конструкций типа '''If''', так и превратить несколько условий прерывания исполнения в одно. См. также пример функции '''_And'''.

===== Магическая функция выбора =====
::<code>?(<выражение>,<выражение если правда>[,<выражение если ложь>])</code>
::<code>_If(<выражение>,<выражение если правда>[,<выражение если ложь>])</code>

Функция вычисляет первый аргумент, и, если результатом является логическая "правда", возвращает вычисленное выражение, следующее вторым аргументом, иначе возвращает вычисленное выражение, следующее третьим аргументом, если он указан или пустое значение, если третий аргумент не указан. Функция производит вычисление второго аргумента только в случае, если первый возвратил "правду", иначе второй аргумент не будет вычислен. Тоже самое касается третьего аргумента. Функция может использоваться как для быстрой проверки типов, для того, чтобы избежать исключений, так и вместо более громоздких конструкций '''If'''. Позволяет не только уменьшить размер кода, улучшить его читаемость, но также ускорить его исполнение. Записи '''?''' и '''_If''' равнозначны. См. также пример функции '''_And'''.

== Инструкция языка ==
Любая программа состоит из инструкций собираемых в блоки, использующиеся внутри функций или особых конструкций языка. Инструкции в одном блоке выполняются последовательно. Инструкции разделены между собой знаком ''';''' (точка с запятой) и могут быть двух типов:
# '''Инструкция исполнения'''. Инструкция представляет собой обращение к функции (функция не может быть магической), вычисляемые выражения могут быть только частью аргументов функции. Если функция возвращает какой-либо результат, он не будет использован. Общий вид инструкции: '''<ИмяФункции>'''{{Optional|(''<Аргумент 1>'',<Аргумент 2>,...)}};.
# '''Инструкция присваивания'''. Инструкция представляет собой вычисляемое выражение, значением которого обновляется значение переменной или свойства объекта. Между именем переменной и выражением используется знак присваивания ''':='''. Использование знака равенства ('''=''') в этом случае допускается, но не рекомендуется, так как это может ухудшить читаемость текста программы. Общий вид инструкции: '''<ИмяПеременнойИлиСвойства>''':='''<Выражение>''';.
Пример использования инструкций обоих типов:
<pre>
Message("12");				//Инструкция исполнения выводит в лог программы значение "12"
a:=1;					//Инструкция присваивания создает новую переменную a и присваивает ей значение 1
a:=Sin(a)*1.5-Cos(a/2)/_Pi*2;		//Инструкция присваивания изменяет значение переменной a в соответствии с результатом вычисления выражения
a:=Message("12");			//Каждая функция возвращает результат, функция Message возвращает пустой результат, который присваивается переменной а.
					//Данная инструкция, в отличие от самой первой в этом блоке, уже является инструкцией присваивания, при этом, она по-прежнему выводит строку "12"
Message("12")+1;			//Ошибочная инструкция, содержащая только выражение, компиляция будет остановлена
?(a=1,2,3);				//Ошибочная инструкция, магическая функция ? может использоваться только в выражениях, и не может быть самостоятельной инструкцией исполнения.
a:=?(a=1,2,3);				//Инструкция присваивания, с использованием магической функции в ее выражении не вызовет ошибки.
a:=a=1;					//Инструкция присваивания, результат логического выражения a=1 (0 или 1) присваивается переменной а
					//Данная инструкция показывает, почему пара ":=" при присваивании предпочтительна простому знаку "="
aTab.CurLine:=12;			//Инструкция присваивания записывает 12 в свойство CurLine объекта, задаваемого переменной aTab (в данном примере объект типа таблица)
</pre>

== Вычисляемые выражения и старшинство операций при вычислении ==

Вычисляемые выражения представляют собой математические или логические формулы с участием числовых, строковых или временных констант, заданных непосредственно в тексте программы, переменных, свойств объектов и функций, связанных между собой знаками или определениями операций и скобками. Простым примером вычисляемого выражения является математическое выражение (к примеру '''1+2'''). Математические знаки и определения операций в основном совпадают с операциями в других языках, общее количество используемых операций невелико (см. ниже). Выражения вычисляются всегда слева направо, даже с учетом приоритета операций и скобок. Функции, используемые в выражении, всегда будут вычислены последовательно без пропусков (см. пример ниже), однако правило может не работать для функций, использующихся в аргументах магических функций. Каждая операция имеет свой приоритет. Если внутри одного уровня скобок встречаются несколько последовательных операций, связывающих разные аргументы (операнды), результат вычисления выражения будет зависеть от приоритетности операций. Ниже дается список приоритетности и список возможных операций языка:
# '''(''', ''')''' -- скобки позволяют вычислять группы операций вместе, и являются самыми приоритетными знаками операций (хотя скобки это не операции в обычном смысле, они приведены в списке для полноты).
# '''NOT''' -- унарная логическая и математическая операция инвертирования
# '''SHL''', '''SHR''' -- бинарные операции математического сдвига
# '''AND''', '''OR''', '''XOR''' -- бинарные логические и математические операции ''и'', ''или'' и ''исключающего или''.
# '''*''', '''/''', '''\''', '''%''' ('''MOD''') -- бинарные математические операции ''умножения'', ''деления'', ''целочисленного деления'' и ''нахождения остатка от деления''
# '''+''', '''-''' -- бинарные математические операции ''сложения'' и ''вычитания'', а также унарные математические операции ''подтверждения знака'' и ''обращения знака''
# '''=''', '''<>''', '''<''', '''>''', '''<=''', '''>=''' -- бинарные логические операции ''равно'', ''не равно'', ''меньше'', ''больше'', ''меньше или равно'', ''больше или равно''
<pre>
//В данном примере показано, что вне зависимости от приоритета, функции в вычисляемых выражениях всегда вычисляются последовательно.
Function Проверка(Аргумент)
Message(Аргумент);
Exit Аргумент;
EndFunction;

a:=Проверка(1)+Проверка(2)*Проверка(3) shl Проверка(4);
//На экран будет выведена последовательность 1,2,3 и 4. С математической точки зрения, необходимо сначала вычислить выражение Проверка(3) shl Проверка(4),
// потом результат умножить на Проверка(2) и сложить с Проверка(1).

a:=((Проверка(1)=0)And(Проверка(2)=0)And(Проверка(3)=0))Or(Проверка(4)=0);
//На экран будет выведена последовательность 1,2,3 и 4. С логической точки зрения, достаточно произвести вычисление Проверка(1)=0, чтобы понять, что проверки Проверка(2)=0 и Проверка(3)=0
// можно пропустить, получив значение "ложь", после этого нужно будет вычислить значение Проверка(4)=0.
</pre>

==== Логические выражения ====
Булева функция может принимать два значения "ложь" и "правда". Любое логическое выражение оперирует и возвращает одно из двух возможных значений булевой функции. В системе, однако, нет выделенного булевого типа, вместо него используется обычный целочисленный тип. При логической проверке конструкциями '''If''', '''While''' и пр. или магическими функциями '''?''', '''_And''' и пр. и везде, где должен быть указан булевый аргумент, в системе используется целочисленный. Значение этого аргумента будет являться "правдой", если его младший бит установлен, и "ложью", если его младший бит сброшен. В таком представлении любые целочисленные логические функции, типа '''And''', '''Or''', '''Xor''' будут также работать с логическими аргументами, надобность в дополнительном типе данных пропадает, программирование системы упрощается. Ниже даны несколько примеров работы с логическими функциями в системе:
<pre>
If 1 Then
Message("Этот текст всегда будет выведен, так как 1 соответствует логическому значению 'правда'");
EndIf;

Message(1>2);				//Выводит число 0 ("ложь")
Message(3>=2);				//Выводит число 1 ("правда")
Message((Sin(1))Or(2)Or(2>1));		//Бессмысленное выражение, смешивающее вещественные числа, целочисленную логику и булеву логику,
					//вычисление которого, между тем, не приводит к ошибке (в лог выводится число 3).
Message(Sqrt(20) And 65535);		//При операциях с целочисленной логикой, вещественные числа приводятся к целым (отбрасывается дробная часть), это выражение выведет 4.

//В данном примере на экран выводится стиль шрифта элемента формы с именем "Поле". Свойство FontStyle отдает число, представляющее битовую маску с битами:
// 1 -- жирный, 2 -- наклонный, 3 -- подчеркнутый, 4 -- зачеркнутый. Пример пользуется тем, что логические функции учитывают только младший бит числа.
аСтиль:=Form.ControlByName("Поле").FontStyle;
Message("Стиль элемента ""Поле"": "+?(аСтиль,"жирный ")+?(аСтиль\2,"наклонный ")+?(аСтиль\4,"подчеркнутый ")+?(аСтиль\8,"зачеркнутый "));
</pre>

== Константы в исходных текстах ==
При написании исходных текстов часто приходится использовать заранее известные значения -- числа, строки или даты. Данные значения называются константами. При компиляции текста, они превращаются в нужный тип данных и сохраняются в компилированном файле с тем, чтобы позже, использоваться при исполнении выражений. Способ задания констант в исходных текстах программы следующий:
* '''Числа''' (вещественные или целые) записываются в стандартной математической форме, кроме десятичных констант система позволяет записывать числа в шестнадцатеричной, восьмеричной и двоичной системах исчисления. Принимаются следующие форматы записи чисел:
# <code>{+,-}*[E{+,-}*]</code> (где ''*'' заменяет любое количество знаков ''0''..''9'') -- используется для записи десятичных целых или вещественных чисел. Число может содержать только следующие знаки ''+'',''-'',''0''..''9'',''.'',''E'' (или ''e'', используется для указания мантиссы вещественных чисел). Разделителем целой и вещественной части служит ''точка'' ('''.'''). Примеры: <code>1.23</code>, <code>1000000000000</code>, <code>1.73E+100</code>.
# <code>$*</code> или <code>0x*</code> (где ''*'' заменяет любое количество знаков ''0''..''9'', ''a''..''f'') -- используется для записи шестнадцатеричных целых чисел. Число может содержать только следующие знаки ''0''..''9'',''x'',''X'',''a''..''f'',''A''..''F''. Ввод вещественных чисел в шестнадцатеричной нотации не допускается. Примеры: <code>$fffaa</code>, <code>0x76AB</code>.
# <code>0o*</code> (где ''*'' заменяет любое количество знаков ''0''..''7'') -- используется для записи восьмеричных целых чисел. Число может содержать только следующие знаки ''0''..''7'',''o'',''O''. Ввод вещественных чисел в восьмеричной нотации не допускается. Примеры: <code>0o7601</code>.
# <code>0b*</code> (где ''*'' заменяет любое количество знаков ''0''..''1'') -- используется для записи двоичных целых чисел. Число может содержать только следующие знаки ''0''..''1'',''b'',''B''. Ввод вещественных чисел в двоичной нотации не допускается. Примеры: <code>0b11010001</code>.
* '''Строки''' всегда заключены в ''двойные кавычки'' ('''"'''). Для того, чтобы добавить двойную кавычку в строку, ее нужно употребить два раза. К примеру, выражение <code>"Строка ""в кавычках"""</code> представляет с собой строку ''Строка "в кавычках"''. Строковая константа всегда должна быть закончена до окончания строки, если необходимо добавить в строку перевод строки, можно использовать [[константы|именованную константу]] '''_NEWLINE'''. Однако, можно также указать в начале следующей строки символ конкатенации строковых констант '''|'''. В этом случае, компилятор продолжит набор строковой константы со следующей строки, а вместо символа '''|''' будет добавлен знак перевода строки. Пример показан ниже:
<pre>
ТЗ:="Period From НачДата to КонДата;
|зБс:=Storage.Банк.БанковскийСчет;
|зЮЛ:=Storage.Банк.ЮрЛицо;
|зСмП:=Income(Сумма);
|зСмР:=Expense(Сумма);
|зСмНО:=BegTotals(Сумма);
|зСмКО:=EndTotals(Сумма);
|Condition(NOT IsEmpty(зЮЛ));";
//В данном примере создается длинная строковая константа, располагающаяся на нескольких строках, вместо знаков | будет добавлен перевод строки.
//Важно понимать, что внутри строк до их завершения невозможно использовать комментарии. Пример:
а:="Некая строка //Данный текст не является комментарием, а будет частью строковой константы
|Другая строка";

а:="Некая строка"+_NEWLINE+ //Данный уже будет являться комментарием
"Другая строка";
</pre>
* '''Константы даты и времени''' всегда заключены в ''апострофы'' ('''<nowiki>'</nowiki>'''). Понимаются следующие форматы записи даты и времени:
# <code>[Д]Д.[М]М.ГГ[ГГ][ [Ч]Ч:[М]М[:[С]С]]</code> -- Стандартный формат записи. Примеры: <code>'10.12.2012'</code>, <code>'31.01.2020 12:00'</code>, <code>'3.6.25 4:12:11'</code>
# <code>[М]М/[Д]Д/ГГ[ГГ][ [Ч]Ч:[М]М[:[С]С]]</code> -- Американский формат, разделителем является знак '''/'''. Время по-прежнему задается в 24-х часовом формате. Примеры: <code>'12/10/2012'</code>, <code>'01/31/2020 12:00'</code>, <code>'6/3/25 4:12:11'</code>
# <code>[Д]Д-[М]М-ГГ[ГГ][ [Ч]Ч:[М]М[:[С]С]]</code> -- Стандартный формат с разделителем '''-'''. Примеры: <code>'10-12-2012'</code>, <code>'31-01-2020 12:00'</code>, <code>'3-6-25 4:12:11'</code>
При попытке использовать другие форматы в тексте исходного кода, компиляция будет остановлена с ошибкой. Если при указании даты временная часть опускается, она считается равной 00:00:00. Если при указании временной части, секундная часть опускается, она считается равной нулю секунд.

== Исключения ==
Исключения могут возникать в моменты ошибочных ситуаций в программах, а могут быть вызваны специально, как прием прерывания выполнения, когда условия не удовлетворяют проверке и продолжение исполнения невозможно. Большинство функций способны вызвать исключение, если, к примеру, они получают в своих аргументах неожиданные или неверные значения (слишком большое число, индекс, выходящих за пределы списка или таблицы и пр.) -- такие исключения сигнализируют об ошибках в написании кода программы, возможны также исключения из-за внешних событий (к примеру, отсутствие файла или его некорректный формат) -- такие исключения невозможно предугадать, поэтому разработчик должен предусмотреть и запрограммировать реакцию программы при их возникновении. Поведением по умолчанию при возникновении исключения является остановка программы на текущей инструкции, текущий модуль, при этом, закрыт не будет (кроме ситуаций, когда исключение возникло в предопределенном событии '''OnOpen''' или в момент исполнения события формы '''OnOpen'''), управление будет отдано пользователю.
Важно понимать, что в данном тексте под исключениями понимаются внутренние события, возникающие на уровне языка. Системные исключения, сигнализирующие ошибки внутри операционной системы или внешние катастрофические события, не затрагиваются этой темой, см. статью "[[Исключения в программе и отладка исключений]]".
Разнообразные конструкции и функции системы помогают настроить работу с исключениями, как это необходимо разработчику. В данный список входят функции и конструкции, которые:
* Изменяют поведение системы по умолчанию при возникновении исключений: конструкции '''Try/Except''', '''Try/Finally''' (описание см. выше)
* Вызывают или подавляют исключения: конструкция '''Raise''' (см. выше), функции '''[[SuppressException]]''', '''[[Assert]]''', '''[[Reraise]]'''.
* Получают информацию по возникшим исключениям: функции '''[[PopError]]''', '''[[PeekError]]'''.
* Получают информацию по стеку исполнения программы: функция '''[[dbgStackTrace]]'''.

== Типы данных, объекты и обращение к ним ==
Каждая переменная в системе содержит какой-либо объект. Объекты разделяются на сложные и простые. Простые объекты (пустое значение, числа, даты, строки) всегда копируются при копировании переменной в другую переменную (<code>a:=b;</code>), а также при передаче переменных в виде аргументов в функцию (т.е., изменение аргумента функции не вызовут изменение внешней переменной, даже если для аргумента использован префикс '''ByRef''', однако, в последнем случае, изменение будет скопировано в назад переменную после окончания выполнения функции). Сложные объекты (количество которых может варьироваться в зависимости от подключения внешних библиотек, сборки системы и пр.) не хранятся непосредственно в переменных, а представлены ссылками. При копировании содержания переменной, или передаче ее в виде аргумента в тело функции, в новой переменной создается дополнительная ссылка на сложный объект (и его внутренний счетчик ссылок увеличивается на единицу). См. также статью [[Объекты]].
Каждый сложный объект принадлежит определенному набору функций и свойств, называемому ''интерфейсом''. Интерфейсы имеют свои имена и к ним можно обращаться, однако, обычно не несут важной функции, кроме как создание новых объектов из них (однако, есть исключения). Интерфейс можно себе представить как трафарет, а объект, как рисунок, полученный с помощью этого трафарета. Интерфейсы не содержат реальных данных, это программный набор функций, он не занимает в памяти дополнительного места. Как только создается объект, в памяти отводится определенное место под его данные (разное для разных объектов), при этом, используя этот созданный объект, можно вызывать функции его интерфейса, чтобы модифицировать его и производить манипуляцию данными с помощью его свойств. Любое обращение к внутренним возможностям объектов и интерфейсов происходит с помощью разделителя . (точка) за которым следует наименование функции или свойства. Некоторые функции или свойства объектов могут возвратить новый (или существовавший ранее) объект. В этом случае, разделитель можно применить повторно, чтобы обратиться к функциям возвращаемого объекта. Таким образом можно создавать конструкции каскадных обращений к объектам с помощью разделителей, которые могли иначе бы занять много строк текста. К примеру, строка <code>аИмя:=Ref.тмцНоменклатура.Find("Code","000000001355").Name</code>, начинается с обращения к интерфейсу Ref, далее созданию [[Объект базы данных|объекта базы данных]] с типом ''справочник тмцНоменклатура'', затем для свежесозданного объекта вызывается функция '''Find''', которая заполняет объект реальным значением из базы данных, после чего находится свойство с именем реквизита базы данных ''Name'', оно и присваивается переменной ''аИмя''.
Интерфейсы (и их объекты) обычно содержат следующие элементы, с помощью которых можно обращаться к ним:
* '''Функция создания нового объекта'''. Вызывается непосредственно из интерфейса. Обычно она называется '''Create''', но может иметь и другие названия, таких функций может быть множество, иногда она может отсутствовать. Зачастую такие функции также можно вызвать из объектов, что, в прочем, не имеет особого смысла (к примеру, <code>aList:=List.Create(1,2,3);bList:=aList.Create();</code> ''bList'' создан вызовом из объекта, а не интерфейса, как это обычно бывает). Замечание: наличие функции удаления объекта не требуется, так как он удаляется автоматически системой, после того, как удалены все его ссылки.
* '''Функции, вызываемые непосредственно из интерфейса''' (включая функции создания новых объектов). Большинство функций интерфейса могут быть вызваны только из объекта, так как им необходимы данные, которые могут ассоциироваться только с объектами, однако, существуют абстрактные функции, которые можно вызывать непосредственно из интерфейса, а есть и такие, которые работают только в совокупности с интерфейсом и не будут работать в объекте.
* '''Свойства объекта'''. Свойства предоставляют доступ к внутренним данным объекта, в отличие от функций обычно не имеют аргументов и часто существует возможность их изменения, т.е., употребления свойства с левой стороны инструкции присваивания (к примеру, <code>aTab.CurLine:=12</code>, ''CurLine'' здесь является свойством объекта ''aTab'' с интерфейсом ''[[Таблица|Tab]]''). Присвоение значений функциям не имеет смысла.
* '''Функции объекта'''. Все остальные функции, перечисленные в интерфейсе и доступные для использования в его объектах.

== Компиляция и способ хранения текстов ==
Исходные тексты программы хранятся не только в модулях системы (отдельных текстовых файлах, специально предназначенных для хранения таких текстов), но также могут быть привязаны к данным другого вида, в последнем случае, они являются событиями или триггерами. Исполнения программ только из модулей недостаточно, чтобы удобно описать взаимодействие пользователя с пользовательским интерфейсом или некоторых объектов базы данных и основной программы, поэтому тексты программ приходится привязывать к визуальным объектам, чтобы, к примеру, выполнить какое-либо действие после того, как пользователь нажал на кнопку или изменилась выделенная строка в таблице. Также удобнее, к примеру, описать механизм отмены обработки документа в специальном месте, привязанном к объекту базы данных, в частности, это позволяет вызывать такую программу-триггер как в момент вызова программой функций '''[[DB.Unpublish|Unpublish()]]''' или '''[[DB.Mark|Mark()]]''' (без какой-либо необходимости что-то дополнительно описывать, передавать в параметрах имя процедуры обработки и пр.), так и при визуальном удалении документа из журнала, упрощая программирование системы и уменьшая число возможных ошибок. Ниже представлены разнообразные способы хранения исходных текстов в системе:
* '''Модули''' (в т.ч. глобальные). Отдельные файлы, полностью отданные под хранение модулей.
* '''Визуальные события'''. Тексты событий хранятся внутри особых контейнеров внутри файлов-описаний форм. События, описанные таким образом, могут быть привязаны как к элементам формы (причем каждому элементу может быть задано множество событий), так и к самой форме в общем.
* '''События пунктов меню''' и '''события панели инструментов'''. Тексты триггеров событий хранятся внутри файлов с описанием меню и панелей инструментов. События выполняются, когда пользователь выбирает определенный пункт меню или нажимает на кнопку на панели инструментов.
* '''Триггеры объектов базы данных'''. Тексты хранятся внутри файла метаданных и вызываются в моменты создания, записи или обработки объектов.
Для увеличения скорости исполнения все тексты (включая события и триггеры) до передачи на сервер базы данных подвергаются компиляции. Компиляция это необратимое преобразование текстового файла программы в бинарный файл, не являющийся файлом машинного кода, но более понятный и удобный для исполнения машине, чем текстовый файл. Компилированные файлы невозможно в полной мере превратить назад в тот вид, какими они были до компиляции (при компиляции, к примеру, теряются комментарии, возможно меняются имена переменных и пр.). Поэтому, такие файлы хранятся только на сервере, тогда как разработчик может продолжать производить требуемые изменения в тестах проекта. Компиляция выполняется автоматически программой разработки [[Общая информация и интерфейс Студии|'''Студия''']], при этом в компиляции участвуют и подвергаются обновлению на сервере только те файлы, в которых производились изменения.

== Предопределенные события ==
В некоторых случаях, более удобно описать какое-либо событие внутри модуля, нежели в контейнере обработчике событий. Иногда это связано с тем, что такое событие будет вызвано по умолчанию, и, если его разместить в глобальном модуле, можно изменить поведение всего проекта при наступлении какого-либо события в любом его месте, после чего для определенных форм это поведение можно модифицировать в обработчиках событий. Иногда же, такой способ является единственно возможным (к примеру, файлы электронных таблиц на данный момент не подразумевают наличия своего хранилища событий, поэтому, события, связанные со свободными окнами электронных таблиц вызываются только из модуля, из которого эти таблицы были созданы (данный модуль будет оставаться в памяти системы, до того, как будет закрыта последняя таблица); однако, для электронной таблицы, помещенной на форму, как ее элемент, уже можно задать свои события из редактора форм.
С учетом внешних событий или событий, задаваемых подключаемыми модулями, количество типов предопределенных событий в системе не ограничено. Однако основные события, описанные на уровне системы, поддаются полному описанию. Для получения информации см. статью [[Предопределенные события]].

Временная таблица базы данных

2026-04-01T10:01:20Z

Admin: 1 revision imported

{{infobox object
|object=TempDB
|status=2
|create=[[TempDB.Create|Create]]}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]}}
Объект '''временная таблица базы данных''' работает в двух режимах -- как несохраняемая в базе данных таблица СУБД, которая будет удалена при уничтожении объекта временной таблицы, либо как постоянная таблица не связанная с метаданными в другой базе данных, к которой имеет доступ текущая СУБД. В первом режиме (временной таблицы), объект может использоваться для создания выгрузок во внешние источники больших объемов данных, полученных из нескольких объектов базы данных и объединенных сложным образом. Также любая выгрузка или обработка, оперирующая данными, которая проходит без участия пользователя (консольный клиент), имеющая потенциально большой объем информации, может быть написана с использованием временных таблиц баз данных вместо [[Объект запрос базы данных|запросов баз данных]]. Второй режим позволяет использовать внешние базы данных для хранения большого объема информации, который не выгодно держать в рабочей базе данных, либо информация будет использоваться или изменяться внешними программами. К примеру, это могут быть логи, бинарные файлы, данные, которые зависят от времени с большим объемом, которыми, возможно пользуется другая база данных и т.п. Для того, чтобы использовать такие базы данных, они должны быть сначала перечислены в файле инициализации сервера (см. [[Установки сервера]], ветка '''SimpleDBases'''). Функционально работа между двумя режимами не имеет отличий (за исключением того, что есть функции, которые работают только с режимом временной базы данных (к. примеру [[TempDB.Group|Group]]), а есть, которые только в режиме постоянной базы данных (к примеру, [[TempDB.DeleteTable|DeleteTable]]). В данном описании объекты обоих режимов называются "временными таблицами" по наименованию исходного объекта языка.
Работа с информацией с помощью временных таблиц сильно отличается от таковой при работе с запросами. Основное отличие заключается в том, что временные таблицы всегда хранятся на сервере базы данных и получение информации из них происходит в последний момент, когда все или большинство операций преобразования информации уже выполнено. Таблицы не хранятся в памяти машины текущего клиента, и информация доставляется до программы с помощью выборки по несколько записей одновременно, это позволяет использовать таблицы для преобразования информации неограниченного объема. Однако, работа с таблицами происходит с помощью наборов данных, а не выборкой по каждой записи, как это обычно делается программно при обработке результатов запроса, это может усложнить написание программы, и сделать ее более сложной для понимания. При использовании временных таблиц для вывода информации на экран, удобно пропускать получаемые данных через [[Сборщик объектов|сборщик объектов]], это позволит ускорить вывод и сэкономить память. См. также статью [[Оптимизация отчетов и обработок]].
'''Плюсы''' при использовании временных таблиц баз данных:
* Работа с данными неограниченного объема.
* Значительное ускорение процесса обработки по сравнению с запросами в случаях, когда вычисления можно выполнить с помощью наборов данных.
* Возможность хранить "внешние" данные неограниченного объема в виде простых таблиц, для произвольных целей.

'''Минусы''' использования временных таблиц баз данных:
* Некоторое увеличение нагрузки на сервер баз данных (увеличение расхода памяти и объема записи на диск).
* Значительное усложнение читабельности программного текста по сравнению с запросами.
* Усложнение написания программного текста за счет другой идеологии обработки информации.
* Замедление процесса обработки по сравнению с запросами в случаях, когда вычисления невозможно выполнить с помощью наборов данных, так как выборка данных временных таблиц происходит медленнее, чем получение всех данных запроса одновременно.

==Формулы при вычислении полей записей временной таблицы базы данных==
При работе с функциями, использующими формулы для вычисления отдельных столбцов, а также при использовании формул в фильтрах записей, возникает вопрос, какие функции могут быть использованы в подобных формулах и каким образом производить адресацию внешних переменных, наименований столбцов и т.п. В формулах, связанных с временными таблицами базы данных, используются стандартные возможности [[Объект запрос базы данных|языка запросов]], однако, необходимо выделить некоторые важные моменты использования формул:
* В формулах разрешается использование всех операторов и функций языка запросов (см. [[Объект запрос базы данных#Список операторов и функций языка запроса|Список операторов и функций языка запроса]]), кроме агрегатных функций для работы с сальдо накопителей (''Income'', ''Expence'', ''BegTotals'', ''EndTotals'', ''BegTotalsT'', ''EndTotalsT''), данная возможность планируется.
* Использовании пути и приведение типов данных для путей типов данных (см. [[Объект запрос базы данных#Выражения и задание переменной в виде пути к реквизиту|Выражения и задание переменной в виде пути к реквизиту]]) разрешено. Если выражение указывает на периодический реквизит, также как и в случае с запросами, необходимо задать дату получения его значения с помощью конструкции <code><Путь и наименование реквизита>(<Дата реквизита>)</code>. Все особые реквизиты по-прежнему работают как при их использовании в запросе, однако, есть исключение для особых реквизитов ''@ELEMENT'' и ''@HEADER'' применимо к запросам к строчным частям объектов.
** '''@ELEMENT''' -- задает внутренний код строки строчной части объекта (не на сам элемент, которому принадлежит строчная часть, как это происходит в запросах)
** '''@HEADER''' -- задает элемент, которому принадлежит текущая строка строчной части (тождественно тому, как это происходит в запросах)
* При указании на столбцы временной таблицы, доступно специальное наименование '''@ID''', являющееся уникальным идентификатором записи. Такие идентификаторы содержат числовые значения и присутствуют в любой временной таблице. Использовать их можно, к примеру, в случае получения данных из таблицы с помощью функции [[TempDB.Unload|Unload]], изменения их каким-либо образом, затем сопоставлением с оригинальными записями таблицы.
* Так как при работе с временными таблицами базы данных нет возможности определения дополнительных переменных в формулах запроса, задание пути и адресация реквизитов возможны непосредственно после указания полей текущей временной таблицы, реквизитов адресуемого объекта базы данных или полей другой адресуемой временной таблицы. Путь можно начинать задавать непосредственно после указания на поле. К примеру, если в текущей таблице существует поле (столбец) с наименованием ''Номенклатура'', который был задан, как тип данных ''DB'' и нам необходимо с помощью фильтра выбрать только те записи временной таблицы, поле Номенклатура которых содержит номенклатуру с реквизитом ТоварнаяГруппа, значение которого, входит в список спТоварныеГруппы, можно задать для фильтра следующее логическое выражение: <code>Номенклатура..Ref.Номенклатура.ТоварнаяГруппа IN спТоварныеГруппы</code>. Приведение типа здесь используется, так как тип данных столбца определен таким образом, что система не знает, ссылки на какой объект в нем хранятся (''DB'').
* Функции агрегации (''AVG'', ''MAX'', ''MIN'', ''SUM'', ''COUNT'') применимы только в случае выполнения агрегатных запросов, к примеру, в функции [[TempDB.LoadFrom|LoadFrom]]. Однако, по умолчанию всегда выполняется обычный запрос, для использования запросов агрегации необходимо дополнительное указание на тип запроса.
* При работе с наименованиями внешних переменных, полями временной таблицы базы данных, а также наименованиями реквизитов объектов базы данных, может получиться ситуация неопределенной адресации (ambiguity), когда наименования поля и реквизита совпадают, для таких случаев для указания на источник наименования предусмотрен особый префикс (особенно это важно для функции [[TempDB.LoadFrom|LoadFrom]], которая оперирует дополнительным источником данных, который может быть не только объектом базы данных, но и другой временной таблицей базы данных). Система ищет объект наименования в следующей приоритетной последовательности:
** Поиск реквизитов объектов базы данных с указанным наименованием, либо наименований полей другой временной таблицы базы данных (см. [[TempDB.LoadFrom|LoadFrom]]).
** Поиск наименований полей текущей временной таблицы базы данных. Если необходимо форсировать указание на то, что данное наименование это имя поля текущей временной таблицы, для него можно использовать префикс ''':''' (пример: <code>:ИмяПоляТаблицы</code>).
** Поиск наименований внешних переменных языка или констант языка. Если необходимо форсировать указание на то, что данное наименование это имя внешней переменной или константы, для него можно использовать префикс '''::''' (пример: <code>::aList</code>).

==Пример синергичной работы сборщика объектов и временной таблицы базы данных==

<pre>
//Пример показывает рабочий цикл с объектами из временной таблицы, используя сборщик объектов для уменьшения расхода памяти
//MainTab -- визуальная таблица, в которую будут копироваться результаты обработки временной таблицы БД

//Создание сборщика объектов
ObjC:=ObjectCollector.Create();

MainTab.Lock();
Try
//Очистка визуальной таблицы
MainTab.ClearLines();

//Создание и загрузка сложной временной таблицы БД, детали загрузки не имеют особого значения для нашего примера
аТемп:=TempDB.Create("зДок:DB,зЗад:DB,зВып:DB,зДата:DATE,зНомерСтроки:NUMBER.10,Номенклатура:DB,Смена:DB,Работники:STRING.200,Количество:NUMBER.15.5");
аТемп.LoadFrom("Doc.РегистрацияВыпускаПродукции.Содержание","@HEADER->зДок,@HEADER.DocDate->зДата,@HEADER.ВыпускПродукции->зВып,@HEADER.ВыпускПродукции..Doc.ВыпускПродукции.ДокОснование->зЗад,"+
"@LINE->зНомерСтроки,Материал->Номенклатура,КоличествоОпераций->Количество,Работники->Работники,Смена->Смена",
"ТипЗаписи=1","not isEmpty(@HEADER.ВыпускПродукции)","IsType(@HEADER.ВыпускПродукции,Doc.ВыпускПродукции)");

Всего:=аТемп.Size();
aNum:=0;
аТемп.Select("зВып+,зДата+,зДок+,зНомерСтроки+");
While аТемп.Next() Do
aNum:=aNum+1;
If aNum%20=0 Then
Form.StatusText("Обработано строк: "+aNum+" из "+Всего);
EndIf;
зНом:=ObjC.Get(аТемп.Номенклатура);
зЗад:=ObjC.Get(аТемп.зЗад);
зВып:=ObjC.Get(аТемп.зВып);
зДок:=ObjC.Get(аТемп.зДок);
MainTab.AddLine("Документ,Номенклатура,Ед,Количество,Смена,зДок,НомСтр,зВып,зЗад,Работники,Индекс",зЗад.DocNum+" от "+зЗад.DocDate,зНом,ObjC.Get(зНом.базЕдиница),аТемп.Количество,
ObjC.Get(аТемп.Смена),зДок,аТемп.зНомерСтроки,зВып,зЗад,ПолучитьСписокРаботников(Trim(аТемп.Работники),ТРаботники),зДок.DocNum+"@"+зДок.DocDate+"@"+аТемп.зНомерСтроки);
EndDo;
MassLoadObjects(MainTab);
Finally
MainTab.Unlock();
EndTry;
Form.MainTab.SetFocus();
</pre>

== Атрибуты и функции==
{{function header}}
{{function entry
|name=[[TempDB.Create|Create]]
|form={{Grey|TempDB.}}'''Create'''({{Optional|<Наименования столбцов с типами данных (STRING)>,<Имя внешней БД и наименование ее таблицы (STRING)>}}):''<Новый объект (TEMPDB)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый объект временной таблицы базы данных с заданными столбцами и их типами данных, если это необходимо. При указании второго аргумента, функция создает или открывает постоянную таблицу внешней базы данных по их именам. Если таблица уже существовала, сервер проверит последовательность и типы данных столбцов таблицы. Если какой-то их типов отличается, функция вызовет исключение, иначе будет создан объект, с помощью которого можно обращаться к этой таблице. Имена БД должны быть предварительно перечислены [[Установки сервера|установках сервера]] (ветка '''SimpleDBases'''). Для наименований таблиц рекомендуется использовать латиницу или цифры, запрещено использовать знаки "." или ",". Таблица может содержать большее количество столбцов, тем указано в функции, если таблица содержит меньшее количество, недостающие столбцы будут созданы.
}}
{{function entry
|name=[[TempDB.DeleteTable|DeleteTable]]
|form={{Grey|TempDB.}}'''DeleteTable'''(''<Имя внешней БД и наименование ее таблицы (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция удалят постоянную таблицу из внешней базы данных по ее имени. Если таблица не существовала, исключение не будет создано. Функция не работает с временными таблицами (которые удаляются автоматически при удалении объекта из системы). Функция вызывается с помощью интерфейса.
}}
{{function entry
|name=[[TempDB.Copy|Copy]]
|form={{Grey|TempDB.}}'''Copy'''():''<Копия ссылки на внешнюю БД (TEMPDB)>''
|type=1
|status=2
|visual=0
|description=Функция создает локальную копию (дубль) ссылки на постоянную таблицу внешней базы данных. Функция не работает с временными таблицами. Дублирование объекта может пригодиться, к примеру, в многопоточном режиме, когда множество потоков выполняют запросы к такой таблице. Если выполнять запросы с помощью одного объекта, следующий запрос будет ожидать окончания предыдущего. Также, эта функция работает гораздо быстрее, чем [[TempDB.Create|Create]], так как не обращается к серверу и не проверяет корректность структуры таблицы.
}}
{{function entry
|name=[[TempDB.LoadFrom|LoadFrom]]
|form={{Grey|TempDB.}}'''LoadFrom'''(''<Источник данных (DB,STRING,TEMPDB)>'',''<Формулы для вычисления столбцов (STRING)>''{{Optional|,<Стандартные фильтры>...}})
|type=1
|status=2
|visual=0
|description=Функция выполняет загрузку записей из указанного источника данных (таблицы объекта проекта или другой временной таблицы базы данных), при этом указанные столбцы таблицы заполняются требуемым образом. Запрос к источнику базы данных может быть выполнен с использованием агрегации или без оной. Если выполняется запрос агрегации, для вычисления столбцов возможно применять функции агрегации.
}}
{{function entry
|name=[[TempDB.Update|Update]]
|form={{Grey|TempDB.}}'''Update'''({{Optional|<Источник данных (STRING,TEMPDB)>}},''<Формулы для вычисления столбцов (STRING)>''{{Optional|,<Стандартные фильтры>...}})
|type=1
|status=2
|visual=0
|description=Функция выполняет групповые вычисления и обновления указанных столбцов указанным образом, при этом можно использовать дополнительный источник данных для вычисления значений столбцов. Источником может быть указание на объект базы данных проекта или другая временная таблица базы данных. Также можно использовать постоянные таблицы из текущей или других внешних БД.
}}
{{function entry
|name=[[TempDB.AddColumns|AddColumns]]
|form={{Grey|TempDB.}}'''AddColumns'''(''<Наименования столбцов с типами данных (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция добавляет указанные столбцы к существующей временной таблице базы данных.
}}
{{function entry
|name=[[TempDB.RemoveColumns|RemoveColumns]]
|form={{Grey|TempDB.}}'''RemoveColumns'''(''<Наименования столбцов (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция удаляет указанные столбцы из существующей временной таблицы базы данных.
}}
{{function entry
|name=[[TempDB.AddLine|AddLine]]
|form={{Grey|TempDB.}}'''AddLine'''({{Optional|<Наименования столбцов (STRING)>,<Значение столбца 1>,<Значение столбца 2>...}})
|type=1
|status=0
|visual=0
|description=Функция добавляет одну запись к временной таблице базы данных. В записи заполняются указанные столбцы.
}}
{{function entry
|name=[[TempDB.Size|Size]], '''SizeL'''
|form={{Grey|TempDB.}}'''Size'''({{Optional|<Стандартные фильтры>...}}):''<Количество записей (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает количество записей, входящих в указанных фильтр
}}
{{function entry
|name=[[TempDB.SizeC|SizeC]]
|form={{Grey|TempDB.}}'''SizeC'''():''<Количество столбцов (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает количество столбцов в текущей временной таблице базы данных.
}}
{{function entry
|name=[[TempDB.GetColumnName|GetColumnName]]
|form={{Grey|TempDB.}}'''GetColumnName'''(''<Индекс столбца (INT)>''):''<Наименование столбца (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает наименование столбца по его индексу
}}
{{function entry
|name=[[TempDB.GetColumnIndex|GetColumnIndex]]
|form={{Grey|TempDB.}}'''GetColumnIndex'''(''<Наименование столбца (STRING)>''):''<Индекс столбца (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает индекс столбца по его наименованию. Если столбца с указанным именем не существует, функция возвращает 0.
}}
{{function entry
|name=[[TempDB.GetColumnDataType|GetColumnDataType]]
|form={{Grey|TempDB.}}'''GetColumnDataType'''(''<Наименование или индекс столбца (INT,STRING)>''):''<Тип данных столбца (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает тип данных столбца, заданный во время добавления столбца в таблицу.
}}
{{function entry
|name=[[TempDB.GetColumnFlags|GetColumnFlags]]
|form={{Grey|TempDB.}}'''GetColumnFlags'''(''<Наименование или индекс столбца (INT,STRING)>''):''<Дополнительные флаги столбца (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает совокупность дополнительных флагов столбца (в данный момент "I" -- столбец индексируется, "U" -- текст столбца имеет кодировку UTF-16), заданных во время добавления столбца в таблицу.
}}
{{function entry
|name=[[TempDB.SetColumnName|SetColumnName]]
|form={{Grey|TempDB.}}'''SetColumnName'''(''<Индекс столбца (INT)>'',''<Наименование столбца (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция изменяет наименование столбца, заданного его индексом.
}}
{{function entry
|name=[[TempDB.Remove|Remove]]
|form={{Grey|TempDB.}}'''Remove'''({{Optional|<Стандартные фильтры>...}})
|type=1
|status=2
|visual=0
|description=Функция удаляет из временной таблицы базы данных записи, входящие в фильтр.
}}
{{function entry
|name=[[TempDB.Upload|Upload]], '''CopyFrom'''
|form={{Grey|TempDB.}}'''Upload'''(''<Источник данных (TAB,LIST)>''{{Optional|,<Наименования столбцов для загрузки (STRING)>,<Наименования столбцов для фильтрации (STRING)>,<Фильтр столбца 1>,<Фильтр столбца 2>...}})
|type=1
|status=2
|visual=0
|description=Функция добавляет в текущую временную таблицу базы данных информацию из таблицы значений или списка значений. При использовании списка, значения добавляются в указанный во втором аргументе столбец таблицы, при использовании таблицы значений, указанные во втором аргументе наименования столбцов таблицы должны соответствовать наименованиям столбцов временной таблицы базы данных.
}}
{{function entry
|name=[[TempDB.Unload|Unload]], '''CopyTo'''
|form={{Grey|TempDB.}}'''Unload'''({{ByRef|''<Объект в который происходит копирование>''}}{{Optional|,<Наименования столбцов для копирования (STRING)>,<Стандартные фильтры>...}})
|type=1
|status=2
|visual=0
|description=Функция осуществляет загрузку записей из временной таблицы базы данных в список значений или таблицу значений. Записи отбираются с помощью фильтра. При загрузке в список значений, указывается столбец загрузки, при загрузке в таблицу, указывает список столбцов, если соответствующий столбец в таблице отсутствует, он будет создан. Объекты базы данных в таблице значений или списке будут незагруженными.
}}
{{function entry
|name=[[TempDB.Select|Select]]
|form={{Grey|TempDB.}}'''Select'''({{Optional|<Наименования столбцов сортировки с направлением сортировки (STRING)>,<Стандартные фильтры>...}}):''<Найдена по крайней мере одна запись (INT)>''
|type=1
|status=2
|visual=0
|description=Функция открывает выборку записей из временной таблицы базы данных. К выборке применяется заданный фильтр, записи сортируются в соответствии с заданным направлением сортировки. При сортировке объектов базы данных нужно учитывать, что сортировка на сервере осуществляется только по внутреннему коду базы данных, а не по реквизиту сортировки объекта. Чтобы осуществить сортировку по требуемому реквизиту сортировки (к примеру, по наименованию или по дате документа), необходимо добавить столбец в таблицу и заполнить его значением требуемого реквизита и осуществлять сортировку по новому столбцу.
}}
{{function entry
|name=[[TempDB.Next|Next]]
|form={{Grey|TempDB.}}'''Next'''():''<Найдена и загружена следующая запись (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает следующую запись выгрузки, открытой ранее с помощью функции [[TempDB.Select|Select]]. Запись загружается во внутренний буфер объекта, столбцы будут доступны по наименованию или с помощью функции [[TempDB.Get|Get]].
}}
{{function entry
|name=[[TempDB.PeekNext|PeekNext]]
|form={{Grey|TempDB.}}'''PeekNext'''():''<Найдена и загружена следующая запись (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает следующую запись выгрузки, открытой ранее с помощью функции [[TempDB.Select|Select]], однако, шаг курсора не происходит, поэтому следующий вызов функции [[TempDB.Next|Next]] вернет эту же самую запись. Запись загружается во внутренний буфер объекта, столбцы будут доступны по наименованию или с помощью функции [[TempDB.Get|Get]].
}}
{{function entry
|name=[[TempDB.UseOption|UseOption]]
|form={{Grey|TempDB.}}'''UseOption'''(''<Наименование установки (STRING)>''{{Optional|,<Значение установки>}}):''<Текущее значение установки>''
|type=1
|status=2
|visual=0
|description=Функция получает или устанавливает значение дополнительных режимов загрузки или выборки текущего объекта временной таблицы базы данных. На данный момент докумен режим ограничения количества запрашиваемых за один раз элементов при выборке из с помощью [[TempDB.Select|Select]].
}}
{{function entry
|name=[[TempDB.Get|Get]]
|form={{Grey|TempDB.}}'''Get'''(''<Наименования столбца (STRING)>''):''<Значение столбца>''
|type=1
|status=2
|visual=0
|description=Функция получает значение указанного по наименованию столбца таблицы в случае, если запись уже загружена с помощью функций [[TempDB.Next|Next]], [[TempDB.PeekNext|PeekNext]] или [[TempDB.Find|Find]].
}}
{{function entry
|name=[[TempDB.Set|Set]]
|form={{Grey|TempDB.}}'''Set'''(''<Наименования столбца (STRING)>'',''<Значение столбца>'')
|type=1
|status=2
|visual=0
|description=Функция изменяет значение указанного по наименованию столбца таблицы в случае, если запись уже загружена с помощью функций [[TempDB.Next|Next]], [[TempDB.PeekNext|PeekNext]] или [[TempDB.Find|Find]].
}}
{{function entry
|name=[[TempDB.ColumnName|<Имя столбца>]]
|form={{Grey|TempDB.}}'''<Имя столбца>''':''<Значение столбца>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или изменяет значение указанного по наименованию столбца таблицы в случае, если запись уже загружена с помощью функций [[TempDB.Next|Next]], [[TempDB.PeekNext|PeekNext]] или [[TempDB.Find|Find]].
}}
{{function entry
|name=[[TempDB.Find|Find]]
|form={{Grey|TempDB.}}'''Find'''({{Optional|<Стандартные фильтры>...}}):''<Запись найдена (INT)>''
|type=1
|status=2
|visual=0
|description=Функция останавливает текущую выборку, если таковая существует и загружает в буфер выборки запись, идентифицируемую фильтром. Если запись загружена, функция возвращает 1, иначе 0.
}}
{{function entry
|name=[[TempDB.New|New]]
|form={{Grey|TempDB.}}'''New'''()
|type=1
|status=0
|visual=0
|description=Функция создает новую пустую запись в буфере выборки. Поля записи в дальнейшем можно заполнить, и запись можно сохранить. После сохранения запись будет добавлена во временную таблицу.
}}
{{function entry
|name=[[TempDB.Save|Save]]
|form={{Grey|TempDB.}}'''Save'''()
|type=1
|status=0
|visual=0
|description=Функция сохраняет изменения в столбцах текущей записи, находящейся в буфере выборки.
}}
{{function entry
|name=[[TempDB.Group|Group]]
|form={{Grey|TempDB.}}'''Group'''({{Optional|<Столбцы группировки (STRING)>,<Столбцы агрегации с операциями (STRING)>}})
|type=1
|status=2
|visual=0
|description=Функция выполняет операцию группировки над записями таблицы, в таблице результате остаются только столбцы группировки и столбцы агрегации. См. также [[Tab.Group|Group]]. Функция не будет работать для постоянных таблиц внешних БД (будет вызывать исключение), если необъходимо ее использовать, можно предварительно скопировать содержимое постоянной таблицы во временную. {{Planned}} Также планируется возможность работы с постоянными таблицами, когда функция возвратит результат в новой временной таблице.
}}
{{function entry
|name=[[TempDB.UpdateFromGroups|UpdateFromGroups]]
|form={{Grey|TempDB.}}'''UpdateFromGroups'''(''<Условие для определения строк группировки (STRING)>'',''<Наименования столбцов сортировки с направлением сортировки (STRING)>'',''<Наименования заполняемых столбцов (STRING)>''{{Optional|,<Стандартные фильтры>...}})
|type=1
|status=2
|visual=0
|description=Функция выполняет заполнение обычных столбцов значениями столбцов группировки. Функция используется, при загрузке из сложных строчных частей с промежуточными группировками или подобных случаев. Выполнение функции может занимать продолжительное время, так как серверы базы данных (типа SQL) не имеют функционала для выполнения таких операции с помощью функций, оперирующих наборами записей.
}}
{{function entry
|name=[[TempDB.Gross1|Gross1]], '''Compute1'''
|form={{Grey|TempDB.}}'''Gross1'''(''<Наименование столбца (STRING)>''{{Optional|,<Тип операции агрегации (STRING)>{{Default|{{Eq}}"SUM"}},<Стандартные фильтры>...}}):''<Результат агрегации>''
|type=1
|status=2
|visual=0
|description=Функция вычисляет значение агрегации указанного столбца таблицы среди записей, входящих в указанный фильтр.
}}
{{function entry
|name=[[TempDB.Compute|Compute]]
|form={{Grey|TempDB.}}'''Compute'''(''<Наименование столбцов группировки (STRING)>'',''<Список столбцов агрегации с типами операций (STRING)>''{{Optional|,<Стандартные фильтры>...}}):''<Результат вычисления (TAB)>''
|type=1
|status=0
|visual=0
|description=Функция производит выборку с агрегацией с помощью указанных фильтров. Результат выборки возвращается в виде таблицы значений со столбцами группировки и агрегации.
}}
{{function entry
|name=[[TempDB.AddIndex|AddIndex]]
|form={{Grey|TempDB.}}'''AddIndex'''(''<Наименования столбцов индекса с направлениями сортировки (STRING)>'')
|type=1
|status=0
|visual=0
|description=Функция добавляет индекс во временную таблицу базы данных. Индекс может быть как простым (использовать один столбец), так и композитным (использовать несколько столбцов). Простые индексы можно задать при добавлении столбцов в таблицу.
}}
{{function footer}}

{{Объекты}}

TempDB.Update

2026-04-01T10:00:51Z

Admin: 1 revision imported

{{infobox function
|name=Update
|object=[[Временная таблица базы данных]]
|caption=Обновление значений столбцов временной таблицы
|type=1
|status=2
|db=2
|exception=Невозможно превратить в строку, неверные аргументы, ошибка сервера
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Временная таблица базы данных]]}}
Функция выполняет групповые вычисления и обновления указанных столбцов таблицы указанным образом, при этом можно использовать дополнительный источник данных для вычисления значений столбцов. Источником может быть указание на объект базы данных проекта или другая временная или постоянная таблица базы данных (даже из другой внешней БД). Данная функция не добавляет и не удаляет записи из временной таблицы, столбцы, не заданные для изменения, также не будут изменены.

== Синтаксис ==
<code>
{{Grey|TempDB.}}'''Update'''({{Optional|<Источник данных (STRING,TEMPDB)>}},''<Формулы для вычисления столбцов (STRING)>''{{Optional|,<Стандартные фильтры>...}})
</code>

==== Аргументы ====
* <code>''<Источник данных (DB,STRING,TEMPDB)>''</code> - {{Optional}} Источник данных для получения дополнительной информации для изменения столбцов таблицы. Параметр необязателен, если он является другой временной таблицей базы данных, также необходимо указать дополнительное условие связи между записями текущей временной таблицы и записями или элементами объекта базы данных (см. второй аргумент). Источником может быть:
** '''Строка''' -- задает путь объекта базы данных и наименование столбца, по которому будет происходить синхронизация между объектом и текущей таблицей в виде <code><Тип данных БД>.<Вид данных БД>:<Столбец, содержащий объекты указанного вида></code>.
** '''Другая временная таблица базы данных''' -- переменная, задающая другую временную или постоянную таблицу базы данных (даже из другой внешней БД).
* <code>''<Формулы для вычисления столбцов (STRING)>''</code> - Аргумент задает способ вычисления столбцов таблицы, формулы могут использовать столбцы самой таблицы при вычислении, а также, если указан дополнительный источник данных, информацию из него. Задание аргумента имеет следующий формат: <code>[<Условие объединения записей текущей таблицы и записей другой временной таблицы-источника данных>,]<Выражение 1>-><Имя столбца 1>,<Выражение 2>-><Имя столбца 2>...</code>. Выражения содержат весь возможный набор функций и операторов языка запросов (см. [[Временная таблица базы данных]], [[Объект запрос базы данных]]). '''Важно''': Не все серверы базы данных готовы принимать выражения с использованием ссылок на поля внешних таблиц (<code>Doc.DocDate</code> и т.п.) в условие ''объединения и записей текущей таблицы и записей другой временной таблицы-источника данных''. Это ограничение можно обойти, предварительно создав дополнительный столбец в оригинальной таблице и заполнив его результатом выражения, с тем, чтобы в условии были только простые указания на столбцы. См. пример, демонстрирующий такую проблему ниже. Также для этого условия рекомендуется использовать наиболее простые выражения без вычислений. SQLite3, к примеру, очень сильно замедляет выполнение запроса, если в условии для объединения использованы какие-либо вычисления.
* <code>''<Стандартные фильтры>''</code> - {{Optional}} Стандартные фильтры отбора записей текущей таблицы данных описаны в статье [[Стандартные фильтры]]. Важное отличие от фильтров функций объектов базы данных заключается в том, что стандартные фильтры всегда работают в сложном (расширенном) режиме, при этом отсутствует требование, что первая строка фильтра должна начинаться на знак '''~'''. Выражения фильтров содержат весь возможный набор функций и операторов языка запросов (см. [[Временная таблица базы данных]], [[Объект запрос базы данных]]), при указании наименование также применимы префиксы (типа ''':'''), как это описано в [[Временная таблица базы данных#Формулы при вычислении полей записей временной таблицы базы данных|статье по временной таблице базы данных]]. Записи таблицы, не входящие в фильтр, будут пропущены при изменении.

== Примеры ==
<pre>
//Пример создает таблицу аТемп, и заполняет ее резервами документа ЗаказНаПроизводство, при этом в ней также заполнено поле документа ВыпускПродукции.
// Документ ВыпускПродукции подчинен документу ЗаказНаПроизводство. Выборка документов происходит за период с НачДата по КонДата.
//Таблица номенклатуры из резервов с выпусками и заданиями
аТемп:=TempDB.Create("зДок:DB,зЗад:DB,зН:DB:I,Количество:NUMBER.15.5");
//Заказы на производство
аТемп.LoadFrom("Stor.Резервы","@LINK->зЗад,Номенклатура->зН,?(@EXPENSE=1,-Количество,Количество)->Количество",
"(BegOfDay(@DATE)>=НачДата)And(BegOfDay(@DATE)<=КонДата)","IsType(@LINK,Doc.ЗаказНаПроизводство)");
//Заполняем зДок (подчиненный документ -- ВыпускПродукции)
вТемп:=TempDB.Create("зДок2:DB,зЗад:DB");
//Выбираются только те документы выпусков, основания которых (ЗаказНаПроизводство) находятся в таблице аТемп
вТемп.LoadFrom("Doc.ВыпускПродукции","@ELEMENT->зДок2,@ELEMENT.ДокОснование->зЗад","@ELEMENT.ДокОснование IN аТемп.зЗад");
//Заполним столбец зДок оригинальной таблицы, объединение происходит по условию ":зЗад=зЗад".
аТемп.Update(вТемп,":зЗад=зЗад,зДок2->зДок");
//В дальнейшем таблицу аТемп можно выводить на экран или использовать в последующих запросах.
</pre>

<pre>
//Второй пример показывает последовательное заполнение реквизитов Контрагент (зК), Адрес (зАД) и Дата документа (зДата) из разных объектов базы данных в таблицу,
// которая содержит совокупность строк, загруженных из накопителя
//Создаем и заполняем таблицу движениями накопителя Остатки, накопитель не содержит всех необходимых нам полей, к примеру, в нем отсутствует указание на контрагента или адрес
аСтроки:=TempDB.Create("зДал:Number.20.7,зН:DB,зПартия:DB,зК:DB,зАД:DB,зДок:DOC,зСклад:DB,зДата:Date");
//Запрос производится за период с НачДата по КонДата, также отбирается номенклатура по спискам оН.Get(1) и оН.Get(2)
аСтроки.LoadFrom("Storage.Остатки","Количество*?(@EXPENSE=0,1,-1)*Номенклатура.Объем->зДал,Номенклатура->зН,Склад->зСклад,Партия->зПартия,@LINK->зДок","@DATE>=НачДата","@Date<КонДата",
"Номенклатура IN оН.Get(1)","Номенклатура NOT IN оН.Get(2)");

//Удаляем из таблицы строки, связанные с документами, типа Сторнирование
аСтроки.Remove("IsType(зДок,Doc.Сторнирование)");

//Заполняем столбцы Контрагент, Адрес и Дата, так как накопитель может иметь записи разных документов, которые являются разными таблицами БД,
// необходимо делать запросы отдельно по каждой из таблицы, альтернативно, можно было бы сделать запрос к какому-нибудь журналу документов,
// если последний содержит нужные поля.
//Запросы выглядят одинаковыми, но они происходят к разным таблицам и разным реквизитам (столбцам) таблиц
// Те записи текущей таблицы, которые отсутствуют в источнике данных, по которому происходит запрос, будут пропущены при обновлении
аСтроки.Update("Doc.Реализация:зДок","Контрагент->зК,Адрес->зАД,DocDate->зДата");
аСтроки.Update("Doc.ВозвратПоставщику:зДок","Контрагент->зК,Адрес->зАД,DocDate->зДата");
аСтроки.Update("Doc.ВозвратОтПокупателя:зДок","Контрагент->зК,Адрес->зАД,DocDate->зДата");
аСтроки.Update("Doc.ПоступлениеТМЦ:зДок","Контрагент->зК,Адрес->зАД,DocDate->зДата");
</pre>

<pre>
//Пример показывает ограничения при использовании функции и обновлении содержимого таблицы с помощью другой таблицы базы данных, когда объединение производится с помощью сложного выражения.
//Таблицы:
//аТемп содержит столбцы зДок (документ ВыпускПродукции) и зН (справочник Номенклатура), Количество (вещественное число)
//бТемп содержит столбцы Index (составной столбец, полученный по формуле зДок.DocNum+":"+GetYear(зДок.DocDate)+":"+зН.Code), Цена (цена материала зН в документе ВыпускПродукции зДок)
//Требуется добавить и заполнить столбец "Сумма" в таблице аТемп используя столбик локальный Количество и столбик Цена из бТемп.

//Данная конструкция не будет работать под MS-SQL, так как при объединении таблиц не разрешается использование переменных из внешних таблиц
// (однако, конструкция, возможно будет работать под управлением других типов СУБД):

аТемп.AddColumns("Сумма:Number.15.2");
аТемп.Update(бТемп,"Trim(:зДок..Doc.ВыпускПродукции.DocNum)+"":""+Str(GetYear(:зДок..Doc.ВыпускПродукции.DocDate))+"":""+:зН..Ref.тмцНоменклатура.Code=Index,Цена*:Количество->Сумма");

//Данная конструкция будет работать корректно (заметьте, что локальные столбцы помечаются префиксом ":", чтобы избежать разночтения системой):

аТемп.AddColumns("Сумма:Number.15.2,Index:STRING.100");
аТемп.Update(,"Trim(зДок..Doc.ВыпускПродукции.DocNum)+"":""+Str(GetYear(зДок..Doc.ВыпускПродукции.DocDate))+"":""+зН..Ref.тмцНоменклатура.Code->Index");
аТемп.Update(бТемп,":Index=Index,Цена*:Количество->Сумма");
</pre>

TempDB.Create

2026-04-01T10:00:50Z

Admin: 1 revision imported

{{infobox function
|name=Create
|object=[[Временная таблица базы данных]]
|caption=Создание объекта временной таблицы
|type=1
|status=2
|db=2
|exception=Невозможно превратить в строку, неверные аргументы, ошибка сервера
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Временная таблица базы данных]]}}
Функция создает новый объект временной таблицы базы данных с заданными столбцами и их типами данных, если это необходимо. При указании второго аргумента, функция создает или открывает постоянную таблицу внешней базы данных по их именам. Если таблица уже существовала, сервер проверит последовательность и типы данных столбцов таблицы. Если какой-то их типов отличается, функция вызовет исключение, иначе будет создан объект, с помощью которого можно обращаться к этой таблице. Если столбец ранее не сущестсвовал, он будет добавлен в таблицу. Если таблицы с таким именем не было в указанной базе данных, она будет создана. Имена БД должны быть предварительно перечислены [[Установки сервера|установках сервера]] (ветка '''SimpleDBases'''). Для наименований таблиц рекомендуется использовать латиницу или цифры, запрещено использовать знаки "." или ",". Таблица может содержать большее количество столбцов, тем указано в функции, если таблица содержит меньшее количество, недостающие столбцы будут созданы. Функция вызывается из интерфейса временной таблицы.

== Синтаксис ==
<code>
{{Grey|TempDB.}}'''Create'''({{Optional|<Наименования столбцов с типами данных (STRING)>,<Имя внешней БД и наименование ее таблицы (STRING)>}}):''<Новый объект (TEMPDB)>''
</code>

==== Аргументы ====
* <code>''<Наименования столбцов с типами данных (STRING)>''</code> - {{Optional}} Задает наименования столбцов в создаваемой таблице через запятую, формат задания столбца: <code><Наименование столбца>:<Тип данных столбца>[:<Дополнительные флаги столбца>]</code>.
** Наименование столбца подчиняется стандартным правилам создания наименований в системе и может содержать международные символы.
** [[Нотация типов данных|Тип данных]] задается либо в виде прямого указания на тип данных <code><Тип>[.<Размер>[.<Точность>]]</code>, возможно указание на следующие типы:
*** '''NUMBER''', '''NUM''' -- задает вещественное число с указанием на точность его представления. Тип записывается в виде <code>NUMBER.<Общее количество цифр>.<Количество цифр после точки></code>.
*** '''INTEGER''', '''INT''' -- задает целое 64-битное число.
*** '''REAL''' -- задает произвольное вещественное число (в инженерной нотации)
*** '''DATE''' -- задает тип данных даты и времени.
*** '''STRING''', '''STR''' -- задает строковой тип данных с указанием длины строки в виде <code>STRING.<Длина строки в символах></code>. Для строк произвольной длины, необходимо указать ноль (возможности при работе с такими строками имеют определенные ограничения для SQL серверов).
*** '''ANY''', '''DB''' -- задает произвольный тип базы данных.
*** '''<Тип данных БД>[.<Вид данных БД>]''' -- задает определенный тип данных базы данных. В ''типе данных БД'' можно указать '''REF''', '''DOC''', '''JOUR''', '''STOR''' или '''ENUM'''.
** Также ''тип данных'' можно задать с помощью указания на существующий реквизит объекта базы данных, иногда такой способ является более универсальным. В это случае формат записи выглядит следующим образом: <code>-><Тип данных БД>.<Вид данных БД>.<Реквизит объекта БД></code>. Система автоматически использует тип данных указанного реквизита для создания столбца временной таблицы.
** ''Флаги столбца'' представляют совокупность букв-указаний. В данный момент можно использовать следующие указания:
*** '''I''' -- Добавить индекс к данному столбцу после создания
*** '''U''' -- Текстовые данные, хранящиеся в столбце будут использовать формат UTF-16. '''Внимание''': без такого указания, по умолчанию текст будет храниться в текущей кодировке ANSI, что может явиться причиной потери международных символов.
* <code>''<Имя внешней БД и наименование ее таблицы (STRING)>''</code> - {{Optional}} При использовании этого аргумента будет создана, модифицирована или проверена постоянная таблица БД с указанным именем в указанной базе данных СУБД. Аргмент задается в формате <code><Имя базы данных>.<Имя временной таблицы></code>. Имена баз данных должны быть заранее заданы в [[Установки сервера|установках сервера]] (ветка '''SimpleDBases'''), имена таблиц могут быть произвольными, однако рекомендуется использовать только латиницу и цифры, запрещено использовать знаки "." или ",". Объект, созданный в этом режиме, будет функционально соответствовать обычному объекту временной таблицы БД, однако, на данный момент функция [[TempDB.Group|Group]] недоступна для таких таблиц, и функция удаления таблицы [[TempDB.DeleteTable|DeleteTable]] будет работать только для них.

==== Возвращаемое значение ====
Возвращает новый объект временной таблицы базы данных.

== Примеры ==
<pre>
//Пример создает таблицу аТемп, и заполняет ее резервами документа ЗаказНаПроизводство, при этом в ней также заполнено поле документа ВыпускПродукции.
// Документ ВыпускПродукции подчинен документу ЗаказНаПроизводство. Выборка документов происходит за период с НачДата по КонДата.
//Таблица номенклатуры из резервов с выпусками и заданиями
аТемп:=TempDB.Create("зДок:DB,зЗад:DB,зН:DB:I,Количество:NUMBER.15.5");
//Заказы на производство
аТемп.LoadFrom("Stor.Резервы","@LINK->зЗад,Номенклатура->зН,?(@EXPENSE=1,-Количество,Количество)->Количество",
"(BegOfDay(@DATE)>=НачДата)And(BegOfDay(@DATE)<=КонДата)","IsType(@LINK,Doc.ЗаказНаПроизводство)");
//Заполняем зДок (подчиненный документ -- ВыпускПродукции)
вТемп:=TempDB.Create("зДок2:DB,зЗад:DB");
//Выбираются только те документы выпусков, основания которых (ЗаказНаПроизводство) находятся в таблице аТемп
вТемп.LoadFrom("Doc.ВыпускПродукции","@ELEMENT->зДок2,@ELEMENT.ДокОснование->зЗад","@ELEMENT.ДокОснование IN аТемп.зЗад");
//Заполним столбец зДок оригинальной таблицы, объединение происходит по условию ":зЗад=зЗад".
аТемп.Update(вТемп,":зЗад=зЗад,зДок2->зДок");
//В дальнейшем таблицу аТемп можно выводить на экран или использовать в последующих запросах.
</pre>

TempDB.DeleteTable

2026-04-01T10:00:50Z

Admin: 1 revision imported

{{infobox function
|name=DeleteTable
|object=[[Временная таблица базы данных]]
|caption=Удаление объекта временной таблицы
|type=1
|status=2
|db=2
|exception=Невозможно превратить в строку, неверные аргументы, ошибка сервера
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Временная таблица базы данных]]}}
Функция удалят постоянную таблицу из внешней базы данных по ее имени. Если таблица не существовала, исключение не будет создано. Функция не работает с временными таблицами (которые удаляются автоматически при удалении объекта из системы), ее можно использовать только для постоянных таблиц. Функция вызывается с помощью интерфейса.

== Синтаксис ==
<code>
{{Grey|TempDB.}}'''DeleteTable'''(''<Имя внешней БД и наименование ее таблицы (STRING)>'')
</code>

==== Аргументы ====
* <code>''<Имя внешней БД и наименование ее таблицы (STRING)>''</code> - Аргмент задается в формате <code><Имя базы данных>.<Имя временной таблицы></code>. Имена баз данных должны быть заранее заданы в [[Установки сервера|установках сервера]] (ветка '''SimpleDBases'''), имена таблиц могут быть произвольными.

== Примеры ==
<pre>
//Создание или открытие постоянной таблицы "table1" в базе данных DBExport
аТемп:=TempDB.Create("зДок:DB,зЗад:DB,зН:DB:I,Количество:NUMBER.15.5","DBExport.table1");

//Удаление постоянной таблицы "table2" из базы данных DBExport. Если она не существовала, никаких действий выполнено не будет.
TempDB.DeleteTable("DBExport.table2");
</pre>

TempDB.Group

2026-04-01T10:00:50Z

Admin: 1 revision imported

{{infobox function
|name=Group
|object=[[Временная таблица базы данных]]
|caption=Группировка таблицы
|type=1
|status=2
|db=2
|exception=Невозможно превратить в строку, неверные наименования столбцов, неверные аргументы, ошибка сервера
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Временная таблица базы данных]]}}
Функция выполняет операцию группировки над записями таблицы, в таблице результате остаются только столбцы группировки и столбцы агрегации. В операции участвуют все записи таблицы. См. также [[Tab.Group|Group]]. Функция не будет работать для постоянных таблиц внешних БД (будет вызывать исключение), если необъходимо ее использовать, можно предварительно скопировать содержимое постоянной таблицы во временную. {{Planned}} Также планируется возможность работы с постоянными таблицами, когда функция возвратит результат в новой временной таблице.

== Синтаксис ==
<code>
{{Grey|TempDB.}}'''Group'''({{Optional|<Столбцы группировки (STRING)>,<Столбцы агрегации с операциями (STRING)>}})
</code>

==== Аргументы ====
* <code>''<Столбцы группировки (STRING)>''</code> - {{Optional}} Аргумент перечисляет через запятую наименования столбцов, по которым будет группироваться таблица. Регистр наименований не имеет значения. Каждый заданный столбец должен присутствовать во временной таблице.
* <code>''<Столбцы агрегации с операциями (STRING)>''</code> - {{Optional}} Аргумент перечисляет наименования столбцов через запятую, для которых будет выполнена заданная операция агрегации. Регистр наименований не имеет значения. Каждый заданный столбец должен присутствовать в таблице. Формат записи выглядит сл. образом: <code><Столбец1[:<Операция1>][,<Столбец2[:<Операция2>]...]></code>. Функция позволяет использовать следующие операции:
** '''SUM''' (по умолчанию) -- значения столбца для удаляемых строк и оставшихся строк будут найдены суммированием.
** '''AVG''' -- Будут найдены средние значения столбца для удаляемых строк и оставшихся строк.
** '''MAX''' -- В столбцах оставшихся строках будет содержаться максимальное из значение удаляемых строк и оставшихся.
** '''MIN''' -- В столбцах оставшихся строках будет содержаться минимальное из значение удаляемых строк и оставшихся.
** '''COUNT''' -- В столбцах оставшихся строках будет содержаться количество удаленных строк этой группировки, увеличенное на единицу.

== Примеры ==
<pre>
//Пример создает таблицу аТемп, и заполняет ее резервами реализациями договора аДоговор с помощью загрузки движений накопителя Взаиморасчеты
// При этом суммы подчиненных документов возврата отнимаются от сумм документов реализации
//После создания, производится выборка записей по датам документов реализации
аТемп:=TempDB.Create("аДок:DB,Сумма:NUMBER.15.2");
аТемп.LoadFrom("Stor.Взаиморасчеты","@LINK->аДок,Сумма*?(@EXPENSE=1,-1,1)->Сумма","Договор=аДоговор","isEmpty(Тара)","IsType(@LINK,Doc.Реализация,Doc.ВозвратОтПокупателя)");
//Для документов возврата подставляем в столбик аДок их основание
аТемп.Update(,"аДок..Doc.ВозвратОтПокупателя.ДокОснование->аДок","IsType(аДок,Doc.ВозвратОтПокупателя)");
аТемп.Group("аДок","Сумма");
аТемп.Remove("(Сумма<=0)Or(Not isType(аДок,Doc.Реализация))");
аТемп.AddColumns("Дата:DATE");
аТемп.Update(,"аДок..Doc.Реализация.DocDate->Дата");
аТемп.Select("Дата-");
...
</pre>

TempDB.LoadFrom

2026-04-01T10:00:50Z

Admin: 1 revision imported

{{infobox function
|name=LoadFrom
|object=[[Временная таблица базы данных]]
|caption=Загрузка данных во временную таблицу
|type=1
|status=2
|db=2
|exception=Невозможно превратить в строку, неверные аргументы, ошибка сервера
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Временная таблица базы данных]]}}
Функция выполняет загрузку записей из указанного источника данных (таблицы объекта проекта или другой временной таблицы базы данных), при этом указанные столбцы таблицы заполняются требуемым образом. Запрос к источнику базы данных может быть выполнен с использованием агрегации или без оной. Если выполняется запрос агрегации, для вычисления столбцов возможно применять функции агрегации. Предыдущие записи, находившиеся до этого момента в таблице не изменяются, операция только добавляет новые записи.

== Синтаксис ==
<code>
{{Grey|TempDB.}}'''LoadFrom'''(''<Источник данных (DB,STRING,TEMPDB)>'',''<Формулы для вычисления столбцов (STRING)>''{{Optional|,<Стандартные фильтры>...}})
</code>

==== Аргументы ====
* <code>''<Источник данных (DB,STRING,TEMPDB)>''</code> - Источник данных для добавления записей может быть:
** '''Объект базы данных''' -- принимаются объекты типа Справочник, Документ, Накопитель или Журнал.
** '''Строка''' -- задает путь объекта базы данных в виде <code><Тип данных БД>.<Вид данных БД></code>.
** '''Другая временная таблица базы данных''' -- переменная, задающая другую временную или постоянную таблицу базы данных, записи которой будут копироваться в данную. Постоянная таблица может принадлежать другой внешней БД.
* <code>''<Формулы для вычисления столбцов (STRING)>''</code> - Аргумент задает способ вычисления столбцов текущей таблицы при добавлении записей из источника. Столбцы, не указанные в данном аргументе, при добавлении новой записи, будут заполнены пустыми значениями по умолчанию. Задание аргумента имеет следующий формат: <code>[Aggregate[:<Столбцы группировки через ":">],]<Выражение 1>-><Имя столбца 1>,<Выражение 2>-><Имя столбца 2>...</code>. При наличии зарезервированного слова ''Aggregate'' к источнику данных будет создан запрос агрегации с группировкой по указанным столбцам таблицы или реквизитам объекта {{Planned}}, при этом в выражениях для вычисления можно использовать функции агрегации. Выражения содержат весь возможный набор функций и операторов языка запросов (см. [[Временная таблица базы данных]], [[Объект запрос базы данных]]).
* <code>''<Стандартные фильтры>''</code> - {{Optional}} Стандартные фильтры отбора записей источника данных описаны в статье [[Стандартные фильтры]]. Важное отличие от фильтров функций объектов базы данных заключается в том, что стандартные фильтры всегда работают в сложном (расширенном) режиме, при этом отсутствует требование, что первая строка фильтра должна начинаться на знак '''~'''. Выражения фильтров содержат весь возможный набор функций и операторов языка запросов (см. [[Временная таблица базы данных]], [[Объект запрос базы данных]]), при указании наименование также применимы префиксы (типа ''':'''), как это описано в [[Временная таблица базы данных#Формулы при вычислении полей записей временной таблицы базы данных|статье по временной таблице базы данных]].

== Примеры ==
<pre>
//Пример создает таблицу аТемп, и заполняет ее резервами документа ЗаказНаПроизводство, при этом в ней также заполнено поле документа ВыпускПродукции.
// Документ ВыпускПродукции подчинен документу ЗаказНаПроизводство. Выборка документов происходит за период с НачДата по КонДата.
//Таблица номенклатуры из резервов с выпусками и заданиями
аТемп:=TempDB.Create("зДок:DB,зЗад:DB,зН:DB:I,Количество:NUMBER.15.5");
//Заказы на производство
аТемп.LoadFrom("Stor.Резервы","@LINK->зЗад,Номенклатура->зН,?(@EXPENSE=1,-Количество,Количество)->Количество",
"(BegOfDay(@DATE)>=НачДата)And(BegOfDay(@DATE)<=КонДата)","IsType(@LINK,Doc.ЗаказНаПроизводство)");
//Заполняем зДок (подчиненный документ -- ВыпускПродукции)
вТемп:=TempDB.Create("зДок2:DB,зЗад:DB");
//Выбираются только те документы выпусков, основания которых (ЗаказНаПроизводство) находятся в таблице аТемп
вТемп.LoadFrom("Doc.ВыпускПродукции","@ELEMENT->зДок2,@ELEMENT.ДокОснование->зЗад","@ELEMENT.ДокОснование IN аТемп.зЗад");
//Заполним столбец зДок оригинальной таблицы, объединение происходит по условию ":зЗад=зЗад".
аТемп.Update(вТемп,":зЗад=зЗад,зДок2->зДок");
//В дальнейшем таблицу аТемп можно выводить на экран или использовать в последующих запросах.
</pre>

TempDB.Copy

2026-04-01T10:00:49Z

Admin: 1 revision imported

{{infobox function
|name=Copy
|object=[[Временная таблица базы данных]]
|caption=Дублирование объекта временной таблицы
|type=1
|status=2
|db=0
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Временная таблица базы данных]]}}
Функция создает локальную копию (дубль) ссылки на постоянную таблицу внешней базы данных. Функция не работает с временными таблицами. Дублирование объекта может пригодиться, к примеру, в многопоточном режиме, когда множество потоков выполняют запросы к такой таблице. Если выполнять запросы с помощью одного объекта, следующий запрос будет ожидать окончания предыдущего. Также, эта функция работает гораздо быстрее, чем [[TempDB.Create|Create]], так как не обращается к серверу и не проверяет корректность структуры таблицы.

== Синтаксис ==
<code>
{{Grey|TempDB.}}'''Copy'''():''<Копия ссылки на внешнюю БД (TEMPDB)>''
</code>

==== Возвращаемое значение ====
Возвращает новый объект временной таблицы базы данных.

== Примеры ==
<pre>
//Создание или открытие постоянной таблицы "table1" в базе данных DBExport
аТемп:=TempDB.Create("зДок:DB,зЗад:DB,зН:DB:I,Количество:NUMBER.15.5","DBExport.table1");

//Создадим копию объекта
аТемп2:=аТемп.Copy();
</pre>

Table.RenderToPicture

2026-04-01T10:00:48Z

Admin: 1 revision imported

{{infobox function
|name=RenderToPicture
|object=[[Электронная таблица SFT|Электронная таблица]]
|caption=Работа с печатью и выводом
|type=1
|status=2
|db=0
|exception=Неверные аргументы, системная ошибка.
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Электронная таблица SFT|Электронная таблица]]}}
Функция подготавливает печать таблицы на принтер (деление на страницы, колонтитулы и пр.), однако, выводит информацию в виде картинок в формате BMP вместо печати. Аргумент задает установки для создания картинок, такие как ширина и высота каждой картинки, глубина ее цвета, дипазон страниц для вывода и пр.

== Синтаксис ==
<code>
{{Grey|Table.}}'''RenderToPicture'''(''<Список с настройками для создания рисунков (LIST)>''):''<Картинки в формате BMP (LIST)>''
</code>

==== Аргументы ====
* <code>''<Список с настройками для создания рисунков (LIST)>''</code> - Список содержит настройки, наименованиями служат перечисленные ниже наименования настроек, значениями -- их значения.
** '''PaperWidth''', '''Width''' -- настройка задает ширину картинок в точках. Настройка должна обязательно присутствовать.
** '''PaperHeight''', '''Height''' -- настройка задает высоту картинок в точках. Настройка должна обязательно присутствовать.
** '''BPP''' -- настройка задает глубину цвета в создаваемых картинках. По умолчанию '''16'''. Разрешено использовать значения: 8, 16, 24 и 32.
** '''FromPage''', '''ToPage''' -- настройки задают начальную и конечную страницу таблицы для превращения в картинки. По умолчанию превращать все страницы.
** '''DPI''' -- настройка задают плотность точек на бумаге (Dots per inch), которая используется только для определения размеров полей страницы, так как поля задаются в миллиметрах, а не в точках. По умолчанию этот параметр задается как '''300'''. Также часто используются значения ''72'', ''150'', ''600'', но значение может быть любым. Используя это значение размер поля будет вычисляться по формуле <code><Поле в мм>/25.4*<dpi></code>.

==== Возвращаемое значение ====
Функция возвращает список с некоторым числом объектов типа картинка.

== Примеры ==
<pre>
пТекст:="Текст для поле в таблице";
Т:=Table.Create();
Т.SetSourceName("Modules\FreeForms\СвободныеТаблицы\ТекстНаЭтикетке");

Т.CopyByX("v31",1);
Т.Area(1,1).WrappingMode:=1;
Т.Printing.Fields.Up:=0;
Т.Printing.Fields.Down:=0;
Т.Printing.Fields.Left:=0;
Т.Printing.Fields.Right:=0;
Т.Printing.Titles.Up.Size:=0;
Т.Printing.Titles.Down.Size:=0;
Т.Printing.PageOptions:=_PRN_PAGE_CENTERX+_PRN_PAGE_CENTERY;
Т.Printing.ScaleMode:=3;

//Параметры превращения в картинку
aList:=List.Create();
//Размеры в точках
aList["Width"]:=600;
aList["Height"]:=200;
//Глубина цвета (16 бит)
aList["BPP"]:=16;

//Должна получиться всего одна картинка
bList:=Т.RenderToPicture(aList);
//Сохраним в файл без изменения формата
bList[1].Save("c:\picture.bmp","bmp");
</pre>

Tab.Copy

2026-04-01T10:00:24Z

Admin: 1 revision imported

{{infobox function
|name=Copy
|object=[[Таблица]]
|caption=Копия таблицы
|type=1
|status=2
|db=0
|exception=Невозможно превратить в число
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Таблица]]}}
Функция создает новый объект таблицы и заполняет ее столбцами, строками и значениями из текущей таблицы. Значения скопированы не будут, если первый аргумент равен ''1''. Для больших таблиц, подобная операция может занять продолжительное время. Функция может использоваться, когда, к примеру, исходную таблицу необходимо сохранить, однако, требуется также получение группировок таблицы, либо в подобных ситуациях.

== Синтаксис ==
<code>
{{Grey|Tab.}}'''Copy'''({{Optional|<Только создать столбцы (INT)>{{Default|{{Eq}}0}}}}):''<Новая таблица (TAB)>''
</code>

==== Аргументы ====
* <code>''<Только создать столбцы (INT)>''</code> - {{Optional}} Если аргумент задан и равен ''1'', будет скопирована только структура столбцов таблицы, строки и значения скопированы не будут.

==== Возвращаемое значение ====
Возвращается таблица, полностью соответствующая текущей, однако, являющаяся новым объектом.

== Примеры ==
<pre>
//Создается и заполняется таблица значений
aTab:=Tab.Create("b1,b2,b3,b4");

aTab.AddLine("b1,b2,b3,b4",1,2,3,4);
aTab.AddLine("b1,b2,b3,b4",2,2,3,33);
aTab.AddLine("b1,b2,b3,b4",3,5,5,4);
aTab.AddLine("b1,b2,b3,b4",4,2,3,4);
aTab.AddLine("b1,b2,b3,b4",4,2,3,77);
aTab.AddLine("b1,b2,b3,b4",5,2,3,4);

//Создается копия таблицы, новый объект.
bTab:=aTab.Copy();
//Таблица bTab группируется по столбцам b2 и b3, оригинальная таблица aTab не изменяется
bTab.Group("b2,b3","b1,b4");

Message("Таблица aTab:");
aTab.Select();
While aTab.Next() Do
Message(""+aTab.b1+"; "+aTab.b2+"; "+aTab.b3+"; "+aTab.b4);
EndDo;

Message("Таблица bTab:");
bTab.Select();
While bTab.Next() Do
Message(""+bTab.b1+"; "+bTab.b2+"; "+bTab.b3+"; "+bTab.b4);
EndDo;

//Будет выведено последовательно:
//"Таблица aTab:"
//"1; 2; 3; 4"
//"2; 2; 3; 33"
//"3; 5; 5; 4"
//"4; 2; 3; 4"
//"4; 2; 3; 77"
//"5; 2; 3; 4"
//"Таблица bTab:"
//"16; 2; 3; 122"
//"3; 5; 5; 4"
</pre>

Mutex.ExecuteFunctionInSeparateThread

2026-04-01T09:59:36Z

Admin: 1 revision imported

{{infobox function
|name=ExecuteFunctionInSeparateThread
|object=[[Функции общего назначения#Объект семафор|Семафор]]
|caption=Работа с подчиненными потоками
|type=1
|status=2
|db=0
|exception=Невозможно превратить в строку, число, неверные параметры вызова, системная ошибка
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения#Объект семафор|Семафор]]}}
Функция инициирует исполнение функции с указанным именем в новом подчиненном потоке с заданными аргументами, способ поиска задается вторым аргументом. Если искомая функция не существует, пропущен обязательный аргумент или заданное количество аргументов слишком велико, будет создано исключение. Созданный поток будет автоматически завершен, если выполнение функции завершится (в т.ч. из-за необработанного исключения), либо если основной поток будет завершен. При завершении подчиненного потока, система не ждет полного окончания завершения, так как оно может занять продолжительное время, если функция выполняет внешний вызов OLE и пр., чтобы убедиться, что поток завершен, можно использовать функцию [[Mutex.TerminateThread|TerminateThread]]. Для того, чтобы определить программно, происходит ли исполнение в режиме подчиненного потока, можно использовать функцию [[IsExecutingInSeparateThread]]. Функция может быть вызвана для интерфейса Mutex. Некоторые важные свойства функций, исполняемых в отдельных потоках:
* Если создание такой функции инициировано корневым потоком, функция не будет завершена автоматически и будет находиться в памяти до тех пор, пока клиент не будет закрыт, либо программа не вызовет функцию [[Mutex.TerminateThread|TerminateThread]].
* Исполняемая функция не обязательно должна быть корневой функцией текущего модуля, возможен, к примеру, вызов функции, подчиненной текущей функции, либо функции родительского или глобального модулей.
* Функция, исполняемая в отдельном потоке, может вызывать все функции, находящиеся в текущем модуле, и также она '''будет иметь доступ''' к экспортированным переменным этого модуля. При использовании внешних переменных в отдельном потоке, нужно помнить, что система будет сначала искать по имени локальные переменные, потом экспортируемые переменные текущего модуля и только потом глобальные экспортированные переменные. Если имена переменных будут совпадать, может возникнуть конфликт и неочевидная ошибка.
* В отличие от функции [[ExecuteFunction]], для аргументов функции не будет работать признак ''ByRef'', так как вызвавший поток не ожидает завершения выполнения функции и продолжает работать параллельно с новым.
* Необработанные исключения внутри функции останавливают ее выполнение, но информация об этих исключениях будет поглощена и выведена в лог не будет (отладчик, однако, будет открыт в момент создания исключения, если режим отладки для визуального клиента разрешен).
* Исполнение таких функций происходит быстрее, чем вызов новых модулей в отдельных потоках с помощью [[LoadModule]], однако, открытые потоки завершаются при завершении основного потока, когда как потоки, открытые [[LoadModule]] независимы.

== Синтаксис ==
<code>
{{Grey|Mutex.}}'''ExecuteFunctionInSeparateThread'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска или компилированная функция (INT, COMPILEDFUNCTION)>{{Default|{{Eq}}0}},<Аргумент 1>,<Аргумент 2>...}}):''<Указатель на среду функции (MUTEX)>''
</code>
==== Аргументы ====
* <code>''<Имя функции (STRING)>''</code> - Имя функции, которую необходимо исполнить
* <code>''<Глубина поиска (INT)>''</code> - {{Optional}} Может принимать следующие значения:
** -1 -- выполнять поиск по последовательности функций из стека вызовов, а не искать, используя подчинение функций на момент компиляции. Этот способ предпочтительнее использовать в компилированных функциях, вызываемых из разных мест модуля или из разных модулей, чтобы получить доступ к реальной среде функций, а не к оной на момент компиляции.
** 0 (по умолчанию) -- выполнять поиск по всех модулях [[Общее описание языка#Вложенность функций и модулей, уровни вложенности|большего уровня вложенности]] (родительских) и во всех глобальных модулях.
** 1 -- выполнять поиск только внутри текущего модуля.
** 2 -- выполнять поиск только внутри родительского модуля.
** 3..x -- выполнять поиск только внутри родительского модуля указанного уровня (к примеру, для уровня 3, выполнять поиск только в родителе родителя текущего модуля).
** Объект типа [[Compile|компилированная функция]] -- выполнять поиск функции внутри заданной компилированной функции (только среди функций верхнего уровня).
* <code>''<Аргумент ?>''</code> - {{Optional}} Аргументы, передаваемые исполняемой функции

==== Возвращаемое значение ====
Возвращает объект семафора, указывающего на новый запущенный поток. В дальнейшем этот объект можно использовать с функциями, типа [[Mutex.TerminateThread|TerminateThread]]. Если поток не удалось запустить, по каким-либо причинам, функция либо вызывает исключение, либо отдает объект, для которого функция [[Mutex.IsThreadActive|IsThreadActive]] возвращает ноль.

== Примеры ==
<pre>
//Пример выполняет параллельный процесс отправки данных и обновляет индикатор его выполнения

Function ВыполнитьПроцесс(спДанные)
Форма:=спДанные.GetByName("Форма");
TCP:=спДанные.GetByName("Соединение");
аСтр:=спДанные.GetByName("Данные");
аВсего:=Length(аСтр);
аОтослано:=0;
Фл:=1;
//Цикл отсылает данные и обновляет текстовое поле на форме
While Length(аСтр)>0 Do
аСтр2:=Left(аСтр,1024);
аСтр:=Mid(аСтр,1025);
Try
TCP.SendStrRaw(аСтр2);
Except
Фл:=0;
Break;
EndTry;
аОтослано:=аОтослано+Length(аСтр2);
Форма.оИндикатор.Caption:="Выполнено: "+Round(аОтослано/аВсего,2)+"%";
EndDo;
If Фл Then
Форма.оИндикатор.Caption:="Отправка выполнена успешно!";
Else
Форма.оИндикатор.Caption:="Ошибка при отправке!";
EndIf;
EndFunction

//Подготовка данных аСтр, соединение с удаленным сервером TCP

спДанные:=List.Create();
спДанные.SetByName("Форма",Form.ThisForm());
спДанные.SetByName("Соединение",TCP);
спДанные.SetByName("Данные",аСтр);
Mutex.ExecuteFunctionInSeparateThread("ВыполнитьПроцесс",0,спДанные);

...
</pre>

Lib.CreateCallbackFunction

2026-04-01T09:59:32Z

Admin: 1 revision imported

{{infobox function
|name=CreateCallbackFunction
|object=[[Объект загружаемой системной библиотеки|Библиотека]]
|caption=Создание функции обратного вызова
|type=1
|status=2
|db=0
|exception=Невозможно превратить в строку, локальная функция не найдена, неверные аргументы, системная ошибка.
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Объект загружаемой системной библиотеки|Библиотека]]}}
Функция создает особую область в памяти, вызывая которую, любая внешняя библиотека или приложение будут автоматически вызывать указанную локальную функцию. Аргументы вызова переводятся по заданным правилам в объекты системы. Локальная функция, кроме возврата результата, может изменить аргументы, которые возвратятся на вызывающую сторону, если они помечены, как изменяемые аргументы. Функция может быть вызвана как из того же самого системнго потока, так и из любого другого (однако, в последнем случае, если исходный поток занят выполнением программы в момент вызова, будет создано исключение). Обычно такие функции могут пригодиться, если вызов системной библиотеки включает обратный вызов для перечисления результатов или индикации выполнения какого-либо процесса. Функция будет доступна для вызова, пока сам объект не будет удален из системы, поэтому, если адрес передается во внешнюю среду, нужно хранить объект до тех, пока он может использоваться.

== Синтаксис ==
<code>
{{Grey|Lib.}}'''CreateCallbackFunction'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска (INT)>{{Default|{{Eq}}0}},<Способ вызова (STRING)>{{Default|{{Eq}}"Stdcall"}},<Аргументы функции (STRING)>,<Возвращаемое значение (STRING)>}}):''<Новый объект функции обратного вызова (CBFUNCTION)>''
</code>
==== Аргументы ====
* <code>''<Имя функции (STRING)>''</code> - Аргумент задает имя локальной или глобальной функции, которой будет передано управление в момент внешнего вызова системной функции, задаваемой своим адресом.
* <code>''<Глубина поиска (INT)>''</code> - {{Optional}} Задает способ поиска локальной функции. Может принимать следующие значения:
** -1 -- выполнять поиск по последовательности функций из стека вызовов, а не искать, используя подчинение функций на момент компиляции. Этот способ предпочтительнее использовать в компилированных функциях, вызываемых из разных мест модуля или из разных модулей, чтобы получить доступ к реальной среде функций, а не к оной на момент компиляции.
** 0 (по умолчанию) -- выполнять поиск во всех модулях [[Общее описание языка#Вложенность функций и модулей, уровни вложенности|большего уровня вложенности]] (родительских) и во всех глобальных модулях.
** 1 -- выполнять поиск только внутри текущего модуля.
** 2 -- выполнять поиск только внутри родительского модуля.
** 3..x -- выполнять поиск только внутри родительского модуля указанного уровня (к примеру, для уровня 3, выполнять поиск только в родителе родителя текущего модуля).
* <code>''<Способ вызова (STRING)>''</code> - {{Optional}} Аргумент задает способ вызова функции системной функции снешним источником (см. [[Объект загружаемой системной библиотеки|статью]] для дополнительной информации). Возможны следующие значения аргумента:
** '''stdcall''' (x86,x64) -- стандартный способ вызова функций Windows, используется по умолчанию. Для x64 является единственным доступным способом вызова.
** '''cdecl''' (x86) -- используется при вызове из среды, скомпилированной с помощью C или C++.
** '''fastcall''' (x86) -- используется при вызове из среды, скомпилированной с помощью C или C++, когда вызываемая функция там помечена, как fastcall.
** '''register''' (x86) -- используется при вызове из функций, скомпилированных с помощью Delphi или Free Pascal. Важно понимать, что, возможно, придется пометить некоторые параметры при вызове таких функций с помощью префикса "+" (см. ниже).
** '''vectorcall''' (x86,x64) -- способ вызова, оперирующий длинными числами (128 бит), в данный момент не поддерживается.
* <code>''<Аргументы функции (STRING)>''</code> - {{Optional}} Задает список и тип аргументов, передаваемых функции. Строка имеет следующий формат: <code><Аргумент 1>,<Аргумент 2>,...</code>. Где ''аргумент'' имеет следующий формат: <code>[<Префиксы типа данных>]<Тип данных аргумента>[<Размер типа данных>]</code>. Далее даются все возможные префиксы и наименования типов данных:
** '''^''' (префикс) -- определяет то, что аргумент будет являться ссылкой (указателем, ''pointer'') на данные, а не самими данными.
** '''^^''' (префикс) -- определяет то, что аргумент будет являться ссылкой (указатель, ''pointer'') на ссылку на данные, а не самими данными. Префикс можно эмулировать с помощью манипуляции с буфером данных.
** '''@''' (префикс) -- определяет то, что аргумент будет являться ссылкой (указателем, ''pointer'') на данные, а не самими данными. Также помечает аргументы "by ref", т.е., аргументы, значение которых может быть изменено функцией и должно быть передано назад в вызывавшую программу. '''Важно''': без этого префикса, измененные функцией значения не будут переданы назад, даже если аргумент локальной функции имеет префикс ''ByRef''. Префикс может дополняться префиксом ''^'', если необходимо.
** '''U''' (префикс) -- используется для типов ''I'' или ''N'', указывает на то, что данные представляют собой беззнаковое число (по умолчанию число со знаком)
** '''+''' (префикс) -- определяет то, что данный аргумент всегда будет передаваться в стек, а не с помощью регистра процессора. Флаг имеет значение только для способа вызова функции ''register''. Для его использования необходимо полностью понимать, как работает вызов функции (calling convention) такого типа. Обычно нет необходимости в использовании этого префикса, система сама правильно определит какие аргументы будут передаваться в стек, а какие с помощью регистров.
** '''I<Размер в битах>''' или '''Int<Размер в битах>''' (наименование типа данных) -- задает целый тип аргумента. Размер может принимать следующие значения: '''8''', '''16''', '''32''', '''64'''.
** '''N''' или '''Native''' (наименование типа данных) -- задает целый тип аргумента с размером, задаваемым текущей архитектурой исполнения приложения. Для ''x86'' длина поля будет представлять 32 бита, для ''x64'' -- 64 бита.
** '''R<Размер в битах>''' или '''Real<Размер в битах>''' (наименование типа данных) -- задает вещественный тип аргумента. Размер может принимать следующие значения: '''32''' (одинарная точность), '''64''' (двойная точность), '''80''' (расширенная точность). Расширенная точность не поддерживается при стандартных вызовах "x64" функций, при написании расширения программы, можно пользоваться, к примеру, ссылкой на вещественное число ('''P''') и получение его из буфера.
** '''B<Размер в битах>''' или '''Bool<Размер в битах>''' (наименование типа данных) -- задает булевый тип аргумента. Размер может принимать следующие значения: '''8''', '''16''', '''32''', '''64'''.
** '''P''' или '''Pointer''' (наименование типа данных) -- задает тип данных указателя на данные. Для ''x86'' длина поля будет поставлять 32 бита, для ''x64'' -- 64 бита. При вызове функцией в аргументах такого типа удобно возвращать объекты буфера или записи.
** '''SZ<Размер в байтах>''' или '''SZW<Размер в словах>''' (наименование типа данных) -- задает аргумент с типом строка, заканчивающаяся нулевым символом. Строка может иметь формат ANSI (''SZ'') или UTF-16 (''SZW''). Строки всегда должны быть объявлены с префиксом ''^'' (ссылка на данные). Размер может принимать нулевое значение, если заранее неизвестно, строка какого размера будет использоваться. В случае нулевого размера, однако, при подготовке аргумента, размер будет выделен точно под строку. Кроме строковых значений, система принимает также буферы или записи (для которых вызов выполняется несколько быстрее, чем для строк).
** '''S<Размер в байтах>''' или '''SW<Размер в словах>''' (наименование типа данных) -- задает аргумент с типом строка фиксированной длины. Строка может иметь формат ANSI (''S'') или UTF-16 (''SW''). Строки всегда должны быть объявлены с префиксом ''^'' (ссылка на данные). Размер может принимать нулевое значение, если заранее неизвестно, строка какого размера будет использоваться. В случае нулевого размера, однако, при подготовке аргумента, размер будет выделен точно под строку. Кроме строковых значений, система принимает также буферы (для которых вызов выполняется несколько быстрее, чем для строк).
* <code>''<Возвращаемое значение (STRING)>''</code> - {{Optional}} Имеет формат одного аргумента функции (см. выше), если аргумент опущен, возвращаемое функцией значение будет игнорировано (функция не возвращает значения).

==== Возвращаемое значение ====
Возвращается новый объект функции обратного вызова.

== Примеры ==
<pre>
//Пример производит вывод на экран заголовков и наименований классов всех видимых верхних окон системы.
Var aUser32 Export;

Function EnumWindowsProc(hwnd,LParam)
If aUser32.IsWindowVisible(hwnd) Then
СтрИмя:="";
aUser32.GetWindowText(hwnd,СтрИмя,4095);
СтрКласс:="";
aUser32.GetClassName(hwnd,СтрКласс,4095);
Message(""+hwnd+":"+СтрКласс+?(СтрИмя<>"","("+СтрИмя+")"));
EndIf;
Result:=1;
EndFunction

//Загрузка нужных системных функций
aUser32:=Lib.Load("user32.dll");
aUser32.RegisterFunction("EnumWindows","stdcall","P,N","B32");
aUser32.RegisterFunction("GetWindowTextW:GetWindowText","stdcall","N,@SZW4096,I32","I32");
aUser32.RegisterFunction("GetClassNameW:GetClassName","stdcall","N,@SZW4096,I32","I32");
aUser32.RegisterFunction("IsWindowVisible","stdcall","N","B32");

//Создание функции объекта для вызова EnumWindowsProc из системной области памяти
aEnumWindowsProc:=Lib.CreateCallbackFunction("EnumWindowsProc",,"stdcall","I32,N","B32");

//Вызов системной функции EnumWindowsProc, которая, в свою очередь, будет вызывать созданную ранее EnumWindowsProc для каждого найденного окна
aUser32.EnumWindows(aEnumWindowsProc,0);
</pre>

GlobalStringsSaveToFile

2026-04-01T09:59:06Z

Admin: 1 revision imported

{{infobox function
|name=GlobalStringsSaveToFile
|object=[[Функции общего назначения]]
|caption=Глобальные строки-массивы
|type=1
|status=2
|db=0
|exception=Неверные агрументы, системная ошибка сервера, не найден массив.
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция выполняет сохранение массива на диск в файловой системе сервера в виде файла. Обычно она выполняется автоматически, если в массиве были изменения после определенного количества времени.
== Синтаксис ==
<code>
'''GlobalStringsSaveToFile'''(''<Имя или идентификатор массива (STRING,INT)>''{{Optional|,<Имя файла на сервере (STRING)>,<Если время последней записи было не раньше в мс. (INT)>{{Default|{{Eq}}0}}}}):''<1 или 0>''
</code>
==== Аргументы ====
* <code>''<Имя или идентификатор массива (STRING,INT)>''</code> - Параметр задает имя массива (строка) или идентификатор массива (число).
* <code>''<Имя файла на сервере (STRING)>''</code> - {{Optional}} Аргумент, строковое представление которого будет представлять имя файла в [[Имена файлов|нотации системы]]. На данный момент принимается только путь к файлам на сервере. Если аргумент не задан, используется тот файл, который был указан при создании массива, см. [[GlobalStringsHeapsAdd]].
* <code>''<Если время последней записи было не раньше в мс. (INT)>''</code> - {{Optional}} {{Planned}} Сохранение будет выполняться только если последнее автоматическое или вызванное этой функцией сохранение было не ранее указанного количества миллисекунд назад. По умолчанию, '''0''', выполняется безусловное сохранение.
==== Возвращаемое значение ====
Возвращает 1, если сохранение выполнено успешно (или не требуется, так как предыдущее было выполнено недавно), 0, если сохранение не удалось выполнить (к примеру, из-за того, что файл был занят).

== Примеры ==
<pre>
GlobalStringsSaveToFile(Массив,"Temp\Массивы\Current.bin");
</pre>

GlobalStringsShrink

2026-04-01T09:59:06Z

Admin: 1 revision imported

{{infobox function
|name=GlobalStringsShrink
|object=[[Функции общего назначения]]
|caption=Глобальные строки-массивы
|type=1
|status=2
|db=0
|exception=Неверные агрументы, системная ошибка сервера, не найден массив.
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция форсирует процедуру сжатия памяти буферов массива, которая обычно выполняется автоматически после определенного количества удалений из массива.
== Синтаксис ==
<code>
'''GlobalStringsShrink'''(''<Имя или идентификатор массива (STRING,INT)>''{{Optional|,''<Порог сжатия в % (INT)>''{{Default|{{Eq}}0}}}})
</code>
==== Аргументы ====
* <code>''<Имя или идентификатор массива (STRING,INT)>''</code> - Параметр задает имя массива (строка) или идентификатор массива (число).
* <code>''<Порог сжатия в % (INT)>''</code> - {{Optional}} Аргумент задает процент свободного места в данных буфера по отношению к размеру данных в буфере для инициации процедуры сжатия для буфера. Проверки выполняются для отдельных буферов, множество которых входят в один массив. По умолчанию -- 0%, безусловное сжатие.

== Примеры ==
<pre>
//Выполнить удаление большого количества значений из массива Массив
GlobalStringsRemove(Массив,СтрЗначения,0);

//Сжать буферы массива, освободив память, если место, занимаемое полезными данными в них, менее половины объема буферов
GlobalStringsShrink(Массив,50);
</pre>

GlobalStringsAdd

2026-04-01T09:59:05Z

Admin: 1 revision imported

{{infobox function
|name=GlobalStringsAdd
|object=[[Функции общего назначения]]
|caption=Глобальные строки-массивы
|type=1
|status=2
|db=0
|exception=Неверные агрументы, системная ошибка сервера, не найден массив.
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция добавляет произвольное количество строк из списка или одной строки с разделителями в массив, заданный по его наименованию или идентификатору. Режим функции задает условие добавления, а также формат ответа (последний может быть как числовым, так и в виде списка).
== Синтаксис ==
<code>
'''GlobalStringsAdd'''(''<Имя или идентификатор массива (STRING,INT)>'',''<Значения (STRING,LIST)>''{{Optional|,''<Режим (INT)>''{{Default|{{Eq}}0}}}}):''<Статус или результат (INT,LIST)>''
</code>
==== Аргументы ====
* <code>''<Имя или идентификатор массива (STRING,INT)>''</code> - Параметр задает имя массива (строка) или идентификатор массива (число) для добавления значений.
* <code>''<Значения (STRING,LIST)>''</code> - Значения для добавления могут быть в списке или в строке. Каждое значение может содержать префикс, отделенный от основной строки разделителем префикса (см. [[GlobalStringsHeapsAdd]]). При добавлении из строки, каждое значение (с префиксом) должно быть разделено разделителем значений (см. [[GlobalStringsHeapsAdd]]).
* <code>''<Режим (INT)>''</code> - {{Optional}} Аргумент задает режим добавления и является битовой маской. На данный момент доступны следующие биты:
** '''бит 0''' -- если установлен, функция возвращает список уже присутствующих (из добавляемых) в массиве значений, иначе статус будет числом (см. ниже).
** '''бит 1''' -- если установлен, функция добавляет те значения, которых нет, игнорируя те, что уже присутствуют в массиве. Если сброшен (по умолчанию), функция не изменяет массив, если по крайней мере одно из добавляемых значений уже содержится в массиве.
** '''бит 2''' -- если установлен, функция обновит префиксы для значений, которые уже присутствовали в массиве (в не зависимости от того, установлен ли бит 1 или нет).
** '''бит 3''' -- если установлен (и не установлен бит 0), функция возвращает только 0 (все значения новые) или 1 (некоторые значения присутствовали в массиве). Вместо статуса 2 (все значения уже присутствовали в массиве) также возвращается число 1, что позволяет выполнить операцию немного быстрее.
==== Возвращаемое значение ====
Если бит 0 аргумента режима сброшен (по умолчанию), возвращает следующее числовое значение: '''0''' -- все значения новые и были добавлены в массив, '''1''' -- некоторые значения присутствовали в массиве (по умолчанию, в массив ничего не добавлено, но при установке бита 1 аргумента режима, отсутствующие значения все-таки были добавлены, также в зависимости от бита 2 режима, в массиве могли быть обновлены префиксы найденных значений), '''2''' -- все значения уже присутствали в массиве (в зависимости от бита 2 режима, в массиве могли быть обновлены префиксы значений). Если бит 0 аргумента режима установлен, функция возвращает список.

== Примеры ==
<pre>
Массив:=GlobalStringsHeapsFind("MRK"+FormatDate(Date(),"YYYYmmdd"));

...
//Находится строка добавления СтрНовыеМарки, значения разделены заранее заданной строкой-разделителем.
...

If Массив>0 Then
GlobalStringsAdd(Массив,СтрНовыеМарки,6);//форсированное добавление, обновление префиксов, если они изменились
EndIf;
</pre>

GlobalStringsAddFromFile

2026-04-01T09:59:05Z

Admin: 1 revision imported

{{infobox function
|name=GlobalStringsAddFromFile
|object=[[Функции общего назначения]]
|caption=Глобальные строки-массивы
|type=1
|status=2
|db=0
|exception=Неверные агрументы, системная ошибка сервера, не найден массив.
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция выполняет добавление сохраненного ранее массива с диска в файловой системе сервера к массиву, заданному по наименованию или идентификатору. Обычно она выполняется автоматически при создании массива, если указан файл его хранения.
== Синтаксис ==
<code>
'''GlobalStringsAddFromFile'''(''<Имя или идентификатор массива (STRING,INT)>'',''<Имя файла на сервере (STRING)>''{{Optional|,''<Очистить массив перед загрузкой (INT)>''{{Default|{{Eq}}0}}}}):''<1 или 0>''
</code>
==== Аргументы ====
* <code>''<Имя или идентификатор массива (STRING,INT)>''</code> - Параметр задает имя массива (строка) или идентификатор массива (число).
* <code>''<Имя файла на сервере (STRING)>''</code> - Аргумент, строковое представление которого будет представлять имя файла в [[Имена файлов|нотации системы]]. На данный момент принимается только путь к файлам на сервере.
* <code>''<Очистить массив перед загрузкой (INT)>''</code> - {{Optional}} Массив, заданный первым агрументом будет очищен, перед загрузкой, если данный аргумент равен ''1''. По умолчанию, ''0'', данные будут добавлены к текущему массиву.
==== Возвращаемое значение ====
Возвращает 1, если загрузка выполнена успешно, 0, если загрузку не удалось выполнить (к примеру, файл не существовал).

== Примеры ==
<pre>
GlobalStringsAddFromFile(Массив,"Temp\Массивы\Current.bin");
</pre>

GlobalStringsFind

2026-04-01T09:59:05Z

Admin: 1 revision imported

{{infobox function
|name=GlobalStringsAdd
|object=[[Функции общего назначения]]
|caption=Глобальные строки-массивы
|type=1
|status=2
|db=0
|exception=Неверные агрументы, системная ошибка сервера, не найден массив.
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция выполняет поиск произвольного количества строк, заданных в списке или в одной строке с разделителями, в массиве по его наименованию или идентификатору. Режим функции задает условие поиска, а также формат ответа (последний может быть как числовым, так и в виде списка).
== Синтаксис ==
<code>
'''GlobalStringsFind'''(''<Имя или идентификатор массива (STRING,INT)>'',''<Значения (STRING,LIST)>''{{Optional|,''<Режим (INT)>''{{Default|{{Eq}}0}}}}):''<Статус или результат (INT,LIST)>''
</code>
==== Аргументы ====
* <code>''<Имя или идентификатор массива (STRING,INT)>''</code> - Параметр задает имя массива (строка) или идентификатор массива (число) для поиска значений.
* <code>''<Значения (STRING,LIST)>''</code> - Значения для поиска могут быть в списке или в строке. Каждое значение может содержать префикс, отделенный от основной строки разделителем префикса (см. [[GlobalStringsHeapsAdd]]). Если аргумент строка, каждое значение (с префиксом) должно быть разделено разделителем значений (см. [[GlobalStringsHeapsAdd]]).
* <code>''<Режим (INT)>''</code> - {{Optional}} Аргумент задает режим поиска и является битовой маской. На данный момент доступны следующие биты:
** '''бит 0''' -- если установлен, функция возвращает список уже найденных в массиве значений, иначе статус будет числом (см. ниже).
** '''бит 3''' -- если установлен (и не установлен бит 0), функция возвращает только 0 (все значения найдены) или 1 (некоторые значения найдены). Вместо статуса 2 (все значения найдены) также возвращается число 1, что позволяет выполнить операцию немного быстрее.
==== Возвращаемое значение ====
Если бит 0 аргумента режима сброшен (по умолчанию), возвращает следующее числовое значение: '''0''' -- все значения были найдены в массиве, '''1''' -- некоторые значения были найдены в массиве, '''2''' -- все значения были найдены в массиве. Если бит 0 аргумента режима установлен, функция возвращает список найденных значений.

== Примеры ==
<pre>
//СтрКоды -- значения для поиска дублей
//СпМассивыМарок -- список массивов, где производится поиск дублей
СпДубли:=List.Create();
For i:=1 To СпМассивыМарок.Size() Do
Try
//Возвратить список и добавить его содержимое к списку СпДубли
GlobalStringsFind(СпМассивыМарок[i],СтрКоды,1).CopyTo(СпДубли);
Except
//Возможно, один из старых массивов был удален до этой операции другим пользователем
EndTry;
EndDo;
//СпДубли -- список найденных дублей для вывода
</pre>

GlobalStringsHeapsFind

2026-04-01T09:59:05Z

Admin: 1 revision imported

{{infobox function
|name=GlobalStringsHeapsFind
|object=[[Функции общего назначения]]
|caption=Глобальные строки-массивы
|type=1
|status=2
|db=0
|exception=Системная ошибка сервера
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция проверяет, существует ли на сервере массив по его наименованию. Если массив существует, будет возвращен его идентификатор, иначе ноль.
== Синтаксис ==
<code>
'''GlobalStringsHeapsFind'''(''<Имя массива (STRING)>''):''<Идентификатор или ноль (INT)>''
</code>
==== Аргументы ====
* <code>''<Имя массива (STRING)>''</code> - Параметр задает имя массива по наименованию (строка) или идентификатору (число).

==== Возвращаемое значение ====
Возвращает числовое значение.

== Примеры ==
<pre>
аДата:=BegOfDay(Date());
If GlobalStringsHeapsFind("MRK"+FormatDate(аДата,"YYYYmmdd"))>0 Then
Message("Массив за сегодня уже был создан!");
EndIf;
</pre>

GlobalStringsRemove

2026-04-01T09:59:05Z

Admin: 1 revision imported

{{infobox function
|name=GlobalStringsRemove
|object=[[Функции общего назначения]]
|caption=Глобальные строки-массивы
|type=1
|status=2
|db=0
|exception=Неверные агрументы, системная ошибка сервера, не найден массив.
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция удаляет произвольное количество строк из списка или одной строки с разделителями из массива, заданного по его наименованию или идентификатору. Режим функции задает условие удаления, а также формат ответа (последний может быть как числовым, так и в виде списка).
== Синтаксис ==
<code>
'''GlobalStringsRemove'''(''<Имя или идентификатор массива (STRING,INT)>'',''<Значения (STRING,LIST)>''{{Optional|,''<Режим (INT)>''{{Default|{{Eq}}0}}}}):''<Статус или результат (INT,LIST)>''
</code>
==== Аргументы ====
* <code>''<Имя или идентификатор массива (STRING,INT)>''</code> - Параметр задает имя массива (строка) или идентификатор массива (число) для удаления значений.
* <code>''<Значения (STRING,LIST)>''</code> - Значения для удаления могут быть в списке или в строке. Каждое значение может содержать префикс, отделенный от основной строки разделителем префикса (см. [[GlobalStringsHeapsAdd]]). При добавлении из строки, каждое значение (с префиксом) должно быть разделено разделителем значений (см. [[GlobalStringsHeapsAdd]]).
* <code>''<Режим (INT)>''</code> - {{Optional}} Аргумент задает режим удаления и является битовой маской. На данный момент доступны следующие биты:
** '''бит 0''' -- если установлен, функция возвращает список удаленных из массива значений (только те, что были найдены), иначе статус будет числом (см. ниже).
** '''бит 1''' -- если установлен, функция не выполняет удаления значений, если хотя бы одно из них отсутствует в массиве на момент выполнения операции. Если сброшен (по умолчанию), функция удаляет найденные, вне зависимости от того, все ли значения присутствуют в массиве.
==== Возвращаемое значение ====
Если бит 0 аргумента режима сброшен (по умолчанию), возвращает следующее числовое значение: '''0''' -- ни одно из искомых значений не было найдено в массиве (удаления не производилось), '''1''' -- некоторые значения присутствовали в массиве (по умолчанию, он были удалены из массива, но при установке бита 1 аргумента режима, массив не был изменен), '''2''' -- все значения присутствали в массиве и были удалены. Если бит 0 аргумента режима установлен, функция возвращает список.

== Примеры ==
<pre>

...
//СтрСтарыеМарки: значения для удаления разделены заранее заданной строкой-разделителем.
//СпМассивыМарок: массивы, созданные на данный момент
If СтрСтарыеМарки<>"" Then
For i:=1 To СпМассивыМарок.Size() Do
Try
GlobalStringsRemove(СпМассивыМарок[i],СтрСтарыеМарки,0);//Удалить те, которые были найдены
Except
//Возможно, один из старых массивов был удален до этой операции другим пользователем
EndTry;
EndDo;
EndIf;

</pre>

GetModuleFunction

2026-04-01T09:59:04Z

Admin: 1 revision imported

{{infobox function
|name=GetModuleFunction
|object=[[Функции общего назначения]]
|caption=Системные функции
|type=1
|status=2
|db=0
|exception=Невозможно превратить в число, неверный уровень функции.
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция отдает объект компилированной функции, находящейся на требуемом уровне над текущей исполняемой функцией (этот объект, если найден, всегда включает текущую исполняемую функцию). В дальнейшем этот объект можно использовать для вызова функций по именам (см. [[ExecuteFunction]]), или экспортирования функции.
== Синтаксис ==
<code>
'''GetModuleFunction'''({{Optional|<Уровень родительской функции от текущей (INT)>{{Default|{{Eq}}0}}}}):''<Требуемая функция в виде объекта (COMPILEDFUNCTION)>''
</code>
==== Аргументы ====
* <code>''<Уровень родительской функции от текущей (INT)>''</code> - {{Optional}} Аргумент задает требуемый уровень родительской функции. По-умолчанию, ''0'', объект содается для текущей функции. Нужнопонимать, что уровень родителя здесь, это не уровень вызова (рекурсии), а уровень исходного текста.

==== Возвращаемое значение ====
Возвращает новый объект компилированной функции, который можно исполнить с помощью функций [[Exec]] и [[ExecEx]], либо экспортировать в память с помощью [[SaveFunctionToBuffer]].

== Примеры ==
<pre>
//Пример показывает разницу между уровенем исходного текста при получении функции и уровнем рекурсии,
// а также глобальными переменными, доступными в контексте исполнения, а не внутри объекта функции.
Var Счетчик Export;

Function Рекурсия()
Счетчик:=Счетчик+1;
Message("Счетчик (вложенность вызова): "+Счетчик);
If Счетчик>99 Then
Message("Выходим из рекурсии.");
Exit;
EndIf;
//Получим объект функции, в которой располагается текущая функция Рекурсия()
аФункция:=GetModuleFunction(1);
//Выполним вызов из этого объекта
ExecuteFunction("Рекурсия",аФункция);
EndFunction

Счетчик:=0;
Рекурсия();
//В логе должно отобразиться: 100 строк "Счетчик (вложенность вызова): ??" и последняя строка "Выходим из рекурсии.".
</pre>

GIObject.LinkEvent

2026-04-01T09:59:03Z

Admin: 1 revision imported

{{infobox function
|name=LinkEvent
|object=[[Объект GI#Атрибуты и функции графических объектов|Графический объект объекта GI]]
|caption=Функции графических объектов
|type=1
|status=2
|db=0
|exception=Неверные аргументы.
|visual=1}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Объект GI]]}}
Функция ассоциирует локальную функцию по ее имени со стандартным событием графического объекта. Также функции может передаваться один произвольный аргумент при ее вызове. На данный момент доступны следующие стандартные события объектов: '''OnDraw''', '''OnNewInput''', '''OnChange''', '''OnMove'''.

== Синтаксис ==
<code>
{{Grey|GIObject.}}'''LinkEvent'''(''<Имя события (STRING)>''{{OptionalByRef|,<Имя локальной функции (STRING)>,<Глубина поиска (INT)>{{Default|{{Eq}}0}},<Аргумент функции>}})
</code>

==== Аргументы ====
* <code>''<Имя события (STRING)>''</code> - Аргумент задает имя события для ассоциации. На данный момент доступны следующие имена событий:
** '''OnDraw''': Событие вызывается в момент необходимости нарисовать текущий объект. В нем можно разместить произвольный код для прорисовки и в нужный момент вызвать функцию [[GIObject.DrawObject|DrawObject]], которая выполняет саму прорисовку объекта. Локальная функция для вызова этого события должна содержать три аргумента -- объект GI, рисуемый графический объект и доп. параметр, заданный в этой функции, пример: <code>Function Прорисовка(aGI,аОбъект,ДопПараметр)</code>.
** '''OnNewInput''': {{Planned}} Событие будет вызываться в момент получения новой информации от внешних устройств ввода (клавиатура, мышь, контроллер), когда объект имеет фокус, либо в момент получения или потери фокуса объектом.
** '''OnChange''': {{Planned}} Событие будет вызываться в момент изменения статуса объекта или его определенных атрибутов.
** '''OnMove''': {{Planned}} Событие будет вызываться в момент движения, вращения или мастабирования объекта.
* <code>''<Имя локальной функции (STRING)>''</code> - Аргумент задает имя локальной или глобальной функции, которая будет вызываться при наступлении события.
* <code>''<Глубина поиска (INT)>''</code> - {{Optional}} Задает способ поиска локальной функции. Может принимать следующие значения:
** -1 -- выполнять поиск по последовательности функций из стека вызовов, а не искать, используя подчинение функций на момент компиляции. Этот способ предпочтительнее использовать в компилированных функциях, вызываемых из разных мест модуля или из разных модулей, чтобы получить доступ к реальной среде функций, а не к оной на момент компиляции.
** 0 (по умолчанию) -- выполнять поиск во всех модулях [[Общее описание языка#Вложенность функций и модулей, уровни вложенности|большего уровня вложенности]] (родительских) и во всех глобальных модулях.
** 1 -- выполнять поиск только внутри текущего модуля.
** 2 -- выполнять поиск только внутри родительского модуля.
** 3..x -- выполнять поиск только внутри родительского модуля указанного уровня (к примеру, для уровня 3, выполнять поиск только в родителе родителя текущего модуля).
* <code>''<Аргумент функции>''</code> - {{Optional}} Содержит произвольное значение, которое будет передано локальной функции третим аргументом при ее вызове.

== Примеры ==
<pre>
//Используется фрагмент из обработки tetris.sfo

Function OnDrawObject(aGI,aObj)
aGI.ShaderProgramSetVariable(лкПрограммы[2],"u_offset",,0,лкТекущаяФигура[5]*лкШиринаКвадрата);
aObj.DrawObject();
aGI.ShaderProgramSetVariable(лкПрограммы[2],"u_offset",,0,0);
EndFunction

...
аМодель:=GIModel.New();
аМодель.SimpleModel(Buffer.Create());
аОбъектФигуры:=aGI.AddObject();
аОбъектФигуры.Model(аМодель);
аОбъектФигуры.LinkEvent("ONDRAW","OnDrawObject",1);
лкОбъекты[2]:=аОбъектФигуры;

</pre>

GI.LinkEvent

2026-04-01T09:59:01Z

Admin: 1 revision imported

{{infobox function
|name=LinkEvent
|object=[[Объект GI]]
|caption=Общие функции объекта GI
|type=1
|status=2
|db=0
|exception=Неверные аргументы, локальная функция не найдена.
|visual=1}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Объект GI]]}}
Функция ассоциирует локальную функцию по ее имени со стандартным событием объекта ''GI''. Предыдущая ассоциация при этом удаляется. Также функции может передаваться один произвольный аргумент. На данный момент доступны следующие стандартные события: '''OnDraw''', '''OnResize''', '''OnNewInput'''.

== Синтаксис ==
<code>
{{Grey|GI.}}'''LinkEvent'''(''<Имя события (STRING)>''{{Optional|,<Имя локальной функции (STRING)>,<Глубина поиска (INT)>{{Default|{{Eq}}0}},<Аргумент функции>}})
</code>

==== Аргументы ====
* <code>''<Имя события (STRING)>''</code> - Аргумент задает имя события для ассоциации. На данный момент доступны следующие имена событий:
** '''OnDraw''': Событие вызывается в момент прорисовки кадра из функции [[GI.InitiateRedraw|InitiateRedraw]]. В нем можно разместить произвольный код для прорисовки и в нужный момент вызвать функцию [[GI.DrawScene|DrawScene]], которая выполняет рисование всех графических объектов. Локальная функция для вызова этого события должна содержать два аргумента -- объект GI и доп. параметр, заданный в этой функции, пример: <code>Function Прорисовка(ОбъектGI,ДопПараметр)</code>.
** '''OnResize''': Событие вызывается в момент изменения размера окна ''GI'' из функции [[GI.InitiateRedraw|InitiateRedraw]]. В нем можно разместить произвольный код, связанный с изменением размеров рисуемых элементов. Локальная функция для вызова этого события должна содержать четыре аргумента (разрешается не указывать два последних) -- объект GI и доп. параметр, заданный в этой функции, новая ширина окна ''GI'', новая высота окна ''GI'', пример: <code>Function ИзменилосьОкно(ОбъектGI,ДопПараметр,ШиринаОкна,ВысотаОкна)</code>.
** '''OnNewInput''': Событие вызывается в момент получения новой информации от внешних устройств ввода (клавиатура, мышь, контроллер), либо в момент получения или потери фокуса окном ''GI'' из функции [[GI.InitiateRedraw|InitiateRedraw]]. В нем можно разместить произвольный код, связанный с реакцией на эти события. Локальная функция для вызова этого события может содержать до семи аргументов (пример: <code>Function СобытиеВводаДанных(ОбъектGI,ДопПараметр,ТипСобытия,Арг1,Арг2,Арг3,Арг4)</code>), описание аргументов предлагается ниже:
*** '''ОбъектGI''': передает текущий объект ''GI'', для которого вызывается событие.
*** '''ДопПараметр''': передает значение дополнительного параметра, заданного в функции ''LinkEvent''.
*** '''ТипСобытия''': передает цифровой тип события, на данный момент доступные следующие типы:
**** '''0-9''': события, связанные с мышью. Назначение аргументов: Арг1 -- клавиша, колесо мыши или ноль, Арг2 -- позиция мыши X, Арг3 -- позиция мыши Y, Арг4 -- нажатые клавиши мыши. Причем:
***** '''0''' -- движение мыши, аргументы ''Арг2'' и ''Арг3'' задают новое положение мыши относительно левой верхней точки окна ''GI'', ''Арг4'' задает битовую маску нажатых в данный момент клавиш мыши (бит 0 -- левая клавиша, бит 1 -- правая клавиша, бит 4 -- средняя клавиша и пр.).
***** '''1''' -- нажата клавиша мыши, аргумент ''Арг1'' задает номер нажатой клавиши (0 -- левая, 1 -- правая, 2 -- средняя), остальные аргументы соответствуют аргументам для события движения мыши (см. выше).
***** '''2''' -- отпущена клавиша мыши, аргумент ''Арг1'' задает номер отпущенной клавиши (0 -- левая, 1 -- правая, 2 -- средняя), остальные аргументы соответствуют аргументам для события движения мыши (см. выше).
***** '''3''' -- событие движения колеса мыши, аргумент ''Арг1'' задает число -- значение прокрутки колеса мыши, остальные аргументы соответствуют аргументам для события движения мыши (см. выше).
**** '''10-19''': события, связанные с клавиатурой. Назначение аргументов: Арг1 -- виртуальный код клавиши, Арг2 -- является ли клавиша дополнительной (extended), Арг3, Арг4 -- не заполнятся. Причем:
***** '''10''' -- произошло повторение предыдущего нажатия клавиши, так как она продолжает быть удерживаемой.
***** '''11''' -- нажата клавиша клавиатуры.
***** '''12''' -- отпущена клавиша клавиатуры.
**** '''20-29''': события, связанные с фокусом окна ''GI''. Дополнительные аргумента Арг1, Арг2, Арг3, Арг4 не заполнятся. Причем:
***** '''20''' -- Окно ''GI'' получило фокус.
***** '''21''' -- Окно ''GI'' потеряло фокус.
* <code>''<Имя локальной функции (STRING)>''</code> - Аргумент задает имя локальной или глобальной функции, которая будет вызываться при наступлении события.
* <code>''<Глубина поиска (INT)>''</code> - {{Optional}} Задает способ поиска локальной функции. Может принимать следующие значения:
** -1 -- выполнять поиск по последовательности функций из стека вызовов, а не искать, используя подчинение функций на момент компиляции. Этот способ предпочтительнее использовать в компилированных функциях, вызываемых из разных мест модуля или из разных модулей, чтобы получить доступ к реальной среде функций, а не к оной на момент компиляции.
** 0 (по умолчанию) -- выполнять поиск во всех модулях [[Общее описание языка#Вложенность функций и модулей, уровни вложенности|большего уровня вложенности]] (родительских) и во всех глобальных модулях.
** 1 -- выполнять поиск только внутри текущего модуля.
** 2 -- выполнять поиск только внутри родительского модуля.
** 3..x -- выполнять поиск только внутри родительского модуля указанного уровня (к примеру, для уровня 3, выполнять поиск только в родителе родителя текущего модуля).
* <code>''<Аргумент функции>''</code> - {{Optional}} Содержит произвольное значение, которое будет передано локальной функции вторым аргументом при ее вызове.

== Примеры ==
<pre>

//Событие движения мыши и нажатия на клавиши
Function OnNewInput(aGI,СпУскор,ТипСобытия,Арг1,Арг2,Арг3,Арг4)
If ТипСобытия=0 Then
//Движение мыши -- обновить переменные поворота
//Арг2, Арг3 -- смещение мыши по X и Y относительно окна прорисовки
If aGI.MouseCaptured Then
СпУскор[4]:=Арг2-aGI.Width div 2;
СпУскор[5]:=Арг3-aGI.Height div 2;
EndIf;
ElseIf ТипСобытия=1 Then
//Нажатие мыши на экран, захватить мышь
aGI.CaptureMouse();
ElseIf ТипСобытия=11 Then //Клавиша нажата
If (Арг1=0x57)Or(Арг1=0x26) Then//W или стрелка вперед -- движение по Z
СпУскор[3]:=1;
ElseIf (Арг1=0x53)Or(Арг1=0x28) Then//S или стрелка назад -- движение по Z
СпУскор[3]:=-1;
ElseIf (Арг1=0x51)Or(Арг1=0x25) Then//Q или стрелка влево -- движение по X
СпУскор[1]:=-1;
ElseIf (Арг1=0x45)Or(Арг1=0x27) Then//E или стрелка вправо -- движение по X
СпУскор[1]:=1;
ElseIf (Арг1=0x20)Or(Арг1=0x41) Then//A или пробел -- прыжок
СпУскор[2]:=1;
ElseIf Арг1=0x1B Then//ESC -- отпустить мышь
aGI.ReleaseMouse();
EndIf;
ElseIf ТипСобытия=12 Then //Клавиша отпущена
If ((Арг1=0x57)Or(Арг1=0x26))And(СпУскор[3]=1) Then//Отменить движение по Z, если оно было инициировано W
СпУскор[3]:=0;
ElseIf ((Арг1=0x53)Or(Арг1=0x28))And(СпУскор[3]=-1) Then//Отменить движение по Z, если оно было инициировано S
СпУскор[3]:=0;
ElseIf ((Арг1=0x51)Or(Арг1=0x25))And(СпУскор[1]=-1) Then//Отменить движение по X, если оно было инициировано Q
СпУскор[1]:=0;
ElseIf ((Арг1=0x45)Or(Арг1=0x27))And(СпУскор[1]=1) Then//Отменить движение по X, если оно было инициировано E
СпУскор[1]:=0;
ElseIf _Or(Арг1=0x20,Арг1=0x41) Then//Отменить прыжок
СпУскор[2]:=0;
EndIf;
ElseIf ТипСобытия=21 Then//Потеря фокуса окном, отпустить мышь
aGI.ReleaseMouse();
EndIf;
EndFunction

...
//Инициализация графического объекта для элемента аЭлемент: режим выделенного цикла, двойная буферизация
aGI:=GI.Init(аЭлемент,,1,1);

//Внутренние переменные, для использования в обработчиках событий
СпУскор:=List.Create(0,0,0,0,0); //Переменные ускорения: по x, по y, по z,поворот мыши по x,поворот мыши по y

//Автоматически захватывать мышь
aGI.MouseMode(1);
//Указание на функции обработчиков событий
aGI.LinkEvent("ONDRAW","OnDraw",1,СпКоорд);
aGI.LinkEvent("ONNEWINPUT","OnNewInput",1,СпУскор);
//Включить режим фильтрации MSAA
aGI.AntiAliasing(1);
//Включить режим ограничения кадров по развертке экрана
aGI.FrameLimiter(1);
//Включить 3D перспективу, FOV 90
aGI.WorldPerspective(0,90,0.1,1000);

...
</pre>

ExecuteFunction

2026-04-01T09:58:39Z

Admin: 1 revision imported

{{infobox function
|name=ExecuteFunction
|object=[[Функции общего назначения]]
|caption=Системные функции
|type=1
|status=2
|db=0
|exception=Невозможно превратить в строку, число, исключение внутри функции, неверные параметры вызова
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция инициирует исполнение функции с указанным именем в текущем контексте исполнения с заданными аргументами, способ поиска задается вторым аргументом. Если искомая функция не существует, пропущен обязательный аргумент или заданное количество аргументов слишком велико, будет создано исключение. Функции этой группы могут использоваться в макросах форм для вызова заранее определенных функций-событий. От использования [[Exec]] функции ''DoesFunctionExist'' и ''ExecuteFunction'' отличаются избирательным поиском функций, к примеру, ''Exec'' может исполнить функцию с таким же именем в глобальном модуле, тогда как, возможно, это нежелательно.

== Синтаксис ==
<code>
'''ExecuteFunction'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска или компилированная функция (INT, COMPILEDFUNCTION)>{{Default|{{Eq}}0}}{{ByRef|,<Аргумент 1>,<Аргумент 2>...}}}}):''<Результат исполнения функции>''
</code>
==== Аргументы ====
* <code>''<Имя функции (STRING)>''</code> - Имя функции, которую необходимо исполнить
* <code>''<Глубина поиска (INT)>''</code> - {{Optional}} Может принимать следующие значения:
** -1 -- выполнять поиск по последовательности функций из стека вызовов, а не искать, используя подчинение функций на момент компиляции. Этот способ предпочтительнее использовать в компилированных функциях, вызываемых из разных мест модуля или из разных модулей, чтобы получить доступ к реальной среде функций, а не к оной на момент компиляции.
** 0 (по умолчанию) -- выполнять поиск во всех модулях [[Общее описание языка#Вложенность функций и модулей, уровни вложенности|большего уровня вложенности]] (родительских) и во всех глобальных модулях.
** 1 -- выполнять поиск только внутри текущего модуля.
** 2 -- выполнять поиск только внутри родительского модуля.
** 3..x -- выполнять поиск только внутри родительского модуля указанного уровня (к примеру, для уровня 3, выполнять поиск только в родителе родителя текущего модуля).
** Объект типа [[Compile|компилированная функция]] -- выполнять поиск функции внутри заданной компилированной функции (только среди функций верхнего уровня).
* <code>''<Аргумент ?>''</code> - {{Optional}} {{ByRef}} Аргументы, передаваемые исполняемой функции

==== Возвращаемое значение ====
Возвращает результат исполнения функции.

== Примеры ==
<pre>
//Визуальное событие OnClick в макросе, состоящем из группы кнопок
//Событие вызывает функции в локальном модуле, на форме которого размещен макрос

//Событие в локальном модуле может отменить обработку документа
//флПарам -- параметр, передаваемый в модуль обработки документа, может быть изменен функцией OnBeforeDocumentSaveOrPublish
//ФлТип -- если OnBeforeDocumentSaveOrPublish возвратит 0, обработка будет отменена
// 1 -- обработка будет выполнена
// 2 -- обработку выполнила сама функция OnBeforeDocumentSaveOrPublish, выполнять ее здесь не требуется
флПарам:=0;
ФлТип:=0;
If DoesFunctionExist("OnBeforeDocumentSaveOrPublish",1) Then
ФлТип:=Number(ExecuteFunction("OnBeforeDocumentSaveOrPublish",1,1,флПарам));
If ФлТип=0 Then
Exit;
EndIf;
EndIf;

//Далее следует блок обработки документа
If ФлТип<>2 Then
Try
If aEl.Status()<0 Then //Документ необходимо записать, если он новый
aEl.Save();
EndIf;
if not aEl.Publish(флПарам) Then
Exit;
EndIf;
Except
Message(глПодготовитьОшибкуОбработки(),"!");
Exit;
EndTry;
EndIf;

//Событие в локальном модуле может произвести действия, необходимые после обработки документа
If DoesFunctionExist("OnAfterDocumentSaveOrPublish",1) Then
ExecuteFunction("OnAfterDocumentSaveOrPublish",1,1,флПарам);
EndIf;
</pre>

<pre>
//Пример показывает исполнение определенной функции из компилированного блока текста
//Заметьте: вызванная таким образом функция HelloWorld не имеет доступа к переменной Перем1, заданной в блоке для компиляции

//Блок текста для компиляции
Стр:="Var Перем1 Export;
|
|Function HelloWorld(Arg1)
| Message(""Аргумент: ""+Arg1);
| Result:=132;
|EndFunction;
|
|Message(""Исполнение вне функции HelloWorld"");";

//Компилируем блок текста, получаем объект аФунк
аФунк:=Compile(Стр);

//На экран будет выведено последовательно:
//"Аргумент: Строковой аргумент"
//"Результат: 132"
Message("Результат: "+ExecuteFunction("HelloWorld",аФунк,"Строковой аргумент"));
</pre>

DoesFunctionExist

2026-04-01T09:58:38Z

Admin: 1 revision imported

{{infobox function
|name=DoesFunctionExist
|object=[[Функции общего назначения]]
|caption=Системные функции
|type=1
|status=2
|db=0
|exception=Невозможно превратить в строку, число
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция проверяет, существует ли функция с указанным именем в текущем контексте исполнения, способ поиска задается вторым аргументом. Функции этой группы могут использоваться в макросах форм для вызова заранее определенных функций-событий. От использования [[Exec]] функции ''DoesFunctionExist'' и ''ExecuteFunction'' отличаются избирательным поиском функций, к примеру, ''Exec'' может исполнить функцию с таким же именем в глобальном модуле, тогда как, возможно, это нежелательно.

== Синтаксис ==
<code>
'''DoesFunctionExist'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска или компилированная функция (INT, COMPILEDFUNCTION)>{{Default|{{Eq}}0}}}}):''<Существует ли функция (INT)>''
</code>
==== Аргументы ====
* <code>''<Имя функции (STRING)>''</code> - Имя функции, существование которой нужно проверить.
* <code>''<Глубина поиска (INT)>''</code> - Может принимать следующие значения:
** -1 -- выполнять поиск по последовательности функций из стека вызовов, а не искать, используя подчинение функций на момент компиляции. Этот способ предпочтительнее использовать в компилированных функциях, вызываемых из разных мест модуля или из разных модулей, чтобы получить доступ к реальной среде функций, а не к оной на момент компиляции.
** 0 (по умолчанию) -- выполнять поиск во всех модулях [[Общее описание языка#Вложенность функций и модулей, уровни вложенности|большего уровня вложенности]] (родительских) и во всех глобальных модулях.
** 1 -- выполнять поиск только внутри текущего модуля.
** 2 -- выполнять поиск только внутри родительского модуля.
** 3..x -- выполнять поиск только внутри родительского модуля указанного уровня (к примеру, для уровня 3, выполнять поиск только в родителе родителя текущего модуля).
** Объект типа [[Compile|компилированная функция]] -- выполнять поиск функции внутри заданной компилированной функции (только среди функций верхнего уровня).

==== Возвращаемое значение ====
Возвращает 1, если функция найдена, 0, если она не существует.

== Примеры ==
<pre>
//Визуальное событие OnClick в макросе, состоящем из группы кнопок
//Событие вызывает функции в локальном модуле, на форме которого размещен макрос

//Событие в локальном модуле может отменить обработку документа
//флПарам -- параметр, передаваемый в модуль обработки документа, может быть изменен функцией OnBeforeDocumentSaveOrPublish
//ФлТип -- если OnBeforeDocumentSaveOrPublish возвратит 0, обработка будет отменена
// 1 -- обработка будет выполнена
// 2 -- обработку выполнила сама функция OnBeforeDocumentSaveOrPublish, выполнять ее здесь не требуется
флПарам:=0;
ФлТип:=0;
If DoesFunctionExist("OnBeforeDocumentSaveOrPublish",1) Then
ФлТип:=Number(ExecuteFunction("OnBeforeDocumentSaveOrPublish",1,1,флПарам));
If ФлТип=0 Then
Exit;
EndIf;
EndIf;

//Далее следует блок обработки документа
If ФлТип<>2 Then
Try
If aEl.Status()<0 Then //Документ необходимо записать, если он новый
aEl.Save();
EndIf;
if not aEl.Publish(флПарам) Then
Exit;
EndIf;
Except
Message(глПодготовитьОшибкуОбработки(),"!");
Exit;
EndTry;
EndIf;

//Событие в локальном модуле может произвести действия, необходимые после обработки документа
If DoesFunctionExist("OnAfterDocumentSaveOrPublish",1) Then
ExecuteFunction("OnAfterDocumentSaveOrPublish",1,1,флПарам);
EndIf;
</pre>

BroadcastChannelReceiveMessage

2026-04-01T09:57:50Z

Admin: 1 revision imported

{{infobox function
|name=BroadcastChannelReceiveMessage
|object=[[Функции общего назначения]]
|caption=Доставка сообщений
|type=1
|status=2
|db=0
|exception=Невозможно превратить в число, строку, ошибка сервера
|visual=1}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция выполняет получение одного сообщения из очереди сообщений для канала сообщений, заданного по его имени или идентификатору. Полученные сообщения удаляются из очереди. Функция используется только для абонентов подписки, для которых при подписке не была указана форма (см. [[BroadcastChannelSubscribe]]). Если сообщение в очереди отсутствует, функция может ожидать его появления некоторое время (заданное вторым аргументом). Функция возвращает '''1''', если сообщение получено и '''0''' в ином случае. Полученное сообщение возвращается в виде трех переменных -- числовой идентификатор сообщение, текст сообщения и текстовый код, определяющий отправителя (состоящий из номера канала клиента и идентификатора потока клиента).

== Синтаксис ==
<code>
'''BroadcastChannelReceiveMessage'''(''<Имя или идентификатор канала (INT,STRING)>''{{Optional|,<Ожидать нового сообщения, мс. (INT)>{{Default|{{Eq}}0}}}}{{OptionalByRef|,<Код сообщения (INT)>,<Содержимое сообщения (STRING)>,<Отправитель (STRING)>}}):''<Получено новое сообщение (INT)>''
</code>
==== Аргументы ====
* <code>''<Имя или идентификатор канала (INT,STRING)>''</code> - Имя канала для подписки (строка) или его идентификатор (число).
* <code>''<Ожидать нового сообщения, мс. (INT)>''</code> - {{Optional}} Максимальное числов времени в мс., которое функция может провести в ожидении появления сообщение. При нуле (по умолчанию), функция возвращается без ожидания.
* <code>''<Код сообщения (INT)>''</code> - {{Optional}} {{ByRef}} Переменная, которая получит код сообщения, если сообщение было получено. Если сообщение не было получено, переменная изменена не будет.
* <code>''<Содержимое сообщения (STRING)>''</code> - {{Optional}} {{ByRef}} Переменная, которая получит текст сообщения, если сообщение было получено. Если сообщение не было получено, переменная изменена не будет.
* <code>''<Отправитель (STRING)>''</code> - {{Optional}} {{ByRef}} Переменная, которая получит идентификатор отправителя сообщения, если сообщение было получено. Если сообщение не было получено, переменная изменена не будет. Обычно отправитель состоит из номера канала клиента и идентификатора потока клиента.

==== Возвращаемое значение ====
Возвращает количество отосланных сообщений.

== Примеры ==
<pre>
//Пример простого отправителя и подписчика в одном фрагменте текста.

Function Подписчик()
аКодКанала:=BroadcastChannelSubscribe("Канал");
аНум:=0;
While 1 Do
If not BroadcastChannelReceiveMessage(аКодКанала,100,аНум) Then
Continue;
EndIf;
Message("Получено сообщение с ID "+аНум);
If аНум=100 Then
Break;
EndIf;
EndDo;
BroadcastChannelUnsubscribe(аКодКанала);
Message("Поток закончил работу...");
EndFunction

Mutex.ExecuteFunctionInSeparateThread("Подписчик",0);

аКодКанала:=BroadcastChannelSubscribe("Канал");
ИдСообщения:=1;
While ИдСообщения<=100 Do
If BroadcastChannelSendMessage(аКодКанала,ИдСообщения,"")>0 Then
ИдСообщения:=ИдСообщения+1;
EndIf;
EndDo;
//Ожидания завершения потока после принятия сообщения 100
//Без этой паузы, поток можен быть завершен форсировано, так как текущий (родительский) поток будет завершен
Sleep(1000);

//Будет выведено:
//Получено сообщение с ID 1
//Получено сообщение с ID 2
//..
//Получено сообщение с ID 100
//Поток закончил работу...
</pre>

BroadcastChannelSendMessage

2026-04-01T09:57:50Z

Admin: 1 revision imported

{{infobox function
|name=BroadcastChannelSendMessage
|object=[[Функции общего назначения]]
|caption=Доставка сообщений
|type=1
|status=2
|db=0
|exception=Невозможно превратить в число, строку, ошибка сервера
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция выполняет отсылку сообщения (состоящего из произвольного числового идентификатора и произвольного текста) всем абонентам, подписанным на канал сообщений, заданный по его имени или идентификатору. Для подписчиков, использующих форму (см. [[BroadcastChannelSubscribe]]), сообщения доставляются сразу же (однако, может пройти долгое время, пока форма закончит текущую работу, и даже когда она ожидает действий пользователя, может пройти до нескольких секунд). Доставка будет осуществляться по такому же принципу, как доставляются сообщения [[BroadcastGlobalMessage]]. Если форма больше не существует, сообщение для таких подписчиков доставлены не будут. Подписчикам без указания формы, подтребуется вызвать функцию [[BroadcastChannelReceiveMessage]], чтобы забрать первое из сообщений из очереди. Разрешается использовать функцию из потоков, которые не подписаны на канал, для которого происходит отправка. Функцию также можно использовать для каналов, на которые не подписан ни один абонент (в этом случае, сообщение будет проигнорировано). Функция возвращает количество отосланных сообщений (которое совпадает с количеством абонентов канала на момент вызова функции).

== Синтаксис ==
<code>
'''BroadcastChannelSendMessage'''(''<Имя или идентификатор канала (INT,STRING)>'',''<Код сообщения (INT)>'',''<Содержимое сообщения (STRING)>''):''<Количество отосланных сообщений (INT)>''
</code>
==== Аргументы ====
* <code>''<Имя или идентификатор канала (INT,STRING)>''</code> - Имя канала для подписки (строка) или его идентификатор (число).
* <code>''<Код сообщения (INT)>''</code> - Произвольный код сообщения, коды 1-10000 рекомендуется использовать для нужд проекта, остальные для нужд внешних обработок.
* <code>''<Содержимое сообщения (STRING)>''</code> - Произвольный текст сообщения для отправки (строка может содержать международные и любые непечатные символы).

==== Возвращаемое значение ====
Возвращает количество отосланных сообщений.

== Примеры ==
<pre>
//Пример простого отправителя и подписчика в одном фрагменте текста.

Function Подписчик()
аКодКанала:=BroadcastChannelSubscribe("Канал");
аНум:=0;
While 1 Do
If not BroadcastChannelReceiveMessage(аКодКанала,100,аНум) Then
Continue;
EndIf;
Message("Получено сообщение с ID "+аНум);
If аНум=100 Then
Break;
EndIf;
EndDo;
BroadcastChannelUnsubscribe(аКодКанала);
Message("Поток закончил работу...");
EndFunction

Mutex.ExecuteFunctionInSeparateThread("Подписчик",0);

аКодКанала:=BroadcastChannelSubscribe("Канал");
ИдСообщения:=1;
While ИдСообщения<=100 Do
If BroadcastChannelSendMessage(аКодКанала,ИдСообщения,"")>0 Then
ИдСообщения:=ИдСообщения+1;
EndIf;
EndDo;
//Ожидания завершения потока после принятия сообщения 100
//Без этой паузы, поток можен быть завершен форсировано, так как текущий (родительский) поток будет завершен
Sleep(1000);

//Будет выведено:
//Получено сообщение с ID 1
//Получено сообщение с ID 2
//..
//Получено сообщение с ID 100
//Поток закончил работу...
</pre>

BroadcastChannelSubscribe

2026-04-01T09:57:50Z

Admin: 1 revision imported

{{infobox function
|name=BroadcastChannelSubscribe
|object=[[Функции общего назначения]]
|caption=Доставка сообщений
|type=1
|status=2
|db=0
|exception=Невозможно превратить в число, строку, ошибка сервера
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция подписывается на сообщения глобального канала сообщений, заданного по его имени (первый аргумент). Если указана форма-получатель сообщений, они будут приходить в виде события OnMessage ([[Студия/OnMessage|OnMessage]]) в момент, когда форма ожидает действий пользователя (idle). Если форма не указана, программе необходимо получать сообщения самостоятельно с помощью функции [[BroadcastChannelReceiveMessage]]. Подписка действует для текущего потока, если сообщения не забираются, они будут накапливаться на сервере. Для отказа от подписки, используйте [[BroadcastChannelUnsubscribe]]. Подписка удаляется автоматически, когда поток с подпиской заканчивает работу. Если указана форма и она будет закрыта, но поток продолжит работать, подписка не будет отменена (однако сообщения приходить не будут, так как отсутствует форма). Функция возвращает цифровой идентификатор канала, по которому к нему можно выполнять обращения (чуть быстрее, чем по имени). Идентификатор корректен до момента вызова [[BroadcastChannelUnsubscribe]] или завершения потока подписки.

== Синтаксис ==
<code>
'''BroadcastChannelSubscribe'''(''<Имя канала (STRING)>''{{Optional|,<Форма-получатель или ее серийный номер (FORM,INT)>{{Default|{{Eq}}0}}}}):''<Числовой идентификатор канала (INT)>''
</code>
==== Аргументы ====
* <code>''<Имя канала (STRING)>''</code> - Произвольное имя канала для подписки.
* <code>''<Форма-получатель или ее серийный номер (FORM,INT)>''</code> - {{Optional}} Указание на форму, если необходимо поулчать сообщения в виде события ''[[Студия/OnMessage|OnMessage]]''. Форма может быть задана серийным номером или самим объектом формы.

==== Возвращаемое значение ====
Возвращает числовой идентификатор канала на сервере.

== Примеры ==
<pre>
//Пример простого отправителя и подписчика в одном фрагменте текста.

Function Подписчик()
аКодКанала:=BroadcastChannelSubscribe("Канал");
аНум:=0;
While 1 Do
If not BroadcastChannelReceiveMessage(аКодКанала,100,аНум) Then
Continue;
EndIf;
Message("Получено сообщение с ID "+аНум);
If аНум=100 Then
Break;
EndIf;
EndDo;
BroadcastChannelUnsubscribe(аКодКанала);
Message("Поток закончил работу...");
EndFunction

Mutex.ExecuteFunctionInSeparateThread("Подписчик",0);

аКодКанала:=BroadcastChannelSubscribe("Канал");
ИдСообщения:=1;
While ИдСообщения<=100 Do
If BroadcastChannelSendMessage(аКодКанала,ИдСообщения,"")>0 Then
ИдСообщения:=ИдСообщения+1;
EndIf;
EndDo;
//Ожидания завершения потока после принятия сообщения 100
//Без этой паузы, поток можен быть завершен форсировано, так как текущий (родительский) поток будет завершен
Sleep(1000);

//Будет выведено:
//Получено сообщение с ID 1
//Получено сообщение с ID 2
//..
//Получено сообщение с ID 100
//Поток закончил работу...
</pre>

BroadcastChannelUnsubscribe

2026-04-01T09:57:50Z

Admin: 1 revision imported

{{infobox function
|name=BroadcastChannelUnsubscribe
|object=[[Функции общего назначения]]
|caption=Доставка сообщений
|type=1
|status=2
|db=0
|exception=Невозможно превратить в число, строку, ошибка сервера
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция отменяет подписку на сообщения глобального канала сообщений, заданного по его имени или идентификатору (первый аргумент). См. описание [[BroadcastChannelSubscribe]]. Функция вызывается в потоке, для которого ранее была вызвана [[BroadcastChannelSubscribe]]. Отмена подписки происходит автоматически при завершении потока с подпиской. Если подписки не было, функция не выполняется никаких действий.

== Синтаксис ==
<code>
'''BroadcastChannelUnsubscribe'''(''<Имя или идентификатор канала (INT,STRING)>'')
</code>
==== Аргументы ====
* <code>''<Имя или идентификатор канала (INT,STRING)>''</code> - Имя канала для подписки (строка) или его идентификатор (число).

== Примеры ==
<pre>
//Пример простого отправителя и подписчика в одном фрагменте текста.

Function Подписчик()
аКодКанала:=BroadcastChannelSubscribe("Канал");
аНум:=0;
While 1 Do
If not BroadcastChannelReceiveMessage(аКодКанала,100,аНум) Then
Continue;
EndIf;
Message("Получено сообщение с ID "+аНум);
If аНум=100 Then
Break;
EndIf;
EndDo;
BroadcastChannelUnsubscribe(аКодКанала);
Message("Поток закончил работу...");
EndFunction

Mutex.ExecuteFunctionInSeparateThread("Подписчик",0);

аКодКанала:=BroadcastChannelSubscribe("Канал");
ИдСообщения:=1;
While ИдСообщения<=100 Do
If BroadcastChannelSendMessage(аКодКанала,ИдСообщения,"")>0 Then
ИдСообщения:=ИдСообщения+1;
EndIf;
EndDo;
//Ожидания завершения потока после принятия сообщения 100
//Без этой паузы, поток можен быть завершен форсировано, так как текущий (родительский) поток будет завершен
Sleep(1000);

//Будет выведено:
//Получено сообщение с ID 1
//Получено сообщение с ID 2
//..
//Получено сообщение с ID 100
//Поток закончил работу...
</pre>

ArgumentsNumber

2026-04-01T09:57:49Z

Admin: 1 revision imported

{{infobox function
|name=ArgumentsNumber
|object=[[Функции общего назначения]]
|caption=Системные функции
|type=1
|status=2
|db=0
|exception=Невозможно превратить в строку, число
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Функции общего назначения]]}}
Функция возвращает количество аргументов функции с указанным именем в текущем контексте исполнения, способ поиска задается вторым аргументом. Если искомая функция не существует, будет возвращено значение -1. Функции этой группы могут использоваться в макросах форм для вызова заранее определенных функций-событий. От использования [[Exec]] функции ''DoesFunctionExist'' и ''ExecuteFunction'' отличаются избирательным поиском функций, к примеру, ''Exec'' может исполнить функцию с таким же именем в глобальном модуле, тогда как, возможно, это нежелательно.

== Синтаксис ==
<code>
'''ArgumentsNumber'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска или компилированная функция (INT, COMPILEDFUNCTION)>{{Default|{{Eq}}0}}}}):''<Количество аргументов (INT)>''
</code>
==== Аргументы ====
* <code>''<Имя функции (STRING)>''</code> - Имя функции, количество аргументов которой необходимо найти
* <code>''<Глубина поиска (INT)>''</code> - {{Optional}} Может принимать следующие значения:
** -1 -- выполнять поиск по последовательности функций из стека вызовов, а не искать, используя подчинение функций на момент компиляции. Этот способ предпочтительнее использовать в компилированных функциях, вызываемых из разных мест модуля или из разных модулей, чтобы получить доступ к реальной среде функций, а не к оной на момент компиляции.
** 0 (по умолчанию) -- выполнять поиск во всех модулях [[Общее описание языка#Вложенность функций и модулей, уровни вложенности|большего уровня вложенности]] (родительских) и во всех глобальных модулях.
** 1 -- выполнять поиск только внутри текущего модуля.
** 2 -- выполнять поиск только внутри родительского модуля.
** 3..x -- выполнять поиск только внутри родительского модуля указанного уровня (к примеру, для уровня 3, выполнять поиск только в родителе родителя текущего модуля).
** Объект типа [[Compile|компилированная функция]] -- выполнять поиск функции внутри заданной компилированной функции (только среди функций верхнего уровня).

==== Возвращаемое значение ====
Возвращает количество аргументов найденной функции или -1, если функция не найдена.

== Примеры ==
<pre>
//Визуальное событие OnClick в макросе, состоящем из группы кнопок
//Событие вызывает функции в локальном модуле, на форме которого размещен макрос

//Событие в локальном модуле может отменить обработку документа
//флПарам -- параметр, передаваемый в модуль обработки документа, может быть изменен функцией OnBeforeDocumentSaveOrPublish
//ФлТип -- если OnBeforeDocumentSaveOrPublish возвратит 0, обработка будет отменена
// 1 -- обработка будет выполнена
// 2 -- обработку выполнила сама функция OnBeforeDocumentSaveOrPublish, выполнять ее здесь не требуется
флПарам:=0;
ФлТип:=0;
If ArgumentsNumber("OnBeforeDocumentSaveOrPublish",1)=2 Then
ФлТип:=Number(ExecuteFunction("OnBeforeDocumentSaveOrPublish",1,1,флПарам));
If ФлТип=0 Then
Exit;
EndIf;
EndIf;

//Далее следует блок обработки документа
If ФлТип<>2 Then
Try
If aEl.Status()<0 Then //Документ необходимо записать, если он новый
aEl.Save();
EndIf;
if not aEl.Publish(флПарам) Then
Exit;
EndIf;
Except
Message(глПодготовитьОшибкуОбработки(),"!");
Exit;
EndTry;
EndIf;

//Событие в локальном модуле может произвести действия, необходимые после обработки документа
If ArgumentsNumber("OnAfterDocumentSaveOrPublish",1)=2 Then
ExecuteFunction("OnAfterDocumentSaveOrPublish",1,1,флПарам);
EndIf;
</pre>

Template:Общие функции, связанные с БД

2025-12-27T17:09:36Z

Admin: 1 revision imported

{{function header}}
{{function entry
|name=[[DBCodeLength]]
|form='''DBCodeLength'''():''<Длина строки внутреннего кода объекта БД (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает число 20, являющееся длиной строки [[DBObjectFromDBCode|внутреннего кода объекта]] базы данных.
}}
{{function entry
|name=[[DBTypeStr]]
|form='''DBTypeStr'''(''<Аргумент>''):''<Тип объекта базы данных (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает тип объекта базы данных в виде строки. Пример возвращаемых значений: <code>DOC</code>, <code>REF</code>, <code>ENUM</code> и т.п. В случае, если аргумент не является объектом базы данных, будет возвращена пустая строка.
}}
{{function entry
|name=[[DBObjectName]]
|form='''DBObjectName'''(''<Аргумент>''):''<Вид объекта базы данных (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает вид объекта базы данных в виде строки. Пример для элемента справочника <code>REF.Справочник1</code> будет возвращена строка <code>Справочник1</code>. Результат функции соответствует конструкции <code><Переменная>.DBName()</code>. В случае, если аргумент не является объектом базы данных или вид объекта не выбран, будет возвращена пустая строка.
}}
{{function entry
|name=[[IsDBObject]]
|form='''IsDBObject'''(''<Аргумент>''):''<Является ли аргумент объектом БД (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает 1, если аргумент является объектом базы данных, иначе будет возвращен 0.
}}
{{function entry
|name=[[MassLockWithWait]]
|form='''MassLockWithWait'''(''<Список с объектами для блокировки (LIST)>''{{Optional|,<Режим пропуска (INT)>{{OptionalDefault|{{eq}}0}},<Разблокировка при ошибках (INT)>{{OptionalDefault|{{eq}}1}},<Период ожидания млс. (INT)>{{OptionalDefault|{{eq}}0}},{{OptionalByRef|<Объект ошибки>}},{{OptionalByRef|<Заблокировано пользователем (STRING)>}},{{OptionalByRef|<Заблокировано на машине (STRING)>}},{{OptionalByRef|<Время блокировки (DATE)>}}}}):''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция позволяет установить блокировку на множестве объектов базы данных (или/и семафорах), блокировка происходит по указанным правилам (см. полное описание)
}}
{{function entry
|name=[[MassUnlock]]
|form='''MassUnlock'''(''<Список с объектами для разблокировки (LIST)>''{{OptionalByRef|,<Объект ошибки>}},{{Optional|{{OptionalByRef|<Заблокировано пользователем (STRING)>}},{{OptionalByRef|<Заблокировано на машине (STRING)>}},{{OptionalByRef|<Время блокировки (DATE)>}}}}):''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция позволяет снять блокировку со множества объектов базы данных (или/и семафоров) по указанным правилам (см. полное описание)
}}
{{function entry
|name=[[DBLockStringMutex]]
|form='''DBLockStringMutex'''(''<Имя семафора (STRING)>''{{OptionalByRef|,<Заблокировано пользователем (STRING)>,<Заблокировано на машине (STRING)>,<Время блокировки (DATE)>}}{{Optional|,<Время ожидания блокировки (INT)>{{Default|{{Eq}}0}}}}):''<Результат (INT)>''
|type=1
|status=2
|visual=0
|description=Функция осуществляет блокировку именованного серверного семафора, либо возвращает данные пользователя, который его заблокировал.
}}
{{function entry
|name=[[DBIsStringMutexLocked]]
|form='''DBIsStringMutexLocked'''(''<Имя семафора (STRING)>''{{OptionalByRef|,<Заблокировано пользователем (STRING)>,<Заблокировано на машине (STRING)>,<Время блокировки (DATE)>}}):''<Результат (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, заблокирован ли именованный серверный семафор, и возвращает данные пользователя, который его заблокировал при необходимости.
}}
{{function entry
|name=[[DBUnlockStringMutex]]
|form='''DBUnlockStringMutex'''(''<Имя семафора (STRING)>''{{OptionalByRef|,<Заблокировано пользователем (STRING)>,<Заблокировано на машине (STRING)>,<Время блокировки (DATE)>}}):''<Результат (INT)>''
|type=1
|status=2
|visual=0
|description=Функция осуществляет разблокировку именованного серверного семафора, либо возвращает данные пользователя, который его заблокировал.
}}
{{function entry
|name=[[StoreValue]]
|form='''StoreValue'''(''<Имя переменной (STRING)>'',''<Значение переменной>'')
|type=1
|status=2
|visual=0
|description=Функция сохраняет на сервере для текущего пользователя произвольное значение под выбранным именем. Функция работает только если клиент имеет подключение к серверу.
}}
{{function entry
|name=[[RestoreValue]]
|form='''RestoreValue'''(''<Имя переменной (STRING)>''):''<Значение переменной>''
|type=1
|status=2
|visual=0
|description=Функция получает, сохраненное ранее на сервере для текущего пользователя произвольное значение с выбранным именем. Функция работает только если клиент имеет подключение к серверу. Если значение с указанным именем не было сохранено, будет возвращено пустое значение.
}}
{{function entry
|name=[[StoreGlobalTempString]]
|form='''StoreGlobalTempString'''(''<Имя переменной (STRING)>'',''<Значение переменной (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция изменяет значение временной именной переменной на сервере, которая будет доступна другим пользователям, однако, будет потеряна при перезагрузке сервера.
}}
{{function entry
|name=[[RestoreGlobalTempString]]
|form='''RestoreGlobalTempString'''(''<Имя переменной (STRING)>''):''<Значение переменной (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает значение временной именной переменной на сервере. Подобные переменные доступны другим пользователям, однако, теряются при перезагрузке сервера.
}}
{{function entry
|name=[[BroadcastDBUpdate]]
|form='''BroadcastDBUpdate'''(''<Тип базы данных (STRING)>''{{Optional|,<Для всех пользователей (INT)>{{Default|{{Eq}}0}}}}):''<Сообщение успешно отправлено (INT)>''
|type=1
|status=2
|visual=0
|description=Функция рассылает запросы на обновление форм, содержащих таблицы базы данных указанного типа в текущей системе или глобально по всем клиентам сервера. В последнем случае, нужно быть осторожным, чтобы не перегружать сервер внезапным большим количеством запросов, даже с учетом того, что серверная часть использует особую систему замедления отправки запросов клиентам.
}}
{{function entry
|name=[[DBObjectFromDBCode]]
|form='''DBObjectFromDBCode'''(''<Внутренний код базы данных (STRING)>''):''<Объект базы данных (DB)>''
|type=1
|status=2
|visual=0
|description=Функция создает объект базы данных по его внутреннему коду. Нужно понимать, что внутренний код является уникальным в пределах текущей базы данных, при перенесении информации в другую базу данных, внутренние коды объектов будут совсем другими.
}}
{{function entry
|name=[[MassLoadObjects]]
|form='''MassLoadObjects'''(''<Объект для загрузки>''{{Optional|,<Аргумент 1>,<Аргумент 2>,<Также загружать периодические реквизиты (INT)>{{Default|{{Eq}}0}},<Производить загрузку заголовков (INT)>{{Default|{{Eq}}0}},<Доп. реквизиты при загрузке заголовков (STRING)>{{Default|{{Eq}}""}}}}):''<Количество объектов, которые были загружены (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит загрузку большого количества объектов из списка, таблицы или являющихся реквизитами объекта БД, одновременно, что быстрее, чем загрузка этих объектов один за другим. Дополнительные параметры позволяют настроить загрузку, в т.ч. ограничить ее загрузкой только заголовков.
}}
{{function entry
|name=[[LockDBPath]]
|form='''LockDBPath'''(''<Путь или объект для блокировки (STRING,DB)>''{{OptionalByRef|,<Заблокировано пользователем (STRING)>,<Заблокировано на машине (STRING)>,<Время блокировки (DATE)>}}):''<0 или 1 (INT)>''
|type=1
|status=0
|visual=0
|description=Функция производит попытку блокировки всей таблицы указанных объектов (к примеру, всего справочника с указанным видом).
}}
{{function entry
|name=[[UnlockDBPath]]
|form='''UnlockDBPath'''(''<Путь или объект для разблокировки (STRING,DB)>''{{OptionalByRef|,<Описание ошибки (STRING)>}}):''<0 или 1 (INT)>''
|type=1
|status=0
|visual=0
|description=Функция производит разблокировки всей таблицы указанных объектов (к примеру, всего справочника с указанным видом), заблокированных ранее функцией [[LockDBPath]]
}}
{{function entry
|name=[[GetServerLocksInformation]]
|form='''GetServerLocksInformation'''({{Optional|<Перекрестная проверка (INT)>{{Default|{{Eq}}0}}}}):''<Таблица блокировок сервера (TAB)>''
|type=1
|status=2
|visual=0
|description=Функция получает полный список блокированных в данный момент объектов на сервере (включая именованные семафоры).
}}
{{function entry
|name=[[GetServerStoragesInformation]]
|form='''GetServerStoragesInformation'''({{Optional|<Имена накопителей через запятую (STRING)>{{Default|{{Eq}}""}}}}):''<Информация по накопителям (TAB)>''
|type=1
|status=2
|visual=0
|description=Функция получает информацию по всем накопителям проекта с сервера в виде таблицы. В ней присутствует информация по крайним документам, дате остатков и пр.
}}
{{function entry
|name=[[GetServerUsedSpaceInformation]]
|form='''GetServerUsedSpaceInformation'''():''<Информация по объему таблиц БД (TAB)>''
|type=1
|status=2
|visual=0
|description=Функция получает информацию по затраченному месту в базе данных по всем объектам проекта и системным таблицам с сервера в виде таблицы. В таблице также присутствует информация строчным частям и таблицам периодических значений.
}}
{{function entry
|name=[[CheckDBConsistency]]
|form='''CheckDBConsistency'''({{Optional|<Путь или объект (STRING,DB)>{{Default|{{Eq}}""}},<Режим (INT)>{{Default|{{Eq}}0}}}}):''<Информация по проблемам БД (TAB)>''
|type=1
|status=0
|visual=0
|description=Функция осуществляет проверку корректности информации на сервере для всех таблиц или таблиц с заданным путем. Информация возвращается в виде таблицы.
}}
{{function entry
|name=[[BeginTransaction]]
|form='''BeginTransaction'''():''<Уровень вложения транзакции (INT)>''
|type=1
|status=2
|visual=0
|description=Функция инициирует начало транзактного изменения объектов БД. По умолчанию транзакция на сервере не включена и возникает периодически при записи объектов или обработке документов. Каждый поток имеет свой уровень вложения транзакции. Функция опасна и при некорректном использовании может привести к порче данных. См. полное описание.
}}
{{function entry
|name=[[CommitTransaction]]
|form='''CommitTransaction'''():''<Уровень вложения транзакции (INT)>''
|type=1
|status=2
|visual=0
|description=Функция уменьшает текущий уровень транзакции на единицу и, если он равен нулю, фиксирует изменения в базе данных. См. также [[BeginTransaction]].
}}
{{function entry
|name=[[RollbackTransaction]]
|form='''RollbackTransaction'''()
|type=1
|status=2
|visual=0
|description=Функция отменяет все изменения, произведенные в текущей транзакции и уменьшает уровень транзакции до нуля. См. также [[BeginTransaction]].
}}
{{function entry
|name=[[IsTransactionActive]]
|form='''IsTransactionActive'''():''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает 1 в случае, если в данном потоке уровень транзакции больше нуля (транзакция активна).
}}
{{function entry
|name=[[CollectObjectsLinks]]
|form='''CollectObjectsLinks'''(''<Список объектов (LIST)>''):''<Таблица ссылок данных объектов (TAB)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает полную таблицу ссылок всех объектов БД из заданного списка. К примеру, если объект содержится в движениях накопителя или выбран в реквизите другого объекта (в т.ч. периодическом), в таблицу добавится запись о такой ссылке. Функция может использоваться перед физическим удалением объектов из БД, чтобы убедиться, что никакие другие таблицы БД не имеют на них ссылок. Функция может сильно загрузить сервер базы данных.
}}
{{function entry
|name=[[LockStorage]]
|form='''LockStorage'''(''<Наименование накопителя (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция производит блокировку указанного накопителя для всех пользователей сервера. Если накопитель был заблокирован другим пользователем, функция вызовет исключение. Функция вызывается автоматически при обработке документов с включенным режимом автоматической транзакции. Время между блокировкой и разблокировкой необходимо минимизировать, чтобы улучшить производительность базы данных. При ошибке, функция не предлагает имени пользователя, заблокировавшего накопитель, если такая информация необходима, разработчик может использовать функцию [[LockDBPath]] вместо текущей. Обычно функция используется вне модуля обработки документа. В отличие от функции [[UnlockStorage]], функция может использоваться как внутри транзакции, так и вне оной.
}}
{{function entry
|name=[[UnlockStorage]]
|form='''UnlockStorage'''(''<Наименование накопителя (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция производит разблокировку указанного накопителя, при его блокировке функцией [[LockStorage]]. Функция может использоваться только '''вне режима транзакции''', так как при окончании транзакции, все заблокированные накопители автоматически будут разблокированы системой.
}}
{{function entry
|name=[[InitiateBackupCreation]]
|form='''InitiateBackupCreation'''(''<Идентификатор протокола резервного копирования (STRING)>''{{Optional|,<Ожидать завершения процесса (INT)>{{Default|{{Eq}}0}}}}):''<Внутренний код процесса резервного копирования (INT)>''
|type=1
|status=2
|visual=0
|description=Функция инициирует (и ожидает завершения, если необходимо) процесс резервного копирования базы данных и сопутствующих файлов проекта по протоколу, заданному в файлах инициализации сервера. Идентификатор протокола задается из установок в файле инициализации сервера. Если ожидание окончания процесса не задано, функция возвращается сразу же после инициации процесса резервного копирования, иначе только после окончания процесса или возникновения ошибки. Для получения информации по асинхронному процессу, а также для получения описания ошибки, остановившей процесс, используется функция [[QueryBackupProgress]].
}}
{{function entry
|name=[[QueryBackupProgress]]
|form='''QueryBackupProgress'''(''<Код процесса резервного копирования (INT)>''{{OptionalByRef|,<Текущее сообщение процесса копирования или сообщение об ошибке (STRING)>,<Дата и время начала последнего процесса (DATE)>}}):''<Код состояния процесса резервного копирования (INT)>''
|type=1
|status=2
|visual=0
|description=Функция используется для получения информации об окончании или состоянии процесса резервного копирования, инициированого функцией [[InitiateBackupCreation]].
}}
{{function entry
|name=[[QueryScheduledBackupFailure]]
|form='''QueryScheduledBackupFailure'''({{OptionalByRef|<Идентификатор протокола последней ошибки резервного копирования (STRING)>,<Сообщение об ошибке, произошедшей во время резервного копирования (STRING)>,<Дата и время начала последнего процесса (DATE)>}}):''<Ошибка происходила (1), ошибки не было (0) (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает информацию по последней ошибке при резервном копировании, выполнявшемся по расписанию. Если ошибка произошла при инициации копирования функцией [[InitiateBackupCreation]], она не будет возвращена этой функцией. Функция может выполняться при запуске клиента с административными правами, чтобы предупредить администратора о том, что какой-либо из процессов резервного копирования закончился с ошибкой. Чтобы очистить информацию об ошибке, необходимо удалить сохраненный файл ошибки в каталоге проекта на сервере.
}}
{{function entry
|name=[[SysRebuildIndexes]]
|form='''SysRebuildIndexes'''({{Optional|<Наименование объекта, для которого необходимо выполнить процедуру перестроения индексов (STRING)>}})
|type=1
|status=2
|visual=0
|description=Функция выполняет процедуру перестроения индексов для указанного объекта базы данных или для всех объектов базы данных. Данная процедура может занять продолжительное время. Необходимость в такой процедуре может появляться при обновлении сервера базы данных или порче данных в базе данных и т.д. Для некоторых типов СУБД нет возможности выполнить такую процедуру с помощью сторонних утилит, к примеру, для ''SQLite3'' использование особых типов сравнения для текстовых данных, делает невозможным использование сторонних утилит, поэтому, эта функция становится особенно важной. Альтернативой перестроения индексов может служить выгрузка дампа базы данных и создание с помощью него новой базы данных.
}}
{{function entry
|name=[[SysExecServer]]
|form='''SysExecServer'''(''<Командная строка исполнения (STRING)>''{{Optional|,<Не возвращаться до завершения (INT)>{{Default|{{Eq}}0}}}}):''<Код, возвращенный приложением (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит запуск приложения с параметрами в командной строке на стороне сервера, разбор командной строки не производится. Пользователь должен обладать административными правами для использования этой функции. Также нужно понимать, что запуск с флагом ожидания завершения (второй аргумент) приведет к "зависшей" сессии на сервере, если приложение не будет завершено. Этой функцией следует пользоваться в исключительных обстоятельствах и только когда поведение запускаемого приложения хорошо известно заранее.
}}
{{function footer}}

Template:Infobox function

2025-12-27T17:09:35Z

Admin: 1 revision imported

<includeonly><div style="float:right; margin:0px 30px 0px 10px">
{|cellspacing="0" cellpadding="0" width="100%" style="border: 0px;"
|-
{| class="infobox" style="font-size:80%; width:350px;"
|- style="text-align:left; vertical-align:middle"
! colspan="2" style="background-color:#99cff4; color:#000000; font-size:120%; padding:5px;" |   {{#if:{{{image|}}}|[[Image:{{{image|}}}|16px]]  }}{{{name|}}}{{#if:{{{caption|}}}| ({{{caption}}})|}}
|- style="text-align:left;"
| colspan="2" style="padding:0px;" | <table width="100%">{{#if:{{{object|}}}|<tr><td style="width:40%;text-align:left;">'''Объект:'''</td><td style="width:60%;text-align:left;">'''{{{object|}}}'''</td></tr>|}}{{#if:{{{element|}}}|<tr><td style="width:40%;text-align:left;">'''Применимость:'''</td><td style="width:60%;text-align:left;">{{{element}}}</td></tr>|}}{{#if:{{{eventtype|}}}|<tr><td style="width:40%;text-align:left;">'''Тип события:'''</td><td style="width:60%;text-align:left;">{{{eventtype}}}</td></tr>|}}<tr><td style="width:40%;text-align:left;">'''Статус разработки:'''</td>
<td style="width:60%;text-align:left;">{{#if:{{{status|}}}|{{#ifeq:{{{status|}}}|0|'''Планируется'''|{{#ifeq:{{{status|}}}|1|'''Частичная реализация'''|{{#ifeq:{{{status|}}}|2|'''Реализована'''|?}}}}}}|?}}</td></tr>{{#if:{{{type|}}}|<tr><td style="width:40%;text-align:left;">'''Тип:'''</td><td style="width:60%;text-align:left;">{{#ifeq:{{{type|}}}|0|Атрибут|{{#ifeq:{{{type|}}}|1|Функция|{{#ifeq:{{{type|}}}|2|Магическая функция или конструкция|?}}}}}}</td></tr>|}}{{#if:{{{db|}}}|<tr><td style="width:40%;text-align:left;">'''[[Обращение к базе данных (описание)|Обращение к БД]]:'''</td><td style="width:60%;text-align:left;">{{#ifeq:{{{db|}}}|1|Сервер|{{#ifeq:{{{db|}}}|2|Сервер и БД|{{#ifeq:{{{db|}}}|4|В зав. от аргументов|Нет}}}}}}</td></tr>|}}{{#if:{{{location|}}}|<tr><td style="width:40%;text-align:left;">'''Расположение:'''</td><td style="width:60%;text-align:left;">{{{location}}}</td></tr>|}}{{#if:{{{rw|}}}|<tr><td style="width:40%;text-align:left;">'''Доступность:'''</td><td style="width:60%;text-align:left;">{{#ifeq:{{{rw|}}}|1|Только чтение|{{#ifeq:{{{rw|}}}|2|Только запись|Чтение и запись}}}}</td></tr>|}}{{#if:{{{exception|}}}|<tr><td style="width:40%;text-align:left;">'''[[Исключения]]:'''</td><td style="width:60%;text-align:left;">{{{exception|}}}</td></tr>|}}{{#if:{{{visual|}}}|<tr><td style="width:40%;text-align:left;">'''[[Визуальные функции|Визуальность]]:'''</td><td style="width:60%;text-align:left;">{{#ifeq:{{{visual|}}}|1|Да|Нет}}</td></tr>|}}</table>
|}</div>[[Category:Functions and properties]]__NOTOC__</includeonly>

Template:Function entry

2025-12-27T17:09:34Z

Admin: 1 revision imported

|-align="left"
|{{{name}}}
|{{#if:{{{status|}}}|{{#ifeq:{{{status|}}}|0|'''Планируется'''|{{#ifeq:{{{status|}}}|1|'''Частичная реализация'''|{{#ifeq:{{{status|}}}|2|'''Реализована'''|?}}}}}}|?}}
|{{#if:{{{type|}}}|{{#ifeq:{{{type|}}}|0|Атрибут|{{#ifeq:{{{type|}}}|1|Функция|{{#ifeq:{{{type|}}}|2|Магическая функция|?}}}}}}|?}}
|{{#ifeq:{{{visual|}}}|1|<div align="center" style="color:#8F0000;">Да</div>|}}
|{{{form}}}
|{{{description}}}

Электронная таблица SFT

2025-12-27T17:09:09Z

Admin: 1 revision imported

{{infobox object
|image=table.png
|visual=[[Студия/Электронная таблица SFT|Таблица SFT]]
|object=Table
|status=2
|create=[[Table.Create|Create]]}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]}}
Объект '''электронная таблица SFT''' дает возможность создания, заполнения, вывода на экран и принтер, а также чтения данных и проведения других операций с электронными таблицами SFT. Обычно объект используется для создания и вывода на экран отчетов и печатных форм документов. В таких случаях, алгоритм работы с объектом следующий:
* Создается новый объект и задается таблица-шаблон (по умолчанию файл шаблона '''Table''' должен находиться в той же папке (объекте), где находится модуль, создающий объект, однако, путь и имя таблицы-шаблона можно задать с помощью функции [[Table.SetSourceName|SetSourceName]]). Создавать таблицу с нуля, программно изменяя шрифт каждой ячейки, тип границ и объединения, является очень сложной и трудоемкой задачей, поэтому, такой подход на практике не применяется, а используется таблица-шаблон (или несколько таких таблиц). Шаблон представляет собой обычную таблицу, при создании отчета или печатной формы документа, заданные части шаблона будут копироваться в новую создаваемую таблицу. При копировании частей шаблона, система автоматически заполняет ячейки с формулами результатом их выполнения (такие ячейки в таблице-шаблоне имеют галочку "Текст представляет собой выражения для вычисления", см. [[Студия/Редактор электронных таблиц|Редактор электронных таблиц]]), это дает возможность предусмотреть в шаблоне ячейки с сальдо, наименованиями и реквизитами юридических лиц и прочим, в зависимости от типа выводимой формы. Для удобства написания программ, нужные куски таблицы-шаблона отмечаются на этапе редактирования, им присваиваются свои наименования, по которым программа может обращаться к ним, чтобы из этих кусков сконструировать таблицу-результат.
* Выполняется запрос или требуемые данные подготавливаются другим путем.
* Происходит обход по результату запроса или другим данным и последовательное добавление нужных частей таблицы-шаблона в таблицу результат с заполнением ячеек данными, полученными в цикле обхода (Для копирования частей таблицы-шаблона можно использовать функции [[Table.CopyByX|CopyByX]], [[Table.CopyByY|CopyByY]], [[Table.CopyTitles|CopyTitles]], [[Table.Area.CopyTo|CopyTo]]).
* Созданная новая электронная таблица выводится на экран или принтер.
При программной работе с объектом нужно различать четыре типа объектов: сама электронная таблица SFT, объект область таблицы (''Area'') (получаемая с помощью вызова функций типа [[Table.Area|Area]] и необходимая для проведения прямого изменения в ячейках области), объект свойств таблицы (''Options'') (включающий множество подобъектов, к примеру, ''выделение'' или ''свойства печати'') и объект визуальных элементов (объектов) таблицы (''Objects''). Все объекты связаны с электронной таблицей SFT, которая не будет удалена из памяти до тех пор, пока останется по крайней мере один объект, ссылающийся на нее. Ячейки таблицы могут содержать объекты языка любого вида, поэтому кроме внешних ссылок на таблицу, иногда может возникнуть ситуация, когда внутри какой-либо ячейки (или визуального элемента) хранится ссылка на самую же таблицу, это бывает, к примеру, когда в визуальной кнопке таблицы для обновления результата отчета, хранится список с данными, связанными с этим отчетом, в том числе сама таблица. Для таблиц, которые хранят ссылки на самих себя требуется указывать количество таких ссылок с помощью атрибута [[Table.SelfReferenceCount|SelfReferenceCount]], иначе после удаления последнего объекта, ссылающегося на таблицу, таблица останется в памяти (см. [[Объекты#Ссылки на самого себя|Ссылки на самого себя]]).
Основные свойства ячейки таблицы перечислены ниже:
* Таблица может иметь практически неограниченное количество столбцов и строк (до 2 млрд.), сдвигая видимое поле, пользователь может увидеть любую ячейку таблицы. Память для хранения ячеек выделяется только для определенного количества столбцов и строк таблицы, этот диапазон задает высоту и ширину таблицы. При изменении текста или других свойств ячейки вне диапазона этих строк и столбцов, выделенный диапазон автоматически расширяется.
* Ячейка содержит текст в ANSI или UTF-16 кодировках, либо текст шаблона, представляющего собой программу на встроенном языке, программа будет исполнена и результат будет записан, как текст ячейки в момент копирования частей таблицы-шаблона в таблицу результат.
* Ячейка содержит произвольный объект встроенного языка, использующийся как значение ячейки при клике по ячейке или редактировании оной. Вместо объекта языка в ячейке может находиться текст шаблона, представляющего собой программу на встроенном языке, программа будет исполнена и результат будет записан, как значение ячейки в момент копирования частей таблицы-шаблона в таблицу результат.
* Текст ячейки может иметь стандартные свойства форматирования: шрифт, выделение, цвет фона, цвет текста и рамки и пр., либо для ячейки может быть задан шаблон цвета (color template). В последнем случае, пользователи смогут выбирать другую палитру цветов, по своему желанию, поэтому, использование шаблонов цвета предпочтительнее при формировании результатов отчетов.
* Ячейки могут быть объединены между собой в группы ячеек. Текст в такой группе будет использовать все пространство группы и будет получен из верхней левой ячейки группы.
* Ячейки имеют разнообразные свойства переноса текста, выравнивания по горизонтали и вертикали, отступов по горизонтали и вертикали, угол направления текста и пр.
* Каждая ячейка имеет четыре границы вокруг себя, каждая из границ может иметь свой рисунок и цвет. Из-за использования шаблонов для создания таблиц-результата, двух границ для каждой ячейки недостаточно.
* Столбцы и строки таблицы имеют дополнительное свойство "автоматическое расширение", обычно номера таких строк или столбцов выделены визуально для удобства создания таблиц-шаблонов. Строки или столбцы со свойством "автоматическое расширение" будут автоматически изменять размеры, в зависимости от текста, помещенного внутрь их ячеек.
* При печати больших таблиц, происходит их распределение на несколько листов, иногда важно, чтобы определенные блоки текста (строки или столбцы) не разделялись и шли всегда вместе (к примеру, блок с подписями и печатями), для этого предусмотрены блоки строк или столбцов без разделения.
Основные свойства визуальных элементов (объектов) таблицы перечислены ниже:
* Объекты могут быть добавлены в любое место таблицы и могут представлять собой не только текстовые поля, но и рисунки, OLE-объекты и пр.
* Объект содержит текст в ANSI или UTF-16 кодировках, либо текст шаблона, представляющего собой программу на встроенном языке. Для шаблонов, программа будет исполнена и результат будет записан, как текст ячейки в момент копирования частей таблицы-шаблона в таблицу результат.
* Объект содержит произвольный объект встроенного языка, использующийся как значение ячейки при клике по ячейке или редактировании оной. Вместо объекта языка в ячейке может находиться текст шаблона, представляющего собой программу на встроенном языке, программа будет исполнена и результат будет записан, как значение ячейки в момент копирования частей таблицы-шаблона в таблицу результат.
* Текст объекта может иметь стандартные свойства форматирования: шрифт, выделение, цвет фона, цвет текста и рамки и пр., либо для ячейки может быть задан шаблон цвета (color template). В последнем случае, пользователи смогут выбирать другую палитру цветов, по своему желанию, поэтому, использование шаблонов цвета предпочтительнее при формировании результатов отчетов.
* Объекты имеют разнообразные свойства переноса текста, выравнивания по горизонтали и вертикали, отступов по горизонтали и вертикали, угол направления текста и пр.
* Каждый объект имеет четыре границы вокруг себя, каждая из границ может иметь свой рисунок и цвет.
* Объект может не выводиться на печать, если это необходимо
* Объект может иметь наименование, по которому можно обратиться к нему из текста программы
* Положение и размеры объекта могут быть привязаны к абсолютной координате внутри таблицы или к определенной ячейке таблицы. Таким образом можно создать объекты, которые не будут перемещаться или/и изменять размеры при изменении размеров ячеек таблицы, либо будут привязаны к определенным ячейкам.

Не стоит путать электронные таблицы SFT (наименование интерфейса объекта '''Table''') и [[Таблица|таблицы значений]] (наименование интерфейса объекта '''Tab'''), это совершенно разные объекты.

== Пример создания электронной таблицы с помощью таблицы-шаблона и вывода ее на экран/печать ==
Простой пример выполнения запроса и вывода информации в виде отчета с произвольным количеством горизонтальных столбиков.
<pre>
//Переменные, которые были подготовлены заранее:
//спНоменклатура -- список номенклатурных позиций, выводящихся в отчет (горизонтальные строки отчета с папками)
//спТипыЦен -- список типов цен, которые будут следовать по горизонтали столбиками
//ДатаФормирования -- дата нахождения цены

//Выполняем запрос для получения горизонтального разреза
ТЗ:="зН:=Ref.Номенклатура;
|зСтатус:=Ref.Номенклатура.@STATUS;Condition(зСтатус=0);
|зПапка:=Ref.Номенклатура.@ISFOLDER;
|Condition(зПапка=0);
|Condition(зН IN спНоменклатура);
|Group зН with folders;";

З:=Query.Create();
З.Execute(ТЗ);

Т:=Table.Create();
Т.SetSourceName("Отчет");
//Здесь и далее переменные с префиксом "п" используются в таблице-шаблоне "Отчет" в соответствующих ячейках,
// при копировании куска таблицы с помощью CopyByX, ячейки автоматически заполняются значениями нужных переменных.
пЗагол:="Отчет по ценам номенклатуры";

//Копирование из таблицы-шаблона будет осуществляться слева направо и затем сверху вниз
//Столбец "h1" в таблице-шаблоне содержит столбец с наименованием номенклатурной позиции, левый отступ, порядковый номер и пр.
//Столбец "h2" -- цена текущей позиции по типу цен из спТипыЦен
//Столбец "h3" -- завершает таблицу (правая граница)
//Строка "v1" таблицы-шаблона содержит заголовок отчета с заголовками столбцов
//Строка "v2" таблицы-шаблона содержит одну строку отчета
//Строка "v3" таблицы-шаблона содержит одну строку папки отчета, цены для папок не выводятся
//Строка "v4" таблицы-шаблона завершает отчет снизу (нижняя граница)

//Первый блок добавляется "с начала строки"
Т.CopyByX("v1|h1",1);
For i:=1 to спТипыЦен.Size() Do
пТипЦен:=спТипыЦен.Get(i);
//Последующие блоки добавляются слева направо без перевода на другую строку, пТипЦен выводится в заголовки столбцов
Т.CopyByX("v1|h2");
EndDo;
//Окончание вывода блока заголовка таблицы
Т.CopyByX("v1|h3");
//Фиксирование заголовка, чтобы он всегда был на экране при перемещении курсора по таблице
Т.Options.FixedLine:=Т.Height();

пКолВо:=0;
While З.Next(1) Do
//Переменные используются в столбце "h1"
пН:=З.зН;
пКод:=пН.Code;

If пН.IsFolder() Then
//Вывод строки с папкой
Т.CopyByX("v3|h1",1);
For i:=1 to спТипыЦен.Size() Do
Т.CopyByX("v3|h2");
EndDo;
Т.CopyByX("v3|h3");
пКолВо:=пКолВо+1;
Else
//Вывод обычной строки
Т.CopyByX("v2|h1",1);
For i:=1 to спТипыЦен.Size() Do
пЦ:=глНайтиЦену(З.зН,спТипыЦен.Get(i),ДатаФормирования);
Т.CopyByX("v2|h2");
EndDo;
Т.CopyByX("v2|h3");
EndIf;

//Вывод информации о состоянии формирования отчета
пКолВо:=пКолВо+1;
//Этот текст выводится в строку состояния
Form.StatusText(""+пКолВо+" из "+З.ResultTable.Size());
//Этот текст выводится в виде индикатора выполнения, как подсказка при наведении курсора мыши на кнопку задачи отчета
Form.UpdateProgress(пКолВо,З.ResultTable.Size());
EndDo;
//Выведем нижнюю границу отчета
Т.CopyByX("v4|h1",1);
For i:=1 to спТипыЦен.Size() Do
Т.CopyByX("v4|h2");
EndDo;
Т.CopyByX("v4|h3");

//Изменим параметры печати
Т.Printing.Orientation:=1;
Т.Printing.ScaleMode:=1;
//Режим просмотра для удобства пользователя
Т.EditorMode:=1;
//Выводим на экран или принтер?
If флВывестиСразуНаПринтер Then
Т.Printing.Printer:=тПринтер;
Т.Print();
Else
Т.Show(пЗагол);
EndIf;
</pre>

== Основные атрибуты и функции ==
Данный раздел содержит основные функции, которые используются совместно с объектом электронной таблицы.

{{function header}}
{{function entry
|name=[[Table.Create|Create]]
|form={{Grey|Table.}}'''Create'''():''<Новый объект электронной таблицы (TABLE)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый объект электронной таблицы.
}}
{{function entry
|name=[[Table.CurLine|CurLine]]
|form={{Grey|Table.}}'''CurLine''':''<Строка визуального курсора таблицы (INT)>''
|type=0
|status=2
|visual=1
|description=Получить или изменить текущую строку курсора таблицы. Курсор таблицы только косвенно связан с выделенными ячейками таблицы и не зависит от текущего выделения, для получения информации по выделению в таблице, используйте атрибут [[Table.Selection|Selection]]. Нумерация строк начинается с единицы.
}}
{{function entry
|name=[[Table.CurColumn|CurColumn]], '''CurCol'''
|form={{Grey|Table.}}'''CurColumn''':''<Столбец визуального курсора таблицы (INT)>''
|type=0
|status=2
|visual=1
|description=Получить или изменить текущий столбец курсора таблицы. Курсор таблицы только косвенно связан с выделенными ячейками таблицы и не зависит от текущего выделения, для получения информации по выделению в таблице, используйте атрибут [[Table.Selection|Selection]]. Нумерация столбцов начинается с единицы.
}}
{{function entry
|name=[[Table.CurPutX|CurPutX]]
|form={{Grey|Table.}}'''CurPutX''':''<Столбец курсора добавления областей к таблице (INT)>''
|type=0
|status=2
|visual=0
|description=Получить или изменить текущий столбец курсора добавления областей к таблице. Курсор добавления областей используется в момент вызова функций [[Table.CopyByX|CopyByX]] и [[Table.CopyByY|CopyByY]] и определяет место добавления следующей области из таблицы-шаблона. Нумерация столбцов начинается с единицы.
}}
{{function entry
|name=[[Table.CurPutY|CurPutY]]
|form={{Grey|Table.}}'''CurPutY''':''<Строка курсора добавления областей к таблице (INT)>''
|type=0
|status=2
|visual=0
|description=Получить или изменить текущую строку курсора добавления областей к таблице. Курсор добавления областей используется в момент вызова функций [[Table.CopyByX|CopyByX]] и [[Table.CopyByY|CopyByY]] и определяет место добавления следующей области из таблицы-шаблона. Нумерация строк начинается с единицы.
}}
{{function entry
|name=[[Table.EditorMode|EditorMode]]
|form={{Grey|Table.}}'''EditorMode''':''<Режим редактирования таблицы (INT)>''
|type=0
|status=2
|visual=1
|description=Получить или изменить режим редактирования таблицы.
}}
{{function entry
|name=[[Table.Restrict|Restrict]]
|form={{Grey|Table.}}'''Restrict''':''<Режимы запрета работы с таблицей (INT)>''
|type=0
|status=2
|visual=1
|description=Получить или изменить режимы запрета работы с таблицей.
}}
{{function entry
|name=[[Table.Scale|Scale]]
|form={{Grey|Table.}}'''Scale''':''<Масштаб отображения таблицы (INT)>''
|type=0
|status=2
|visual=1
|description=Получить или изменить масштаб отображения таблицы на экране. Масштаб по умолчанию равен 100.
}}
{{function entry
|name=[[Table.SelectionMode|SelectionMode]]
|form={{Grey|Table.}}'''SelectionMode''':''<Тип текущего выделения ячеек (INT)>''
|type=0
|status=2
|visual=1
|description=Получить тип текущего выделения ячеек или визуальных элементов таблицы.
}}
{{function entry
|name=[[Table.SelfReferenceCount|SelfReferenceCount]]
|form={{Grey|Table.}}'''SelfReferenceCount''':''<Количество ссылок на себя в объектах таблицы (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут позволяет получить или изменить количество ссылок на себя, хранящихся в объектах таблицы. Если не установить это число корректно, таблица не может быть удалена из памяти, так как количество ссылок на нее останется больше нуля, когда она будет удалена из ссылающейся последней переменной, и это приведет к утечке памяти.
}}
{{function entry
|name=[[Table.AttachedModule|AttachedModule]]
|form={{Grey|Table.}}'''AttachedModule''':''<Связать текущий модуль с событиями таблицы (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут позволяет получить или изменить свойство связи текущего модуля со свободной таблицей. Если модуль будет закрыт позже, а таблица останется открытой, события таблиц типа [[OnDoubleClick]] будут вызываться сначала в этом связанном модуле, а уже потом в модуле, под которым работает таблица, или в глобальном модуле. Это удобно для отчетов, которые производят определенные действия при работе со свободными таблицами, получаемыми в результате их выполнения. Таким образом можно избежать утери этой функциональности, если обработка отчета будет закрыта, но нужно понимать, что вызванное таким образом событие, возможно будет работать со стеком и переменными другого модуля. Также стоит заметить, что функция [[ModuleTag]] понимает эту связь и будет отдавать переменную, привязанную именно к модулю таблицы.
}}
{{function entry
|name=[[Table.PrintSettingsChanged|PrintSettingsChanged]]
|form={{Grey|Table.}}'''PrintSettingsChanged'''():''<Были изменены установки печати таблицы (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает 1, если были изменены любые установки, связанные с печатью таблицы (кроме названия принтера). После выполнения печати этот атрибут автоматически сбрасывается. Атрибут может использоваться в универсальных обработчиках печати, а также для сохранения индивидуальных изменений печатных форм.
}}
{{function entry
|name=[[Table.ResetCursor|ResetCursor]]
|form={{Grey|Table.}}'''ResetCursor'''()
|type=1
|status=2
|visual=1
|description=Функция сдвигает видимое пространство таблицы таким образом, чтобы ячейка, в которой находится визуальный курсор, была видна на экране, если визуальный курсор уже виден на экране, функция не производит никаких изменений. Положение курсора не изменяется.
}}
{{function entry
|name=[[Table.SetCursor|SetCursor]]
|form={{Grey|Table.}}'''SetCursor'''(''<Столбец курсора (INT)>'',''<Строка курсора (INT)>'')
|type=1
|status=2
|visual=1
|description=Функция перемещает визуальный курсор в требуемую ячейку таблицы. При этом сдвига видимого пространства таблицы не происходит и курсор может оказаться за пределами видимости.
}}
{{function entry
|name=[[Table.AddObject|AddObject]]
|form={{Grey|Table.}}'''AddObject'''(''<Тип визуального объекта (INT)>''{{Optional|,<Наименование объекта (STRING)>,<Источник объекта>,<Тип координат объекта (INT)>{{Default|{{Eq}}0}},<Координаты объекта (STRING)>}})
|type=1
|status=2
|visual=0
|description=Функция добавляет новый объект в таблицу. Для объекта указывается тип, координаты, наименование. Если объект имеет тип OLE или картинка, также задается дополнительный параметр "источник объекта".
}}
{{function entry
|name=[[Table.Lock|Lock]]
|form={{Grey|Table.}}'''Lock'''()
|type=1
|status=2
|visual=1
|description=Функция блокирует отображения изменений в таблице до вызова функции [[Table.Unlock|Unlock]]. Функция может использоваться перед большим количеством обновлений или заполнении таблицы для получения значительного ускорения операции. Функцию не имеет смысла вызывать для таблиц, которые (еще) не были выведены на экран, так как такие таблицы не обновляются визуально.
}}
{{function entry
|name=[[Table.Unlock|Unlock]]
|form={{Grey|Table.}}'''Unlock'''()
|type=1
|status=2
|visual=1
|description=Функция снимает блокировку отображения изменений в таблице, установленную функцией [[Table.Lock|Lock]], и вызывает полное визуальное обновление таблицы.
}}
{{function entry
|name=[[Table.Update|Update]]
|form={{Grey|Table.}}'''Update'''()
|type=1
|status=2
|visual=1
|description=Функция вызывает полное визуальное обновление таблицы.
}}
{{function entry
|name=[[Table.Size|Size]], '''Lines''', '''Height'''
|form={{Grey|Table.}}'''Size'''({{Optional|<Новое количество выделенных строк в таблице (INT)>}}):''<Количество выделенных строк в таблице (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает или изменяет высоту таблицы (количество строк в таблице, где производились какие-либо изменения, либо строки были скопированы из таблицы-шаблона и т.п.). При уменьшении количества строк, удаление будет происходить с конца таблицы.
}}
{{function entry
|name=[[Table.SizeC|SizeC]], '''Columns''', '''Width'''
|form={{Grey|Table.}}'''SizeC'''({{Optional|<Новое количество выделенных столбцов в таблице (INT)>}}):''<Количество выделенных столбцов в таблице (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает или изменяет ширину таблицы (количество столбцов в таблице, где производились какие-либо изменения, либо столбцы были скопированы из таблицы-шаблона и т.п.). При уменьшении количества столбцов, удаление будет происходить с конца таблицы.
}}
{{function entry
|name=[[Table.InsertColumns|InsertColumns]]
|form={{Grey|Table.}}'''InsertColumns'''(''<Начиная со столбца (INT)>''{{Optional|,<Количество столбцов (INT)>{{Default|{{Eq}}1}},<Ширина вставляемых столбцов (INT)>,<Автоматическая ширина столбцов (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=0
|visual=0
|description=Функция вставляет требуемое количество столбцов начиная с требуемой позиции. Вставка столбцов может вызвать разъединение областей ячеек, если области включают позицию добавления.
}}
{{function entry
|name=[[Table.InsertLines|InsertLines]]
|form={{Grey|Table.}}'''InsertLines'''(''<Начиная со строки (INT)>''{{Optional|,<Количество строк (INT)>{{Default|{{Eq}}1}},<Высота вставляемых строк (INT)>,<Автоматическая высота строк (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=0
|visual=0
|description=Функция вставляет требуемое количество строк начиная с требуемой позиции. Вставка строк может вызвать разъединение областей ячеек, если области включают позицию добавления.
}}
{{function entry
|name=[[Table.RemoveColumns|RemoveColumns]]
|form={{Grey|Table.}}'''RemoveColumns'''(''<Начиная со столбца (INT)>''{{Optional|,<Количество столбцов (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=0
|visual=0
|description=Функция удаляет требуемое количество столбцов начиная с требуемой позиции. Удаление столбцов может вызвать разъединение областей ячеек, если области включают удаляемые столбцы.
}}
{{function entry
|name=[[Table.RemoveLines|RemoveLines]]
|form={{Grey|Table.}}'''RemoveLines'''(''<Начиная со строки (INT)>''{{Optional|,<Количество строк (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=0
|visual=0
|description=Функция удаляет требуемое количество строк начиная с требуемой позиции. Удаление строк может вызвать разъединение областей ячеек, если области включают удаляемые строки.
}}
{{function entry
|name=[[Table.Copy|Copy]]
|form={{Grey|Table.}}'''Copy'''():''<Копия таблицы (TABLE)>''
|type=1
|status=2
|visual=0
|description=Функция создает полную копию таблицы в памяти.
}}
{{function entry
|name=[[Table.Clear|Clear]]
|form={{Grey|Table.}}'''Clear'''()
|type=1
|status=2
|visual=0
|description=Функция удаляет все столбцы и ячейки и объекты из таблицы и устанавливает все свойства таблицы по умолчанию.
}}
{{function entry
|name=[[Table.Find|Find]]
|form={{Grey|Table.}}'''Find'''(''<Текст для поиска (STRING)>''{{Optional|,<Установки поиска (INT)>{{Default|{{Eq}}0}},<Область поиска (STRING)>,<Переместить курсор на найденную ячейку (INT)>{{Default|{{Eq}}0}}}}):''<Найденная ячейка (STRING)>''
|type=1
|status=0
|visual=0
|description=Функция производит поиск строки или части строки в тексте ячеек указанной области таблицы (или во всей таблице), руководствуясь заданными правилами. Если ячейка найдена, функция возвращает ее координату в виде строки <code>"<Столбец>:<Строка>"</code> (пример ''"12:100"'') и перемещает курсор в найденную ячейку, если это необходимо, если ячейка не найдена, функция возвращает пустую строку.
}}
{{function entry
|name=[[Table.FindByValue|FindByValue]]
|form={{Grey|Table.}}'''FindByValue'''(''<Значение для поиска>''{{Optional|,<Установки поиска (INT)>{{Default|{{Eq}}0}},<Область поиска (STRING)>,<Переместить курсор на найденную ячейку (INT)>{{Default|{{Eq}}0}}}}):''<Найденная ячейка (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск строки или части строки в значениях ячеек указанной области таблицы (или во всей таблице), руководствуясь заданными правилами. Если ячейка найдена, функция возвращает ее координату в виде строки <code>"<Столбец>:<Строка>"</code> (пример ''"12:100"'') и перемещает курсор в найденную ячейку, если это необходимо, если ячейка не найдена, функция возвращает пустую строку.
}}
{{function entry
|name=[[Table.Show|Show]]
|form={{Grey|Table.}}'''Show'''({{Optional|<Заголовок формы с таблицей (STRING)>,<Наименования файла по умолчанию при сохранении таблицы (STRING)>,<Выводить окно на передний план (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=1
|description=Функция выводит таблицу на экран в виде самостоятельной формы, подчиненной текущей форме. Окно имеет требуемый заголовок, при сохранении таблицы в виде файла, по умолчанию используется имя файла, которое можно задать в аргументе этой функции.
}}
{{function entry
|name=[[Table.ShowOnParent|ShowOnParent]]
|form={{Grey|Table.}}'''ShowOnParent'''({{Optional|<Заголовок формы с таблицей (STRING)>,<Наименования файла по умолчанию при сохранении таблицы (STRING)>,<Выводить окно на передний план (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=1
|description=Функция выводит таблицу на экран в виде самостоятельной формы, подчиненной верхней родительской форме. Окно имеет требуемый заголовок, при сохранении таблицы в виде файла, по умолчанию используется имя файла, которое можно задать в аргументе этой функции. Если таблица формируется из потока, модуля или функции, не отображаемых на экране в виде формы, либо текущая форма вызывает другую, с тем, чтобы последняя вывела таблицу на экран и закрылась после вывода, эта функция может закрепить выведенную таблицу за верхней родительской формой, вместо текущей, это позволит избежать ситуации запрета исполнения родительской формы до тех пор, пока не будут закрыты все печатные формы, созданные подчиненной. См. также [[Форма]].
}}
{{function entry
|name=[[Table.Hide|Hide]]
|form={{Grey|Table.}}'''Hide'''()
|type=1
|status=0
|visual=1
|description=Функция позволяет закрыть открытую ранее форму таблицы и сделать таблицу невизуальной.
}}
{{function entry
|name=[[Table.HasWindow|HasWindow]]
|form={{Grey|Table.}}'''HasWindow'''():''<Режим вывода таблицы на экран (INT)>''
|type=1
|status=0
|visual=1
|description=Функция возвращает 0, если таблица не выведена на экран, 1 -- если она выведена, как самостоятельная форма, 2 -- если она является частью элемента формы.
}}
{{function entry
|name=[[Table.NavigationState|NavigationState]]
|form={{Grey|Table.}}'''NavigationState'''({{Optional|<Новое состояние навигации (STRING)>}}):''<Текущее состояние навигации (STRING)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает или/и изменяет состояние навигации в таблице. В это понятие включается: первая видимая верхняя левая ячейка, количество закрепленных строк и столбцов, положение курсора в таблице. Сохранение и восстановление состояния, к примеру, удобно использовать при обновлении отчета, чтобы после обновления вернуть курсор в ячейку, в которой он находился до обновления.
}}
{{function entry
|name=[[Table.ShowPreview|ShowPreview]]
|form={{Grey|Table.}}'''ShowPreview'''()
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный диалог предварительного просмотра перед печатью.
}}
{{function entry
|name=[[Table.ShowPrintProperties|ShowPrintProperties]]
|form={{Grey|Table.}}'''ShowPrintProperties'''()
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный диалог установок печати таблицы.
}}
{{function entry
|name=[[Table.Print|Print]]
|form={{Grey|Table.}}'''Print'''({{Optional|<Показать стандартный диалог печати до ее осуществления (INT)>{{Default|{{Eq}}0}},<Наименование задания на принтере (STRING)>,<Режим диалога отмены печати (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция производит печать на принтер, с выводом стандартного диалога печати, если это необходимо. После деления данных на страницы при печати, функция изменяет текст колонтитулов созданных страниц, подставляя вместо выражения <code>#P</code> номер соответствующей страницы, а вместо <code>#Q</code> общее количество страниц при печати.
}}
{{function entry
|name=[[Table.CreatePageIndex|CreatePageIndex]]
|form={{Grey|Table.}}'''CreatePageIndex'''({{Optional|<Максимальное время ожидания освобождения принтера (INT)>{{Default|{{Eq}}5000}}}}):''<Список размеров страниц (LIST)>''
|type=1
|status=2
|visual=0
|description=Функция создает или обновляет список страниц, которые будут выведены на печать, если текущие установки таблицы не изменятся. '''Внимание:''' функция может выполняться достаточно длительное время, из-за того, что установки печати записываются в свойства принтера перед подсчетом, кроме того, функция пересчитывает все параметры ячеек с изменяемыми размерами, поэтому, чем больше таблица по размеру, тем медленнее работает эта функция. Если принтер занят в данный момент печатью, функция также ожидает ее окончания, максимальное время этого ожидания задается в первом аргументе в миллисекундах.
}}
{{function entry
|name=[[Table.Load|Load]]
|form={{Grey|Table.}}'''Load'''(''<Наименование файла (STRING)>''{{Optional|,<Формат (INT,STRING)>,<Индекс или наименование листа (INT,STRING)>}}):''<Наименование загруженного листа или список с листами (STRING,LIST)>''
|type=1
|status=2
|visual=0
|description=Функция производит загрузку текущей таблицы из файла в указанном формате, предыдущие данные, находившиеся в таблице, будут утеряны.
}}
{{function entry
|name=[[Table.Save|Save]]
|form={{Grey|Table.}}'''Save'''(''<Наименование файла (STRING)>''{{Optional|,<Формат (INT,STRING)>,<Список таблиц для сохранения в листы книги (LIST)>}})
|type=1
|status=2
|visual=0
|description=Функция производит сохранение текущей таблицы в файл в указанном формате.
}}
{{function entry
|name=[[Table.LoadFromBuffer|LoadFromBuffer]]
|form={{Grey|Table.}}'''LoadFromBuffer'''(''<Объект буфера или строка (BUFFER,STRING)>''{{Optional|,<Начальная позиция буфера (INT)>{{Default|{{Eq}}0}},<Размер таблицы в буфере (INT)>,<Формат (INT,STRING)>,<Индекс или наименование листа (INT,STRING)>}}):''<Наименование загруженного листа или список с листами (STRING,LIST)>''
|type=1
|status=2
|visual=0
|description=Функция производит загрузку текущей таблицы из буфера в указанном формате, предыдущие данные, находившиеся в таблице, будут утеряны.
}}
{{function entry
|name=[[Table.SaveToBuffer|SaveToBuffer]]
|form={{Grey|Table.}}'''SaveToBuffer'''(''<Объект буфера (BUFFER)>''{{Optional|,<Начальная позиция буфера (INT)>{{Default|{{Eq}}0}},<Формат (INT,STRING)>{{Default|{{Eq}}0}},<Установки (INT)>{{Default|{{Eq}}0}},<Список таблиц для сохранения в листы книги (LIST)>}}):''<Размер в байтах, добавленный в буфер (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит сохранение текущей таблицы в буфер в указанном формате с указанными установками.
}}
{{function entry
|name=[[Table.SetSourceName|SetSourceName]]
|form={{Grey|Table.}}'''SetSourceName'''(''<Наименование таблицы-шаблона (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция задает новое наименование (и путь, если необходимо) таблицы-шаблона из которого функции, типа [[Table.CopyByX|CopyByX]] будут копировать информацию в текущую таблицу. Имя таблицы задается без расширения. Функция не проверяет существование таблицы с заданным именем, таблица будет загружена в момент, когда будет производиться копирование из нее.
}}
{{function entry
|name=[[Table.GetSourceName|GetSourceName]]
|form={{Grey|Table.}}'''GetSourceName'''():''<Наименование таблицы-шаблона (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает текущее наименование таблицы-шаблона из которого функции, типа [[Table.CopyByX|CopyByX]] будут копировать информацию в текущую таблицу.
}}
{{function entry
|name=[[Table.SetSource|SetSource]]
|form={{Grey|Table.}}'''SetSource'''(''<Таблица-шаблон (TABLE)>'')
|type=1
|status=2
|visual=0
|description=Функция задает таблицу-шаблон из которой функции, типа [[Table.CopyByX|CopyByX]] будут копировать информацию в текущую таблицу.
}}
{{function entry
|name=[[Table.Source|Source]]
|form={{Grey|Table.}}'''Source'''():''<Таблица-шаблон (TABLE)>''
|type=1
|status=2
|visual=0
|description=Функция получает текущую таблицу-шаблон. Функция возвращает значение типа ''таблица SFT'' только в случае, когда таблица уже загружена (т.е., работа с ней уже велась). Если таблица не была загружена, функция возвращает пустое значение.
}}
{{function entry
|name=[[Table.CopyTitles|CopyTitles]]
|form={{Grey|Table.}}'''CopyTitles'''()
|type=1
|status=2
|visual=0
|description=Функция выполняет копирование колонтитулов из таблицы-шаблона в текущую таблицу. В момент копирования тексты колонтитулов, являющиеся шаблонами, будут превращены в результаты их вычисления.
}}
{{function entry
|name=[[Table.CopyByX|CopyByX]]
|form={{Grey|Table.}}'''CopyByX'''(''<Указание на область таблицы-шаблона (STRING)>''{{Optional|,<Перейти на новую строку до добавления области (INT)>{{Default|{{Eq}}0}},<Не производить изменения размеров столбцов или строк (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция выполняет копирование указанной области ячеек и объектов, находящихся внутри этой области из таблицы-шаблона в текущую таблицу, начиная с ячейки, заданной атрибутами [[Table.CurPutX|CurPutX]] и [[Table.CurPutY|CurPutY]]. В момент копирования тексты и значения ячеек и объектов, являющиеся шаблонами, будут превращены в результаты их вычисления. Если третий аргумент равен 1, до начала копирования, функция переводит курсор копирования в левый столбик и производит сдвиг курсора по вертикали (размер сдвига по вертикали определяется высотой копируемой области). После окончания копирования функция переводит курсор копирования вправо на ширину области копирования. Если четвертый аргумент равен 1, функция не будет изменять размеры строк или столбцов в соответствии с размерами строк и столбцов копируемой области, однако, при копировании текста в ячейки, автоматически рассчитываемые размеры строк или столбцов по-прежнему будут изменены, если это необходимо. После копирования любого визуального объекта, функция вызывает событие [[OnFinishCopyObject]], если оно существует в текущем или глобальном модуле.
}}
{{function entry
|name=[[Table.CopyByY|CopyByY]]
|form={{Grey|Table.}}'''CopyByY'''(''<Указание на область таблицы-шаблона (STRING)>''{{Optional|,<Перейти на новый столбец до добавления области (INT)>{{Default|{{Eq}}0}},<Не производить изменения размеров столбцов или строк (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция выполняет копирование указанной области ячеек и объектов, находящихся внутри этой области из таблицы-шаблона в текущую таблицу, начиная с ячейки, заданной атрибутами [[Table.CurPutX|CurPutX]] и [[Table.CurPutY|CurPutY]]. В момент копирования тексты и значения ячеек и объектов, являющиеся шаблонами, будут превращены в результаты их вычисления. Если третий аргумент равен 1, до начала копирования, функция переводит курсор копирования на первую строку и производит сдвиг курсора по горизонтали (размер сдвига по горизонтали определяется шириной копируемой области). После окончания копирования функция переводит курсор копирования вниз на высоту области копирования. Если четвертый аргумент равен 1, функция не будет изменять размеры строк или столбцов в соответствии с размерами строк и столбцов копируемой области, однако, при копировании текста в ячейки, автоматически рассчитываемые размеры строк или столбцов по-прежнему будут изменены, если это необходимо. После копирования любого визуального объекта, функция вызывает событие [[OnFinishCopyObject]], если оно существует в текущем или глобальном модуле.
}}
{{function entry
|name=[[Table.RecalcColumnWidth|RecalcColumnWidth]]
|form={{Grey|Table.}}'''RecalcColumnWidth'''(''<Столбец начала пересчета (INT)>''{{Optional|,<Количество пересчитываемых столбцов (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=0
|visual=0
|description=Функция пересчитывает ширину указанных столбцов, если их ширина рассчитывается автоматически.
}}
{{function entry
|name=[[Table.RecalcLineHeight|RecalcLineHeight]]
|form={{Grey|Table.}}'''RecalcLineHeight'''(''<Строка начала пересчета (INT)>''{{Optional|,<Количество пересчитываемых строк (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=0
|visual=0
|description=Функция пересчитывает высоту указанных строк, если их высота рассчитывается автоматически.
}}
{{function footer}}

== Атрибуты и функции вспомогательных объектов (Table.Options, Table.Printing и т.п.) ==
Данный раздел содержит функции, применяемые к подчиненным объектам, связанным с основным объектом таблицы. Данные группа объектов имеет тип ''Table.Options'' и включает следующие объекты:
* Объект визуального выделения ячеек таблицы
* Объект списка выделенных визуальных элементов (объектов) таблицы
* Объект работы с визуальными уровнями таблицы
* Объект общих настроек таблицы
* Объект работы с разбиениями таблицы на отдельные страницы при печати
* Объект настройки параметров печати, полей окружения страницы и колонтитулов
* Объект работы с со строками или столбцами таблицы, выводящимися на каждой странице
{{function header}}
{{function entry
|name=[[Table.Selection|Selection]]
|form={{Grey|Table.}}'''Selection'''():''<Объект выделения таблицы (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает объект текущего выделения ячеек. С объектом можно вызывать функции, типа [[Table.Selection.Add|Add]] и пр.
}}
{{function entry
|name=[[Table.Selection.Count|Count]]
|form={{Grey|Table.Selection.}}'''Count'''():''<Количество областей визуального выделения (INT)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает количество областей визуального выделения в таблице. Выделение не удаляется даже если пользователь выберет визуальный объект. При выделении объекта, выделение ячеек остается, но будет скрыто. Чтобы узнать, что выделено в данный момент, можно использовать атрибут [[Table.SelectionMode|SelectionMode]].
}}
{{function entry
|name=[[Table.Selection.Add|Add]]
|form={{Grey|Table.Selection.}}'''Add'''(''<Левый столбец выделения (INT)>'',''<Верхняя строка выделения (INT)>'',''<Правый столбец выделения (INT)>'',''<Нижняя строка выделения (INT)>'')
|type=1
|status=2
|visual=1
|description=Функция добавляет к визуально выделенным областям еще одну заданную область.
}}
{{function entry
|name=[[Table.Selection.Delete|Delete]]
|form={{Grey|Table.Selection.}}'''Delete'''(''<Индекс области выделения (INT)>'')
|type=1
|status=2
|visual=1
|description=Функция удаляет область визуального выделения с указанным индексом. Первая область выделения имеет индекс 1.
}}
{{function entry
|name=[[Table.Selection.Get|Get]]
|form={{Grey|Table.Selection.}}'''Get'''(''<Индекс области выделения (INT)>'',''<Тип границы выделения (INT)>''):''<Столбец или строка выделения (INT)>''
|type=1
|status=2
|visual=1
|description=Функция получает строку или столбец визуального выделения с указанным индексом.
}}
{{function entry
|name=[[Table.Selection.GetArea|GetArea]]
|form={{Grey|Table.Selection.}}'''GetArea'''(''<Индекс области выделения (INT)>'',{{ByRef|<Левый столбец выделения (INT)>,<Верхняя строка выделения (INT)>,<Правый столбец выделения (INT)>,<Нижняя строка выделения (INT)>}})
|type=1
|status=2
|visual=1
|description=Функция получает координаты визуального выделения с указанным индексом.
}}
{{function entry
|name=[[Table.Selection.Clear|Clear]]
|form={{Grey|Table.Selection.}}'''Clear'''()
|type=1
|status=2
|visual=1
|description=Функция удаляет все области выделения; остается одна область, совпадающая с положением визуального курсора.
}}
{{function entry
|name=[[Table.SelectedObjects|SelectedObjects]]
|form={{Grey|Table.}}'''SelectedObjects'''():''<Выделенные визуальные объекты таблицы (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает объект выделенных визуальных объектов таблицы. С объектом можно вызывать функции, типа [[Table.SelectedObjects.Get|Get]] и пр.
}}
{{function entry
|name=[[Table.SelectedObjects.Count|Count]]
|form={{Grey|Table.SelectedObjects.}}'''Count'''():''<Количество выделенных визуальных объектов (INT)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает количество выделенных визуальных объектов в таблице. Чтобы узнать, что выделено в данный момент, можно использовать атрибут [[Table.SelectionMode|SelectionMode]].
}}
{{function entry
|name=[[Table.SelectedObjects.Add|Add]]
|form={{Grey|Table.SelectedObjects.}}'''Add'''(''<Индекс добавляемого к выделенным объекта (INT)>'')
|type=1
|status=0
|visual=1
|description=Функция добавляет к выделенным в данный момент объектам указанный по индексу объект. Если до момента вызова функции был активен режим выделения ячеек, после вызова функции активируется режим выделения визуальных объектов с единственным выбранным объектом.
}}
{{function entry
|name=[[Table.SelectedObjects.Delete|Delete]]
|form={{Grey|Table.SelectedObjects.}}'''Delete'''(''<Индекс исключаемого из выделения объекта (INT)>'')
|type=1
|status=0
|visual=1
|description=Функция исключает из выделенных в данный момент объектов указанный по индексу объект.
}}
{{function entry
|name=[[Table.SelectedObjects.Get|Get]]
|form={{Grey|Table.SelectedObjects.}}'''Get'''(''<Индекс выделенного объекта (INT)>''):''<Визуальный объект (TABLE.OBJECT>''
|type=1
|status=2
|visual=1
|description=Функция получает визуальный объект таблицы по индексу в массиве выделенных в данный момент объектов
}}
{{function entry
|name=[[Table.SelectedObjects.Clear|Clear]]
|form={{Grey|Table.SelectedObjects.}}'''Clear'''()
|type=1
|status=0
|visual=1
|description=Функция исключает все выделенные объекты из массива выделенных объектов и активирует режим выделения ячеек.
}}
{{function entry
|name=[[Table.Levels|Levels]]
|form={{Grey|Table.}}'''Levels'''({{Optional|<Тип уровня (INT)>{{Default|{{Eq}}0}},<Индекс уровня (INT)>,<Индекс дочернего уровня (INT)>...}}):''<Визуальные уровни таблицы (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает объект визуальных уровней таблицы. Уровни используются для выделения групп столбцов или строк таблицы. Уровни можно закрывать или открыть. Если уровень закрыт, строки или столбцы, входящие в него (кроме основной строки/столбца) будут скрыты. Уровни могут быть вложенными друг в друга. С объектом можно вызывать функции, типа [[Table.Levels.Open|Open]] и пр. Функция содержит указание на конкретный уровень (если заданы индексы), после чего к нему можно добавить дочерние уровни, либо указание на корневой уровень (если индексы не заданы).
}}
{{function entry
|name=[[Table.Levels.Child|Child]]
|form={{Grey|Table.Levels.}}'''Child'''(''<Индекс уровня (INT)>''):''<Объект вложенного уровня по его индексу (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=1
|description=Функция получает объект уровня, вложенного в текущий, по его индексу. Индексация начинается с единицы.
}}
{{function entry
|name=[[Table.Levels.Parent|Parent]]
|form={{Grey|Table.Levels.}}'''Parent'''():''<Объект уровня, в который вложен данный (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=1
|description=Функция получает уровень, в который вложен данный. Если функция вызывается с объектом верхнего уровня, она возвращает пустое значение.
}}
{{function entry
|name=[[Table.Levels.Index|Index]]
|form={{Grey|Table.Levels.}}'''Index'''():''<Индекс текущего уровня внутри родительского (INT)>''
|type=1
|status=2
|visual=1
|description=Функция получает индекс текущего уровня относительно родительского уровня. Индексация начинается с единицы.
}}
{{function entry
|name=[[Table.Levels.Add|Add]]
|form={{Grey|Table.Levels.}}'''Add'''(''<Направление уровня (INT)>'',''<Начальная позиция уровня (INT)>'',''<Конечная позиция уровня (INT)>'')
|type=1
|status=2
|visual=1
|description=Функция добавляет визуальный уровень к текущему, либо к одному из детей текущего уровня, если начальная и конечная позиции располагаются полностью внутри дочернего уровня.
}}
{{function entry
|name=[[Table.Levels.Delete|Delete]]
|form={{Grey|Table.Levels.}}'''Delete'''({{Optional|<Начальная позиция (INT)>,<Конечная позиция (INT)>,<Рекурсивно удалить дочерние уровни (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=1
|description=Функция удаляет указанные с помощью границ визуальные уровни, если необходимо, со всеми подчиненными уровнями. Если текущий объект указывает на существующий, а не корневой уровень, аргументы можно опустить и функция удалит текущей уровень со всеми его подчиненными подуровнями.
}}
{{function entry
|name=[[Table.Levels.Count|Count]]
|form={{Grey|Table.Levels.}}'''Count'''():''<Количество дочерних уровней (INT)>''
|type=1
|status=2
|visual=1
|description=Функция получает общее количество уровней, дочерних по отношению к данному.
}}
{{function entry
|name=[[Table.Levels.Beg|Beg]]
|form={{Grey|Table.Levels.}}'''Beg''':''<Начальная позиция текущего уровня (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает начальную позицию текущего уровня, функция не может применяться для корневого уровня (не имеющего видимый переключатель в таблице)
}}
{{function entry
|name=[[Table.Levels.End|End]]
|form={{Grey|Table.Levels.}}'''End''':''<Конечная позиция текущего уровня (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает конечную позицию текущего уровня, функция не может применяться для корневого уровня (не имеющего видимый переключатель в таблице)
}}
{{function entry
|name=[[Table.Levels.IsClosed|IsClosed]]
|form={{Grey|Table.Levels.}}'''IsClosed''':''<Текущий уровень закрыт (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает статус, открыт ли текущий уровень, функция не может применяться для корневого уровня (не имеющего видимый переключатель в таблице)
}}
{{function entry
|name=[[Table.Levels.Open|Open]]
|form={{Grey|Table.Levels.}}'''Open'''()
|type=1
|status=2
|visual=1
|description=Функция открывает текущий уровень. При применении функции к верхнему уровню, она открывает все уровни таблицы.
}}
{{function entry
|name=[[Table.Levels.Close|Close]]
|form={{Grey|Table.Levels.}}'''Close'''()
|type=1
|status=2
|visual=1
|description=Функция закрывает текущий уровень. При применении функции к верхнему уровню, она закрывает все уровни таблицы.
}}
{{function entry
|name=[[Table.Options|Options]]
|form={{Grey|Table.}}'''Options''':''<Объект установок таблицы (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок таблицы. С объектом можно вызывать функции, типа [[Table.Options.FixedLine|FixedLine]] и пр.
}}
{{function entry
|name=[[Table.Options.ShowGrid|ShowGrid]]
|form={{Grey|Table.Options.}}'''ShowGrid''':''<Показывать сетку редактирования (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет режим отображения сетки редактирования в таблице.
}}
{{function entry
|name=[[Table.Options.ShowCaptions|ShowCaptions]]
|form={{Grey|Table.Options.}}'''ShowCaptions''':''<Показывать заголовки строк и столбцов (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет режим отображения заголовков строк и столбцов в таблице.
}}
{{function entry
|name=[[Table.Options.FixedLine|FixedLine]]
|form={{Grey|Table.Options.}}'''FixedLine''':''<Закрепить на экране указанное количество строк (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет количество строк, закрепленных на экране. При сдвиге отображаемого поля таблицы закрепленные строки останутся видимыми. По умолчанию этот атрибут равен 0 (нет закрепленных строк).
}}
{{function entry
|name=[[Table.Options.FixedColumn|FixedColumn]]
|form={{Grey|Table.Options.}}'''FixedColumn''':''<Закрепить на экране указанное количество столбцов (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет количество столбцов, закрепленных на экране. При сдвиге отображаемого поля таблицы закрепленные столбцы останутся видимыми. По умолчанию этот атрибут равен 0 (нет закрепленных столбцов).
}}
{{function entry
|name=[[Table.Options.GroupsVisible|GroupsVisible]]
|form={{Grey|Table.Options.}}'''GroupsVisible''':''<Видимость группировок таблиц-шаблонов (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет режим отображения наименований группировок, используемых в таблицах-шаблонах для получения областей таблиц по наименованиям.
}}
{{function entry
|name=[[Table.Options.LevelsVisible|LevelsVisible]]
|form={{Grey|Table.Options.}}'''LevelsVisible''':''<Видимость уровней группировок (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет режим отображения уровней группировок таблицы. Уровни используются для группировки строк или столбцов, каждый уровень может быть закрыт (тогда его столбцы или строки не будут отображаться на экране), либо открыт. Уровни могут быть вложенными.
}}
{{function entry
|name=[[Table.Options.Scrollable|Scrollable]]
|form={{Grey|Table.Options.}}'''Scrollable''':''<Разрешить сдвиг отображаемой части таблицы (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет режим разрешения сдвига отображаемой части таблицы. При запрете сдвига на экране будет отображаться только верхняя левая часть таблицы, сдвинуть ее вверх или влево будет невозможно.
}}
{{function entry
|name=[[Table.Options.IsChanged|IsChanged]]
|form={{Grey|Table.Options.}}'''IsChanged''':''<Производились ли изменения в таблице (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или изменяет признак того, были ли произведены визуальные изменения в таблице с момента ее предыдущего сохранения. Для таблицы, выведенных на экран, признак виден в заголовке таблицы.
}}
{{function entry
|name=[[Table.PageBreaks|PageBreaks]]
|form={{Grey|Table.}}'''PageBreaks''':''<Объект разбиения на страницы (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект разбиения таблицы на страницы. Таблицу можно разбить на страницы в нужных строках и нужных столбцах, разбитые области будут выводиться отдельными страницами при печати, даже если активна установка печати "помещать на одной странице". С объектом можно вызывать функции, типа [[Table.PageBreaks.Add|Add]] и пр.
}}
{{function entry
|name=[[Table.PageBreaks.Add|Add]]
|form={{Grey|Table.PageBreaks.}}'''Add'''({{Optional|<Строка разбиения (INT)>}})
|type=1
|status=2
|visual=0
|description=Функция позволяет добавить новое разбиение страницы по горизонтали.
}}
{{function entry
|name=[[Table.PageBreaks.AddVertical|AddVertical]]
|form={{Grey|Table.PageBreaks.}}'''AddVertical'''({{Optional|<Столбец разбиения (INT)>''}})
|type=1
|status=2
|visual=0
|description=Функция позволяет добавить новое разбиение страницы по вертикали.
}}
{{function entry
|name=[[Table.PageBreaks.Count|Count]]
|form={{Grey|Table.PageBreaks.}}'''Count'''({{Optional|<Вертикальные разбиения (INT)>{{Eq}}1}}):''<Количество разбиений на страницы (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут отдает количество (горизонтальных или вертикальных) разбиений на страницы в данной таблице.
}}
{{function entry
|name=[[Table.PageBreaks.Delete|Delete]]
|form={{Grey|Table.PageBreaks.}}'''Delete'''(''<Индекс разбиения (INT)>'')
|type=1
|status=0
|visual=0
|description=Функция удаляет разбиение с указанным индексом.
}}
{{function entry
|name=[[Table.PageBreaks.GetPosition|GetPosition]]
|form={{Grey|Table.PageBreaks.}}'''GetPosition'''(''<Индекс разбиения (INT)>''{{Optional|,<Вертикальные разбиения (INT)>{{Eq}}1}}):''<Позиция разбиения (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает столбец (если разбиение горизонтальное) или строку разбиения (если разбиение вертикальное) по индексу разбиения.
}}
{{function entry
|name=[[Table.Printing|Printing]]
|form={{Grey|Table.}}'''Printing''':''<Объект установок печати (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок печати таблицы. С объектом можно вызывать функции, типа [[Table.Printing.Printer|Printer]] и пр.
}}
{{function entry
|name=[[Table.Printing.Orientation|Orientation]]
|form={{Grey|Table.Printing.}}'''Orientation''':''<Ориентация листа при печати (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает ориентацию листа при печати (0 -- в виде портрета, 1 -- в виде ландшафта).
}}
{{function entry
|name=[[Table.Printing.ScaleMode|ScaleMode]]
|form={{Grey|Table.Printing.}}'''ScaleMode''':''<Режим масштабирования при печати (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает режим масштабирования страниц при печати. Возможные значения: 0 -- сжимать таблицу до ширины листа, 1 -- сжимать или увеличивать таблицу до ширины листа, 2 -- использовать заданный масштаб при печати страницы (см. [[Table.Printing.Scale|Scale]]), 3 -- сжимать или увеличивать таблицу, чтобы она умещалась на одном листе. Важно понимать, что в таблицах, где использовано разбиение на страницы (см. [[Table.PageBreaks|PageBreaks]]), сжатие и расширение (в т.ч. размещение на одном листе) происходит для каждой страницы, полученной в результате разбиения.
}}
{{function entry
|name=[[Table.Printing.Scale|Scale]]
|form={{Grey|Table.Printing.}}'''Scale''':''<Масштаб в режиме печати с заданным масштабом (REAL)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает масштаб печати в режиме печати с заданным масштабом. Масштаб устанавливается в процентах и может быть вещественным числом. По умолчанию этот атрибут равен 100.
}}
{{function entry
|name=[[Table.Printing.Printer|Printer]]
|form={{Grey|Table.Printing.}}'''Printer''':''<Наименование текущего принтера (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает наименование текущего принтера для печати таблицы. Если этому атрибуту присваивается пустая строка, будет использован принтер по умолчанию..
}}
{{function entry
|name=[[Table.Printing.Copies|Copies]]
|form={{Grey|Table.Printing.}}'''Copies''':''<Количество копий при печати (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает количество копий при печати таблицы. По умолчанию, этот атрибут равен единице.
}}
{{function entry
|name=[[Table.Printing.PageOptions|PageOptions]]
|form={{Grey|Table.Printing.}}'''PageOptions''':''<Дополнительные установки печати (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает дополнительные установки страницы. Атрибут имеет тип битовой маски, возможные значения перечислены в статье [[Константы#Константы свойств таблиц|Константы]].
}}
{{function entry
|name=[[Table.Printing.Fields|Fields]]
|form={{Grey|Table.Printing.}}'''Fields''':''<Объект установок полей таблицы при печати (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок полей таблицы при печати. С объектом можно вызывать функции, типа [[Table.Printing.Fields.Left|Left]] и пр.
}}
{{function entry
|name=[[Table.Printing.Fields.Left|Left]]
|form={{Grey|Table.Printing.Fields.}}'''Left''':''<Ширина левого поля в мм. (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает ширину пустого левого поля при печати страницы. По умолчанию ширина поля равна 10 мм.
}}
{{function entry
|name=[[Table.Printing.Fields.Right|Right]]
|form={{Grey|Table.Printing.Fields.}}'''Right''':''<Ширина правого поля в мм. (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает ширину пустого правого поля при печати страницы. По умолчанию ширина поля равна 10 мм.
}}
{{function entry
|name=[[Table.Printing.Fields.Up|Up]]
|form={{Grey|Table.Printing.Fields.}}'''Up''':''<Ширина верхнего поля в мм. (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает ширину пустого верхнего поля при печати страницы. По умолчанию ширина поля равна 10 мм. Поле следует до начала верхнего колонтитула и не включается в ширину колонтитула.
}}
{{function entry
|name=[[Table.Printing.Fields.Down|Down]]
|form={{Grey|Table.Printing.Fields.}}'''Down''':''<Ширина нижнего поля в мм. (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает ширину пустого нижнего поля при печати страницы. По умолчанию ширина поля равна 10 мм. Поле следует после нижнего колонтитула и не включается в ширину колонтитула.
}}
{{function entry
|name=[[Table.Printing.Titles|Titles]]
|form={{Grey|Table.Printing.}}'''Titles''':''<Объект установок колонтитулов таблицы при печати (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок колонтитулов таблицы при печати. С объектом можно вызывать функции, типа [[Table.Printing.Titles.Up|Up]] и пр.
}}
{{function entry
|name=[[Table.Printing.Titles.Up|Up]]
|form={{Grey|Table.Printing.Titles.}}'''Up''':''<Объект установок верхнего колонтитула таблицы при печати (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок верхнего колонтитула таблицы при печати. С объектом можно вызывать функции, типа [[Table.Printing.Titles.Text|Text]] и пр.
}}
{{function entry
|name=[[Table.Printing.Titles.Down|Down]]
|form={{Grey|Table.Printing.Titles.}}'''Down''':''<Объект установок нижнего колонтитула таблицы при печати (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок нижнего колонтитула таблицы при печати. С объектом можно вызывать функции, типа [[Table.Printing.Titles.Text|Text]] и пр.
}}
{{function entry
|name=[[Table.Printing.Titles.Size|Size]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''Size''':''<Ширина выбранного колонтитула в мм. (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает ширину выбранного колонтитула при печати таблицы. По умолчанию ширина колонтитула равна 7 мм.
}}
{{function entry
|name=[[Table.Printing.Titles.Text|Text]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''Text''':''<Текст или шаблон колонтитула (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает текст или шаблон выбранного колонтитула при печати таблицы.
}}
{{function entry
|name=[[Table.Printing.Titles.TextOptions|TextOptions]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''TextOptions''':''<Установки форматирования колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает установки форматирования выбранного колонтитула при печати таблицы. Значение является битовой маской и использует сл. биты: биты 0..1: режим выравнивания по горизонтали, биты 2..3: режим выравнивания по вертикали.
}}
{{function entry
|name=[[Table.Printing.Titles.Orientation|Orientation]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''Orientation''':''<Угол направления текста (REAL)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет угол направления прорисовки текста выбранного колонтитула при печати таблицы. По умолчанию это значение равно 0 (горизонтальный текст).
}}
{{function entry
|name=[[Table.Printing.Titles.TitleOptions|TitleOptions]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''TitleOptions''':''<Дополнительные установки колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает дополнительные установки выбранного колонтитула при печати таблицы. Значение является битовой маской и использует сл. биты: бит 0: режим шаблона для текста активен, бит 2: при переносе текста принимать во внимание границы слов.
}}
{{function entry
|name=[[Table.Printing.Titles.PrintFromPage|PrintFromPage]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''PrintFromPage''':''<Начинать печатать колонтитул с указанной страницы (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут получает или устанавливает номер страницы, с которой будет начитать печататься колонтитул. По умолчанию, этот атрибут равен единице.
}}
{{function entry
|name=[[Table.Printing.Titles.ColorProfile|ColorProfile]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''ColorProfile''':''<Шаблон цвета колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер шаблона цвета выбранного колонтитула таблицы. По умолчанию это значение равно 0 (цвета и стиль форматирования определяется соответствующими атрибутами колонтитула, а не номером шаблона). Номера шаблонов можно найти в [[Номера шаблонов цветов ячеек таблицы|этой статье]].
}}
{{function entry
|name=[[Table.Printing.Titles.BackgroundColor|BackgroundColor]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''BackgroundColor''':''<Номер цвета фона колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета фона выбранного колонтитула таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Printing.Titles.BackgroundColorRGB|BackgroundColorRGB]].
}}
{{function entry
|name=[[Table.Printing.Titles.BackgroundColorRGB|BackgroundColorRGB]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''BackgroundColorRGB''':''<Цвет фона колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет фона выбранного колонтитула таблицы по его 24-битному значению.
}}
{{function entry
|name=[[Table.Printing.Titles.FontColor|FontColor]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''FontColor''':''<Номер цвета текста колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета текста выбранного колонтитула таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Printing.Titles.FontColorRGB|FontColorRGB]].
}}
{{function entry
|name=[[Table.Printing.Titles.FontColorRGB|FontColorRGB]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''FontColorRGB''':''<Цвет текста колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет текста выбранного колонтитула таблицы по его 24-битному значению.
}}
{{function entry
|name=[[Table.Printing.Titles.FontStyle|FontStyle]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''FontStyle''':''<Стиль текста колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет стиль текста выбранного колонтитула таблицы.
}}
{{function entry
|name=[[Table.Printing.Titles.FontSize|FontSize]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''FontSize''':''<Размер шрифта колонтитула (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет размер шрифта текста выбранного колонтитула таблицы.
}}
{{function entry
|name=[[Table.Printing.Titles.Font|Font]]
|form={{Grey|Table.Printing.Titles.<Тип колонтитула>.}}'''Font''':''<Наименование шрифта текста колонтитула (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет наименование шрифта текста выбранного колонтитула таблицы.
}}
{{function entry
|name=[[Table.Printing.ContinualLines|ContinualLines]]
|form={{Grey|Table.Printing.}}'''ContinualLines''':''<Объект установок строк таблицы, печатающихся на каждой странице (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок строк таблицы, выводящихся на печать на каждой странице. К примеру, для таблиц данных, которые занимают несколько страниц при печати, удобно печатать заголовок на каждой новой страницы до момента, когда таблица закончится. С объектом можно вызывать функции, типа [[Table.Printing.ContinualPrinting.From|From]] и пр.
}}
{{function entry
|name=[[Table.Printing.ContinualColumns|ContinualColumns]]
|form={{Grey|Table.Printing.}}'''ContinualColumns''':''<Объект установок столбцов таблицы, печатающихся на каждой странице (TABLE.OPTIONS)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект установок столбцов таблицы, выводящихся на печать на каждой странице. С объектом можно вызывать функции, типа [[Table.Printing.ContinualPrinting.From|From]] и пр.
}}
{{function entry
|name=[[Table.Printing.ContinualPrinting.From|From]]
|form={{Grey|Table.Printing.<Тип объекта>.}}'''From''':''<Строка или столбец начала области (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или устанавливает строку или столбец, с которой начинается область, печатающаяся на каждой странице.
}}
{{function entry
|name=[[Table.Printing.ContinualPrinting.To|To]]
|form={{Grey|Table.Printing.<Тип объекта>.}}'''To''':''<Строка или столбец окончания области (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или устанавливает строку или столбец, на которой заканчивается область, печатающаяся на каждой странице. Копия области будет выведена на следующей по горизонтали или вертикали странице (в зависимости от типа объекта).
}}
{{function entry
|name=[[Table.Printing.ContinualPrinting.EndCell|EndCell]]
|form={{Grey|Table.Printing.<Тип объекта>.}}'''EndCell''':''<Строка или столбец, после которого, заданная область, печатавшаяся на каждой странице, больше не выводится (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или устанавливает строку или столбец, после вывода на печать которых, заданная область, печатавшаяся на каждой странице, больше не выводится.
}}
{{function footer}}

== Атрибуты и функции объекта области таблицы (Table.Area) ==
Данный раздел содержит функции, применяемые к объекту области таблицы. Объект области позволяет получить или изменять параметры ячеек, входящих в нее. При создании объекта, не производится копирования области в памяти, а создается только ссылка на нее.
{{function header}}
{{function entry
|name=[[Table.Area|Area]]
|form={{Grey|Table.}}'''Area'''(''<Левый столбец области (INT)>'',''<Верхняя строка области (INT)>''{{Optional|,<Правый столбец области (INT)>,<Нижняя строка области (INT)>}}):''<Объект области таблицы (TABLE.AREA)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект области таблицы. С объектом можно вызывать функции, типа [[Table.Area.Text|Text]] и пр.
}}
{{function entry
|name=[[Table.Area.Text|Text]]
|form={{Grey|Table.Area.}}'''Text''':''<Текст ячеек области (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет текст ячеек области таблицы. Текст получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.Value|Value]], '''Formula'''
|form={{Grey|Table.Area.}}'''Value''':''<Значение ячеек таблицы>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет значение, ассоциированное с ячейками области таблицы. Значение получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.ValueTemplate|ValueTemplate]]
|form={{Grey|Table.Area.}}'''ValueTemplate''':''<Формула шаблона ячейки (STRING)>''
|type=0
|status=0
|visual=0
|description=Атрибут возвращает или изменяет текст формулы шаблона, ассоциированной с ячейками области таблицы. Значение получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы. Формула шаблона использует тоже самое место хранения, что и значение ячейки. Для ячейки может быть задана либо формула, либо значение.
}}
{{function entry
|name=[[Table.Area.WrappingMode|WrappingMode]]
|form={{Grey|Table.Area.}}'''WrappingMode''':''<Режим переноса текста (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет значение режима переноса текста ячеек области таблицы. Значение получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы. Значение 0 задает режим переноса с соблюдением границы слов, 1 -- без соблюдения.
}}
{{function entry
|name=[[Table.Area.IsTemplate|IsTemplate]]
|form={{Grey|Table.Area.}}'''IsTemplate''':''<Является ли текст формулой шаблона (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак того, является ли текст ячеек области таблицы шаблоном (шаблон выполняется при копировании области в другую таблицу). Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.IsValueTemplate|IsValueTemplate]]
|form={{Grey|Table.Area.}}'''IsValueTemplate''':''<Является ли значение формулой шаблона (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак того, является ли значения ячеек области таблицы шаблоном (шаблон выполняется при копировании области в другую таблицу). Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.HAlign|HAlign]]
|form={{Grey|Table.Area.}}'''HAlign''':''<Выравнивание по горизонтали (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим выравнивания текста ячеек области таблицы по горизонтали. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.VAlign|VAlign]]
|form={{Grey|Table.Area.}}'''VAlign''':''<Выравнивание по вертикали (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим выравнивания текста ячеек области таблицы по вертикали. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.ClipMode|ClipMode]]
|form={{Grey|Table.Area.}}'''ClipMode''':''<Контроль границы ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим контроля выхода за границу ячейки текста ячеек области таблицы. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.RedNegative|RedNegative]]
|form={{Grey|Table.Area.}}'''RedNegative''':''<Отрицательные красным (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим выделения красным текста ячеек области таблицы, когда они содержат отрицательные числа. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.Protected|Protected]]
|form={{Grey|Table.Area.}}'''Protected''':''<Защита от изменения в режиме просмотра (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим защиты ячеек области таблицы от изменения в режиме просмотра (игнорируется в режиме редактирования и запрета изменений). По умолчанию признак защиты установлен. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.Orientation|Orientation]]
|form={{Grey|Table.Area.}}'''Orientation''':''<Угол направления текста (REAL)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет угол направления прорисовки текста ячеек области таблицы. По умолчанию это значение равно 0 (горизонтальный текст). Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.ParentCell|ParentCell]]
|form={{Grey|Table.Area.}}'''ParentCell''':''<Тип объединения ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает тип объединения, связанный с крайней левой верхней ячейкой области таблицы. Получаемый атрибут может принимать следующие значения: 0 -- ячейка не участвует в объединении ячеек, 1 -- это крайняя левая ячейка области объединения (основная ячейка, из свойств которой используются цвета, шрифт, текст и пр. для всей области), 2 -- эта ячейка участвует в объединении, как подчиненная ячейка.
}}
{{function entry
|name=[[Table.Area.ExtentX|ExtentX]]
|form={{Grey|Table.Area.}}'''ExtentX''':''<Ссылка по горизонтали на основную ячейку объединения (INT)>''
|type=0
|status=2
|visual=0
|description=Для крайней левой верхней ячейкой области атрибут возвращает расстояние в ячейках по горизонтали от текущей ячейки до основной ячейки объединения (отрицательное число); количество ячеек в области объединения по горизонтали, если это основная ячейка (см. [[Table.Area.ParentCell|ParentCell]]); либо 0, если ячейка не участвует в объединении ячеек.
}}
{{function entry
|name=[[Table.Area.ExtentY|ExtentY]]
|form={{Grey|Table.Area.}}'''ExtentY''':''<Ссылка по вертикали на основную ячейку объединения (INT)>''
|type=0
|status=2
|visual=0
|description=Для крайней левой верхней ячейкой области атрибут возвращает расстояние в ячейках по вертикали от текущей ячейки до основной ячейки объединения (отрицательное число); количество ячеек в области объединения по вертикали, если это основная ячейка (см. [[Table.Area.ParentCell|ParentCell]]); либо 0, если ячейка не участвует в объединении ячеек.
}}
{{function entry
|name=[[Table.Area.IndentX|IndentX]], '''Indent'''
|form={{Grey|Table.Area.}}'''IndentX''':''<Отступ текста по горизонтали (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет отступ текста по горизонтали от границы ячеек области таблицы. По умолчанию это значение равно 0 (отступ отсутствует). Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.IndentY|IndentY]]
|form={{Grey|Table.Area.}}'''IndentY''':''<Отступ текста по вертикали (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет отступ текста по вертикали от границы ячеек области таблицы. По умолчанию это значение равно 0 (отступ отсутствует). Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.ColorProfile|ColorProfile]]
|form={{Grey|Table.Area.}}'''ColorProfile''':''<Шаблон цвета ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер шаблона цвета ячеек области таблицы. По умолчанию это значение равно 0 (цвета и стиль форматирования определяется соответствующими атрибутами ячейки, а не номером шаблона). Номера шаблонов можно найти в [[Номера шаблонов цветов ячеек таблицы|этой статье]]. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.BackgroundColor|BackgroundColor]]
|form={{Grey|Table.Area.}}'''BackgroundColor''':''<Номер цвета фона ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета фона ячеек области таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Area.BackgroundColorRGB|BackgroundColorRGB]]. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.BackgroundColorRGB|BackgroundColorRGB]]
|form={{Grey|Table.Area.}}'''BackgroundColorRGB''':''<Цвет фона ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет фона ячеек области таблицы по его RGB значению. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.FontColor|FontColor]]
|form={{Grey|Table.Area.}}'''FontColor''':''<Номер цвета текста ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета текста ячеек области таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Area.FontColorRGB|FontColorRGB]]. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.FontColorRGB|FontColorRGB]]
|form={{Grey|Table.Area.}}'''FontColorRGB''':''<Цвет текста ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет текста ячеек области таблицы по его RGB значению. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.FrameColor|FrameColor]]
|form={{Grey|Table.Area.}}'''FrameColor''':''<Номер цвета границы ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета границы ячеек области таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Area.FrameColorRGB|FrameColorRGB]]. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.FrameColorRGB|FrameColorRGB]]
|form={{Grey|Table.Area.}}'''FrameColorRGB''':''<Цвет границы ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет границы ячеек области таблицы по его RGB значению. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.FontStyle|FontStyle]]
|form={{Grey|Table.Area.}}'''FontStyle''':''<Стиль текста ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет стиль текста ячеек области таблицы. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.FontSize|FontSize]]
|form={{Grey|Table.Area.}}'''FontSize''':''<Размер шрифта текста ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет размер шрифта текста ячеек области таблицы. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.Font|Font]]
|form={{Grey|Table.Area.}}'''Font''':''<Наименование шрифта текста ячейки (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет наименование шрифта текста ячеек области таблицы. Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.Frame|Frame]]
|form={{Grey|Table.Area.}}'''Frame''':''<Рисунок и наличие 4-х границ вокруг ячейки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет рисунок и наличие четырех границ вокруг каждой ячейки из области таблицы. Значение представляет собой битовую маску, где на каждую из границ используется по 4 бита. По умолчанию, это значение равно 0 (ячейка не окружена границами). Значение признака получается для крайней левой верхней ячейки области, и устанавливается для всех ячеек таблицы.
}}
{{function entry
|name=[[Table.Area.RowAutoSize|RowAutoSize]]
|form={{Grey|Table.Area.}}'''RowAutoSize''':''<Признак автоматического изменения высоты строки (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак автоматического изменения высоты строк ячеек области таблицы. Значение признака получается для строки верхних ячеек области, и устанавливается для всех строк области таблицы.
}}
{{function entry
|name=[[Table.Area.ColAutoSize|ColAutoSize]]
|form={{Grey|Table.Area.}}'''ColAutoSize''':''<Признак автоматического изменения ширины столбца (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак автоматического изменения ширины столбцов ячеек области таблицы. Значение признака получается для столбца левых ячеек области, и устанавливается для всех столбцов области таблицы.
}}
{{function entry
|name=[[Table.Area.RowHeight|RowHeight]]
|form={{Grey|Table.Area.}}'''RowHeight''':''<Высота строки в пикселях (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет высоту строк ячеек области таблицы. Значение признака получается для строки верхних ячеек области, и устанавливается для всех строк области таблицы. При установке этого атрибута, атрибут [[Table.Area.RowAutoSize|RowAutoSize]] автоматически принимает нулевое значение.
}}
{{function entry
|name=[[Table.Area.ColWidth|ColWidth]]
|form={{Grey|Table.Area.}}'''ColWidth''':''<Ширина столбца в пикселях (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет ширину столбцов ячеек области таблицы. Значение признака получается для столбца левых ячеек области, и устанавливается для всех столбцов области таблицы. При установке этого атрибута, атрибут [[Table.Area.ColAutoSize|ColAutoSize]] автоматически принимает нулевое значение.
}}
{{function entry
|name=[[Table.Area.ContinuousRegionX|ContinuousRegionX]]
|form={{Grey|Table.Area.}}'''ContinuousRegionX''':''<Признак неразрывности горизонтального региона (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак неразрывности при печати горизонтального региона ячеек области таблицы. При установке признака можно использовать значения 0 (регион теряет все свойства неразрывности) или 1 (регион становится неразрывным). При чтении, возможны следующие значения: 0 -- в регионе отсутствуют неразрывные диапазоны, 1 -- весь регион представляет собой неразрывный диапазон, 2 -- регион содержит определенное количество неразрывных диапазонов или их частей.
}}
{{function entry
|name=[[Table.Area.ContinuousRegionY|ContinuousRegionY]]
|form={{Grey|Table.Area.}}'''ContinuousRegionY''':''<Признак неразрывности вертикального региона (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак неразрывности при печати вертикального региона ячеек области таблицы. При установке признака можно использовать значения 0 (регион теряет все свойства неразрывности) или 1 (регион становится неразрывным). При чтении, возможны следующие значения: 0 -- в регионе отсутствуют неразрывные диапазоны, 1 -- весь регион представляет собой неразрывный диапазон, 2 -- регион содержит определенное количество неразрывных диапазонов или их частей.
}}
{{function entry
|name=[[Table.Area.Merge|Merge]]
|form={{Grey|Table.Area.}}'''Merge'''()
|type=1
|status=2
|visual=0
|description=Функция объединяет ячейки области таблицы в один регион объединения. Если с областью граничили или находились внутри области другие регионы объединения, они будут разъединены до выполнения объединения текущей области.
}}
{{function entry
|name=[[Table.Area.Demerge|Demerge]]
|form={{Grey|Table.Area.}}'''Demerge'''()
|type=1
|status=2
|visual=0
|description=Функция разъединяет ячейки области таблицы, это относится ко всем регионам объединения входящим в или граничащим с текущей областью таблицы.
}}
{{function entry
|name=[[Table.Area.CopyTo|CopyTo]]
|form={{Grey|Table.Area.}}'''CopyTo'''(''<Таблица в которую происходит копирование (TABLE)>'',''<Столбец таблицы для вставки (INT)>'',''<Строка таблицы для вставки (INT)>''{{Optional|,<Копировать также объекты (INT)>{{Default|{{Eq}}1}},<Превращать шаблоны в их значения (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=0
|visual=0
|description=Функция копирует текущую область в указанную таблицу по начиная с указанной ячейки, таблица результат может также быть текущей таблицей.
}}
{{function entry
|name=[[Table.Area.Copy|Copy]]
|form={{Grey|Table.Area.}}'''Copy'''({{Optional|<Копировать также объекты (INT)>{{Default|{{Eq}}1}}}}):''<Копия области в виде новой таблицы (TABLE)>''
|type=1
|status=2
|visual=0
|description=Функция создает новую таблицу и заполняет ее ячейками текущей области. Область копируется в таблицу начиная с первой верхней левой ячейки.
}}
{{function entry
|name=[[Table.Area.Execute|Execute]]
|form={{Grey|Table.Area.}}'''Execute'''({{Optional|<Также находить значения шаблонов для объектов (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=0
|visual=0
|description=Функция превращает все тексты шаблонов ячеек (и объектов) области в их значения.
}}
{{function entry
|name=[[Table.Area.Modify|Modify]]
|form={{Grey|Table.Area.}}'''Modify'''(''<Левый столбец (INT)>'',''<Верхняя строка (INT)>''{{Optional|,<Правый столбец (INT)>,<Нижняя строка (INT)>}})
|type=1
|status=2
|visual=0
|description=Функция изменяет размеры и положение текущей области в соответствующей ей таблице. Т.е., действие функции соответствует вызову [[Table.Area|Area]], только на существующем объекте, который после исполнения функции будет указывать на другую область.
}}
{{function entry
|name=[[Table.Area.Clear|Clear]]
|form={{Grey|Table.Area.}}'''Clear'''()
|type=1
|status=0
|visual=0
|description=Функция разъединяет все объединенные ячейки области, очищает весь текст и значения ячеек, стили, границы, цвета и пр. устанавливает в состояние по умолчанию.
}}
{{function footer}}

== Атрибуты и функции визуальных объектов таблицы (Table.Object) ==
Данный раздел содержит функции, применяемые к совокупности или к одному визуальному элементу (объекту) таблицы. Объект позволяет получить или изменять параметры элементов, которые он адресует. Визуальным элементом (объектом), к примеру, может быть рисунок, или текст, добавленные в произвольное место таблицы и имеющие произвольный размер. Такие элементы выводятся на печать и их содержимое закрывает текст ячеек, находящихся непосредственно под ними.
{{function header}}
{{function entry
|name=[[Table.Objects|Objects]]
|form={{Grey|Table.}}'''Objects'''({{Optional|<Индекс или наименование определенного объекта (INT,STRING)>}}):''<Визуальный объект таблицы или все визуальные объекты (TABLE.OBJECT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает объект доступа к визуальным объектам таблицы. При указании на определенный визуальный объект, текущим объектом можно пользоваться для изменения его свойств, иначе текущий объект будет указывать на всю совокупность объектов таблицы.
}}
{{function entry
|name=[[Table.Object.Count|Count]]
|form={{Grey|Table.Object.}}'''Count''':''<Общее количество объектов таблицы (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает общее количество объектов в таблице.
}}
{{function entry
|name=[[Table.Object.Type|Type]]
|form={{Grey|Table.Object.}}'''Type''':''<Тип текущего объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает цифровой тип текущего объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Name|Name]]
|form={{Grey|Table.Object.}}'''Name''':''<Наименование текущего объекта (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет наименование текущего объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Text|Text]]
|form={{Grey|Table.Object.}}'''Text''':''<Текст текущего объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет текст, ассоциированный с текущим объектом таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.ValueTemplate|ValueTemplate]]
|form={{Grey|Table.Object.}}'''ValueTemplate''':''<Формула шаблона объекта (STRING)>''
|type=0
|status=0
|visual=0
|description=Атрибут возвращает или изменяет текст формулы шаблона, ассоциированной с текущим объектом таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте. Формула шаблона использует тоже самое место хранения, что и значение объекта. Для объекта может быть задана либо формула, либо значение.
}}
{{function entry
|name=[[Table.Object.Value|Value]], '''Formula'''
|form={{Grey|Table.Object.}}'''Value''':''<Значение объекта>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет произвольное значение, ассоциированной с текущим объектом таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.WrappingMode|WrappingMode]]
|form={{Grey|Table.Object.}}'''WrappingMode''':''<Режим переноса текста (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет значение режима переноса текста текущего объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.IsTemplate|IsTemplate]]
|form={{Grey|Table.Object.}}'''IsTemplate''':''<Является ли текст формулой шаблона (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак того, является ли текст визуального объекта таблицы шаблоном (шаблон выполняется при копировании области в другую таблицу). Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.IsValueTemplate|IsValueTemplate]]
|form={{Grey|Table.Object.}}'''IsValueTemplate''':''<Является ли значение формулой шаблона (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак того, является ли значение визуального объекта таблицы шаблоном (шаблон выполняется при копировании области в другую таблицу). Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.HAlign|HAlign]]
|form={{Grey|Table.Object.}}'''HAlign''':''<Выравнивание по горизонтали (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим выравнивания текста визуального объекта таблицы по горизонтали. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.VAlign|VAlign]]
|form={{Grey|Table.Object.}}'''VAlign''':''<Выравнивание по вертикали (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим выравнивания текста визуального объекта таблицы по вертикали. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.ClipMode|ClipMode]]
|form={{Grey|Table.Object.}}'''ClipMode''':''<Контроль границы для текста объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим контроля выхода за границу текста визуального объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.RedNegative|RedNegative]]
|form={{Grey|Table.Object.}}'''RedNegative''':''<Отрицательные красным (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим выделения красным текста визуального объекта таблицы, когда он содержит отрицательное число. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Protected|Protected]]
|form={{Grey|Table.Object.}}'''Protected''':''<Защита от изменения в режиме просмотра (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим защиты визуального объекта от изменения в режиме просмотра (игнорируется в режиме редактирования и запрета изменений). По умолчанию признак защиты установлен. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Orientation|Orientation]]
|form={{Grey|Table.Object.}}'''Orientation''':''<Угол направления текста объекта (REAL)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет угол направления прорисовки текста визуального объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.IsAnchoredPosition|IsAnchoredPosition]]
|form={{Grey|Table.Object.}}'''IsAnchoredPosition''':''<Изменяется ли положение объекта при изменении размеров ячеек (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак того, изменяется ли положение объекта при изменении размеров ячеек.
}}
{{function entry
|name=[[Table.Object.IsAnchoredSize|IsAnchoredSize]]
|form={{Grey|Table.Object.}}'''IsAnchoredSize''':''<Изменяются ли ширина и высота объекта при изменении размеров ячеек (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет признак того, изменяются ли ширина и высота объекта при изменении размеров ячеек.
}}
{{function entry
|name=[[Table.Object.AbsoluteCoordinates|AbsoluteCoordinates]]
|form={{Grey|Table.Object.}}'''AbsoluteCoordinates''':''<Абсолютные координаты объекта (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет координаты объекта, заданные в абсолютной величине (в точках) от начала таблицы. Возвращаемое значение представляет собой следующий строку: <code><Координата левой границы>,<Координата верхней границы>,<Координата правой границы>,<Координата нижней границы></code>. При установке атрибута, третью и четвертую координаты можно пропустить, в этом случае, ширина и высота объекта изменяться не будет.
}}
{{function entry
|name=[[Table.Object.RelativeCoordinates|RelativeCoordinates]]
|form={{Grey|Table.Object.}}'''RelativeCoordinates''':''<Относительные координаты объекта (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет координаты объекта, заданные в относительных величинах (смещениях ячеек). Возвращаемое значение представляет собой следующий строку: <code><Столбец левой верхней точки объекта>:<Смещение в столбце>,<Строка левой верхней точки объекта>:<Смещение в строке>,<Столбец правой нижней точки объекта>:<Смещение в столбце>,<Строка правой нижней точки объекта>:<Смещение в строке></code>. Смещения задаются как цифровой индекс от 0 до 65535. 0 означает левый край столбца или верхний край строки, 65535 означает самая правая крайняя точка столбца или самая крайняя нижняя точка строки. Все, что между этими числами пропорционально лежит внутри крайних точек. При установке атрибута, правые и нижние координаты можно пропустить, в этом случае, ширина и высота объекта изменяться не будет.
}}
{{function entry
|name=[[Table.Object.Width|Width]]
|form={{Grey|Table.Object.}}'''Width''':''<Ширина объекта в пикселях (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет ширину объекта в пикселях. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Height|Height]]
|form={{Grey|Table.Object.}}'''Height''':''<Высота объекта в пикселях (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет высоту объекта в пикселях. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.ScaleOption|ScaleOption]]
|form={{Grey|Table.Object.}}'''ScaleOption''':''<Способ масштабирования объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет способ масштабирования объекта. Доступны следующие значения: 0 -- оригинальный размер, 1 -- уменьшать размер, если это необходимо, 2 -- уменьшать или увеличивать размер если необходимо. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Proportional|Proportional]]
|form={{Grey|Table.Object.}}'''Proportional''':''<Пропорциональность при масштабировании объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим соблюдения пропорции при масштабировании содержимого объекта (картинки или OLE-объекта). Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.NotForPrinting|NotForPrinting]]
|form={{Grey|Table.Object.}}'''NotForPrinting''':''<Запрет вывода объекта на печать (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет режим запрета вывода объекта на печать. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Picture|Picture]]
|form={{Grey|Table.Object.}}'''Picture''':''<Картинка объекта (PICTURE)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает объект картинки в случае, если текущий объект является картинкой. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.OLE|OLE]]
|form={{Grey|Table.Object.}}'''OLE''':''<OLE-объект (OLE)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает ассоциированный OLE-объект в случае, если текущий объект является OLE-объектом. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.ColorProfile|ColorProfile]]
|form={{Grey|Table.Object.}}'''ColorProfile''':''<Шаблон стиля объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер шаблона стиля визуального объекта таблицы. По умолчанию это значение равно 0 (цвета и стиль форматирования определяется соответствующими атрибутами объекта, а не номером шаблона). Номера шаблонов можно найти в [[Номера шаблонов цветов ячеек таблицы|этой статье]]. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.BackgroundColor|BackgroundColor]]
|form={{Grey|Table.Object.}}'''BackgroundColor''':''<Номер цвета фона объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета фона визуального объекта таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Object.BackgroundColorRGB|BackgroundColorRGB]]. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.BackgroundColorRGB|BackgroundColorRGB]]
|form={{Grey|Table.Object.}}'''BackgroundColorRGB''':''<Цвет фона объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет фона визуального объекта таблицы по его RGB значению. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.FontColor|FontColor]]
|form={{Grey|Table.Object.}}'''FontColor''':''<Номер цвета текста объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета текста визуального объекта таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Object.FontColorRGB|FontColorRGB]]. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.FontColorRGB|FontColorRGB]]
|form={{Grey|Table.Object.}}'''FontColorRGB''':''<Цвет текста объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет текста визуального объекта таблицы по его RGB значению. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.FrameColor|FrameColor]]
|form={{Grey|Table.Object.}}'''FrameColor''':''<Номер цвета обрамления объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет номер цвета обрамления визуального объекта таблицы. Система получает цвет по номеру из палитры, для прямого указания цвета используйте атрибут [[Table.Object.FrameColorRGB|FrameColorRGB]]. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.FrameColorRGB|FrameColorRGB]]
|form={{Grey|Table.Object.}}'''FrameColorRGB''':''<Цвет обрамления объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет цвет обрамления визуального объекта таблицы по его RGB значению. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.FontStyle|FontStyle]]
|form={{Grey|Table.Object.}}'''FontStyle''':''<Стиль текста объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет стиль текста визуального объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.FontSize|FontSize]]
|form={{Grey|Table.Object.}}'''FontSize''':''<Размер шрифта текста объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет размер шрифта текста визуального объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Font|Font]]
|form={{Grey|Table.Object.}}'''Font''':''<Наименование шрифта текста объекта (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет наименование шрифта текста визуального объекта таблицы. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Frame|Frame]]
|form={{Grey|Table.Object.}}'''Frame''':''<Рисунок и наличие 4-х границ обрамления объекта (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает или изменяет рисунок и наличие четырех границ обрамления визуального объекта таблицы. Значение представляет собой битовую маску, где на каждую из границ используется по 4 бита. По умолчанию, это значение равно 0 (объект не имеет обрамления). Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.LastLoadedImagePath|LastLoadedImagePath]]
|form={{Grey|Table.Object.}}'''LastLoadedImagePath''':''<Наименование файла последней загруженной картинки (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает наименование файла последней загруженной картинки для визуальных объектов таблицы с типом картинка. Признак сохраняется в объекте, к примеру, для универсальных обработчиков печати, и будет заполнен только если картинка была загружена в виде файла. Атрибут работает только, когда визуальный объект был выбран для работы в текущем объекте.
}}
{{function entry
|name=[[Table.Object.Delete|Delete]]
|form={{Grey|Table.Object.}}'''Delete'''()
|type=1
|status=2
|visual=0
|description=Функция удаляет текущий объект из таблицы.
}}
{{function footer}}

{{Объекты}}

Функции общего назначения

2025-12-27T17:09:06Z

Admin: 1 revision imported

{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]}}
Функции общего назначения представляют собой обширную коллекцию совершенно разных по действию и применению функций. Условное деление, представленное здесь, помогает быстрее найти необходимую функцию.

== Общие системные функции ==
Функции, которые нельзя отнести к другим разделам, представлены в этом общем разделе. Сюда входят функции загрузки модулей, магические функции булевой логики, функции для определения типа объекта, функции работы с именами файлов и прочие.

{{function header}}
{{function entry
|name=[[TypeStr]]
|form='''TypeStr'''(''<Аргумент>''):''<Тип аргумента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает строку, соответствующую типу аргумента или типу объекта аргумента. Пример возвращаемых значений: <code>NUMBER</code>, <code>STRING</code>, <code>DATE</code>, <code>LIST</code>, <code>TAB</code>, <code>DB.REF.<Вид справочника></code>, и т.п.
}}
{{function entry
|name=[[TypeNum]]
|form='''TypeNum'''(''<Аргумент>''):''<Тип аргумента (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает число, соответствующую типу аргумента или типу объекта аргумента. Числа является внутренними идентификаторами типов объектов. Пример возвращаемых значений: <code>0</code> (пустое значение), <code>1</code> (целое число), <code>2</code> (вещественное число), <code>50</code> (список), <code>54</code> (таблица), <code>61</code> (объект базы данных), и т.п.
}}
{{function entry
|name=[[NumeralTypeStr]]
|form='''NumeralTypeStr'''(''<Аргумент>''):''<Тип числового аргумента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает строку "REAL", в случае, если числовое представление аргумента является вещественным, иначе будет возвращена строка "INT"
}}
{{function entry
|name=[[StringTypeStr]]
|form='''StringTypeStr'''(''<Аргумент>''):''<Тип строкового аргумента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает строку "ANSI", в случае, если строковое представление аргумента использует однобайтовую кодировку (ANSI), иначе будет возвращена строка "UNICODE"
}}
{{function entry
|name=[[IsEmpty]]
|form='''IsEmpty'''(''<Аргумент>''):''<Является ли аргумент пустым объектом (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает 1, если аргумент является пустым объектом (пустое значение, 0, пустая строка, объект базы данных с невыбранным типом или видом и пр.), иначе будет возвращен 0.
}}
{{function entry
|name=[[Coalesce]]
|form='''Coalesce'''({{Optional|<Аргумент 1>,<Аргумент 2>...}}):''<Первый не пустой или не БД объект>''
|type=2
|status=2
|visual=0
|description=Функция возвращает первый из аргументов, который не является пустым (не выбранным) объектом базы данных, пустым значением, либо не является объектом базы данных. Функция является магической (вычисление следующего аргумента не выполняется, если текущий удовлетворяет условию функции).
}}
{{function entry
|name=[[CoalesceEx]]
|form='''CoalesceEx'''({{Optional|<Режим>{{Default|{{Eq}}1}}}}{{Default|}}{{Optional|,<Аргумент 1>,<Аргумент 2>...}}):''<Первый не пустой объект по правилам, заданым режимом>''
|type=2
|status=2
|visual=0
|description=Функция возвращает первый из аргументов, который не является пустым объектом по правилам, заданным режимом. В режиме ''0'' функция работает аналогично функции [[Coalesce]]. Функция является магической (вычисление следующего аргумента не выполняется, если текущий удовлетворяет условию функции).
}}
{{function entry
|name=[[Sleep]]
|form='''Sleep'''(''<Период в миллисекундах (INT)>'')
|type=1
|status=2
|visual=0
|description=Функция выполняет цикл ожидания в течение указанного в миллисекундах времени.
}}
{{function entry
|name=[[GetNothing]], '''Nothing'''
|form='''GetNothing'''({{Optional|<Тип базы данных (STRING)>{{Default|{{Eq}}""}}}}):''<Пустое значение или пустое значение базы данных>''
|type=1
|status=2
|visual=0
|description=Функция получает пустое значение, если аргумент не указан, либо не выбранный объект базы данных, если аргумент указан.
}}
{{function entry
|name=[[DisableGUIInterrupts]]
|form='''DisableGUIInterrupts'''(''<Защита (INT)>''{{Optional|,<Текст защиты (STRING)>{{Default|{{Eq}}""}}}})
|type=1
|status=2
|visual=0
|description=Функция позволяет запретить прерывание выполнения потока или закрытие программы, если первый аргумент равен 1, до того, как она будет вызвана повторно с первым аргументом, равным 0. Дополнительный текст будет показан пользователю, в момент попытки прерывания или закрытия программы. Функция работает только для визуального режима, и должна использоваться только с блоком <code>Try ... Finally</code>, так как в ином случае существует опасность получить состояние клиента, когда он не отвечает на попытки закрытия корректным образом.
}}
{{function entry
|name=[[FlushMessages]]
|form='''FlushMessages'''()
|type=1
|status=2
|visual=1
|description=Функция выполняет все ожидающие в очереди визуальные сообщения. Функцию можно использовать, к примеру, если необходимо убедиться, что нужные изменения на экране выполнены (закрыто окно, полностью обновлена таблица на форме и пр.).
}}
{{function entry
|name=[[If|_If]], '''?'''
|form='''_If'''(''<Условие>'',''<Результат, если условие выполнено>''{{Optional|,<Результат, если условие не выполнено>{{Default|{{Eq}}<NOTHING>}}}}):''<Результат>''
|type=2
|status=2
|visual=0
|description=Магическая функция позволяет превратить конструкцию '''If''' в вычисляемое выражение.
}}
{{function entry
|name=[[If2|__If]], '''??'''
|form='''__If'''(''<Условие>'',''<Результат, если условие выполнено>''{{Optional|,<Условие 2>,<Результат, если условие 2 выполнено>,...<Результат, если не выполнено ни одно из условий>{{Default|{{Eq}}<NOTHING>}}}}):''<Результат>''
|type=2
|status=2
|visual=0
|description=Магическая функция позволяет превратить несколько последовательных конструкций '''If''' в вычисляемое выражение.
}}
{{function entry
|name=[[And|_And]]
|form='''_And'''(''<Условие 1>''{{Optional|,<Условие 2>,<Условие 3> ...}}):''<Результат 0 или 1 (INT)>''
|type=2
|status=2
|visual=0
|description=Магическая функция позволяет вычислять только требуемые условия, для получения результата -- логического "и".
}}
{{function entry
|name=[[Or|_Or]]
|form='''_Or'''(''<Условие 1>''{{Optional|,<Условие 2>,<Условие 3> ...}}):''<Результат 0 или 1 (INT)>''
|type=2
|status=2
|visual=0
|description=Магическая функция позволяет вычислять только требуемые условия, для получения результата -- логического "или".
}}
{{function entry
|name=[[InSet]]
|form='''InSet'''(''<Значение поиска>''{{Optional|,<Значение множества 1>,<Значение множества 2>...}}):''<Искомое значение присутствует во множестве (INT)>''
|type=2
|status=2
|visual=0
|description=Магическая функция проверяет, присутствует ли значение поиска во множетсве значений для проверки. Может упростить конструкцию ''If''.
}}
{{function entry
|name=[[InRange]]
|form='''InRange'''(''<Значение поиска>''{{Optional|,<Начало диапазона 1>,<Конец диапазона 1>,<Начало диапазона 2>,<Конец диапазона 2>...}}):''<Искомое значение присутствует в диапазоне (диапазонах) (INT)>''
|type=2
|status=2
|visual=0
|description=Магическая функция проверяет, присутствует ли значение поиска в диапазонах значений для проверки. Искомое значение может быть числом, датой или строкой. Функция может упростить конструкцию ''If''. Для проверки используются нестрогие неравенства (<code> >= или =< </code>). Функция возвращает ''1'', если искомое значение присутствует по крайней мере в одном диапазоне.
}}
{{function entry
|name=[[InRangeEx]]
|form='''InRangeEx'''({{Optional|<Режим (INT)>{{Default|{{Eq}}0}}}},''<Значение поиска>''{{Optional|,<Начало диапазона 1>,<Конец диапазона 1>,<Начало диапазона 2>,<Конец диапазона 2>...}}):''<Искомое значение присутствует в диапазоне (диапазонах) (INT)>''
|type=2
|status=2
|visual=0
|description=Магическая функция проверяет, присутствует ли значение поиска в диапазонах значений для проверки. Искомое значение может быть числом, датой или строкой. Функция может упростить конструкцию ''If''. В зависимости от режима (первый аргумент), для проверки используются строгие или нестрогие неравенства. В зависимости от режима, функция возвращает ''1'', если искомое значение присутствует по крайней мере в одном диапазоне или во всех диапазонах.
}}
{{function entry
|name=[[CreateOLE]]
|form='''CreateOLE'''(''<Идентификатор объекта OLE (STRING)>''):''<Новый объект OLE (OLE)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый объект OLE (COM) по строке идентификатора
}}
{{function entry
|name=[[CreateThreadedOLE]]
|form='''CreateThreadedOLE'''(''<Идентификатор объекта OLE (STRING)>''):''<Новый объект OLE (OLE)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый объект OLE (COM) по строке идентификатора. Объект может быть доступен в любом потоке, не только в том, который создал объект. Вызовы к таким объектам осуществляются несколько медленнее.
}}
{{function entry
|name=[[OLE.SetTimeout|SetTimeout]]
|form={{Grey|OLE.}}'''SetTimeout'''({{Optional|<Время ожидания исполнения команд в мс. (INT)>}}):''<Предыдущее время ожидания исполнения команд в мс. (INT)>''
|type=1
|status=0
|visual=0
|description=Функция задает или получает для объекта максимальное время ожидания исполнения команд. По умолчанию при создании объекта, это время равно 0 (не ограничено). При истечении времени ожидания система произведет отсоединение от текущего OLE-объекта и выполнявшаяся функция вызовет исключение.
}}
{{function entry
|name=[[IsMultithreaded]]
|form='''IsMultithreaded'''(''<Аргумент>''):''<Является ли объект многопоточным (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, является ли объект, содержащийся в переменной-аргументе многопоточным или однопоточным (см. статью [[Объекты]])
}}
{{function entry
|name=[[SetMultiThreaded]]
|form='''SetMultiThreaded'''(''<Аргумент>'')
|type=1
|status=2
|visual=0
|description=Функция позволяет безусловно установить флаг многопоточности на объекте, содержащемся в переменной-аргументе. Функция может использоваться при работе с объектами, содержащими ссылки на самого себя (см. статью [[Объекты]])
}}
{{function entry
|name=[[LockObject]]
|form='''LockObject'''(''<Аргумент>'')
|type=1
|status=2
|visual=0
|description=Функция позволяет заблокировать доступ к сложному объекту из других программных потоков. Обычно система выполняет это действие автоматически, однако, если состояние непротиворечивости объекта требует нескольких вызовов функций изменения, эта функция может стать гарантом его непротиворечивости в других потоках. После окончания выполнения кода изменения объекта, необходимо вызвать функцию ''UnlockObject''. Функция не должна применяться к визуальным объектам, кроме того внутри кода изменения существуют ограничения по вызову визуальных функций.
}}
{{function entry
|name=[[UnlockObject]]
|form='''UnlockObject'''(''<Аргумент>'')
|type=1
|status=2
|visual=0
|description=Функция позволяет разблокировать доступ к сложному объекту, заблокированному ранее с помощью функции ''LockObject''.
}}
{{function entry
|name=[[LockCount]]
|form='''LockCount'''(''<Аргумент>''):''<Количество вложенных блокировок (INT)>''
|type=1
|status=2
|visual=0
|description=Функция позволяет получить количество вложенных блокировок объекта (осуществленных с помощью функции [[LockObject]] или системой) даже если объект не удерживается текущим потоком (таким образом ее можно также использовать, как индикатор того, что объект заблокирован другим потоком, если известно, что текущий поток его не блокировал, однако, нужно понимать, что объекты, могут автоматически блокироваться системой на время вызова функций, вероятность обнаружить такую блокировку может быть высока, если объект, используется в потоке, который выполняет какую-то работу в данный момент).
}}
{{function entry
|name=[[Message]]
|form='''Message'''(''<Аргумент>''{{Optional|,<Тип текста (STRING)>{{Default|{{Eq}}""}},<Интерактивный объект 1 для подстановки в текст>,<Интерактивный объект 2 для подстановки в текст>...}})
|type=1
|status=2
|visual=1
|description=Функция выводит строковое представление аргумента в [[Визуальный лог клиента|лог]] клиента, при этом текст может быть выделен, если необходимо, как ошибка или информация.
}}
{{function entry
|name=[[LoadModule]]
|form='''LoadModule'''(''<Способ вызова (INT)>'',''<Путь или имя базы данных (STRING)>''{{OptionalByRef|,<Параметр>,<Опция>}}{{Optional|,<Имя модуля (STRING)>{{Default|{{Eq}}"Module"}},<Имя формы (STRING)>{{Default|{{Eq}}"SelectForm"}}}}{{OptionalByRef|,<Серийный номер потока, в котором происходит исполнение (INT)>}}):''<Результат модального выполнения>''
|type=1
|status=2
|visual=1
|description=Функция позволяет загружать и инициировать выполнение произвольного модуля с произвольной формой. Модуль может быть загружен как модально к текущему потоку (если текущий поток не является корневым), так и создавать новый поток, передавая ему два аргумента. В случае модального исполнения, функция не возвратит результат до тех пор, пока модуль не закончит работы, при этом, модуль может возвратить результат и изменить переданные параметры, если они представляли собой переменные.
}}
{{function entry
|name=[[LoadToolForm]]
|form='''LoadToolForm'''(''<Способ вызова (INT)>'',''<Режим загрузки формы (INT)>'',''<Путь или имя базы данных (STRING)>''{{OptionalByRef|,<Параметр>,<Опция>}}{{Optional|,<Имя формы (STRING)>{{Default|{{Eq}}"Form"}}}}{{OptionalByRef|,<Объект открытой формы (FORM)>}}):''<Результат, возвращенный при инициализации формы>''
|type=1
|status=2
|visual=1
|description=Функция позволяет загружать произвольную форму в режиме инструментария. Формы в таком режиме не имеют модулей и работают в контексте текущего модуля, либо в контексте корневого модуля, в зависимости от параметров загрузки. Функция может возвратить серийный номер открытой формы, чтобы программа могла осуществлять переговоры с ней с помощью отсылки сообщений.
}}
{{function entry
|name=[[ImportFunctionsFromModule]]
|form='''ImportFunctionsFromModule'''(''<Путь или имя базы данных (STRING)>''{{Optional|,<Имя модуля (STRING)>{{Default|{{Eq}}"Module"}},<Пространство имен (STRING)>{{Default|{{Eq}}""}}}})
|type=1
|status=0
|visual=0
|description=Функция позволяет импортировать в текущий выполняющийся модуль функции другого модуля, после импорта функции можно исполнять, как будто они были созданы в текущем модуле. Если при импорте, имя создаваемой функции уже существует, будет вызвано исключение. Часть кода, не находящаяся внутри функций, будет игнорирована. Чтобы увеличить устойчивость загрузки из разных источников, можно использовать дополнительный идентификатор -- пространство имен. Идентификатор не должен содержать знаков, недоступных в наименованиях функций и знаков ".". После импорта новые функции можно будет вызвать с помощью конструкции <code><Идентификатор>.<Имя функции>([...])</code>. Функцию можно использовать для увеличения функциональности, доступной во внешних модулях, к примеру, если модуль производит выгрузку, которая зависит от поключенного устройства, можно импортировать функции модуля, который был создан для конкретного устройства.
}}
{{function entry
|name=[[ImportFunctionsFromText]]
|form='''ImportFunctionsFromText'''(''<Строка с кодом для компиляции (STRING)>''{{Optional|,<Пространство имен (STRING)>{{Default|{{Eq}}""}}}})
|type=1
|status=0
|visual=0
|description=Функция позволяет импортировать в текущий выполняющийся модуль функции из строки текста. Перед началом импорта, текст будет скомпилирован в контексте текущего модуля. Если при импорте, имя создаваемой функции уже существует, будет вызвано исключение. Часть кода, не находящаяся внутри функций, будет игнорирована. Чтобы увеличить устойчивость загрузки из разных источников, можно использовать дополнительный идентификатор -- пространство имен. Идентификатор не должен содержать знаков, недоступных в наименованиях функций и знаков ".". После импорта новые функции можно будет вызвать с помощью конструкции <code><Идентификатор>.<Имя функции>([...])</code>. Функцию можно использовать для увеличения функциональности, доступной во внешних модулях, к примеру, если модуль производит выгрузку, которая зависит от поключенного устройства, можно импортировать функции текста кода, который был создан для конкретного устройства.
}}
{{function entry
|name=[[RemoveImportedFunctions]]
|form='''RemoveImportedFunctions'''()
|type=1
|status=0
|visual=0
|description=Функция удаляет из контекста текущего модуля все функции, импортированные из других модулей или текстовых строк (см. [[ImportFunctionsFromModule]] и [[ImportFunctionsFromText]]).
}}
{{function entry
|name=[[OpenObject]]
|form='''OpenObject'''(''<Объект базы данных (DB)>'',''<Режим просмотра (INT)>'',''<Способ вызова (INT)>''{{OptionalByRef|,<Параметр>,<Опция>}}{{Optional|,<Имя модуля (STRING)>,<Имя формы (STRING)>}}):''<Результат модального выполнения>''
|type=1
|status=2
|visual=1
|description=Функция позволяет загружать и инициировать выполнение модуля и формы, связанных с заданным объектом, при этом сам объект загружается в форму для редактирования или просмотра. Модуль может быть загружен как модально к текущему потоку (если текущий поток не является корневым), так и создавать новый поток, передавая ему два аргумента. В случае модального исполнения, функция не возвратит результат до тех пор, пока модуль не закончит работы, при этом, модуль может возвратить результат и изменить переданные параметры, если они представляли собой переменные. Функция может возвратить особые текстовые результаты, если требуемый объект был заблокирован другим пользователем. Для полной информации см. описание функции.
}}
{{function entry
|name=[[SelectObject]], '''AskObject'''
|form='''SelectObject'''(''<Путь или имя базы данных (STRING)>''{{OptionalByRef|,<Параметр>,<Опция>}}{{Optional|,<Имя модуля (STRING)>{{Default|{{Eq}}"Module"}},<Имя формы (STRING)>{{Default|{{Eq}}"SelectForm"}},<Объект для позиционирования>,<Наименование объекта формы, осуществляющего выбор (STRING)>,<Заголовок формы (STRING)>,<Дополнительные установки (INT)>}}):''<Выбранный объект или пустое значение>''
|type=1
|status=2
|visual=1
|description=Функция позволяет загружать и инициировать выполнение модуля и формы в модальном режиме для выбора объекта базы данных из списка объектов, при этом возможно начальное позиционирование на указанный объект, определение требуемого объекта формы списка объектов (если их несколько), изменение заголовка формы, использование других возможностей. Функция не возвратит результат до тех пор, пока модуль не закончит работы, при этом, модуль может изменить переданные параметры, если они представляли собой переменные.
}}
{{function entry
|name=[[MassSelectObjects]]
|form='''MassSelectObjects'''(''<Имя функции для принятия результата выбора (STRING)>'',''<Путь или имя базы данных (STRING)>''{{OptionalByRef|,<Параметр>,<Опция>}}{{Optional|,<Имя модуля (STRING)>{{Default|{{Eq}}"Module"}},<Имя формы (STRING)>{{Default|{{Eq}}"SelectForm"}},<Объект для позиционирования>,<Наименование объекта формы, осуществляющего выбор (STRING)>,<Заголовок формы (STRING)>,<Параметр функции принятия выбора>,<Дополнительные установки (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=1
|description=Функция позволяет загружать и инициировать выполнение модуля и формы в модальном режиме для выбора множества объектов базы данных из списка объектов, при этом возможно начальное позиционирование на указанный объект, определение требуемого объекта формы списка объектов (если их несколько), изменение заголовка формы, использование других возможностей. В момент выбора очередного объекта пользователем, система вызывает особую функцию выбора (возможно с доп. параметром), имя которой задается в первом аргументе. Функция не возвратится до тех пор, пользователь не закроет исполняемый модуль, при этом, модуль может изменить переданные параметры, если они представляли собой переменные.
}}
{{function entry
|name=[[SendMessageToForm]]
|form='''SendMessageToForm'''(''<Серийный номер формы (INT)>'',''<Код сообщения (INT)>''{{OptionalByRef|,<Параметр>,<Опция>}}{{Optional|,<Гарантировать доставку (INT)>{{Default|{{Eq}}1}},<Имя макроса или страницы объекта формы (STRING)>{{Default|{{Eq}}""}}}}):''<Сообщение не было доставлено 0 или результат выполнения OnMessage>''
|type=1
|status=1
|visual=1
|description=Функция осуществляет доставку пользовательского сообщения с параметрами указанной по серийному номеру форме. Для формы будет вызвано визуальное событие [[Студия/OnMessage|OnMessage]]. Доставка также может быть осуществлена макросу, располагающемуся на форме или указанной по имени странице страничного элемента. Функция возвращается после обработки сообщения формой или ошибке при доставке.
}}
{{function entry
|name=[[PostMessageToForm]]
|form='''PostMessageToForm'''(''<Серийный номер формы (INT)>'',''<Код сообщения (INT)>''{{Optional|,<Параметр>,<Опция>,<Гарантировать доставку (INT)>{{Default|{{Eq}}1}},<Имя макроса или страницы объекта формы (STRING)>{{Default|{{Eq}}""}}}}):''<Сообщение было отправлено 0 или 1 (INT)>''
|type=1
|status=1
|visual=1
|description=Функция осуществляет доставку пользовательского сообщения с параметрами указанной по серийному номеру форме. Для формы будет вызвано визуальное событие [[Студия/OnMessage|OnMessage]]. Доставка также может быть осуществлена макросу, располагающемуся на форме или указанной по имени странице страничного элемента. Функция возвращается сразу после успешной отправки сообщения или ошибке при отправке. Измененные формой параметры не будут переданы назад.
}}
{{function entry
|name=[[BroadcastGlobalMessage]]
|form='''BroadcastGlobalMessage'''(''<Код сообщения (INT)>'',''<Содержимое сообщения (STRING)>''{{Optional|,<Для всех пользователей (INT)>{{Default|{{Eq}}0}}}}):''<Сообщение успешно отправлено (INT)>''
|type=1
|status=2
|visual=1
|description=Функция рассылает пакеты, которые вызывают исполнения событий ''OnMessage'' для всех открытых форм (в момент когда они активны или когда они станут активными), в текущей системе или глобально всем клиентам сервера. В последнем случае, нужно быть осторожным, чтобы не перегружать сервер внезапным большим количеством запросов, даже с учетом того, что серверная часть использует особую систему замедления отправки запросов клиентам.
}}
{{function entry
|name=[[BroadcastMessage]]
|form='''BroadcastMessage'''(''<Код сообщения (INT)>''{{Optional|,<Параметр>,<Опция>,<Тип форм-получателей (INT)>{{Default|{{Eq}}1}},<Имя макроса или страницы объекта формы (STRING)>{{Default|{{Eq}}""}}}}):''<Сообщение было отправлено 0 или 1 (INT)>''
|type=1
|status=0
|visual=1
|description=Функция осуществляет доставку пользовательского сообщения с параметрами всем открытым в данный момент в системе формам с указанным типом. Для форм будет вызвано визуальное событие [[Студия/OnMessage|OnMessage]]. Доставка также может быть осуществлена макросу, располагающемуся на формах или указанной по имени странице страничного элемента. Функция возвращается сразу после успешной отправки сообщений или ошибке при отправке. Измененные формой параметры не будут переданы назад.
}}
{{function entry
|name=[[ModuleTag]]
|form='''ModuleTag'''({{Optional|<Новое значение>}}):''<Предыдущее значение>''
|type=1
|status=2
|visual=0
|description=Функция получает или изменяет свободную переменную, привязанную к текущему (исполняемому) модулю. Значение может использоваться по усмотрению разработчика.
}}
{{function entry
|name=[[IsKeyComboActive]]
|form='''IsKeyComboActive'''(''<Комбинация клавиш (STRING)>''):''<Комбинация активирована в данный момент, 0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, активирована ли в данный момент пользователем заданная комбинация клавиш (к примеру, <code>"Ctrl+Alt+D"</code>).
}}
{{function entry
|name=[[ObjectToString]]
|form='''ObjectToString'''(''<Значение>''):''<Значение, закодированное в строку (ANSI STRING)>''
|type=1
|status=2
|visual=0
|description=Функция кодирует внутрисистемным образом заданное значение в строку, значение может быть почти любым. К примеру, может представлять собой список, таблицу, объект базы данных, OLE-объект и пр.
}}
{{function entry
|name=[[ObjectFromString]]
|form='''ObjectFromString'''(''<Закодированное значение (STRING)>''):''<Значение>''
|type=1
|status=2
|visual=0
|description=Функция перекодирует строку в значение, закодированное внутрисистемным образом.
}}
{{function entry
|name=[[ObjectToFile]]
|form='''ObjectToFile'''(''<Значение>'',''<Имя файла (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция кодирует внутрисистемным образом заданное значение в строку, значение может быть почти любым. К примеру, может представлять собой список, таблицу, объект базы данных, OLE-объект и пр. Значение, затем, будет сохранено в заданный файл. При наличии ошибки при сохранении в файл, будет вызвано исключение.
}}
{{function entry
|name=[[ObjectFromFile]]
|form='''ObjectFromFile'''(''<Имя файла (STRING)>''):''<Значение>''
|type=1
|status=2
|visual=0
|description=Функция получает строку из указанного файла и перекодирует строку в значение, закодированное внутрисистемным образом.
}}
{{function entry
|name=[[Swap]]
|form='''Swap'''({{ByRef|<Переменная 1>,<Переменная 2>}})
|type=1
|status=2
|visual=0
|description=Функция меняет местами значения переменных.
}}
{{function entry
|name=[[DoesFunctionExist]]
|form='''DoesFunctionExist'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска или компилированная функция (INT, COMPILEDFUNCTION)>{{Default|{{Eq}}0}}}}):''<Существует ли функция (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, существует ли функция с указанным именем в текущем контексте исполнения, способ поиска задается вторым аргументом.
}}
{{function entry
|name=[[ArgumentsNumber]]
|form='''ArgumentsNumber'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска или компилированная функция (INT, COMPILEDFUNCTION)>{{Default|{{Eq}}0}}}}):''<Количество аргументов (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает количество аргументов функции с указанным именем в текущем контексте исполнения, способ поиска задается вторым аргументом. Если искомая функция не существует, будет возвращено значение -1.
}}
{{function entry
|name=[[ExecuteFunction]]
|form='''ExecuteFunction'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска или компилированная функция (INT, COMPILEDFUNCTION)>{{Default|{{Eq}}0}}{{ByRef|,<Аргумент 1>,<Аргумент 2>...}}}}):''<Результат исполнения функции>''
|type=1
|status=2
|visual=0
|description=Функция инициирует исполнение функции с указанным именем в текущем контексте исполнения с заданными аргументами, способ поиска задается вторым аргументом. Если искомая функция не существует, пропущен обязательный аргумент или заданное количество аргументов слишком велико, будет создано исключение. Функция может использоваться как более быстрая альтернатива функции <code>Eval</code> (если необходимо вызвать только одну функцию).
}}
{{function entry
|name=[[AsyncExecuteFunction]]
|form='''AsyncExecuteFunction'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска или компилированная функция (INT, COMPILEDFUNCTION)>{{Default|{{Eq}}0}},<Аргумент 1>,<Аргумент 2>...}}):''<Результат исполнения функции>''
|type=1
|status=0
|visual=0
|description=Функция инициирует исполнение функции с указанным именем в текущем контексте исполнения с заданными аргументами, способ поиска задается вторым аргументом. Если искомая функция не существует, пропущен обязательный аргумент, заданное количество аргументов слишком велико или исполнение в визуальном контексте невозможно, будет создано исключение. Функция будет исполнена в визуальном контексте [[Студия/Визуальные события|асинхронно]], в момент, когда он будет свободен (если это не произойдет в течение некотрого промежутка времени, функция не будет выполнена). Подобный способ исполнения можно использовать, к примеру, в обработчике события OnOpen, с тем, чтобы функция была запущена когда обработчик закончит исполнение и форма будет ожидать действия пользователя. См. также [[Form.InvokeEventAsync]].
}}
{{function entry
|name=[[GlobalBegPeriodDate]]
|form='''GlobalBegPeriodDate'''({{Optional|<Дата начала периода изменения периодических значений (DATE)>}}):''<Предыдущая дата начала периода изменения периодических значений (DATE)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает или/и изменяет дату начала изменения периодических значений при визуальном сохранении элементов с наличием таких значений.
}}
{{function entry
|name=[[GlobalEndPeriodDate]]
|form='''GlobalEndPeriodDate'''({{Optional|<Дата окончания периода изменения периодических значений (DATE)>}}):''<Предыдущая дата окончания периода изменения периодических значений (DATE)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает или/и изменяет дату окончания изменения периодических значений при визуальном сохранении элементов с наличием таких значений. Данная дата совпадает с датой просмотра периодических значений в визуально открытом элементе базы данных или таблице с такими элементами.
}}
{{function entry
|name=[[MinPeriodicalAccessDate]]
|form='''MinPeriodicalAccessDate'''({{Optional|<Новая минимальная дата просмотра периодических реквизитов (DATE)>}}):''<Текущая минимальная дата просмотра периодических реквизитов (DATE)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает и/или изменяет минимальную дату просмотра периодических значений реквизитов в стандартных формах периодических реквизитов. Значения с датой менее данной не будут отображаться при выводе формы просмотра или редактирования, невозможно будет также создать новые записи с датами, ранее указанной. Дата используется для всех потоков клиента, но не влияет на программное получение периодических данных.
}}
{{function entry
|name=[[MinPeriodicalEditDate]]
|form='''MinPeriodicalEditDate'''({{Optional|<Новая минимальная дата редактирования периодических реквизитов (DATE)>}}):''<Текущая минимальная дата редактирования периодических реквизитов (DATE)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает и/или изменяет минимальную дату редактирования периодических значений реквизитов в стандартных формах периодических реквизитов. Значения с датой менее данной не будут доступны для редактирования, невозможно будет также создать новые записи с датами, ранее указанной. Дата используется для всех потоков клиента, но не влияет на программное получение периодических данных.
}}
{{function entry
|name=[[GlobalDefaultSystemFont]]
|form='''GlobalDefaultSystemFont'''({{Optional|<Новое значение шрифта системы по умолчанию (STRING)>}}):''<Предыдущее значение шрифта системы по умолчанию (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает или/и изменяет внутрисистемный шрифт по умолчанию. Будут обновлены значения глобальных коэффициентов масштабирования форм. В зависимости от новых установок, текст и формы будут выглядеть крупнее или мельче. Шрифт умолчания для систем на Windows XP и более ранних "MS Sans Serif, 8" (не поддерживает международные символы), умолчания для более новых систем "Tahoma, 8" (поддерживает международные символы).
}}
{{function entry
|name=[[GlobalFormScaleFactorX]]
|form='''GlobalFormScaleFactorX'''({{Optional|<Новое значение горизонтального коэффициента глобального масштабирования форм (REAL)>}}):''<Предыдущее значение горизонтального коэффициента глобального масштабирования форм (REAL)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает или/и изменяет значение горизонтального коэффициента глобального масштабирования форм. Значение этого коэффициента по умолчанию равно 1. Если значение больше 1, элементы всех форм будут растянуты по горизонтали, если меньше 1, элементы будут сжаты.
}}
{{function entry
|name=[[GlobalFormScaleFactorY]]
|form='''GlobalFormScaleFactorY'''({{Optional|<Новое значение вертикального коэффициента глобального масштабирования форм (REAL)>}}):''<Предыдущее значение вертикального коэффициента глобального масштабирования форм (REAL)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает или/и изменяет значение вертикального коэффициента глобального масштабирования форм. Значение этого коэффициента по умолчанию равно 1. Если значение больше 1, элементы всех форм будут растянуты по вертикали, если меньше 1, элементы будут сжаты.
}}
{{function entry
|name=[[DefaultTablesRestrictMode]]
|form='''DefaultTablesRestrictMode'''({{Optional|<Новое значение режима доступа по умолчанию для новых таблиц (INT)>}}):''<Предыдущее значение режима доступа по умолчанию для новых таблиц (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает или/и изменяет значение режима доступа по умолчанию для новых таблиц. При создании таблицы режим доступа устанавливается в соответствии с режимом по умолчанию. Режим можно изменить с помощью свойства [[Table.Restrict]].
}}
{{function entry
|name=[[DefaultHighlightMode]]
|form='''DefaultHighlightMode'''(''<Режим подсветки таблиц по умолчанию (INT)>''{{Optional|,<Цвет нечетных строк (INT)>,<Процент цвета нечетных строк (INT)>,<Цвет выделения строки или столбца курсора (INT)>,<Процент цвета выделения строки или столбца курсора (INT)>}})
|type=1
|status=2
|visual=1
|description=Функция изменяет глобальный режим подсветки строк всех таблиц. Для изменения подсветки конкретной таблицы см. функцию [[Tab.HighlightMode]].
}}
{{function entry
|name=[[Eval]]
|form='''Eval'''(''<Выражение для вычисления (STRING)>''):''<Результат вычисления выражения>''
|type=1
|status=2
|visual=0
|description=Функция производит компиляцию и вычисление выражения, заданного на внутреннем языке. Выражение исполняется в контексте текущей функции с доступом к именам, совпадающим с доступом из кода, вызвавшего функцию. Функция вызывает прерывание, если аргумент не может быть скомпилирован из-за ошибки, либо он не является вычисляемым выражением. Функция возвращает результат вычисления выражения.
}}
{{function entry
|name=[[Exec]]
|form='''Exec'''(''<Блок для исполнения или компилированная функция (STRING, COMPILEDFUNCTION)>''):''<Исполнение завершено удачно 1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит компиляцию и исполнение блока текста, заданного на внутреннем языке, или компилированной заранее функции. Блок исполняется в контексте текущей функции с доступом к именам, совпадающим с доступом из кода, вызвавшего функцию. Функция вызывает прерывание, если аргумент не может быть скомпилирован из-за ошибки. Исполняемый код обладает свойствами кода внутри новой функции (счетчик циклов равен нулю, создаваемые переменные не будут переданы в вызывавшую функцию), однако, имеет доступ к локальным переменным вызывавшей функции.
}}
{{function entry
|name=[[ExecEx]]
|form='''ExecEx'''(''<Блок для исполнения или компилированная функция (STRING, COMPILEDFUNCTION)>''{{Optional|,<Установки ограничения исполнения (INT)>{{Default|{{Eq}}0}},<Ограничение по времени в мс. (INT)>{{Default|{{Eq}}0}},<Наименование функции, получающей выводимую в лог информацию (STRING)>,<Глубина поиска (INT)>{{Default|{{Eq}}0}},<Ограничение по использованию памяти потоком (INT)>{{Default|{{Eq}}0}}}}):''<Значение переменной Result при исполнении функции>''
|type=1
|status=2
|visual=0
|description=Функция производит компиляцию и исполнение блока текста, заданного на внутреннем языке, или компилированной заранее функции в контролируемой среде исполнения. Аргументы могут ограничить возможности, предоставляемые исполняемому коду, как функционально (некоторые группы функций будут запрещены к использованию), или в заданных пределах доступа к переменным и функциям, так и с ограничением по времени исполнения или по выделяемой памяти. Функция может использоваться для исполнения кода, который может быть опасным или злонамеренным, либо кода из неизвестного источника.
}}
{{function entry
|name=[[Compile]]
|form='''Compile'''(''<Блок для компилирования (STRING)>''{{Optional|,<Степень изолированности (INT)>{{Default|{{Eq}}0}},<Добавочные переменные (STRING)>,<Свойства исходного текста для отладчика (STRING,INT)>}}):''<Компилированная функция в виде объекта (COMPILEDFUNCTION)>''
|type=1
|status=2
|visual=0
|description=Функция производит компиляцию блока текста, заданного на внутреннем языке, и возвращает объект, представляющий результат компиляции. В зависимости от второго аргумента, блок может компилироваться в контексте текущей функции, глобальных модулей или без доступа к внешним переменным и функциям. Функция вызывает прерывание, если компиляция прервана из-за ошибки. Результирующий объект можно использовать многократно с функциями [[Exec]] и [[ExecEx]], это быстрее, чем компилировать блок текста при каждом вызове.
}}
{{function entry
|name=[[LoadFunctionFromBuffer]]
|form='''LoadFunctionFromBuffer'''(''<Экспортированная в память компилированная функция (BUFFER, STRING)>''{{Optional|,<Путь к исходному тексту (STRING),<Исходный текст (STRING)>}}):''<Компилированная функция в виде объекта (COMPILEDFUNCTION)>''
|type=1
|status=2
|visual=0
|description=Функция производит импорт из памяти экспортированной ранее с помощью [[SaveFunctionToBuffer]] компилированной функции. Функция возвращает объект аналогичный результату функции [[Compile]], который можно использовать многократно с функциями [[Exec]] и [[ExecEx]].
}}
{{function entry
|name=[[SaveFunctionToBuffer]]
|form='''SaveFunctionToBuffer'''(''<Компилированная функция (COMPILEDFUNCTION)>''):''<Экспортированная в память компилированная функция (BUFFER)>''
|type=1
|status=2
|visual=0
|description=Функция производит экспорт в память компилированной функции. Функция возвращает буфер с содержимым подобным файлам с компилированными модулями системы.
}}
{{function entry
|name=[[InfoPanelClose]]
|form='''InfoPanelClose'''({{Optional|<Очистить панель (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=1
|description=Функция закрывает информационную панель (панель логов) визуального клиента, очищая текущий текст в ней при необходимости.
}}
{{function entry
|name=[[InfoPanelClear]]
|form='''InfoPanelClear'''()
|type=1
|status=2
|visual=1
|description=Функция очищает текст в информационной панели (панели логов) визуального клиента.
}}
{{function entry
|name=[[InfoPanelOpen]]
|form='''InfoPanelOpen'''()
|type=1
|status=2
|visual=1
|description=Функция открывает информационную панель (панель логов) визуального клиента.
}}
{{function entry
|name=[[IsInfoPanelOpen]]
|form='''IsInfoPanelOpen'''():''<Результат 0 или 1 (INT)>''
|type=1
|status=2
|visual=1
|description=Функция проверяет, открыта ли в данный момент информационная панель (панель логов) визуального клиента.
}}
{{function entry
|name=[[HideControlPanel]]
|form='''HideControlPanel'''(''<Идентификатор панели инструментов (STRING)>'')
|type=1
|status=2
|visual=1
|description=Функция прячет всех окон указанную панель инструментов. Пользовательские панели инструментов задаются в свойствах проекта, кроме пользовательских панелей, можно использовать специальные следующие идентификаторы для адресации стандартных панелей: '''COMMON''', '''TABLE''', '''TEXT'''. См. также функцию для определенного окна [[Form.HideControlPanel]].
}}
{{function entry
|name=[[ShowControlPanel]]
|form='''ShowControlPanel'''(''<Идентификатор панели инструментов (STRING)>'')
|type=1
|status=2
|visual=1
|description=Функция отображает для всех окон указанную панель инструментов. Пользовательские панели инструментов задаются в свойствах проекта, кроме пользовательских панелей, можно использовать специальные следующие идентификаторы для адресации стандартных панелей: '''COMMON''', '''TABLE''', '''TEXT'''. См. также функцию для определенного окна [[Form.ShowControlPanel]].
}}
{{function entry
|name=[[InterThreadWindowsMode]]
|form='''InterThreadWindowsMode'''({{Optional|<Новый режим отображения окон всех потоков (INT)>}}):''<Текущий режим отображения окон всех потоков (INT)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает и/или изменяет текущий режим отображения окон всех потоков. Для более подробной информации см. описание.
}}
{{function entry
|name=[[StandardOutputHook]]
|form='''StandardOutputHook'''({{Optional|<Тип перехватываемого события (INT)>{{Default|{{Eq}}0}},<Наименование функции, вызываемой при перехвате (STRING)>,<Глубина поиска (INT)>{{Default|{{Eq}}0}},<Параметр для передачи в функцию>}}):''<Наименование предыдущей функции-перехватчика (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция добавляет или удаляет ссылку на функцию-перехватчик визуальных событий (к примеру, вывода информации в лог или панель состояния формы). Может использоваться, к примеру, для получения и вывод на экран информации об обработках, протекающих в скрытом потоке. Крайне желательно использование конструкции <code>Try .. Finally</code>, чтобы гарантированно вернуть предыдущее состояние перехватчика после того, как работа будет завершена.
}}
{{function entry
|name=[[RemoveUnacceptablePathChars]]
|form='''RemoveUnacceptablePathChars'''(''<Имя файла, которое необходимо очистить от недопустимых символов (STRING)>''{{Optional|,<Заменить недопустимые символы на (STRING)>{{Default|{{Eq}}""}}}}):''<Очищенное имя файла (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция очищает имя файла (без имен папок) от непечатных и недопустимых символов (удаляются сл. печатные символы <code><, >, :, ", /, \, |, ?, *</code>). Удаляемые символы могут быть заменены на указанный.
}}
{{function entry
|name=[[GetPath]]
|form='''GetPath'''(''<Имя файла с папками (STRING)>''):''<Имена папок без имени файла (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает из полного имени файла строку пути с папками (пример, строка <code>C:\Folder\My.File.txt</code> будет превращена в <code>C:\Folder\</code>).
}}
{{function entry
|name=[[GetFileName]]
|form='''GetFileName'''(''<Имя файла с папками (STRING)>''):''<Имя файла без папок (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает из полного имени файла с папками, имя файла без папок (пример, строка <code>C:\Folder\My.File.txt</code> будет превращена в <code>My.File.txt</code>).
}}
{{function entry
|name=[[GetExt]]
|form='''GetExt'''(''<Имя файла (STRING)>''):''<Расширение файла (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает из имени файла его расширение (пример, строка <code>C:\Folder\My.File.txt</code> будет превращена в <code>txt</code>).
}}
{{function entry
|name=[[AddBackslash]]
|form='''AddBackslash'''(''<Путь с папками (STRING)>''):''<Преобразованный путь (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция добавляет в конец строки знак <code>\</code>, если он там уже не присутствует. Пустая строка не будет изменена.
}}
{{function entry
|name=[[RemoveBackslash]]
|form='''RemoveBackslash'''(''<Путь с папками (STRING)>''):''<Преобразованный путь (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция удаляет с конца строки знак <code>\</code>, если он там был.
}}
{{function entry
|name=[[RemoveExt]]
|form='''RemoveExt'''(''<Имя файла (STRING)>''):''<Имя файла без расширения (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция удаляет из имени файла его расширение (пример, строка <code>C:\Folder\My.File.txt</code> будет превращена в <code>C:\Folder\My.File</code>).
}}
{{function entry
|name=[[GetAccountNames]]
|form='''GetAccountNames'''():''<Список учетных записей системы (LIST)>''
|type=1
|status=2
|visual=0
|description=Функция получает список текущих учетных записей системы (сервера). Для исполнения функции необходимо наличие административных прав. Значениями списка будут строки с наименованиями учетных записей, имена списка будут представлены в виде строки с флагами соответствующих учетных записей.
}}
{{function entry
|name=[[UserCredentialsLock]]
|form='''UserCredentialsLock'''({{OptionalByRef|<Заблокировано пользователем (STRING)>}},{{OptionalByRef|<Заблокировано на машине (STRING)>}},{{OptionalByRef|<Время блокировки (DATE)>}}):''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция временно блокирует доступ к редактору учетных записей пользователей (для подготовки к изменениям). Для исполнения функции необходимо наличие административных прав. '''Внимание''': после функции должен следовать блок <code><Try> ... <Finally><EndTry></code> для гарантированного вызова функции разблокировки [[UserCredentialsUnlock]]. Если доступ уже был заблокирован ранее, функция возвращает имя пользователя, машины и время, когда он был заблокирован.
}}
{{function entry
|name=[[UserCredentialsUnlock]]
|form='''UserCredentialsUnlock'''():''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция разблокирует доступ к редактору учетных записей пользователей, заблокированному ранее функцией [[UserCredentialsLock]]. Для исполнения функции необходимо наличие административных прав.
}}
{{function entry
|name=[[UserCredentialsLoad]]
|form='''UserCredentialsLoad'''():''<Файл учетных записей сервера в виде строки (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает строку-содежимое файла учетных записей пользователей с сервера. Для исполнения функции необходимо наличие административных прав. Строку можно использовать, к примеру, для заполнения объекта [[Ini-файл|ini-файла]]. Чтение учетных записей пользователей, без их предвариельной блокировки функцией [[UserCredentialsLock]], разрешено, однако если данные будут изменяться, необходимо убедиться, что вы читаете актуальную копию данных, поэтому необходимо использование [[UserCredentialsLock]] до начала чтения.
}}
{{function entry
|name=[[UserCredentialsStore]]
|form='''UserCredentialsStore'''(''<Файл учетных записей сервера в виде строки (STRING)>''):''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция сохраняет строку-содежимое файла учетных записей пользователей на сервер. Для исполнения функции необходимо наличие административных прав. Перед вызовом данной функции строго рекомендуется использовать функцию блокировки доступа к редактору учетных записей [[UserCredentialsLock]].
}}
{{function entry
|name=[[ValidateUserPassword]]
|form='''ValidateUserPassword'''(''<Имя пользователя (STRING)>'',''<Пароль пользователя (STRING)>''{{OptionalByRef|,''<Ошибка или ответ сервера (STRING,INT)>''}}):''<Упешная проверка учетной записи (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет корректность имени пользователя и пароля с точки зрения учетных записей сервера (иначе говоря, проверяет, сможет ли этот пользователь зарегистрироваться на сервере под указанным паролем). Если регистрация невозможна, функция возвращает краткое описание причины третьим аргументом, если регистрация удачна, функция возвращает уровень полномочий пользователя третьим аргументом.
}}
{{function entry
|name=[[SendChatMessage]]
|form='''SendChatMessage'''(''<Получатели через запятую (STRING)>'',''<Текст сообщения (STRING)>''):''<Сообщение успешно отправлено (INT)>''
|type=1
|status=0
|visual=1
|description=Функция отправляет сообщение во встроенный чат клиентов, зарегистрированных под пользователями, которые указаны, как получатели сообщения в первом аргументе.
}}
{{function entry
|name=[[GetStandardIcon]]
|form='''GetStandardIcon'''(''<Объект базы данных (DB)>''{{Optional|,''<Закрепленная строка папок (INT)>''{{Default|{{Eq}}0}}}}):''<Индекс стандартной иконки объекта (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает индекс стандартной иконки указанного объекта базы данных, данные индексы не совпадают с номерами иконок из библиотеки иконок и могут быть использованы только для столбцов визуальных таблиц, имеющих тип "стандартная иконка". Различное состояние объекта (удален, новый и пр.) отображается разными иконками. Возможно также указание на то, что иконка находится для открытой папки справочника.
}}
{{function footer}}

== Функции диалога с пользователем==
В данный раздел входят функции, осуществляющие вывод на экран различных диалогов для получения информации от пользователя. Большинство этих функций не будет работать в консольных клиентах.
{{function header}}
{{function entry
|name=[[Box]], '''MsgBox'''
|form='''Box'''(''<Сообщение (STRING)>''{{Optional|,<Тип диалога (INT)>{{Default|{{Eq}}Q_OK}}}})
|type=1
|status=2
|visual=1
|description=Функция выводит модальное окно с текстом сообщения, при этом стиль окна будет зависеть от второго аргумента.
}}
{{function entry
|name=[[AskQuestion]]
|form='''AskQuestion'''(''<Текст вопроса (STRING)>'',''<Тип диалога и его кнопки (INT)>''{{Optional|,<Индекс кнопки по умолчанию (INT)>{{Default|{{Eq}}1}}}}):''<Идентификатор выбранной кнопки (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит модальное окно с текстом вопроса со стилем и кнопками, заданными вторым аргументом. При необходимости, нужную кнопку можно выделить, как кнопку по умолчанию. Пользователь не может закрыть окно, без выбора одной из кнопок, идентификатор которой будет возвращен в результате функции. Для задания режимов и кнопок диалога рекомендуется использовать [[Константы#Константы диалогов|константы диалогов]].
}}
{{function entry
|name=[[SelectDataType]]
|form='''SelectDataType'''({{Optional|<Список типов объектов для выбора (STRING)>,<Заголовок формы (STRING)>}}):''<Тип и имя выбранного объекта или пустая строка (STRING)>''
|type=1
|status=2
|visual=1
|description=Функция позволяет выбрать тип (включая типы и виды объектов базы данных) из списка типов, ограниченного, если необходимо, первым аргументом. Функция возвращает выбранный пользователем тип или пустую строку, если пользователь отказался от выбора.
}}
{{function entry
|name=[[SelectFormSettingsFile]]
|form='''SelectFormSettingsFile'''(''<Загрузка установок (INT)>'',{{ByRef|<Путь файла установок (STRING)>,<Имя файла установок (STRING)>}}):''<Пользователь осуществил выбор 1 или 0 (INT)>''
|type=1
|status=2
|visual=1
|description=Функция показывает диалог сохранения или загрузки установок формы. Если пользователь выбрал файл установок (для загрузки или сохранения), будут заполнены переменные путь к файлу или имя файла установок, и функция возвратится с результатом 1.
}}
{{function entry
|name=[[OpenFileDialog]]
|form='''OpenFileDialog'''({{ByRef|<Имя файла (STRING)>}}{{Optional|,<Заголовок диалога (STRING)>,<Доступные фильтры файлов (STRING)>,<Тип диалога (INT)>{{Default|{{Eq}}0}},<Расширение по умолчанию (STRING)>}}):''<Пользователь выбрал файл (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный системный диалог открытия файла с заголовком и установками, определяемыми аргументами. Результат выбора возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[SaveFileDialog]]
|form='''SaveFileDialog'''({{ByRef|<Имя файла (STRING)>}}{{Optional|,<Заголовок диалога (STRING)>,<Доступные фильтры файлов (STRING)>,<Тип диалога (INT)>{{Default|{{Eq}}0}},<Расширение по умолчанию (STRING)>}}):''<Пользователь нажал на ОК (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный системный диалог сохранения файла с заголовком и установками, определяемыми аргументами. Выбранное имя файла для сохранения возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[OpenFileDialogServer]]
|form='''OpenFileDialogServer'''({{ByRef|<Имя файла (STRING)>}}{{Optional|,<Заголовок диалога (STRING)>,<Доступные фильтры файлов (STRING)>,<Тип диалога (INT)>{{Default|{{Eq}}0}},<Расширение по умолчанию (STRING)>,<Ограничить доступ этим каталогом (STRING)>}}):''<Пользователь выбрал файл (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный системный диалог открытия файла на стороне сервера с заголовком и установками, определяемыми аргументами. Результат выбора возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[SaveFileDialogServer]]
|form='''SaveFileDialogServer'''({{ByRef|<Имя файла (STRING)>}}{{Optional|,<Заголовок диалога (STRING)>,<Доступные фильтры файлов (STRING)>,<Тип диалога (INT)>{{Default|{{Eq}}0}},<Расширение по умолчанию (STRING)>,<Ограничить доступ этим каталогом (STRING)>}}):''<Пользователь нажал на ОК (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный системный диалог сохранения файла на стороне сервера с заголовком и установками, определяемыми аргументами. Выбранное имя файла для сохранения возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[SelectFontDialog]]
|form='''SelectFontDialog'''({{ByRef|<Наименования шрифта с его свойствами (STRING)>}}{{Optional|,<Запретить выбор стилей (INT)>{{Default|{{Eq}}0}},<Минимальный размер шрифта (INT)>{{Default|{{Eq}}0}},<Максимальный размер шрифта (INT)>{{Default|{{Eq}}0}}}}):''<Пользователь нажал на ОК (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный системный диалог выбора шрифта с установками, определяемыми аргументами. Выбранное имя шрифта и его свойства возвращаются в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[SelectIconDialog]]
|form='''SelectIconDialog'''({{ByRef|<Индекс выбранной иконки или ноль (INT)>}}{{Optional|,<Заголовок диалога (STRING)>}}):''<Пользователь выполнил выбор (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный модальный диалог выбора иконки из библиотеки иконок. Если пользователь выберет какую-либо иконку или пункт "без картинки", функция возвратит 1, иначе 0.
}}
{{function entry
|name=[[SelectFolderDialog]]
|form='''SelectFolderDialog'''({{ByRef|<Имя папки (STRING)>}}{{Optional|,<Заголовок диалога (STRING)>}}):''<Пользователь выбрал папку (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит стандартный системный диалог выбора папки с файлами с заголовком, определяемым вторым аргументом. Результат выбора возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[EditScriptDialog]]
|form='''EditScriptDialog'''({{ByRef|<Исходный текст программы (STRING)>}}{{Optional|,<Заголовок диалога (STRING)>,<Внешние переменные ч/з запятые (STRING)>}}):''<Пользователь нажал на ОК (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит модальный диалог редактирования исходного текста программы, заданного первым аргументом. Диалог имеет стандартную подсветку текста и позволяет провести синтаксический контроль при необходимости. Результат редактирования возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[AskString]]
|form='''AskString'''({{ByRef|<Текст для редактирования (STRING)>}}{{Optional|,<Заголовок диалога (STRING)>,<Максимальная длина строки (INT)>{{Default|{{Eq}}256}},<Тип строки (INT)>{{Default|{{Eq}}0}}}}):''<Пользователь нажал на ОК (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит модальный диалог редактирования текста, заданного первым аргументом. Текст может содержать как одну строку, так быть и многострочным. Результат редактирования возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[AskNumber]]
|form='''AskNumber'''({{ByRef|<Число для редактирования (NUMBER)>}}{{Optional|,<Заголовок диалога (STRING)>,<Максимальная длина числа (INT)>{{Default|{{Eq}}30}},<Количество знаков после точки (INT)>{{Default|{{Eq}}0}}}}):''<Пользователь нажал на ОК (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит модальный диалог редактирования числа, заданного первым аргументом. Число может быть как целым, так и вещественным. В диалоге имеется возможность вызова калькулятора. Результат редактирования возвращается в переменной, задающей первый аргумент.
}}
{{function entry
|name=[[AskDate]]
|form='''AskDate'''({{Optional|<Дата по умолчанию (DATE)>,<Заголовок диалога (STRING)>,<Режим показа диалога (INT)>{{Default|{{Eq}}0}}}}):''<Выбранная дата или 0 (DATE,INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит диалог в виде поля или календаря для выбора даты. В режиме поля, у пользователя есть возможность вызвать календарь. Функция возвращает результат выбора или ноль, если пользователь отказался от выбора.
}}
{{function entry
|name=[[AskPeriod]]
|form='''AskPeriod'''({{ByRef|<Начальная дата периода (DATE)>,<Конечная дата периода (DATE)>}}{{Optional|,<Заголовок диалога (STRING)>,<Тип ограничения при выборе периода (INT)>{{Default|{{Eq}}0}}}}):''<Пользователь нажал на ОК (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выводит диалог для выбора периода времени. На возможность выбора могут быть наложены ограничения (к примеру, выбирать только периоды в целый месяц). Результат выбора возвращается в переменных, задающих первые два аргумента.
}}
{{function footer}}

== Функции, связанные с сервером и базой данных==
В данном разделе собраны функции, напрямую или косвенно связанные с сервером базы данных. Если клиент работает в локальном режиме, без подключения к серверу базы данных, многие функции этой группы не будут иметь значения.
{{Общие функции, связанные с БД}}

== Глобальные функции строк-массивов значений ==
Группа функций, позволяющая хранить строки-флаги с префиксами на сервере в виде быстрой небольшой базы данных с двумя столбцами (значение и префикс). Функции можно использовать, когда нужно проверять существует ли группа строк в массиве, добавлять строки в массив или удалять их. Массивы доступны для всех клиентов, так как хранятся в памяти сервера. По этой же причине не рекомендуется использование слишком больших массивов или слишком больших строк, так как на сервере может не остаться памяти на выполнение других запросов. При перезапуске сервера, массивы автоматически не восстанавливаются. Если требуется запомнить их содержимое, чтобы не заполнять их всякий раз при запуске сервера, при создании массива можно указать на бинарный файл, в который массив будет периодически сохраняться после изменений после определенного времени. Такой подход не гарантирует, что текущее изменение будет сохранено, если сервер будет остановлен. Существует также подобная группа функций для клиентской стороны (см. [[Строковые_функции#Функции строк-массивов значений|Функции строк-массивов значений]]), но имеет несколько другой функционал.

{{function header}}
{{function entry
|name=[[GlobalStringsHeaps]]
|form='''GlobalStringsHeaps''':''<Массивы, созданные на сервере (LIST)>''
|type=1
|status=2
|visual=0
|description=Функция получает список всех массивов, созданных на данный момент на сервере. Возвращается список, элементами которого являются идентификаторы массивов (числовые значения), а наименованиями -- имена массивов.
}}
{{function entry
|name=[[GlobalStringsHeapsFind]]
|form='''GlobalStringsHeapsFind'''(''<Имя массива (STRING)>''):''<Идентификатор или ноль (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, существует ли на сервере массив по его наименованию. Если массив существует, будет возвращен его идентификатор, иначе ноль.
}}
{{function entry
|name=[[GlobalStringsHeapsAdd]]
|form='''GlobalStringsHeapsAdd'''(''<Имя массива (STRING)>''{{Optional|,<Строка-разделитель (STRING)>{{Default|{{Eq}}Chr(0)}},<Разделитель префикса (STRING)>{{Default|{{Eq}}""}},<Параметры массива (LIST)>}}):''<Идентификатор массива (INT)>''
|type=1
|status=2
|visual=0
|description=Функция создает на сервере массив по его имени, с указанным разделителем значений и префиксов и указанными параметрами, задающимися в виде списка, и возвращает идентификатор созданного массива. Если массив уже существует, будет возвращен его идентификатор без каких-либо дополнительных изменений.
}}
{{function entry
|name=[[GlobalStringsHeapsRemove]]
|form='''GlobalStringsHeapsRemove'''(''<Имя или идентификатор массива (STRING,INT)>''):''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция удаляет массив с сервера по его наименованию или идентификатору. Если массив удален (найден на сервере), функция возвращает ''1'', иначе ''0''.
}}
{{function entry
|name=[[GlobalStringsAdd]]
|form='''GlobalStringsAdd'''(''<Имя или идентификатор массива (STRING,INT)>'',''<Значения (STRING,LIST)>''{{Optional|,''<Режим (INT)>''{{Default|{{Eq}}0}}}}):''<Статус или результат (INT,LIST)>''
|type=1
|status=2
|visual=0
|description=Функция добавляет произвольное количество строк из списка или одной строки с разделителями в массив, заданный по его наименованию или идентификатору. Режим функции задает условие добавления, а также формат ответа (последний может быть как числовым, так и в виде списка).
}}
{{function entry
|name=[[GlobalStringsRemove]]
|form='''GlobalStringsRemove'''(''<Имя или идентификатор массива (STRING,INT)>'',''<Значения (STRING,LIST)>''{{Optional|,''<Режим (INT)>''{{Default|{{Eq}}0}}}}):''<Статус или результат (INT,LIST)>''
|type=1
|status=2
|visual=0
|description=Функция удаляет произвольное количество строк из списка или одной строки с разделителями из массива, заданного по его наименованию или идентификатору. Режим функции задает условие удаления, а также формат ответа (последний может быть как числовым, так и в виде списка).
}}
{{function entry
|name=[[GlobalStringsFind]]
|form='''GlobalStringsFind'''(''<Имя или идентификатор массива (STRING,INT)>'',''<Значения (STRING,LIST)>''{{Optional|,''<Режим (INT)>''{{Default|{{Eq}}0}}}}):''<Статус или результат (INT,LIST)>''
|type=1
|status=2
|visual=0
|description=Функция выполняет поиск произвольного количества строк, заданных в списке или в одной строке с разделителями, в массиве по его наименованию или идентификатору. Режим функции задает условие поиска, а также формат ответа (последний может быть как числовым, так и в виде списка).
}}
{{function entry
|name=[[GlobalStringsShrink]]
|form='''GlobalStringsShrink'''(''<Имя или идентификатор массива (STRING,INT)>''{{Optional|,''<Порог сжатия в % (INT)>''{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция форсирует процедуру сжатия памяти буферов массива, которая обычно выполняется автоматически после определенного количества удалений из массива.
}}
{{function entry
|name=[[GlobalStringsSaveToFile]]
|form='''GlobalStringsSaveToFile'''(''<Имя или идентификатор массива (STRING,INT)>'',''<Имя файла на сервере (STRING)>''{{Optional|,''<Если время последней записи было не раньше в мс. (INT)>''{{Default|{{Eq}}0}}}}):''<1 или 0>''
|type=1
|status=2
|visual=0
|description=Функция выполняет сохранение массива на диск в файловой системе сервера в виде файла. Обычно она выполняется автоматически, если в массиве были изменения после определенного количества времени.
}}
{{function entry
|name=[[GlobalStringsAddFromFile]]
|form='''GlobalStringsAddFromFile'''(''<Имя или идентификатор массива (STRING,INT)>'',''<Имя файла на сервере (STRING)>''{{Optional|,''<Очистить массив перед загрузкой (INT)>''{{Default|{{Eq}}0}}}}):''<1 или 0>''
|type=1
|status=2
|visual=0
|description=Функция выполняет добавление сохраненного ранее массива с диска в файловой системе сервера к массиву, заданному по наименованию или идентификатору. Обычно она выполняется автоматически при создании массива, если указан файл его хранения.
}}
{{function footer}}

== Функции отладки ==
Функции, собранные здесь, используются для изменения параметров и работы со встроенным отладчиком. Отладчик доступен как для визуальных, так и для консольных клиентов.
{{function header}}
{{function entry
|name=[[DebuggingRights]]
|form='''DebuggingRights'''({{Optional|<Режим отладки 0 или 1 (INT)>}}):''<Текущий режим отладки (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает или/и изменяет текущий режим отладки. Если режим отладки не включен, встроенный отладчик не будет выведен в момент появления исключения или нажатия Ctrl+Alt+C.
}}
{{function entry
|name=[[Debugbreak]]
|form='''Debugbreak'''()
|type=1
|status=2
|visual=0
|description=Функция приостанавливает выполнение и открывает окно отладчика на текущей инструкции, если это позволяет текущий режим отладки. Функция не должна быть последней в модуле.
}}
{{function entry
|name=[[ProfilerStart]]
|form='''ProfilerStart'''()
|type=1
|status=2
|visual=0
|description=Функция включает встроенный профайлер, если это позволяет текущий режим отладки. Данные, накопленные профайлером ранее не изменяются. При включенном профайлере программа исполняется несколько медленнее.
}}
{{function entry
|name=[[ProfilerStop]]
|form='''ProfilerStop'''()
|type=1
|status=2
|visual=0
|description=Функция отключает встроенный профайлер. Данные, накопленные профайлером ранее не изменяются.
}}
{{function entry
|name=[[ProfilerClear]]
|form='''ProfilerClear'''()
|type=1
|status=2
|visual=0
|description=Функция очищает данные, накопленные профайлером.
}}
{{function entry
|name=[[Assert]]
|form='''Assert'''(''<Условие утверждения (INT)>''{{Optional|,<Описание ошибки утверждения (STRING)>}})
|type=1
|status=2
|visual=0
|description=Функция проверяет истинность утверждения, заданного первым аргументом, если утверждение ложно, функция вызывает исключение 71 (ERR_ASSERTIONERROR) с требуемым описанием, если необходимо.
}}
{{function entry
|name=[[AssertMode]]
|form='''AssertMode'''(''<Режим ошибок утверждения (INT)>'')
|type=1
|status=2
|visual=0
|description=Функция изменяет способ обработки ошибок утверждения (<code>[[Assert]]</code>). Режим используется для всех потоков клиента.
}}
{{function entry
|name=[[Raise]]
|form='''Raise''' {{Optional|<Описание исключения (STRING)>}}
|type=2
|status=2
|visual=0
|description=Функция вызывает исключение 41 (ERR_USER) с требуемым описанием, если необходимо.
}}
{{function entry
|name=[[Reraise]]
|form='''Reraise'''()
|type=1
|status=0
|visual=0
|description=Функция может использоваться внутри блока <code>Except ... EndTry</code> для того, чтобы снова вызвать подавленное конструкцией <code>Except</code> исключение.
}}
{{function entry
|name=[[PopError]]
|form='''PopError'''({{Optional|<Режим (INT)>{{Default|{{Eq}}15}}}}):''<Описание исключения (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает описание текущего исключения, собирая его из требуемых частей. Информация об исключении удаляется из очереди (но не само исключение). Функцию рекомендуется использовать внутри блока <code>Except ... EndTry</code>
}}
{{function entry
|name=[[PeekError]]
|form='''PeekError'''({{Optional|<Режим (INT)>{{Default|{{Eq}}15}}}}):''<Описание исключения (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает описание текущего исключения, собирая его из требуемых частей. Информация об исключении не удаляется из очереди. Функцию можно использовать внутри блоков <code>Except ... EndTry</code> или <code>Finally ... EndTry</code>
}}
{{function entry
|name=[[SuppressException]]
|form='''SuppressException'''()
|type=1
|status=2
|visual=0
|description=Функция может использоваться только внутри блока <code>Finally ... EndTry</code>. Текущее исключение в очереди исключений будет удалено, оно не будет инициировано после выполнения <code>EndTry</code>. Функция позволяет превратить конструкцию <code>Try ... Finally</code> в аналог конструции <code>Try ... Except</code> программно.
}}
{{function entry
|name=[[Writeln]]
|form='''Writeln'''(''<Аргумент>'')
|type=1
|status=2
|visual=1
|description=Отладочная функция выводит строковое представление аргумента в [[Визуальный лог клиента|лог]] клиента. Функция является упрощенной версией функции [[Message]].
}}
{{function footer}}

=== Внутренние отладочные функции ===
Данная группа функций обычно напрямую не используется в рабочих программах, но может пригодиться для целей отладки и исправления ошибок.
{{function header}}
{{function entry
|name=[[RefCount]]
|form='''RefCount'''(''<Аргумент>''):''<Значения счетчика ссылок объекта (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает значение счетчика внешних ссылок сложного объекта (см. [[Объекты]]), либо -1, если аргумент не является сложным объектом.
}}
{{function entry
|name=[[BusyCount]]
|form='''BusyCount'''(''<Аргумент>''):''<Значения счетчика занятости однопоточных объектов (INT)>''
|type=1
|status=2
|visual=0
|description=Функция отладки позволяет узнать величину свойства "занят" для однопоточных объектов.
}}
{{function entry
|name=[[dbgVarStackSize]]
|form='''dbgVarStackSize'''():''<Количество переменных в стеке (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция возвращает общее количество переменных в стеке переменных текущего потока.
}}
{{function entry
|name=[[dbgVarDump]]
|form='''dbgVarDump'''()
|type=1
|status=2
|visual=0
|description=Отладочная функция выводит в консоль или панель логов визуального клиента отладочную информацию по текущему состоянию стека переменных текущего потока.
}}
{{function entry
|name=[[dbgObjectHeapsNumber]]
|form='''dbgObjectHeapsNumber'''():''<Количество объектных стеков в системе (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает количество стеков объектов, существующих во всех работающих потоках, а также стеков объектов, которые принадлежали закрытым потокам, однако, содержащих адресуемые объекты.
}}
{{function entry
|name=[[dbgEvalObjectsNumber]]
|form='''dbgEvalObjectsNumber'''():''<Количество объектов в стеке исполнения (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает количество объектов в стеке исполнения текущего потока.
}}
{{function entry
|name=[[dbgObjectsNumber]]
|form='''dbgObjectsNumber'''({{Optional|<Объект, стек которого необходимо использовать>}}):''<Количество объектов в стеке объектов (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает количество объектов в стеке объектов текущего потока исполнения, либо потока, в котором был создан объект аргумента.
}}
{{function entry
|name=[[dbgMemoryAllocated]]
|form='''dbgMemoryAllocated'''():''<Объем памяти, выделенный системой (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает текущий объем памяти в байтах, выделенный системой (с учетом всех внутренних переменных, стеков потоков, объектных стеков и пр.)
}}
{{function entry
|name=[[dbgShowAllocInfo]]
|form='''dbgShowAllocInfo'''(''<Включение режима накопления информации по объектам текущего стека объектов (INT)>'')
|type=1
|status=2
|visual=0
|description=Отладочная функция должна использоваться дважды. В первый раз до выполнения операции, которая может произвести утечку объектов с параметром 1 (включить), затем второй раз после операции с параметром 0 (выключить), после чего функция выводит в консоль информацию по всем объектам, созданным за время операции, оставшимся в памяти после ее окончания. Функция может использоваться только в консольном клиенте.
}}
{{function entry
|name=[[dbgOLEMethodsList]]
|form='''dbgOLEMethodsList'''(''<OLE-объект (OLE)>''):''<Дерево методов и свойств объекта (TREE)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция, позволяет получить внутренний список имен методов и свойств OLE-объекта в виде дерева. Может использоваться, чтобы найти имя метода, если документация недоступна или недостаточно подробна.
}}
{{function entry
|name=[[dbgStackTrace]]
|form='''dbgStackTrace'''():''<Стек вызовов текущего потока (STRING)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает языковый стек вызовов текущего исполняемого потока в виде строки.
}}
{{function entry
|name=[[dbgSysStackTrace]]
|form='''dbgSysStackTrace'''():''<Системный стек вызовов текущего потока (STRING)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает системный стек вызовов текущего исполняемого потока в виде строки. Без наличия соответствующего <code>.map</code> файла клиента, стек будет иметь неописательную информацию.
}}
{{function entry
|name=[[dbgSysStackTraceVisual]]
|form='''dbgSysStackTraceVisual'''():''<Системный стек вызовов визуального потока (STRING)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает системный стек вызовов визуального потока в виде строки. Без наличия соответствующего <code>.map</code> файла клиента, стек будет иметь неописательную информацию. Функция может быть вызвана только для визуального клиента.
}}
{{function entry
|name=[[dbgSysLastExceptionStackTrace]]
|form='''dbgSysLastExceptionStackTrace'''():''<Системный стек вызовов последнего системного исключения (STRING)>''
|type=1
|status=0
|visual=0
|description=Отладочная функция получает системный стек вызовов последнего исключения на уровне системы в виде строки. Без наличия соответствующего <code>.map</code> файла клиента, стек будет иметь неописательную информацию.
}}
{{function entry
|name=[[dbgHRPCAvailable]]
|form='''dbgHRPCAvailable'''():''<Можно ли использовать т.в.т. (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция проверяет, включен ли на данной машине таймер высокой точности (обычно включение происходит в BIOS компьютера).
}}
{{function entry
|name=[[dbgHRPCCurrent]]
|form='''dbgHRPCCurrent'''():''<Текущее значение т.в.т. (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает текущее значение таймера высокой точности. Если таймер не включен на системном уровне, функция возвращает 0.
}}
{{function entry
|name=[[dbgHRPCGetPeriod]]
|form='''dbgHRPCGetPeriod'''(''<Предыдущее значение т.в.т. (INT)>''):''<Прошедшее время в наносекундах (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция получает промежуток времени, прошедший от предыдущего значения таймера высокой точности (заданного аргументом) до текущего момента, выраженное в наносекундах. Если таймер не включен на системном уровне, функция возвращает пустое значение. Перевод периода в секунды можно осуществить по формуле <code><Результат>/1000000000</code>.
}}
{{function entry
|name=[[dbgWriteLog]]
|form='''dbgWriteLog'''(''<Строка лога (STRING)>'')
|type=1
|status=2
|visual=0
|description=Отладочная функция сохраняет информацию в текстовом логе клиента.
}}
{{function entry
|name=[[dbgToFileTime]]
|form='''dbgToFileTime'''(''<Дата (DATE)>''):''<Дата в формате FILETIME (INT)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция превращает дату в 64-битное число в формате FILETIME (формат, в котором система хранит даты).
}}
{{function entry
|name=[[dbgFromFileTime]]
|form='''dbgFromFileTime'''(''<Дата в формате FILETIME (INT)>''):''<Дата (DATE)>''
|type=1
|status=2
|visual=0
|description=Отладочная функция превращает 64-битное число в формате FILETIME (формат, в котором система хранит даты) в дату.
}}
{{function footer}}

=== Объект сторожевого пса ===
Основная характеристика консольных клиентов, работающих в режиме сервера, это их постоянная доступность. Если консольное приложение вызывает внешние функции, есть вероятность зависания, если в этих внешних функциях содержатся ошибки (OLE-объекты могут зависнут, либо, печать на принтер, драйвер которого, может войти в вечный цикл ожидания или вывести сообщение об ошибке на экран, ожидая действия пользователя и пр.). Функции сторожевого пса помогают при появлении зависаний перезапустить программу-клиент. Каждый объект сторожевого пса в активном состоянии работает в отдельном системном потоке, наличие большого количества таких объектов может негативно сказаться на ресурсах системы.
{{function header}}
{{function entry
|name=[[Watchdog.Create|Create]]
|form={{Grey|Watchdog.}}'''Create'''({{Optional|<Режим сторожевого пса (INT)>{{Default|{{Eq}}0}}}}):''<Новый объект сторожевого пса (Watchdog)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый объект сторожевого пса с указанным режимом. Сторожевой пес создается в неактивном состоянии. Для активации необходимо использовать функцию [[Watchdog.Create|Guard]].
}}
{{function entry
|name=[[Watchdog.Guard|Guard]]
|form={{Grey|Watchdog.}}'''Guard'''(''<Количество миллисекунд (INT)>''):''<Сторожевой пес удачно активирован 1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит включение режима сторожевого пса с указанным периодом слежения. Функция может использоваться только в консольном клиенте.
}}
{{function entry
|name=[[Watchdog.Feed|Feed]]
|form={{Grey|Watchdog.}}'''Feed'''()
|type=1
|status=2
|visual=0
|description=Функция обнуляет время ожидания в режиме сторожевого пса. Функция может использоваться только в консольном клиенте. Функция должна исполняться периодически, чтобы пес не инициировал перезагрузку консольного клиента.
}}
{{function entry
|name=[[Watchdog.Sleep|Sleep]]
|form={{Grey|Watchdog.}}'''Sleep'''():''<Сторожевой пес удачно деактивирован 1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит выключение (деактивацию) сторожевого пса. Деактивация будет произведена автоматически в момент удаления объекта из системы, если он был в активном состоянии в момент удаления. Функция может использоваться только в консольном клиенте.
}}
{{function entry
|name=[[Watchdog.Mode|Mode]]
|form={{Grey|Watchdog.}}'''Mode'''
|type=0
|status=2
|visual=0
|description=Атрибут получает или изменяет режим сторожевого пса. Изменения можно производить даже если пес еще не активирован.
}}
{{function entry
|name=[[Watchdog.Active|Active]]
|form={{Grey|Watchdog.}}'''Active'''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает 1, если сторожевой пес активирован, иначе возвращает 0. Атрибут доступен только для чтения.
}}
{{function footer}}

== Функции криптографии ==
Криптографическое функции используются для кодирования информации при пересылке по ненадежным каналам, либо нахождения контрольных сумм или хэшей, используемых в работе с web стандартами.
{{function header}}
{{function entry
|name=[[CreateKeySchedule]]
|form='''CreateKeySchedule'''(''<Стандарт кодирования (STRING)>'',''<Ключ (пароль) (STRING,BUFFER)>''{{Optional|,<Для декодирования (INT)>{{Default|{{Eq}}0}}}}):''<Параметр кодировщика (BUFFER)>''
|type=1
|status=2
|visual=0
|description=Функция позволяет создать из текстового ключа объект, необходимый для кодирования или декодирования информации с помощью этого ключа. В дальнейшем этот объект может использоваться для вызова функций кодирования [[Encrypt]] или декодирования [[Decrypt]]. Первый аргумент задает стандарт кодирования, к примеру, "AES256".
}}
{{function entry
|name=[[Encrypt]]
|form='''Encrypt'''(''<Стандарт кодирования (STRING)>'',''<Информация для кодирования (STRING,BUFFER)>''{{Optional|,''<Параметр кодировщика (расписание кодирования) (BUFFER)>'',<Источник в формате UTF-16 (INT)>{{Default|{{Eq}}0}}}}):''<Закодированная строка или 1>''
|type=1
|status=2
|visual=0
|description=Функция производит кодирование строки или буфера по стандарту, заданному первым аргументом. Размер строки или буфера должен быть кратен определенному количеству байт, заданному стандартом кодирования (к примеру, для AES-256, это число 16); если размер не будет кратен нужному количеству байт, функция вызове исключение. Нужно иметь в виду, что для UTF-16 строк, размер в байтах в два раза больше, чем количество символов в строке. Если первым параметром служит буфер, в результате функция возвратит единицу, а содержимое буфера будет закодировано, если первым параметром была передана строка, функция возвратит ANSI строку.
}}
{{function entry
|name=[[Decrypt]]
|form='''Decrypt'''(''<Стандарт кодирования (STRING)>'',''<Информация для декодирования (STRING,BUFFER)>''{{Optional|,''<Параметр декодировщика (расписание декодирования) (BUFFER)>'',<Результат в формате UTF-16 (INT)>{{Default|{{Eq}}0}}}}):''<Декодированная строка или 1>''
|type=1
|status=2
|visual=0
|description=Функция производит декодирование строки или буфера, закодированных по стандарту, заданному первым аргументом. Размер строки или буфера должен быть кратен количеству байт, заданному стандартом кодирования (к примеру, для AES-256, это число 16); если размер не будет кратен нужному количеству байт, функция вызове исключение. Нужно иметь в виду, что для UTF-16 строк, размер в байтах в два раза больше, чем количество символов в строке. Если первым параметром служит буфер, в результате функция возвратит единицу, а содержимое буфера будет декодировано, если первым параметром была передана строка, функция возвратит ANSI или UTF-16 строку, в зависимости от значения третьего аргумента.
}}
{{function entry
|name=[[CalculateHash]]
|form='''CalculateHash'''(''<Информация для нахождения контрольной суммы (STRING,BUFFER)>''{{Optional|,<Алгоритм (STRING)>{{Default|{{Eq}}"INTERNAL"}},<Завершающий блок (INT)>{{Default|{{Eq}}1}},<Сумма или состояние предыдущего блока (STRING,BUFFER)>,<Дополнительный параметр (STRING)>{{Default|{{Eq}}""}}}}):''<Сумма или текущее состояние (STRING,BUFFER)>''
|type=1
|status=1
|visual=0
|description=Функция подсчет контрольной суммы или хэша буфера или строки по указанному алгоритму, имеется также возможность подсчитать сумму нескольких блоков, как единого целого, вызывая эту функцию для каждого из блоков один раз. В список алгоритмов входят такие, как "MD5", "CRC32", "SHA-1" и пр.
}}
{{function footer}}

== Функции архивации ==
Функции архивации помогают распаковать или упаковать информацию без необходимости использования внешних исполняемых файлов или библиотек. [[StreamCompress]] и [[StreamDecompress]] упаковывают и распаковывают поток данных, не связанный с файлами на диске, позволяя сжимать информацию передаваемую по WEB или создавать сжатые данные произвольного размера.
{{function header}}
{{function entry
|name=[[StreamCompress]]
|form='''StreamCompress'''(''<Данные для упаковки (STRING,BUFFER,TEXT)>''{{Optional|,<Алгоритм (STRING)>{{Default|{{Eq}}"ZLIB"}},<Уровень (INT)>{{Default|{{Eq}}6}},<Завершающий блок (INT)>{{Default|{{Eq}}1}}{{ByRef|,<Словарь упаковки>}}}}):''<Результат упаковки (STRING,BUFFER)>''
|type=1
|status=2
|visual=0
|description=Функция производит упаковку блока данных по заданному алгоритму. Для последовательной упаковки частей одного большого блока данных, функцию необходимо вызвать несколько раз с каждой частью блока данных.
}}
{{function entry
|name=[[StreamDecompress]]
|form='''StreamDecompress'''(''<Данные для распаковки (STRING,BUFFER)>''{{Optional|,<Алгоритм (STRING)>{{Default|{{Eq}}"ZLIB"}},<Завершающий блок (INT)>{{Default|{{Eq}}1}}{{ByRef|,<Словарь распаковки или общий размер упакованного блока (INT,?)>}}}}):''<Результат распаковки (STRING,BUFFER)>''
|type=1
|status=2
|visual=0
|description=Функция производит распаковку блока данных по заданному алгоритму. Для последовательной распаковки частей одного большого блока данных, функцию необходимо вызвать несколько раз с каждой частью блока данных.
}}
{{function footer}}

== Функции штрихкодов и символов ==
Функции штрихкодов и символов позволяют создавать штрихкоды в виду картинок, которые затем можно добавить на форму, напечатать, вывести на web-странице и пр.
{{function header}}
{{function entry
|name=[[Generate1DBarcode]]
|form='''Generate1DBarcode'''(''<Тип штрихкода (STRING)>''{{ByRef|,<Ширина (INT)>,<Высота (INT)>}},''<Кодируемое сообщение (STRING)>''{{Optional|,<Установки (STRING)>}}):''<Результат (PICTURE)>''
|type=1
|status=2
|visual=0
|description=Функция генерирует линейный штрихкод указанного типа с указанными размерами, если необходимо. Параметры генерации настраиваются с помощью дополнительных установок, если необходимо. Функция поддерживает следующие виды штрихкодов: '''Code 128''','''UPC''','''EAN''','''Code 39''','''ISBN''','''Code 93''','''ITF''' (Interleaved 2 of 5),'''MSI''','''Codabar'''.
}}
{{function entry
|name=[[Generate2DBarcode]]
|form='''Generate2DBarcode'''(''<Тип символа (STRING)>''{{ByRef|,<Ширина (INT)>,<Высота (INT)>}},''<Кодируемое сообщение (STRING)>''{{Optional|,<Установки (STRING)>}}):''<Результат (PICTURE)>''
|type=1
|status=1
|visual=0
|description=Функция генерирует двумерный символ указанного типа с указанными размерами, если необходимо. Параметры генерации настраиваются с помощью дополнительных установок, если необходимо. Функция поддерживает следующие виды символов: '''PDF 417''', '''Aztec Code''', '''QR Code''', '''Data Matrix''', '''MaxiCode'''.
}}
{{function entry
|name=[[CountBarcodeCRC]]
|form='''CountBarcodeCRC'''(''<Тип контрольной суммы (STRING)>'',''<Полное кодируемое сообщение (STRING)>''):''<Контрольная сумма (INT,STRING)>''
|type=1
|status=2
|visual=0
|description=Функция используется для случаев, когда кодируемое сообщение разделено на несколько символов (или штрихкодов), при этом необходима контрольная сумма всего сообщения, чтобы программа декодирования смогла проверить корректность результата.
}}
{{function footer}}

== Функции среды исполнения ==
Данная группа функций используется для программного получения информации о разнообразных свойствах среды исполнения, запуска системных приложений и пр.
{{function header}}
{{function entry
|name=[[SysExecNoConsole]]
|form='''SysExecNoConsole'''(''<Командная строка исполнения (STRING)>''{{Optional|,<Не возвращаться до завершения (INT)>{{Default|{{Eq}}0}}}}):''<Код, возвращенный приложением (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит запуск приложения с параметрами в командной строке, подавляя создание консоли при запуске, приложение может находиться на сервере, в этом случае, оно сначала будет перенесено на локальный диск.
}}
{{function entry
|name=[[SysExec]]
|form='''SysExec'''(''<Командная строка исполнения (STRING)>''{{Optional|,<Не возвращаться до завершения (INT)>{{Default|{{Eq}}0}}}}):''<Код, возвращенный приложением (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит запуск приложения с параметрами в командной строке, приложение может находиться на сервере, в этом случае, оно сначала будет перенесено на локальный диск.
}}
{{function entry
|name=[[SysExecNoConsoleLocal]]
|form='''SysExecNoConsoleLocal'''(''<Командная строка исполнения (STRING)>''{{Optional|,<Не возвращаться до завершения (INT)>{{Default|{{Eq}}0}}}}):''<Код, возвращенный приложением (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит запуск приложения с параметрами в командной строке, подавляя создание консоли при запуске, приложение может находиться только на локальном компьютере, разбор командной строки не производится.
}}
{{function entry
|name=[[SysExecLocal]]
|form='''SysExecLocal'''(''<Командная строка исполнения (STRING)>''{{Optional|,<Не возвращаться до завершения (INT)>{{Default|{{Eq}}0}}}}):''<Код, возвращенный приложением (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит запуск приложения с параметрами в командной строке, приложение может находиться только на локальном компьютере, разбор командной строки не производится.
}}
{{function entry
|name=[[SysExecServer]]
|form='''SysExecServer'''(''<Командная строка исполнения (STRING)>''{{Optional|,<Не возвращаться до завершения (INT)>{{Default|{{Eq}}0}}}}):''<Код, возвращенный приложением (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит запуск приложения с параметрами в командной строке на стороне сервера, разбор командной строки не производится. Пользователь должен обладать административными правами для использования этой функции. Также нужно понимать, что запуск с флагом ожидания завершения (второй аргумент) приведет к "зависшей" сессии на сервере, если приложение не будет завершено. Этой функцией следует пользоваться в исключительных обстоятельствах и только когда поведение запускаемого приложения хорошо известно заранее.
}}
{{function entry
|name=[[StdStreamsSysExec]]
|form='''StdStreamsSysExec'''(''<Командная строка исполнения (STRING)>'',{{ByRef|<Буфер с дескрипторами (BUFFER)>}}{{Optional|,<Не возвращаться до завершения (INT)>{{Default|{{Eq}}0}}}}):''<Код, возвращенный приложением (INT)>''
|type=1
|status=0
|visual=0
|description=Функция производит запуск приложения с параметрами в командной строке, подавляя создание консоли при запуске, приложение может находиться на сервере, в этом случае, оно сначала будет перенесено на локальный диск. Переменная, заданная вторым аргументом, получает набор дескрипторов для манипуляции со стандартными потоками и самим приложением. Для закрытия дескрипторов должна быть использована функция [[StdStreamsCloseHandles]]
}}
{{function entry
|name=[[StdStreamsTransfer]]
|form='''StdStreamsTransfer'''(''<Текст для отправки (STRING)>'',''<Буфер с дескрипторами (BUFFER)>'')
|type=1
|status=0
|visual=0
|description=Функция производит выгрузку текста в StdIn потока запущенного ранее приложения.
}}
{{function entry
|name=[[StdStreamsRead]]
|form='''StdStreamsRead'''(''<Буфер с дескрипторами (BUFFER)>''{{Optional|,<StdErr поток (INT)>{{Default|{{Eq}}0}}}}):''<Полученный текст (STRING)>''
|type=1
|status=0
|visual=0
|description=Функция производит получение текста из StdOut или StdErr потоков запущенного ранее приложения.
}}
{{function entry
|name=[[StdStreamsCloseHandles]]
|form='''StdStreamsCloseHandles'''(''<Буфер с дескрипторами (BUFFER)>'')
|type=1
|status=0
|visual=0
|description=Функция закрывает дескрипторы, полученные ранее при запуске приложения. Если не пользоваться этой функцией, в системе будет наблюдаться утечка ресурсов.
}}
{{function entry
|name=[[StdStreamsApplicationExited]]
|form='''StdStreamsApplicationExited'''(''<Буфер с дескрипторами (BUFFER)>''):''<Завершена ли работа приложения (INT)>''
|type=1
|status=0
|visual=0
|description=Функция проверяет, завершена ли работа приложения, идентифицируемого дескрипторами, полученными при его запуске.
}}
{{function entry
|name=[[StdStreamsTerminateApplication]]
|form='''StdStreamsTerminateApplication'''(''<Буфер с дескрипторами (BUFFER)>''):''<Приложение было завершено (INT)>''
|type=1
|status=0
|visual=0
|description=Функция производит попытку завершить работу приложения, идентифицируемого дескрипторами, полученными при его запуске.
}}
{{function entry
|name=[[SysEmulateKeystroke]]
|form='''SysEmulateKeystroke'''(''<Виртуальный код клавиши (INT)>'',''<Произведено нажатие (INT)>'')
|type=1
|status=2
|visual=1
|description=Функция эмулирует нажатие или отпускание клавиши по ее виртуальному коду. Эмуляция производится средствами системы и выполняется даже если окно клиента не является активным окном.
}}
{{function entry
|name=[[SysParamCount]]
|form='''SysParamCount'''():''<Количество параметров командной строки клиента (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает количество параметров, которые были переданы в командной строке при запуске клиента.
}}
{{function entry
|name=[[SysParam]]
|form='''SysParam'''(''<Номер параметра (INT)>''):''<Параметр командной строки (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает параметр командной строки запуска клиента с требуемым номером.
}}
{{function entry
|name=[[SysSetEnvValue]]
|form='''SysSetEnvValue'''(''<Имя переменной (STRING)>'',''<Значение переменной (STRING)>'')
|type=1
|status=0
|visual=0
|description=Функция изменяет переменную системного окружения (environment)
}}
{{function entry
|name=[[SysGetEnvValue]]
|form='''SysGetEnvValue'''(''<Имя переменной (STRING)>''):''<Значение переменной (STRING)>''
|type=1
|status=0
|visual=0
|description=Функция получает значение переменной системного окружения (environment). Если переменная не была установлена, будет возвращена пустая строка.
}}
{{function entry
|name=[[CopyFileToTemp]]
|form='''CopyFileToTemp'''(''<Файл на сервере (STRING)>''):''<Путь и имя файла в локальной временной папке (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция копирует файл во временную папку, отдавая его путь и имя. Исходный файл может находиться на сервере или локальном диске.
}}
{{function entry
|name=[[ClipboardGetText]]
|form='''ClipboardGetText'''({{Optional|<Формат текста буфера (INT)>{{Default|{{Eq}}0}}}}):''<Текст из буфера или пустая строка (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает текст из буфера обмена операционной системы в требуемом формате. При ошибке или отсуствии нужного формата, функция возвращает пустую строку.
}}
{{function entry
|name=[[ClipboardPutText]]
|form='''ClipboardPutText'''(''<Текст (STRING)>''{{Optional|,<Формат текста буфера (INT)>{{Default|{{Eq}}0}}}}):''<Удачно изменен системный буфер (INT)>''
|type=1
|status=2
|visual=0
|description=Функция помещает текст в буфер обмена операционной системы в требуемом формате.
}}
{{function entry
|name=[[ExitProgram]]
|form='''ExitProgram'''({{Optional|<Вопрос о сохранении данных (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=0
|description=Функция позволяет завершить выполнения клиента, по умолчанию, создавая запрос о сохранении текущих форм, требующих сохранения. Все незавершенные транзакции будут либо отменены, либо приняты. Событие [[OnSystemExit]] может отменить действие этой функции.
}}
{{function entry
|name=[[CloseProgram]]
|form='''CloseProgram'''()
|type=1
|status=2
|visual=0
|description=Функция завершает выполнение клиента без каких-либо дополнительных предупреждений и вопросов. Все незавершенные транзации будут отменены в следствии разрыва связи клиентом. Событие [[OnSystemExit]] не будет вызвано.
}}
{{function entry
|name=[[RestartProgram]]
|form='''RestartProgram'''({{Optional|<Мгновенный перезапуск (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=0
|description=Функция может использоваться только для консольного клиента. Если аргумент равен 1, функция завершает выполнение клиента без каких-либо дополнительных предупреждений и вопросов. Все незавершенные транзации будут отменены в следствии разрыва связи клиентом. Событие [[OnSystemExit]] не будет вызвано. В случае, если аргумент равен 0, функция закрывает транзакции корректным образом, событие [[OnSystemExit]] может отменить действие этой функции. После завершения работы клиента, будет произведена попытка его повторного запуска.
}}
{{function entry
|name=[[sysIsTerminalMode]]
|form='''sysIsTerminalMode'''():''<Клиент работает в терминальном режиме (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, запущен ли текущий клиент в терминальном режиме (1), либо в режиме локального компьютера (0).
}}
{{function entry
|name=[[sysTerminalGetComputerName]]
|form='''sysTerminalGetComputerName'''():''<Наименование клиентского компьютера (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция находит наименование клиентского компьютера, с которого он осуществляет работу на терминальном сервере. Если работа не ведется на терминальном сервере, будет возвращена пустая строка.
}}
{{function entry
|name=[[sysLowVideoMemoryMode]]
|form='''sysLowVideoMemoryMode'''({{Optional|<Включить режим экономия видеопамяти (INT)>}}):''<Состояние режима экономии видеопамяти (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает или/и изменяет состояние режима экономии видеопамяти (рекомендуется для терминальных клиентов).
}}
{{function entry
|name=[[MainWindowCaption]]
|form='''MainWindowCaption'''({{Optional|<Заголовок основного окна клиента (STRING)>}}):''<Текущее заголовок основного окна (STRING)>''
|type=1
|status=0
|visual=1
|description=Функция изменяет заголовок основного окна клиента на необходимый.
}}
{{function entry
|name=[[ReturnToForeground]]
|form='''ReturnToForeground'''()
|type=1
|status=0
|visual=1
|description=Функция делает приложение активным и возвращает ему фокус. Функция может пригодиться после модального вызова внешних библиотек или приложений, которые выводят информацию или окна на экран. После завершения такого приложения (в зависимости от его функциональности) окно программы может не быть активировано корректно или вообще быть скрыто.
}}
{{function entry
|name=[[CurrentFormCaption]]
|form='''CurrentFormCaption'''(''<Заголовок текущей формы клиента (STRING)>'')
|type=1
|status=0
|visual=1
|description=Функция изменяет заголовок текущей формы клиента на необходимый. Функция является аналогом функции [[Form.Caption]].
}}
{{function entry
|name=[[ComputerName]]
|form='''ComputerName'''():''<Сетевое имя машины клиента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает сетевое имя машины (компьютера), на которой запущен клиент.
}}
{{function entry
|name=[[UserName]]
|form='''UserName'''():''<Имя учетной записи пользователя на текущей машине (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает имя учетной записи, под которой работает пользователь на текущей машине (компьютере).
}}
{{function entry
|name=[[ServerUserName]], '''LogonName'''
|form='''ServerUserName'''():''<Имя учетной записи сервера базы данных (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает имя учетной записи сервера базы данных под которым работает клиент, если клиент не зарегистрирован на сервере базы данных (локальный клиент), функция может возвратить пустую строку.
}}
{{function entry
|name=[[IsDBAdministrator]]
|form='''IsDBAdministrator'''():''<Уровень административных полномочий клиента (INT)>''
|type=1
|status=2
|visual=0
|description=Функция отдает 0, если клиент зарегистрирован на сервере в режиме обычного пользователя, 1 -- в режиме ограниченного администратора, и 2 -- в режиме администратора (может выполнять привилегированные команды, редактировать учетные записи пользователей и пр.).
}}
{{function entry
|name=[[IsSlowConnection]]
|form='''IsSlowConnection'''():''<Используется медленное соединение (необходима оптимизация) (INT)>''
|type=1
|status=2
|visual=0
|description=Функция отдает 1, если для базы данных активен режим "медленное соединение". В этом режиме клиент будет оптимизировать некоторые запросы к серверу (пытаться уменьшить количество запросов за счет включения нескольких запросов в один), данная функция может служить флагом для программной оптимизации или даже загрузки другого интерфейса для пользователей, работающих по Интернету, а не по локальной сети.
}}
{{function entry
|name=[[ServerName]]
|form='''ServerName'''():''<Внутреннее наименование сервера БД (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает короткое наименование сервера базы данных. Если клиент не зарегистрирован на сервере базы данных (локальный клиент), функция возвратит пустую строку.
}}
{{function entry
|name=[[ServerDescription]]
|form='''ServerDescription'''():''<Внутреннее описание сервера БД (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает описание сервера базы данных. Если клиент не зарегистрирован на сервере базы данных (локальный клиент), функция возвратит пустую строку.
}}
{{function entry
|name=[[DBMSVersion]]
|form='''DBMSVersion'''():''<Версия ПО СУБД сервера базы данных (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает версию ПО СУБД, которая используется сервером базы данных.
}}
{{function entry
|name=[[GetTempDirectory]]
|form='''GetTempDirectory'''():''<Папка временных файлов (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает путь к папке временных файлов. Вне зависимости от прав пользователя в системе, он имеет доступ к чтению и записи внутри такой папки. Папка находится на локальном компьютере.
}}
{{function entry
|name=[[GetDatabaseDirectory]]
|form='''GetDatabaseDirectory'''():''<Путь к файлам текущей локальной конфигурации (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция работает только для локальных клиентов (не связанных с сервером базы данных), и возвращает локальный (или сетевой) путь к файлам текущей конфигурации.
}}
{{function entry
|name=[[GetBinaryDirectory]]
|form='''GetBinaryDirectory'''():''<Путь к папке, из которой запущен исполняемый файл клиента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает путь к папке, из которой запущен исполняемый файл клиента (консольного или визуального).
}}
{{function entry
|name=[[GetUserDirectory]]
|form='''GetUserDirectory'''():''<Путь к личной папке пользователя (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает путь к личной папке пользователя, при наличии подключения к серверу, этот путь указывает на папку на сервере, и выглядит <code>UserSettings\<Имя пользователя>\</code>, если клиент работает без подключения к серверу, этот путь указывает на локальную папку, и будет выглядеть <code><Путь с файлам конфигурации>\UserSettings\<Имя пользователя>\</code>. В данной папке можно хранить установки, предпочтения и другие файлы, связанные с текущим пользователем. Клиент также сохраняет свои установки форм и печати внутри этой папки, поэтому, нельзя рассчитывать, что она будет пустой.
}}
{{function entry
|name=[[CurrentLanguage]]
|form='''CurrentLanguage'''():''<Код текущего языка по умолчанию (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает код текущего языка по умолчанию. Язык по умолчанию используется в функциях прописи и подобных, где есть возможность кодирования на разных языках. Код языка обычно состоит из двух букв (<code>RU,EN...</code>). См. также функцию [[SelectLanguage]].
}}
{{function entry
|name=[[SelectLanguage]]
|form='''SelectLanguage'''(''<Код языка по умолчанию (STRING)>''):''<Код текущего языка по умолчанию (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция изменяет код текущего языка по умолчанию, возвращая предыдущий. Язык по умолчанию используется в функциях прописи и подобных, где есть возможность кодирования на разных языках. Код языка обычно состоит из двух букв (<code>RU,EN...</code>).
}}
{{function entry
|name=[[OSVersion]]
|form='''OSVersion'''():''<Версия операционной системы (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает версию операционной системы, под которой запущен клиент в виде <code><Тип> Version X.X (Build XXXX: <Название пакета обновления>)</code> (к примеру '''Windows Version 6.1 (Build 7601: Service Pack 1)''').
}}
{{function entry
|name=[[ProgramVersion]]
|form='''ProgramVersion'''():''<Версия клиента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает текущую версию клиента в виде <code>X.X (Build: XXXXXX)</code> (к примеру '''1.1 (Build: 190511)'''). Функция работает как для консольных, так и для визуальных клиентов.
}}
{{function entry
|name=[[ProgramMode]]
|form='''ProgramMode'''():''<Тип клиента (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает код типа клиента текущей сессии. 0 -- консольный режим, 1 -- визуальный клиент.
}}
{{function entry
|name=[[ProgramArchitecture]]
|form='''ProgramArchitecture'''():''<Тип архитектуры приложения клиента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает тип архитектуры приложения клиента (к примеру, '''x64''' или '''x86''').
}}
{{function entry
|name=[[PointerSize]]
|form='''PointerSize'''():''<Размер системного указателя в байтах (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает размер системного указателя в байтах. Для x86 размер равен 4, для x64 размер равен 8.
}}
{{function entry
|name=[[ProjectVersion]]
|form='''ProjectVersion'''():''<Номер сборки проекта (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает номер сборки проекта (конфигурации) в виде <code>Build: XXXX</code>.
}}
{{function entry
|name=[[ProjectName]], '''DBCaption'''
|form='''ProjectName'''():''<Наименование проекта (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает наименование проекта (конфигурации), как оно было задано в Студии.
}}
{{function entry
|name=[[DBDescription]]
|form='''DBDescription'''():''<Описание проекта (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает описание проекта (конфигурации), как оно было задано в Студии.
}}
{{function entry
|name=[[ProjectGUID]]
|form='''ProjectGUID'''():''<GUID проекта (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает GUID проекта (конфигурации) в виде <code>{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}</code>
}}
{{function entry
|name=[[UnsupportedServerFeatures]]
|form='''UnsupportedServerFeatures'''():''<Возможности, не поддерживаемые сервером (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает строку с кодами возможностей, не поддерживаемых текущим сервером базы данных. Некоторые серверы могут не поддерживать все возможности, предоставляемые программой, в этом случае, при выполнении запроса к серверу, будет создаваться исключение и запрос не будет выполнен.
}}
{{function entry
|name=[[IsAsyncExecutionMode]]
|form='''IsAsyncExecutionMode'''():''<Текущий контекст асинхронный 1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает 1, если исполнение производится внутри [[Студия/Визуальные события|асинхронного]] визуального события, иначе будет возвращен 0.
}}
{{function entry
|name=[[IsRootThread]]
|form='''IsRootThread'''():''<Результат 0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает 1, если текущая программа исполняется в корневом потоке, иначе будет возвращен 0.
}}
{{function entry
|name=[[IsExecutingInSeparateThread]]
|form='''IsExecutingInSeparateThread'''():''<Результат 0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает 1, если текущая программа исполняется в потоке, созданном функцией [[Mutex.ExecuteFunctionInSeparateThread|ExecuteFunctionInSeparateThread]].
}}
{{function entry
|name=[[IsExecutingInSeparateProcess]]
|form='''IsExecutingInSeparateProcess'''({{OptionalByRef|<Идентификатор процесса (STRING)>}}):''<Результат 0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает 1, если текущая программа исполняется в процессе, созданном функцией [[Mutex.InitializeSeparateProcess|InitializeSeparateProcess]]. Также может получить идентификатор процесса, заданный при его создании.
}}
{{function entry
|name=[[IsExecutingInExternalModule]]
|form='''IsExecutingInExternalModule'''({{OptionalByRef|<Путь и имя файла внешнего объекта (STRING)>}}):''<Результат 0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает 1, если текущая программа исполняется в контексте внешнего объекта (*.sfo). Также функция может получить имя файла объекта, с помощью которого, можно получить сам объект (см. [[ExternalObject.Load]]), если это необходимо.
}}
{{function entry
|name=[[ThreadSerial]]
|form='''ThreadSerial'''():''<Серийный номер (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает уникальный для данной сессии серийный номер потока. Данный серийный номер может использоваться для получения временно-уникального имени семафора или папки для временного хранения данных.
}}
{{function entry
|name=[[ThreadCount]]
|form='''ThreadCount'''():''<Количество программных потоков в текущей сессии (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает количество программных потоков в текущей сессии. После запуска и инициализации клиента, эта функция будет возвращать 1.
}}
{{function entry
|name=[[GetThreadForm]]
|form='''GetThreadForm'''(''<Серийный номер потока (INT)>''):''<Верхнее окно потока (INT)>''
|type=1
|status=2
|visual=1
|description=Функция объект формы для верхнего окна потока, заданного его серийным номером, если поток с указанным серийным номером отсутствует, функция возвращает пустое значение.
}}
{{function entry
|name=[[GetInstalledPrinters]]
|form='''GetInstalledPrinters'''():''<Список принтеров системы (LIST)>''
|type=1
|status=2
|visual=0
|description=Функция получает список текущих принтеров системы. Значениями списка будут строки с наименованиями принтеров, имена списка будут представлены в виде <code><Имя сервера>@<Атрибуты>@<Имя принтера></code>. Подробнее см. описание функции.
}}
{{function entry
|name=[[GetDefaultPrinter]]
|form='''GetDefaultPrinter'''():''<Имя принтера по умолчанию (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает наименование принтера, заданного в системе по умолчанию, либо пустую строку, если такого принтера не существует.
}}
{{function footer}}

== Внешний загружаемый объект ==
Внешние объекты представляют собой файлы с расширением '''sfo''', созданные в [[Общая информация и интерфейс Студии|Студии]]. Файл ''sfo'' является архивом, и содержит набор модулей, форм, таблиц или бинарных файлов, необходимых для выполнения какого-то действия (обработки, отчета и пр.), помещение которого в основном проект по каким-то причинам неудобно или нецелесообразно. Такой внешний объект можно загрузить из главного меню, но иногда необходимо получить программный доступ к файлам объекта, либо запустить модуль и форму объекта из основного проекта. При работе с внешними объектами, полезно знать:
* Файл внешнего объекта находится в памяти системы, пока открыт, по крайней мере, один модуль или одна форма из него, либо существуют переменные, содержащие данный объект. Если объект находится памяти (даже если его открыл пользователь), функция [[ExternalObject.Load]] не будет вызывать его повторной загрузки с диска или сервера, а просто увеличит внутренний счетчик обращений к нему.
* Путь к файлу задается стандартным образом (элементы пути отделяются помощью знаков '''\'''), однако, для элементов пути внутри файла используются уже знаки '''/''' (см. [[Имена файлов]]). К примеру <code>c:\Обработки\Обрабока.sfo/Modules/FreeForms/Таблицы/Table.sft</code>. Для загрузки других модулей и форм объекта из форм самого объекта системный путь к файлу ''sfo'' можно опустить (пример: <code>/Modules/FreeForms/Таблицы/Table.sft</code>), если модуль форма или таблица находятся в той же папке объекта, как и текущий модуль, из которого происходит запрос, достаточно указать знак '''/''', без какого либо дополнительного пути. Стандартную часть <code>/Modules/FreeForms</code> можно пустить, но путь всегда должен начитаться на знак '''/'''.
* См. также функцию [[IsExecutingInExternalModule]], позволяющую определить среду исполнения для внешних объектов.

{{function header}}
{{function entry
|name=[[ExternalObject.FileName|FileName]]
|form={{Grey|ExternalObject.}}'''FileName''':''<Путь и имя файла внешнего объекта (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут позволяет получить путь и имя файла внешнего объекта. Объект должен быть загруженным.
}}
{{function entry
|name=[[ExternalObject.Load|Load]]
|form={{Grey|ExternalObject.}}'''Load'''(''<Путь и имя файла внешнего объекта (STRING)>''):''<Загруженный внешний объект (EXTERNALOBJECT)>''
|type=1
|status=2
|visual=0
|description=Функция загружает (или находит в системе) внешний объект и отдает его, как результат. Если в процессе загрузки произошла ошибка, функция вызывает исключение. Функция может быть вызвана для интерфейса ExternalObject.
}}
{{function entry
|name=[[ExternalObject.DoesFileExist|DoesFileExist]]
|form={{Grey|ExternalObject.}}'''DoesFileExist'''(''<Путь и имя файла внутри объекта (STRING)>''):''<Существует ли указанный файл (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет наличие произвольного файла внутри загруженного внешнего объекта. При указании пути используется разделитель '''/''', начальная часть пути ''Modules/FreeForms'' обязательна к указанию, если файл находится внутри этой ветки (к примеру: <code>Modules/FreeForms/Таблицы/Table.sft</code>).
}}
{{function entry
|name=[[ExternalObject.LoadFileNames|LoadFileNames]]
|form={{Grey|ExternalObject.}}'''LoadFileNames'''(''<Путь и маска для выборки файлов (STRING)>''{{Optional|,<Включать вложенные папки (INT)>{{Default|{{Eq}}0}}}}):''<Список с файлами выборки (LIST)>''
|type=1
|status=2
|visual=0
|description=Функция получает список файлов внутри загруженного внешнего объекта с указанным путем и маской.
}}
{{function entry
|name=[[ExternalObject.FileToString|FileToString]]
|form={{Grey|ExternalObject.}}'''FileToString'''(''<Путь и имя файла файла внутри объекта (STRING)>''{{Optional|,<Кодовая страница (INT)>{{Default|{{Eq}}0}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция загружает указанный файл внешнего объекта в строку, используя указанную кодовую страницу.
}}
{{function entry
|name=[[ExternalObject.FileToBuffer|FileToBuffer]]
|form={{Grey|ExternalObject.}}'''FileToBuffer'''(''<Путь и имя файла файла внутри объекта (STRING)>''):''<Результат (BUFFER)>''
|type=1
|status=2
|visual=0
|description=Функция загружает указанный файл внешнего объекта в буфер.
}}
{{function footer}}

== Объект семафор и многозадачность ==
Семафор -- сложный объект, позволяющий реализовать совокупность методов, для синхронизацию в многозадачном режиме, выполнения частей кода в отдельных потоках и пр. Объект можно применять:
* Как именованный системный объект, позволяющий синхронизировать доступ к файлам и другим внешним ресурсам в пределах одной машины. Пока семафор существует в операционной системе, другая программа, запущенная на той же машине, а также другой программный поток, программы, создавшей семафор, не смогут получить к нему доступ (создать). Такой способ синхронизации позволяет избежать, к примеру, записи в один и тот же временный файл двумя копиями программы. Вторая копия программы, которая не смогла создать семафор с именем файла, может пытаться это сделать с другим именем до тех пор, пока не получится создать семафор.
* Как системное событие, использующееся для синхронизации между потоками в многозадачной среде. Событие имеет два состояния: установлено или сброшено, и позволяет организовать цикл ожидания состояния ''установлено''. Такие циклы используются, чтобы исключить паузу между поступлением команды из другого рабочего потока и началом ее выполнения. Существует также возможность создания цикла ожидания для нескольких семафоров одновременно.
* Как указатель на среду функции, создающийся в момент начала выполнения функции в отдельном потоке. Функции, выполняющиеся в отдельных потоках, являются подчиненными вызвавшему потоку, при завершении основного потока, система автоматически вызывает функцию [[Mutex.TerminateThread|TerminateThread]] для всех работающих в данных момент подчиненных потоков. Поток также завершается автоматически при завершении работы функции.
* Как указатель на среду процесса, создающийся в момент начала выполнения функции в отдельном процессе. Функции, выполняющиеся в отдельных процессах, могут использоваться для изолирования кода исполнения, к примеру когда внешняя библиотека (или OLE объект) работают со сбоями и могут испортить системную память, тем самым вызывая завершение с ошибкой всего процесса клиента. После инициализации режима с помощью функции [[Mutex.InitializeSeparateProcess|InitializeSeparateProcess]], процесс будет находиться в режиме ожидания исполнения, клиент же может периодически вызывать функцию [[Mutex.InterProcessExecuteFunction|InterProcessExecuteFunction]] для исполнения программы в ожидающем процессе. После удаления объекта семафора из системы, подчиненный процесс также будет завершен. Исполнение всегда происходит в синхронном режиме (функция ''InterProcessExecuteFunction'' ожидает окончания исполнения удаленной функции и только после этого возвращает результат), асинхронный режим для большей гибкости при работате планируется в будущем.

{{function header}}
{{function entry
|name=[[Mutex.CreateMutex|CreateMutex]]
|form={{Grey|Mutex.}}'''CreateMutex'''(''<Имя семафора (STRING)>''):''<Ноль или новый объект семафора (INT,MUTEX)>''
|type=1
|status=2
|visual=0
|description=Функция создает именованный семафор с указанным именем, либо возвращает ноль, если семафор с таким именем уже существует в системе. В момент, когда объект будет удален из системы, созданный семафор также удаляется.
}}
{{function entry
|name=[[Mutex.CheckMutex|CheckMutex]]
|form={{Grey|Mutex.}}'''CheckMutex'''(''<Имя семафора (STRING)>''):''<Существует ли семафор (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, существует ли в системе именованный семафор с указанным именем.
}}
{{function entry
|name=[[Mutex.CreateEvent|CreateEvent]]
|form={{Grey|Mutex.}}'''CreateEvent'''({{Optional|<Начальное состояние (INT)>{{Default|{{Eq}}0}}}}):''<Новый объект события (MUTEX)>''
|type=1
|status=2
|visual=0
|description=Функция создает новое системное событие с возможным указанием его начального состояния. Событие может принимать два состояния: ''установлено'' и ''сброшено'', и может использоваться при вызове функций [[Mutex.WaitForEvent|WaitForEvent]] или [[Mutex.WaitForEvents|WaitForEvents]].
}}
{{function entry
|name=[[Mutex.WaitForEvent|WaitForEvent]]
|form={{Grey|Mutex.}}'''WaitForEvent'''({{Optional|<Время ожидания в мс. (INT)>{{Default|{{Eq}}-1}}}}):''<0, если время закончилось, 1, если произошло событие (INT)>''
|type=1
|status=2
|visual=0
|description=Функция выполняет цикл ожидания для текущего события в течение указанного времени (по умолчанию, время не ограничено). Если событие произошло (было ''установлено'' функцией [[Mutex.SignalEvent|SignalEvent]]), функция возвращает 1 и автоматически сбрасывает состояние события.
}}
{{function entry
|name=[[Mutex.WaitForEvents|WaitForEvents]]
|form={{Grey|Mutex.}}'''WaitForEvents'''(''<Список событий (LIST)>''{{Optional|,<Время ожидания в мс. (INT)>{{Default|{{Eq}}-1}}}}):''<0, если время закончилось, иначе индекс произошедшего события (INT)>''
|type=1
|status=2
|visual=0
|description=Функция выполняет цикл ожидания для списка с событиями в течение указанного времени (по умолчанию, время не ограничено). Если одно из событий произошло (было ''установлено'' функцией [[Mutex.SignalEvent|SignalEvent]]), функция возвращает индекс этого события и автоматически сбрасывает его (и только его) состояние. Функция может быть вызвана для интерфейса Mutex.
}}
{{function entry
|name=[[Mutex.SignalEvent|SignalEvent]]
|form={{Grey|Mutex.}}'''SignalEvent'''()
|type=1
|status=2
|visual=0
|description=Функция меняет состояние текущего события на ''установлено''.
}}
{{function entry
|name=[[Mutex.ResetEvent|ResetEvent]]
|form={{Grey|Mutex.}}'''ResetEvent'''()
|type=1
|status=2
|visual=0
|description=Функция меняет состояние текущего события на ''сброшено''. Функция не рекомендуется к использованию (так как есть вероятность потерять одно событие), кроме как внутри конструкции блокировки объекта с помощью [[LockObject]] и проверке [[Mutex.EventState|EventState]] до ее вызова.
}}
{{function entry
|name=[[Mutex.EventState|EventState]]
|form={{Grey|Mutex.}}'''EventState'''():''<0, если сброшено, 1, если установлено (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает текущее состояние события, при этом состояние не изменяется.
}}
{{function entry
|name=[[Mutex.ExecuteFunctionInSeparateThread|ExecuteFunctionInSeparateThread]]
|form={{Grey|Mutex.}}'''ExecuteFunctionInSeparateThread'''(''<Имя функции (STRING)>''{{Optional|,<Глубина поиска или компилированная функция (INT, COMPILEDFUNCTION)>{{Default|{{Eq}}0}},<Аргумент 1>,<Аргумент 2>...}}):''<Указатель на среду функции (MUTEX)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый поток для указанной функции, поток будет создан, как подчиненный текущему и будет автоматически завершен, если выполнение функции завершится (в т.ч. из-за исключения), либо если основной поток будет завершен. При завершении подчиненного потока, система не ждет полного окончания завершения, так как оно может занять продолжительное время, если функция выполняет внешний вызов OLE и пр., чтобы убедиться, что поток завершен, можно использовать функцию [[Mutex.TerminateThread|TerminateThread]]. Функция может быть вызвана для интерфейса Mutex.
}}
{{function entry
|name=[[Mutex.TerminateThread|TerminateThread]]
|form={{Grey|Mutex.}}'''TerminateThread'''({{Optional|<Без ожидания (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция безусловно завершает выполнение подчиненного потока, с ожиданием окончания завершения, если необходимо. При завершении потока, будут выполнены все вложенные конструкции ''Finally'', как будто поток был завершен по требованию пользователя.
}}
{{function entry
|name=[[Mutex.IsThreadActive|IsThreadActive]]
|form={{Grey|Mutex.}}'''IsThreadActive'''():''<Исполняется ли текущий поток (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, работает ли адресуемый текущим объектом подчиненный поток (1), либо он уже завершен (0).
}}
{{function entry
|name=[[Mutex.InitializeSeparateProcess|InitializeSeparateProcess]]
|form={{Grey|Mutex.}}'''InitializeSeparateProcess'''({{Optional|<Идентификатор процесса (STRING)>,<Скомпилированная функция или текст модуля (STRING, COMPILEDFUNCTION)>}}):''<Указатель на среду процесса (MUTEX)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый процесс для указанного модуля (или текущего, если модуль не указан). Процесс может быть создан как для визуального, так и для консольного клиента. После инициализации, процесс ожидает выполнения функций, доступных для указанного модуля. Процесс завершается автоматически, когда объект семаформа будет удален. Функция может быть вызвана для интерфейса Mutex.
}}
{{function entry
|name=[[Mutex.InterProcessExecuteFunction|InterProcessExecuteFunction]]
|form={{Grey|Mutex.}}'''InterProcessExecuteFunction'''(''<Имя функции (STRING)>''{{OptionalByRef|,<Аргумент 1>,<Аргумент 2>...}}):''<Результат исполнения функции>''
|type=1
|status=2
|visual=0
|description=Функция вызывает исполнение указанной функции в подчиненном процессе, созданном ранее функцией [[Mutex.InitializeSeparateProcess|InitializeSeparateProcess]], и возвращает ошибку или результат ее исполнения. При вызове в функцию разрешено передавать объекты произвольного вида (однако, есть определенные особенности для которых см. описание), изменяемые аргументы-переменные также могут быть обновлены после исполнения.
}}
{{function entry
|name=[[Mutex.InterProcessTimeout|InterProcessTimeout]]
|form={{Grey|Mutex.}}'''InterProcessTimeout'''({{Optional|<Тайм-аут в мс.>}}):''<Предыдущий тайм-аут в мс. (INT)>''
|type=1
|status=2
|visual=0
|description=Функция включает сторожевого пса для контроля зависания подчиненного процесса. Процесс будет считаться неработоспособным, если за указанное время основной поток исполнения ни разу не ответил на запрос о состоянии (основной поток создает такие ответы после исполнения каждой команды, а также в моменты бездействия).
}}
{{function entry
|name=[[InterProcessServerTimeout]]
|form='''InterProcessServerTimeout'''({{Optional|<Тайм-аут в мс.>}}):''<Предыдущий тайм-аут в мс. (INT)>''
|type=1
|status=2
|visual=0
|description=Функция позволяет получать или изменять тайм-аут сторожевого пса родительского процесса на стороне подчиненного процесса. Это позволяет, к примеру, для более длительных операций увеличить тайм-аут или временно отключить его.
}}
{{function entry
|name=[[Mutex.TerminateProcess|TerminateProcess]]
|form={{Grey|Mutex.}}'''TerminateProcess'''({{Optional|<Без ожидания (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция безусловно завершает выполнение подчиненного процесса, с ожиданием окончания завершения, если необходимо.
}}
{{function entry
|name=[[Mutex.IsProcessActive|IsProcessActive]]
|form={{Grey|Mutex.}}'''IsProcessActive'''():''<Активен ли подчиненный процесс (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, активен ли (не завершился ли) адресуемый текущим объектом подчиненный процесс.
}}
{{function footer}}

{{Объекты}}

Форма

2025-12-27T17:09:03Z

Admin: 1 revision imported

{{infobox object
|object=Form, Menu
|status=2
|create=[[Form (Interface)|Form]],[[Форма#Функции и атрибуты объекта главного меню|Menu]]...}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]}}

__TOC__
Объект '''форма''' используется для доступа к объектам формы, и позволяет менять их положение, текст, видимость, доступность и прочие свойства, объект также дает доступ к разнообразным визуальным свойствам форм (таким как заголовок окна, флаг изменения данных формы, редактируемый объект и пр.), позволяет сменить текущую форму, сохраняя все данные, измененные пользователем, вызывать визуальные события, сохранять или загружать состояние формы и пр. В большинстве случаев, объект формы используется при работе визуального клиента, однако, некоторые функции могут быть полезны также в консольном клиенте.
Объект формы оперирует внутрисистемным понятием формы, связанным с рабочим потоком. При создании, каждый поток имеет свой выделенный объект формы, даже если на экран не выведено визуальное окно с полями редактирования. При вызове функций, создающих новую модальную форму (к примеру, [[SelectObject]] или [[LoadModule]] в нужном режиме), в массив форм текущего потока добавляется дочерняя форма, при выводе табличных форм отчетов или тестовых файлов, в структуру подчинения текущей формы также будет добавлена дочерняя форма с таблицей или текстом. Функции, типа [[Form.GetParentForm|GetParentForm]] или [[Form.GetChildForm|GetChildForm]] позволяют получать доступ к дочерним или родительским формам текущей формы. Каждая форма имеет свой серийный номер, уникальный в пределах текущей сессии для всех потоков клиента. Этот номер (доступный с помощью атрибута [[Form.SerialNumber|SerialNumber]]) можно использовать, к примеру, для создания уникальной идентификации текущей рабочей формы, в семафорах, именах файлов и пр.
Для работы со свойствами формы и свойствами элементов формы обычно используется прямое обращение к интерфейсу [[Form|Form]], к которому применимы все функции и атрибуты, применимые к объекту формы. При вызове таких функций, интерфейс будет указывать на текущую рабочую форму потока (к примеру, <code>Form.Control("Таблица")</code>). Однако, интерфейс не хранит данных или ссылок, при помещении его в переменную и вызове в другом потоке, он будет указывать уже на другую форму, являющуюся рабочей для этого потока , поэтому, он применяется исключительно для работы с текущей формой, не имеет смысла его передача или хранение. Чтобы получить доступ к объекту текущей формы, который будет указывать на определенную форму вне зависимости от того, где произошел вызов, используйте, к примеру, функцию [[Form.ThisForm|ThisForm]]. Полученные с использованием интерфейса объекты элементов формы ([[Form.Control]]) уже являются самостоятельными объектами и могут передаваться в другие потоки.
Особым типом экранных форм является форма, открытая в режиме инструментария. Такие формы могут быть загружены как для текущего потока, так и для корневого потока. Формы в подобном режиме не имеют загруженного модуля, вся выполняемая работа должна происходить в обработчиках визуальных событий (к примеру, в обработчиках нажатия на кнопку). Формы обычно не имеют доступа к переменным модуля (так как они могут быть открыты в контексте разных модулей, поэтому, для хранения необходимых данных, может использоваться, к примеру, атрибут [[Form.Tag|Tag]], привязанный к определенному элементу формы, функции типа [[Form.StorageGetValue|StorageGetValue]], [[Form.StorageSetValue|StorageSetValue]], либо глобальные переменные. Формы, загруженные в режиме инструментария, для текущего потока будут закрыты по требованию пользователя, либо при закрытии самого потока. Формы, загруженные глобально, будут закрыты по требованию пользователя, либо при окончании работы системы.
Частным случаем открытия формы в режиме инструментария для текущего потока является режим всплывающего окна. В этом режиме форма существует только до тех пор, пока не потеряет фокус, после чего закрывается. Данный режим удобен для создания сложных всплывающих окон, когда простое меню ([[List.Select]]) не имеет достаточной гибкости для выполнения задуманной функции выбора.
===Порядок загрузки форм, и его влияние на доступность функций интерфейса в разные этапы загрузки===
Загрузка визуальных форм в визуальных и консольных клиентах происходит по следующему алгоритму (см. также описание [[LoadModule]]):
* Создание нового внутреннего объекта формы, подчиненной родительской, если создается модельное окно. Форма на этом этапе не имеет визуального представления на экране.
* Создание новых переменных для среды исполнения (''Param'', ''Option'', ''ModalResult'')
* Загрузка модуля формы в формате ''sfc'' (или ''sf'', если первый отсутствует). Если внешний файл уже загружался ранее и не изменялся с тех пор, загрузка будет производиться из внутреннего буфера, для оптимизации скорости загрузки.
* Выполнение загруженного модуля (который может создавать и изменять переменные, однако, визуальный контекст формы пока не доступен). На данном этапе возможно обращение к интерфейсу формы только для некоторых функций и атрибутов, к примеру, [[Form.Type|Type]], [[Form.IsFullyInitialized|IsFullyInitialized]], [[Form.Mode|Mode]], [[Form.Object|Object]] и пр. Если при выполнении модуля возникнет исключение, загрузка формы продолжена не будет.
* Выполнение функции [[OnOpen]], если она присутствует в загруженном модуле. Для выполняемого кода действуют ограничения, описанные в предыдущем пункте. Если при выполнении функции возникнет исключение, либо функция возвратит ноль, загрузка формы продолжена не будет. Данный этап является последним для консольных клиентов, также как и для для модулей, не имеющих форм.
** Для консольного клиента вызывается также функция [[OnConsoleWork]], если таковая присутствует.
** После того, как функция закончит работу, будет вызвана функция ''OnExit'', если она существует, если функция возвратит ноль, система снова вызовет [[OnConsoleWork]].
* Загрузка файла формы в формате ''sfgc'' (или ''sfg'', если первый отсутствует), см. выше информацию для ''sfc''. Если файл формы отсутствует, будет вызвано исключение и загрузка продолжена будет.
* Создание и заполнение визуального объекта формы из загруженного файла формы, при ошибке импорта, система создает исключение и загрузка продолжена будет.
* Выполнение функции [[OnPostOpen]], если она присутствует в загруженном модуле. См. комментарии для функции [[OnOpen]].
* Вывод формы на экран, создание кнопки на панели задач системы, вызов визуального события [[Студия/Визуальные события|''OnOpen'']], заполнение таблиц формы информацией из базы данных, вызов сопутствующих событий, типа [[OnInitLine]]. События, вызываемые на данном этапе, могут свободно оперировать всеми визуальными свойствами формы. Однако, функция [[Form.IsFullyInitialized|IsFullyInitialized]] будет по-прежнему возвращать ноль.
* Устанавливается флаг того, что форма полностью загружена, функция [[Form.IsFullyInitialized|IsFullyInitialized]] будет в дальнейшем возвращать единицу.
* При закрытии визуальной формы:
** Если на форме установлен флаг изменения, будет задан вопрос о целесообразности потери данных.
** Будет вызвано визуальное событие ''OnClose'' внутри которого можно отменить закрытие формы.
** Будет произведено автоматическое сохранение установок формы, если это предусмотрено ее свойствами.
** Будет произведено удаление визуальных элементов и объектов языка, связанных с формой.
===Наследование форм===
При создании нового потока создается также новая виртуальная форма. В момент, когда происходит загрузка файла формы, форма становится визуальной. Если форма, в процессе работы, создает новые табличные ([[Table.Show]]) или текстовые формы, они будут ассоциированы с текущей формой, как дочерние. При закрытии текущей формы, текущий модуль и поток не будут закрыты до тех пор, пока не закрыты все дочерние табличные или иные формы. Это связано с тем, что табличная форма может иметь интерактивные элементы, обработка которых осуществляется с помощью функций локального модуля (см. к примеру, событие [[OnDoubleClick]]), удаление модуля из памяти сделало бы обработку таких событий невозможным. Если форма создает другую форму в модальном режиме (см. [[LoadModule]]), новая форма также становится дочерней формой текущей, и текущая форма будет недоступна для работы до тех пор, пока не закрыта новая модальная форма и все ее дочерние формы.
В определенных случаях, такое сложное подчинение может создать некорректную ситуацию, когда для подчиненной формы были открыты табличные формы (печатные формы), не являющиеся интерактивными, форма была закрыта, однако система не позволяет пользователю продолжить работу с формой верхнего уровня, так как у подчиненной формы остались открытые табличные формы, что не позволило закрыть модуль подчиненной формы и отдать управление материнской. Это помешает работе пользователя. Чтобы избежать такой ситуации, можно использовать функцию [[Form.Destroy|Destroy]] вместо [[Form.Close|Close]] при закрытии формы. Это позволит перенести все созданные свободные табличные формы в подчинение родительской формы. Как альтернатива, можно либо использовать функцию [[Table.ShowOnParent]] вместо [[Table.Show]] при выводе печатных форм на экран.

==Функции и атрибуты объекта формы или элемента формы==
Функции и атрибуты этой группы применяются к объекту формы или интерфейсу формы. Для получения объекта формы из объекта элемента формы, можно применить функцию [[Form.Form|<Элемент>.Form()]].
{{function header}}
{{function entry
|name=[[Form (Interface)|Form]]
|form='''Form''':''<Интерфейс формы, по умолчанию обращающийся к текущей форме потока (INTERFACE)>''
|type=0
|status=2
|visual=1
|description=Интерфейс формы позволяет использовать обычные функции, доступные для объекта формы. При работе с интерфейсом, он всегда указывает на текущую форму того потока, в котором он был вызван. Чтобы получить неизменяемую ссылку на текущую форму, используйте функцию [[Form.ThisForm|ThisForm]].
}}
{{function entry
|name=[[Form.ThisForm|ThisForm]]
|form={{Grey|Form.}}'''ThisForm'''():''<Объект текущей формы потока (FORM)>''
|type=1
|status=2
|visual=1
|description=Функция получает ссылку на текущую форму потока, если она была использована совместно с интерфейсом формы, либо на форму, связанную с текущим объектом (к примеру, если объект адресует визуальный элемент формы).
}}
{{function entry
|name=[[Form.IsForm|IsForm]]
|form={{Grey|Form.}}'''IsForm'''():''<Является ли визуальный объект формой (INT)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает единицу, если визуальный объект адресует форму, иначе функция возвращает ноль (объект адресует элемент формы или макрос).
}}
{{function entry
|name=[[Form.ControlName|<Наименование элемента формы>]]
|form={{Grey|Form.}}'''<Наименование элемента формы>''':''<Визуальный объект формы по его наименованию (FORM)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает визуальный элемент текущей формы по его наименованию (наименование задается при редактировании формы в Студии, по умолчанию элементы не имеют наименований). Если визуальный элемент не существует, будет вызвано исключение.
}}
{{function entry
|name=[[Form.Control|Control]], '''ControlByName'''
|form={{Grey|Form.}}'''Control'''(''<Наименование визуального элемента с наименованием макроса, если необходимо (STRING)>''):''<Найденный визуальный элемент или ноль (FORM,INT)>''
|type=1
|status=2
|visual=1
|description=Функция получает визуальный элемент текущей формы по его наименованию (наименование задается при редактировании формы в Студии, по умолчанию элементы не имеют наименований). При указании наименования, можно также указать наименование элемента макроса, в который включен искомый элемент. Наименование макроса следует первым, затем после точки задается наименование элемента. Если визуальный элемент не найден, функция возвращает ноль.
}}
{{function entry
|name=[[Form.AddControl|AddControl]]
|form={{Grey|Form.}}'''AddControl'''(''<Тип визуального элемента (INT)>''{{Optional|,<Имя элемента (STRING)>,<Значение элемента>,<Якоря элемента (INT)>}},''<Координаты элемента (STRING)>''{{Optional|,<Параметры элемента (LIST)>,<События элемента (LIST)>}}):''<Созданный визуальный элемент (FORM)>''
|type=1
|status=2
|visual=1
|description=Функция создает и помещает на форму новый визуальный элемент с указанными параметрами и событиями.
}}
{{function entry
|name=[[Form.Type|Type]]
|form={{Grey|Form.}}'''Type'''():''<Тип формы (INT)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает тип адресуемой объектом формы. Возможны следующие значения: -1 - форма не имеет визуального окна, либо окно пока не было создано, 0 - обычная визуальная форма, 1 - свободная табличная форма (SFT), 2 - свободная текстовая форма, 1000 - другая неизвестная форма. Атрибут может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.ToolMode|ToolMode]]
|form={{Grey|Form.}}'''ToolMode'''():''<Тип формы инструментария (INT)>''
|type=1
|status=2
|visual=1
|description=Функция получает тип адресуемой формы. Возможные следующие значения: '''-1''' -- данная форма не загружена в режиме инструментария, '''0''' -- данная форма является глобальным инструментарием, '''1''' -- данная форма является локальным инструментарием, '''2''' -- данная форма загружена в режиме всплывающего окошка, '''10''' -- данная форма загружена в режиме модального диалога (не инструментальная форма). Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.Mode|Mode]]
|form={{Grey|Form.}}'''Mode'''():''<Режим загрузки формы (INT)>''
|type=1
|status=2
|visual=1
|description=Функция получает индекс рабочего режима формы. Возможные следующие значения: '''0''' -- обычный режим загрузки, '''1''' -- форма загружена в режиме выбора значения (см. [[SelectObject]], [[MassSelectObjects]]), '''2''' -- форма загружена в режиме инструментария или режиме диалога, '''3''' -- форма загружена в режиме редактирования объекта базы данных, '''4''' -- форма загружена в режиме просмотра объекта базы данных (редактирование запрещено). Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.MassSelectMode|MassSelectMode]]
|form={{Grey|Form.}}'''MassSelectMode'''():''<Форма загружена в режиме множественного выбора (INT)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает единицу, если форма загружена в режиме множественного выбора (см. [[MassSelectObjects]]), иначе возвращается ноль. Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.IsActive|IsActive]]
|form={{Grey|Form.}}'''IsActive'''():''<Активная ли форма в данный момент (INT)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает 1, если выбранная форма активна в данный момент (имеет фокус), иначе возвращается 0. Функция не может быть вызвана из интерфейса, так как интерфейс обычно указывает на активное окно потока, это может явиться причиной неверной логики.
}}
{{function entry
|name=[[Form.DoSelectObject|DoSelectObject]], '''SelectObject'''
|form={{Grey|Form.}}'''DoSelectObject'''(''<Выбранный объект (DB)>'')
|type=1
|status=2
|visual=1
|description=Функция работает для форм, загруженных в режиме выбора объекта (см. [[SelectObject]], [[MassSelectObjects]]) и позволяет программно эмулировать событие, когда клиент осуществил выбор объекта. В процессе фиксации выбора, для случая множественного выбора, система вызывает функцию выбора объекта, которая была задана в момент вызова [[MassSelectObjects]]. Для случая простого выбора ([[SelectObject]]) по окончании выбора форма будет закрыта.
}}
{{function entry
|name=[[Form.Object|Object]], '''Value''', '''EditObject'''
|form={{Grey|Form.}}'''Object''':''<Объект редактирования формы (DB)>''
|type=0
|status=2
|visual=0
|description=Атрибут используется для форм, открытых в режиме редактирования или просмотра объекта базы данных ([[OpenObject]]) и позволяет получить редактируемый (или просматриваемых) в данный момент объект. Атрибут может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.IsResizable|IsResizable]]
|form={{Grey|Form.}}'''IsResizable''':''<Режим изменения размеров элементов формы (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает или устанавливает режим изменения размеров всех элементов на форме при изменении размеров формы. 1 - изменение размеров разрешено, иначе запрещено. Атрибут используется только для загруженных визуальных форм.
}}
{{function entry
|name=[[Form.IsVisible|IsVisible]]
|form={{Grey|Form.}}'''IsVisible''':''<Форма отображается на экране (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает 1, если форма отображается на экране и 0 в другом случае (форма может быть загружена, но еще не выведена на экран). Атрибут используется только для загруженных визуальных форм.
}}
{{function entry
|name=[[Form.IsFullyInitialized|IsFullyInitialized]]
|form={{Grey|Form.}}'''IsFullyInitialized''':''<Форма загружена и инициализирована (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут возвращает 1, если форма загружена, выведена на экран и прошла полный цикл начальной инициализации (см. описание [[Форма]]), иначе возвращается ноль. Атрибут может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.DisableControls|DisableControls]]
|form={{Grey|Form.}}'''DisableControls'''(''<Сделать недоступными элементы формы или подчиненные элементы элемента формы (INT)>'')
|type=1
|status=2
|visual=1
|description=Функция используется для группового изменения доступности всех элементов формы (при вызове функции с объектом формы) или элементов, находящихся на выбранной закладке группы страниц. Чтобы сделать элементы недоступными, первый аргумент должен быть равен единице, чтобы вернуть элементы в доступное состояние, нулю. Функция используется только для загруженный визуальных форм. Флаг доступности, используемый этой функцией, не изменяется функциями, типа [[Form.IsDisabled|IsDisabled]], поэтому, запрещая доступность формы с помощью этой функции можно не опасаться, что во время инициализации, отдельные элементы формы снова станут доступными.
}}
{{function entry
|name=[[Form.Caption|Caption]]
|form={{Grey|Form.}}'''Caption''':''<Заголовок формы (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет заголовок текущей формы. Атрибут используется только для загруженных визуальных форм.
}}
{{function entry
|name=[[Form.Count|Count]]
|form={{Grey|Form.}}'''Count'''():''<Количество форм верхнего уровня (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает количество форм верхнего уровня (включая виртуальную форму корневого потока). Обычно количество таких форм совпадает с количеством рабочих потоков в системе (даже если эти потоки не имеют визуальных форм на экране). Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.GetForm|GetForm]]
|form={{Grey|Form.}}'''GetForm'''(''<Индекс формы верхнего уровня (INT)>''):''<Объект формы (FORM)>''
|type=1
|status=2
|visual=0
|description=Функция получает объект формы верхнего уровня по ее индексу. Объект виртуальной формы корневого потока всегда имеет индекс 1. Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.Handle|Handle]]
|form={{Grey|Form.}}'''Handle''':''<Системный указатель на окно (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут отдает системный указатель текущего окна или визуальный элемент окна. Указатель можно использовать в системных вызовах (к примеру, функция Windows ''PostMessage'').
}}
{{function entry
|name=[[Form.SerialNumber|SerialNumber]]
|form={{Grey|Form.}}'''SerialNumber''':''<Порядковый (серийный) номер визуальной формы (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает порядковый (серийный) номер визуальной формы, который в дальнейшем может использоваться для ее уникальной идентификации. Номер является уникальным для текущей сессии для всех уже созданных или закрытых форм, а также форм, которые могут быть созданы в будущем. Атрибут используется только для загруженных визуальных форм, поток без визуальной формы не имеет серийного номера формы (но имеет серийный номер потока см. [[ThreadSerial]]). В одном потоке могут быть инициализированы несколько форм, каждая будет иметь свой уникальный номер.
}}
{{function entry
|name=[[Form.ChildrenCount|ChildrenCount]]
|form={{Grey|Form.}}'''ChildrenCount'''():''<Количество дочерних форм текущей формы (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает количество дочерних форм текущей формы. Форма может быть не выведена на экран. Дочерними формами могут быть, к примеру окна с текстом, окна с таблицами (печатные формы), формы, открытые в модальном режиме (см. [[LoadModule]]). В список дочерних форм не включаются формы, открытые в режиме окна инструментария (см. [[LoadToolForm]]). Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.GetChildForm|GetChildForm]]
|form={{Grey|Form.}}'''GetChildForm'''(''<Индекс дочерней формы (INT)>''):''<Объект дочерней формы (FORM)>''
|type=1
|status=2
|visual=0
|description=Функция получает дочернюю форму текущей формы по ее индексу. Форма может быть не выведена на экран. Дочерними формами могут быть, к примеру окна с текстом, окна с таблицами (печатные формы), формы, открытые в модальном режиме (см. [[LoadModule]]). В список дочерних форм не включаются формы, открытые в режиме окна инструментария (см. [[LoadToolForm]]). Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.GetParentForm|GetParentForm]]
|form={{Grey|Form.}}'''GetParentForm'''():''<Родительская форма текущей формы или пустое значение (FORM)>''
|type=1
|status=2
|visual=0
|description=Функция получает родительскую форму текущей формы, либо возвращает пустое значение, если текущая форма является формой верхнего уровня. Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.ToolWindowsCount|ToolWindowsCount]]
|form={{Grey|Form.}}'''ToolWindowsCount''':''<Количество дочерних форм в режиме инструментария (INT)>''
|type=1
|status=2
|visual=1
|description=Функция получает количество дочерних форм текущей формы, загруженных в режиме инструментария. Форма может быть не выведена на экран. Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.GetToolWindow|GetToolWindow]]
|form={{Grey|Form.}}'''GetToolWindow'''(''<Индекс дочерней формы, загруженной в режиме инструментария (INT)>''):''<Объект дочерней формы (FORM)>''
|type=1
|status=2
|visual=1
|description=Функция получает дочернюю форму текущей формы, загруженную в режиме инструментария, по ее индексу. Форма может быть не выведена на экран. Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.SwitchToForm|SwitchToForm]]
|form={{Grey|Form.}}'''SwitchToForm'''(''<Наименование формы (STRING)>''{{Optional|,<Не загружать данные текущей формы в новую форму (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=1
|description=Функция позволяет загрузить форму с указанным именем вместо загруженной в данный момент формы. При загрузке формы, поля редактирования с одинаковыми именами будут сохранять свое содержимое. Для новых полей будет использовано содержимое по умолчанию (если они связаны с реквизитами объекта базы данных, они будут загружены из базы данных). Инициализацию визуальных элементов значениями текущей формы можно при необходимости отключить. Форма теряет признак полной загрузки ([[Form.IsFullyInitialized|IsFullyInitialized]]) на время загрузки.
}}
{{function entry
|name=[[Form.Close|Close]]
|form={{Grey|Form.}}'''Close'''({{Optional|<Задавать вопрос о сохранении данных (INT)>{{Default|{{Eq}}1}},<Запретить автоматическое сохранение настроек формы (INT)>{{Default|{{Eq}}0}}}}):''<Закрытие разрешено, форма закрывается (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выполняет закрытие текущей формы. Если форма имеет флаг изменения, будет задан вопрос о целесообразности закрытия формы без сохранения данных (вопрос можно отключить). Также можно запретить автоматическое сохранение настроек формы, если таковое предусмотрено установками формы. Пользователь может отказать в закрытии формы, либо обработчики событий, типа [[Студия/Визуальные события|''OnClose'']] могут отменить попытку закрытия. В случае, если форму не удалось закрыть, функция возвращает 0, иначе 1. В случае успешного выполнения функции, форма не будет закрыта до тех пор, пока текущий код не закончит исполнение, так как внутри кода могут быть другие вызовы к элементам и свойствам формы. Если код не возвращает управление слишком долгое время, система производит отмену закрытия формы, форма закрыта не будет. Из-за такого механизма защиты, рекомендуется после вызова функции закрытия сразу же выйти из исполняемого модуля.
}}
{{function entry
|name=[[Form.Destroy|Destroy]]
|form={{Grey|Form.}}'''Destroy'''({{Optional|<Задавать вопрос о сохранении данных (INT)>{{Default|{{Eq}}1}},<Запретить автоматическое сохранение настроек формы (INT)>{{Default|{{Eq}}0}}}}):''<Закрытие разрешено, форма закрывается (INT)>''
|type=1
|status=2
|visual=1
|description=Функция выполняет закрытие текущей формы. Если форма имеет флаг изменения, будет задан вопрос о целесообразности закрытия формы без сохранения данных (вопрос можно отключить). Также можно запретить автоматическое сохранение настроек формы, если таковое предусмотрено установками формы. Пользователь может отказать в закрытии формы, либо обработчики событий, типа [[Студия/Визуальные события|''OnClose'']] могут отменить попытку закрытия. В случае, если форму не удалось закрыть, функция возвращает 0, иначе 1. В случае успешного выполнения функции, форма не будет закрыта до тех пор, пока текущий код не закончит исполнение, так как внутри кода могут быть другие вызовы к элементам и свойствам формы. Если код не возвращает управление слишком долгое время, система производит отмену закрытия формы, форма закрыта не будет. Из-за такого механизма защиты, рекомендуется после вызова функции закрытия сразу же выйти из исполняемого модуля. В отличии от функции [[Form.Close|Close]], данная функция также переносит все простые дочерние формы (таблицы, текстовые формы и пр.) в подчинение родительской формы, если таковая существует. Это позволяет закрыть модальный модуль текущей формы и перейти к исполнению формы-родителя. См. описание [[Форма]].
}}
{{function entry
|name=[[Form.IsChanged|IsChanged]]
|form={{Grey|Form.}}'''IsChanged'''({{Optional|<Установить флаг изменения формы (INT)>}}):''<Текущий флаг изменения формы (INT)>''
|type=1
|status=2
|visual=1
|description=Функция получает, устанавливает или снимает флаг изменения формы. Флаг изменения может быть установлен только для загруженных визуальных форм, при изменении флага также изменяется заголовок формы (если он не изменялся программой), к заголовку добавляется признак изменения. После изменения также гарантирован вызов визуального события [[Студия/Визуальные события|''OnStatusChange'']], если таковое было объявлено.
}}
{{function entry
|name=[[Form.CallOnStatusChange|CallOnStatusChange]]
|form={{Grey|Form.}}'''CallOnStatusChange'''()
|type=1
|status=2
|visual=1
|description=Функция инициирует визуальное событие [[Студия/Визуальные события|''OnStatusChange'']], если таковое было объявлено для формы. Функция не дожидается начала выполнения события, а просто устанавливает флаг в необходимости его выполнения. Функция используется только для загруженных визуальных форм.
}}
{{function entry
|name=[[Form.CurrentEventControl|CurrentEventControl]]
|form={{Grey|Form.}}'''CurrentEventControl'''():''<Элемент формы, инициировавший событие (FORM)>''
|type=1
|status=2
|visual=1
|description=Функция получает элемент формы, который был активным в момент вызова текущего визуального события, если такой элемент не определен, функция возвращает пустое значение. Если она вызывается не из визуального события, результат функции не определен. Для [[Студия/Визуальные события|визуальных событий]] ''OnOpen'', ''OnReopen'', ''OnSaveRequest'' и ''OnStatusChange'', функция будет возвращать объект макроса, для которого было инициировано это событие, если событие инициировано для самой формы, функция возвратит пустое значение.
}}
{{function entry
|name=[[Form.FocusedControl|FocusedControl]]
|form={{Grey|Form.}}'''FocusedControl'''():''<Активный визуальный элемент формы или пустое значение (FORM,NOTHING)>''
|type=1
|status=2
|visual=1
|description=Функция применяется к загруженной визуальной форме и возвращает текущий активный визуальный элемент формы (элемент с фокусом), либо пустое значение, если ни один из визуальных элементов не является активным.
}}
{{function entry
|name=[[Form.StorageGetValue|StorageGetValue]]
|form={{Grey|Form.}}'''StorageGetValue'''(''<Наименование значения коллекции значений формы (STRING)>''):''<Значение по его наименованию>''
|type=1
|status=2
|visual=0
|description=Функция получает значение, привязанное к текущей форме по его наименованию. Форма может быть не загруженной и не визуальной. Программа может хранить произвольное количество значений в контексте формы, доступных по их наименованиям.
}}
{{function entry
|name=[[Form.StorageSetValue|StorageSetValue]]
|form={{Grey|Form.}}'''StorageSetValue'''(''<Наименование значения коллекции значений формы (STRING)>'',''<Значение>'')
|type=1
|status=2
|visual=0
|description=Функция сохраняет значение, привязанное к текущей форме по его наименованию. Форма может быть не загруженной и не визуальной. Программа может хранить произвольное количество значений в контексте формы, доступных по их наименованиям.
}}
{{function entry
|name=[[Form.ContainsPeriodicalValues|ContainsPeriodicalValues]]
|form={{Grey|Form.}}'''ContainsPeriodicalValues''':''<Форма или элемент содержат периодические значения (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут применяется к форме или визуальному элементу, и позволяет получить или изменить флаг того, что элемент или форма содержат периодические значения базы данных. При установке этого флага к заголовку формы добавляется дата на которую отображаются реквизиты периодических значений. При загрузке формы в режиме редактирования, если по крайней мере одно из полей редактирования привязано к периодическому реквизиту, флаг будет установлен автоматически.
}}
{{function entry
|name=[[Form.SettingsLoaded|SettingsLoaded]]
|form={{Grey|Form.}}'''SettingsLoaded''':''<Для формы были загружены установки (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут применяется к форме, и позволяет получить флаг того, что для формы были загружены сохраненные ранее установки. Флаг заполняется сразу после загрузки визуальной формы до выполнения визуальных событий, и, к примеру, в момент исполнения [[Студия/Визуальные события|''OnOpen'']], если загрузка происходила, он уже установлен.
}}
{{function entry
|name=[[Form.CollectSettings|CollectSettings]]
|form={{Grey|Form.}}'''CollectSettings'''():''<Таблица с установками формы (TAB)>''
|type=1
|status=2
|visual=1
|description=Функция применяется к загруженной визуальной форме и получает таблицу со всеми ее установками. Сбор информации на форме происходит по правилам, которые работают для обычного сохранения и загрузки установок, поэтому определенные элементы формы могут быть пропущены (элементы для которых установлен признак "не сохранять состояние в установках формы", таблицы, привязанные к базе данных и пр.). Таблица-результат имеет следующие столбцы: '''ControlType''', '''ControlName''', '''Value''', '''Selected''', '''Tag'''.
}}
{{function entry
|name=[[Form.ControlsToString|ControlsToString]]
|form={{Grey|Form.}}'''ControlsToString'''({{Optional|<Наименование элементов для создания настройки (STRING)>}}):''<Строка с установками формы (STRING)>''
|type=1
|status=2
|visual=1
|description=Функция применяется к загруженной визуальной форме и получает строку со всеми ее установками (либо установками определенных элементов). Сбор информации на форме происходит по правилам, которые работают для обычного сохранения и загрузки установок, поэтому определенные элементы формы могут быть пропущены (элементы для которых установлен признак "не сохранять состояние в установках формы", таблицы, привязанные к базе данных и пр.). Созданная строка-результат имеет формат ANSI и может быть сохранена в виде текста во внешних источниках, однако, элементы базы данных содержатся в ней в виде внутренних кодов, поэтому, загрузка в другую базу данных приведет к позиционированию на неверных элементах. Аргумент может содержать наименования элементов для создания настройки через запятую, если аргумент не задан, будут использованы все элементы формы.
}}
{{function entry
|name=[[Form.ControlsFromString|ControlsFromString]]
|form={{Grey|Form.}}'''ControlsFromString'''(''<Строка с установками формы (STRING)>'')
|type=1
|status=2
|visual=1
|description=Функция применяется к загруженной визуальной форме и загружает установки элементов формы, содержащиеся в строке, созданной с помощью функции [[Form.ControlsToString|ControlsToString]]. Установки включают значение полей, позицию в таблицах, содержимое таблиц (если они не привязаны к базе данных) и пр. Загрузка строки, созданной в другой базе данных, приведет к позиционированию на неверных элементах.
}}
{{function entry
|name=[[Form.OnTimerInterval|OnTimerInterval]]
|form={{Grey|Form.}}'''OnTimerInterval''':''<Интервал выполнения события OnTimer в мс. (INT)>''
|type=0
|status=0
|visual=1
|description=Атрибут применяется к загруженной визуальной форме и получает или позволяет изменять интервал выполнения визуального события ''OnTimer'' в миллисекундах. При установке нулевого значения, событие будет отключено.
}}
{{function entry
|name=[[Form.StatusText|StatusText]]
|form={{Grey|Form.}}'''StatusText'''({{Optional|<Новая строка статуса выполнения (STRING)>}}):''<Текущая строка статуса выполнения (STRING)>''
|type=1
|status=2
|visual=1
|description=Функция получает или изменяет текст статуса выполнения, выводимый в полосе статуса в самом низу окна клиента. Статус выполнения выводится для каждого потока отдельно и будет показан только пока поток занят исполнением программы. Для консольного клиента информация по статусу обычно выводится в заголовок консоли. Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.UpdateProgress|UpdateProgress]]
|form={{Grey|Form.}}'''UpdateProgress'''(''<Текущий прогресс выполнения (INT)>''{{Optional|,<Максимальный прогресс выполнения (INT)>,<Текущий текст выполнения (STRING)>}})
|type=1
|status=2
|visual=1
|description=Функция изменяет текст и рисунок статуса выполнения, выводимый на текущей кнопке панели задач формы, а также во всплывающей подсказке при наведении курсора мыши на эту кнопку. Статус выполнения выводится для каждого окна отдельно. Текущий прогресс не может быть равен нулю, при передаче аргумента, равного ''-1'', процесс не будет выводиться в виде процента выполнения (режим неопределенного прогресса). Кроме рисунка процента выполнения, можно также указать текст для задания этапа выполнения. Рисование статуса выполнения автоматически останавливается, когда программа завершает работу. Функция может использоваться до инициализации формы.
}}
{{function entry
|name=[[Form.StopProgress|StopProgress]]
|form={{Grey|Form.}}'''StopProgress'''()
|type=1
|status=2
|visual=1
|description=Функция удаляет текст и рисунок статуса выполнения, выводившийся функцией [[Form.UpdateProgress|UpdateProgress]]. Функция может использоваться до инициализации формы.
}}
{{function entry
|name=[[Form.TaskbarIcon|TaskbarIcon]]
|form={{Grey|Form.}}'''TaskbarIcon'''({{Optional|<Новый индекс иконки кнопки панели задач (INT)>,<Тип кнопки панели задач (INT)>{{Default|{{Eq}}0}}}}):''<Текущий индекс иконки кнопки панели задач (INT)>''
|type=1
|status=0
|visual=1
|description=Функция получает или изменяет индекс иконки кнопки панели задач. Кнопка может быть как локальной (кнопка текущего окна), так и глобальной (кнопка потока). Функция может использоваться до инициализации формы.
}}
{{function entry
|name=[[Form.GetFormLocationName|GetFormLocationName]]
|form={{Grey|Form.}}'''GetFormLocationName'''({{Optional|<В виде стандартного пути без изменения (INT)>{{Default|{{Eq}}1}}}}):''<Путь загрузки текущей формы (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает полный путь загрузки текущей формы (без указания на имя файла загрузки). Для форм, загруженных для объектом базы данных, путь может выглядеть, как стандартный (<code>Ref.Номенклатура</code>, для чего аргумент должен быть равен 1), либо будет переведен на основной язык проекта (<code>Справочник.Номенклатура</code>, для чего аргумент должен быть равен 0). Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.GetFormFileName|GetFormFileName]]
|form={{Grey|Form.}}'''GetFormFileName'''():''<Путь загрузки и имя файла текущей формы (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает полный путь загрузки текущей формы с указанием на имя файла загрузки (к примеру, <code>Ref.Номенклатура\Form.sfgc</code> или <code>Modules\FreeForms\Касса\РеестрДоверенностей\SelectForm.sfgc</code>). Функция может использоваться до инициализации формы и в консольном клиенте. Объект должен указывать на визуальную форму.
}}
{{function entry
|name=[[Form.GetModuleFileName|GetModuleFileName]]
|form={{Grey|Form.}}'''GetModuleFileName'''():''<Путь загрузки и имя файла текущего модуля (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает полный путь загрузки текущего модуля с указанием на имя файла загрузки (к примеру, <code>Ref.Номенклатура\Module.sfc</code> или <code>Modules\FreeForms\Касса\РеестрДоверенностей\Module.sfc</code>). Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.BegPeriodDate|BegPeriodDate]]
|form={{Grey|Form.}}'''BegPeriodDate'''({{Optional|<Дата начала периода периодических реквизитов формы (DATE)>}}):''<Текущая дата начала периода периодических реквизитов формы (DATE)>''
|type=1
|status=2
|visual=0
|description=Функция получает или изменяет начальную дату сохранения периодических реквизитов формы. Данная дата присутствует для любой формы, однако, используется только для форм, выводящих таблицы с объектами базы данных. Для форм с редактируемыми объектами базы данных используется дата, хранящаяся в свойствах объекта (см. [[DB.UsePeriod]]). См. также описание функций [[GlobalBegPeriodDate]] и [[GlobalEndPeriodDate]]. Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.EndPeriodDate|EndPeriodDate]]
|form={{Grey|Form.}}'''EndPeriodDate'''({{Optional|<Дата окончания периода и отображения периодических реквизитов формы (DATE)>}}):''<Текущая дата окончания периода и отображения периодических реквизитов формы (DATE)>''
|type=1
|status=2
|visual=0
|description=Функция получает или изменяет конечную дату сохранения периодических реквизитов формы, также используемую как дату отображения реквизитов. Данная дата присутствует для любой формы, однако, используется только для форм, выводящих таблицы с объектами базы данных. Для форм с редактируемыми объектами базы данных используется дата, хранящаяся в свойствах объекта (см. [[DB.UsePeriod]]). См. также описание функций [[GlobalBegPeriodDate]] и [[GlobalEndPeriodDate]]. Функция может использоваться до инициализации формы и в консольном клиенте.
}}
{{function entry
|name=[[Form.DefaultFont|DefaultFont]]
|form={{Grey|Form.}}'''DefaultFont'''({{Optional|<Новое значение шрифта формы по умолчанию (STRING)>}}):''<Предыдущее значение шрифта формы по умолчанию (STRING)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает или/и изменяет шрифт формы по умолчанию. При изменении будут обновлены значения коэффициентов масштабирования формы. В зависимости от новых установок, текст и элементы формы будут выглядеть крупнее или мельче. Значение шрифта можно изменять только до того, как форма была загружена (т.е. при инициализации модуля формы или в его событии [[OnOpen]]).
}}
{{function entry
|name=[[Form.ScaleFactorX|ScaleFactorX]]
|form={{Grey|Form.}}'''ScaleFactorX'''({{Optional|<Новое значение горизонтального коэффициента масштабирования формы (REAL)>}}):''<Предыдущее значение горизонтального коэффициента масштабирования формы (REAL)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает или/и изменяет значение горизонтального коэффициента масштабирования формы. По умолчанию используется значение глобального коэффициента масштабирования, см. [[GlobalFormScaleFactorX]], данное значение отменяет действие глобального только для текущей формы. Если значение больше 1, элементы всех форм будут растянуты по горизонтали, если меньше 1, элементы будут сжаты. Значение коэффициента можно изменять только до того, как форма была загружена (т.е. при инициализации модуля формы или в его событии [[OnOpen]]).
}}
{{function entry
|name=[[Form.ScaleFactorY|ScaleFactorY]]
|form={{Grey|Form.}}'''ScaleFactorY'''({{Optional|<Новое значение вертикального коэффициента масштабирования формы (REAL)>}}):''<Предыдущее значение вертикального коэффициента масштабирования формы (REAL)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает или/и изменяет значение вертикального коэффициента масштабирования формы. По умолчанию используется значение глобального коэффициента масштабирования, см. [[GlobalFormScaleFactorY]], данное значение отменяет действие глобального только для текущей формы. Если значение больше 1, элементы всех форм будут растянуты по вертикали, если меньше 1, элементы будут сжаты. Значение коэффициента можно изменять только до того, как форма была загружена (т.е. при инициализации модуля формы или в его событии [[OnOpen]]).
}}
{{function entry
|name=[[Form.AutoScaleMode|AutoScaleMode]]
|form={{Grey|Form.}}'''AutoScaleMode''':''<Значение режима автоматического масштабирования формы (REAL)>''
|type=0
|status=2
|visual=1
|description=Атрибут изменяет значение режима автоматического масштабирования формы (см. статью [[Студия/Редактор форм|Редактор форм]]). Значение режима можно изменять только до того, как форма была загружена (т.е. при инициализации модуля формы или в его событии [[OnOpen]]).
}}
{{function entry
|name=[[Form.InvokeEvent|InvokeEvent]]
|form={{Grey|Form.}}'''InvokeEvent'''(''<Имя события (STRING)>'',''<Имена переменных, передаваемых событию, через запятые (STRING)>''{{OptionalByRef|,<Значение переменной 1>,<Значение переменной 2>...}})
|type=1
|status=2
|visual=1
|description=Функция инициирует выполнение указанного визуального события привязанного либо к визуальному элементу формы (если оный адресуется объектом, к примеру [[Студия/Визуальные события|''OnInitLine'']]), либо к самой форме (к примеру [[Студия/Визуальные события|''OnOpen'']]). Разработчик должен указать все переменные, участвующие в событие и задать их значения. Если какая-то из переменных не будет указана, при обращении к ней в момент выполнения события будет вызвано исключение. Событие выполняется в синхронном режиме (т.е. является прерывающим событием), управление не будет возвращено до тех пор, пока не закончится выполнение события. Изменения в переменных внутри события будут транслированы на переменные, переданные в виде аргументов события в момент окончания выполнения события. Некоторые события (к примеру, ''OnOpen'') могут быть вызваны несколько раз, если они заданы на вложенных формах макросов или закладках. Для списка возможных событий см. описание Студии. Функция применяется к загруженной визуальной форме или ее элементу.
}}
{{function entry
|name=[[Form.InvokeEventAsync|InvokeEventAsync]]
|form={{Grey|Form.}}'''InvokeEventAsync'''(''<Имя события (STRING)>'',''<Имена переменных, передаваемых событию, через запятые (STRING)>''{{Optional|,<Значение переменной 1>,<Значение переменной 2>...}})
|type=1
|status=2
|visual=1
|description=Функция инициирует выполнение указанного визуального события привязанного либо к визуальному элементу формы (если оный адресуется объектом, к примеру [[Студия/Визуальные события|''OnInitLine'']]), либо к самой форме (к примеру [[Студия/Визуальные события|''OnOpen'']]). Разработчик должен указать все переменные, участвующие в событие и задать их значения. Если какая-то из переменных не будет указана, при обращении к ней в момент выполнения события будет вызвано исключение. Событие выполняется в асинхронном режиме (т.е. может быть выполнено только в момент, когда программа ожидает действий пользователя), управление будет возвращено до того, как начнется выполнение события. Для списка возможных событий см. описание Студии. Функция применяется к загруженной визуальной форме или ее элементу.
}}
{{function entry
|name=[[Form.InvokeSystemAttachButtonEvent|InvokeSystemAttachButtonEvent]]
|form={{Grey|Form.}}'''InvokeSystemAttachButtonEvent'''(''<Индекс связанного элемента (INT)>''{{Optional|,<Метод вызова (INT)>,<Объект, связанный с вызовом>}})
|type=1
|status=0
|visual=1
|description=Функция инициирует выполнение стандартного события, ассоциированного со связанным элементом текущего визуального элемента формы. Вызывается стандартное действие, ассоциированное со связанным элементом, даже если для него задано программное событие.
}}
{{function entry
|name=[[Form.HideControlPanel|HideControlPanel]]
|form={{Grey|Form.}}'''HideControlPanel'''(''<Идентификатор панели инструментов (STRING)>'')
|type=1
|status=2
|visual=1
|description=Функция прячет для текущего активного окна указанную панель инструментов. Пользовательские панели инструментов задаются в свойствах проекта. Панель может быть отражена, при переключении на другое активное окно, однако, будет снова спрятана, при активации оригинального окна. См. также общую функцию [[HideControlPanel]].
}}
{{function entry
|name=[[Form.ShowControlPanel|ShowControlPanel]]
|form={{Grey|Form.}}'''ShowControlPanel'''(''<Идентификатор панели инструментов (STRING)>'')
|type=1
|status=2
|visual=1
|description=Функция отображает для текущего активного окна указанную панель инструментов. Пользовательские панели инструментов задаются в свойствах проекта. Панель может быть спрятана, при переключении на другое активное окно, однако, будет снова отображена, при активации оригинального окна. См. также общую функцию [[ShowControlPanel]].
}}
{{function footer}}

===Функции и атрибуты элементов формы===
Функции и атрибуты этой группы применяются к объектам элементов формы. Чтобы получить из объекта формы (или интерфейса формы) объект элемента, можно найти нужный элемент по имени с помощью функции [[Form.Control]] или напрямую из интерфейса <code>Form.<Наименование элемента></code>. Наименования элементов задаются при редактировании формы в Студии.
{{function header}}
{{function entry
|name=[[Form.Form|Form]]
|form={{Grey|Form.}}'''Form''':''<Форма текущего визуального элемента (FORM)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает объект формы, которому принадлежит текущий визуальный элемент.
}}
{{function entry
|name=[[Form.Macro|Macro]]
|form={{Grey|Form.}}'''Macro''':''<Объект макроса, к которому принадлежит текущий элемент формы или пустое значение (FORM)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает объект макроса или страницы группы страниц, к которому принадлежит текущий элемент формы. Если элемент не принадлежит макросу или странице, атрибут возвращает пустое значение.
}}
{{function entry
|name=[[Form.TypeNum|TypeNum]]
|form={{Grey|Form.}}'''TypeNum''':''<Цифровой тип визуального элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает тип текущего визуального элемента в виде числа.
}}
{{function entry
|name=[[Form.Height|Height]]
|form={{Grey|Form.}}'''Height''':''<Высота визуального элемента в пикселях (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет высоту текущего визуального элемента в пикселях.
}}
{{function entry
|name=[[Form.Width|Width]]
|form={{Grey|Form.}}'''Width''':''<Ширина визуального элемента в пикселях (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет ширину текущего визуального элемента в пикселях.
}}
{{function entry
|name=[[Form.Left|Left]]
|form={{Grey|Form.}}'''Left''':''<Отступ слева от начала формы или макроса в пикселях (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет отступ слева от начала формы или макроса в пикселях текущего визуального элемента.
}}
{{function entry
|name=[[Form.Top|Top]]
|form={{Grey|Form.}}'''Top''':''<Отступ сверху от начала формы или макроса в пикселях (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет отступ сверху от начала формы или макроса в пикселях текущего визуального элемента.
}}
{{function entry
|name=[[Form.Name|Name]]
|form={{Grey|Form.}}'''Name''':''<Идентификатор визуального элемента (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает строковой идентификатор текущего визуального элемента.
}}
{{function entry
|name=[[Form.Control.Caption|Caption]], '''Text'''
|form={{Grey|Form.}}'''Caption''':''<Заголовок визуального элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет заголовок текущего визуального элемента. Атрибут может приняться даже к элементам, не имеющим видимого заголовка.
}}
{{function entry
|name=[[Form.Font|Font]]
|form={{Grey|Form.}}'''Font''':''<Шрифт визуального элемента (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет шрифт текущего визуального элемента. Атрибут может приняться даже к элементам, для которых изменение шрифта не имеет смысла. Шрифт задается во внутреннем формате, см. статью [[Формат записи шрифтов в системе]].
}}
{{function entry
|name=[[Form.FontStyle|FontStyle]]
|form={{Grey|Form.}}'''FontStyle''':''<Стиль штрифта визуального элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет цифровой стиль шрифта текущего визуального элемента. Атрибут может приняться даже к элементам, для которых изменение шрифта не имеет смысла. Стиль шрифта представляет собой число-битовую маску.
}}
{{function entry
|name=[[Form.FontColor|FontColor]]
|form={{Grey|Form.}}'''FontColor''':''<Цвет текста визуального элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет цвет текста текущего визуального элемента. Атрибут может приняться даже к элементам, для которых изменение цвета текста не имеет смысла. Цвет представлен 3 байтами (24 бит).
}}
{{function entry
|name=[[Form.Anchors|Anchors]]
|form={{Grey|Form.}}'''Anchors''':''<Визуальные якоря элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет якоря текущего визуального элемента. Значение представляет собой число-битовую маску, которая определяет какие части элемента будут увеличены или сужены при изменении размеров формы, а какие будут оставаться без изменения.
}}
{{function entry
|name=[[Form.Color|Color]]
|form={{Grey|Form.}}'''Color''':''<Цвет визуального элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет цвет текущего визуального элемента. Атрибут может приняться даже к элементам, для которых изменение цвета не имеет смысла. Цвет представлен 3 байтами (24 бит).
}}
{{function entry
|name=[[Form.HAlign|HAlign]]
|form={{Grey|Form.}}'''HAlign''':''<Горизонтальное выравнивание текста элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет горизонтальное выравнивание текста текущего визуального элемента. Атрибут может применяться даже к элементам, для которых горизонтальное выравнивание текста не имеет смысла.
}}
{{function entry
|name=[[Form.VAlign|VAlign]]
|form={{Grey|Form.}}'''VAlign''':''<Вертикальное выравнивание текста элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет вертикальное выравнивание текста текущего визуального элемента. Атрибут может применяться даже к элементам, для которых вертикальное выравнивание текста не имеет смысла.
}}
{{function entry
|name=[[Form.Glyph|Glyph]]
|form={{Grey|Form.}}'''Glyph''':''<Номер иконки, отображаемой на элементе (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет номер иконки, отображаемой на визуальном элементе. Атрибут может применяться даже к элементам, для которых отображение иконки не имеет смысла.
}}
{{function entry
|name=[[Form.GroupName|GroupName]]
|form={{Grey|Form.}}'''GroupName''':''<Наименование группы переключателей (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает наименование группы переключателей, к которой принадлежит на визуальный элемент.
}}
{{function entry
|name=[[Form.Mask|Mask]]
|form={{Grey|Form.}}'''Mask''':''<Маска редактирования элемента (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет маску редактирования визуального элемента. Обычно маска используется для поля редактирования или при редактировании ячеек таблицы. См. также [[Tab.Column.Mask|Mask]].
}}
{{function entry
|name=[[Form.Hotkey|Hotkey]]
|form={{Grey|Form.}}'''Hotkey''':''<Сочетание клавиш для быстрого доступа к элементу (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет сочетание клавиш, используемое для быстрого доступа к визуальному элементу. Сочетание записывается в формате <code>[<Модификатор>+]<Клавиша></code> (к примеру <code>Alt+F1</code>).
}}
{{function entry
|name=[[Form.Scale|Scale]]
|form={{Grey|Form.}}'''Scale''':''<Режим поведения картинки визуального элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим поведения картинки визуального элемента. Атрибут используется только для визуальных элементов типа картинка и позволяет определить поведение картинки, если ее внутренние размеры больше или меньше фактических размеров элемента.
}}
{{function entry
|name=[[Form.SelectedPage|SelectedPage]]
|form={{Grey|Form.}}'''SelectedPage''':''<Индекс текущей страницы группы страниц с закладками (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет индекс текущей страницы группы страниц с закладками. Атрибут используется только для визуальных элементов типа группа страниц.
}}
{{function entry
|name=[[Form.Hint|Hint]]
|form={{Grey|Form.}}'''Hint''':''<Всплывающая подсказка к визуальному элементу (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет всплывающую подсказку к визуальному элементу.
}}
{{function entry
|name=[[Form.IsDisabled|IsDisabled]]
|form={{Grey|Form.}}'''IsDisabled''':''<Режим недоступности визуального элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим недоступности визуального элемента. В режиме недоступности любой доступ к элементу будет запрещен, пользователь не сможет, к примеру, выделить и поместить в буфер обмена содержание поля редактирования. Для запрета редактирования полей редактирования можно использовать атрибут [[Form.IsReadOnly|IsReadOnly]].
}}
{{function entry
|name=[[Form.IsInvisible|IsInvisible]]
|form={{Grey|Form.}}'''IsInvisible''':''<Режим невидимости визуального элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим невидимости визуального элемента. В этом режиме элемент не будет отображен на экране.
}}
{{function entry
|name=[[Form.IsChecked|IsChecked]]
|form={{Grey|Form.}}'''IsChecked''':''<Индекс галочки визуального элемента флажка (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет индекс галочки визуального элемента флажка. Флажок поддерживает три положения (включенный, выключенный и неопределенный).
}}
{{function entry
|name=[[Form.IsWithCheckboxes|IsWithCheckboxes]]
|form={{Grey|Form.}}'''IsWithCheckboxes''':''<Режим отображения флажков в списке (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим отображения флажков в визуальных элементах списков.
}}
{{function entry
|name=[[Form.IsInEnterChain|IsInEnterChain]]
|form={{Grey|Form.}}'''IsInEnterChain''':''<Элемент входит в цепочку редактирования (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает флаг принадлежности визуального элемента цепочке редактирования (Enter-цепочке).
}}
{{function entry
|name=[[Form.IfSetChangeFlag|IfSetChangeFlag]]
|form={{Grey|Form.}}'''IfSetChangeFlag''':''<Режим автоматической установки флага изменения формы при изменении элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим автоматической установки флага изменения формы при изменении элемента.
}}
{{function entry
|name=[[Form.IfNotInSettings|IfNotInSettings]]
|form={{Grey|Form.}}'''IfNotInSettings''':''<Запрет сохранения состояния визуального элемента в установки формы (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет запрет сохранения состояния визуального элемента при создании установок формы.
}}
{{function entry
|name=[[Form.IsDefault|IsDefault]]
|form={{Grey|Form.}}'''IsDefault''':''<Флаг кнопки по умолчанию (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет флаг того, что визуальный элемент кнопки используется по умолчанию. На форме должна быть только одна кнопка, использующаяся по умолчанию. Такая кнопка имеет особую подсветку, и активируется автоматически при активации пользователем комбинации клавиш <code>Ctrl+Enter</code>.
}}
{{function entry
|name=[[Form.HasNoFocus|HasNoFocus]]
|form={{Grey|Form.}}'''HasNoFocus''':''<Кнопка не принимает фокус (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут отдает флаг того, что визуальный элемент кнопки не может иметь фокус (задается в Студии). Такой режим может использоваться на формах без элементов с фокусом, к примеру, для сенсорных экранов.
}}
{{function entry
|name=[[Form.IsAsyncMode|IsAsyncMode]]
|form={{Grey|Form.}}'''IsAsyncMode''':''<Событие кнопки выполняется в асинхронном режиме (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут отдает флаг того, событие, связанное с кнопкой будет выполняться в асинхронном режиме (1, по умолчанию) или в режиме прерывания (0).
}}
{{function entry
|name=[[Form.NoDisable|NoDisable]]
|form={{Grey|Form.}}'''NoDisable''':''<Элемент не может быть недоступным (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает флаг того, что визуальный элемент кнопки не будет недоступным в режиме только для чтения формы или при использовании DisableControls. Такой режим может использоваться для кнопок не выполняющий действия по изменению информации (к примеру, вызывающих помощь).
}}
{{function entry
|name=[[Form.IsNoGridLines|IsNoGridLines]]
|form={{Grey|Form.}}'''IsNoGridLines''':''<Не отображать линии сетки для списков и таблиц (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет флаг запрета отображения линий сетки для списков, таблиц и электронных таблиц.
}}
{{function entry
|name=[[Form.IsPassword|IsPassword]]
|form={{Grey|Form.}}'''IsPassword''':''<Не отображать символы, вводимые в поле редактирования (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим отображения символов, вводимых в поле редактирования. Если режим пароля установлен, вместо информации в поле редактирования будут отражены знаки '''*'''.
}}
{{function entry
|name=[[Form.IsNoCaptions|IsNoCaptions]]
|form={{Grey|Form.}}'''IsNoCaptions''':''<Не отображать заголовок для списков и таблиц (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет флаг запрета отображения заголовка столбцов для списков, таблиц и электронных таблиц.
}}
{{function entry
|name=[[Form.IsMultiLine|IsMultiLine]]
|form={{Grey|Form.}}'''IsMultiLine''':''<Режим, в котором поле редактирования может содержать более одной строки (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим, в котором поле редактирования может содержать более одной строки.
}}
{{function entry
|name=[[Form.IsNoLevels|IsNoLevels]]
|form={{Grey|Form.}}'''IsNoLevels''':''<Не отображать уровни итогов в электронной таблице (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим, в котором уровни итогов в электронной таблице не будут отображены.
}}
{{function entry
|name=[[Form.IsReadOnly|IsReadOnly]]
|form={{Grey|Form.}}'''IsReadOnly''':''<Режим запрета редактирования для полей редактирования и таблиц (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим запрета редактирования для полей редактирования и таблиц. В отличии от режима запрета доступа ([[Form.IsDisabled|IsDisabled]]), режим запрета редактирования позволяет просматривать информацию в полях или таблицах, однако, не позволяет ее изменять.
}}
{{function entry
|name=[[Form.IsEditable|IsEditable]]
|form={{Grey|Form.}}'''IsEditable''':''<Режим разрешения редактирования для электронных таблиц (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим разрешения редактирования для электронных таблиц.
}}
{{function entry
|name=[[Form.IsWrapped|IsWrapped]]
|form={{Grey|Form.}}'''IsWrapped''':''<Режим переноса текста на другую строчку для текстовых полей (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим переноса текста на другую строчку для текстовых полей.
}}
{{function entry
|name=[[Form.IsHyperLink|IsHyperLink]]
|form={{Grey|Form.}}'''IsHyperLink''':''<Режим отображения текстового поля в виде интерактивной подчеркнутой ссылки (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим отображения текстового поля в виде интерактивной подчеркнутой ссылки.
}}
{{function entry
|name=[[Form.IsShowGroups|IsShowGroups]]
|form={{Grey|Form.}}'''IsShowGroups''':''<Отображать наименований групп в электронной таблице (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим отображения наименований групп в электронной таблице.
}}
{{function entry
|name=[[Form.IsBeveled|IsBeveled]]
|form={{Grey|Form.}}'''IsBeveled''':''<Режим объемного отображения разделителя (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим объемного отображения разделителя.
}}
{{function entry
|name=[[Form.IsNoScrolling|IsNoScrolling]]
|form={{Grey|Form.}}'''IsNoScrolling''':''<Запретить прокрутку ячеек в электронной таблице (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим запрета прокрутки ячеек в электронной таблице.
}}
{{function entry
|name=[[Form.IsMoveable|IsMoveable]]
|form={{Grey|Form.}}'''IsMoveable''':''<Разрешение сдвига мышью визуального элемента разделителя (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим разрешения сдвига мышью визуального элемента разделителя.
}}
{{function entry
|name=[[Form.IsProportional|IsProportional]]
|form={{Grey|Form.}}'''IsProportional''':''<Режим сохранения пропорции картинки при изменении размеров (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим сохранения пропорции картинки визуального элемента. Атрибут используется только для визуальных элементов типа картинка.
}}
{{function entry
|name=[[Form.IsOutlined|IsOutlined]]
|form={{Grey|Form.}}'''IsOutlined''':''<Режим отображения контура картинки (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет отображения контура картинки визуального элемента. Атрибут используется только для визуальных элементов типа картинка.
}}
{{function entry
|name=[[Form.IsDBAutoUpdate|IsDBAutoUpdate]]
|form={{Grey|Form.}}'''IsDBAutoUpdate''':''<Режим автоматического обновления элемента из базы данных через определенные промежутки времени (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим автоматического обновления элемента из базы данных через определенные промежутки времени. Время автоматического обновления задается в свойствах проекта.
}}
{{function entry
|name=[[Form.AreFoldersSelectable|AreFoldersSelectable]]
|form={{Grey|Form.}}'''AreFoldersSelectable''':''<Режим разрешения выбора папок для табличных элементов форм, открытых в режиме выбора (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим разрешения выбора папок для табличных элементов форм, открытых в режиме выбора. Данный режим используется по умолчанию, однако, при вызове формы, он может быть изменен программой.
}}
{{function entry
|name=[[Form.IfQFiltersAlwaysAllowed|IfQFiltersAlwaysAllowed]]
|form={{Grey|Form.}}'''IfQFiltersAlwaysAllowed''':''<Режим разрешения использования быстрых фильтров для таблиц, не связанных с базой данных (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим разрешения использования быстрых фильтров (фильтры вводятся непосредственно в столбиках таблицы) для таблиц, не связанных с базой данных.
}}
{{function entry
|name=[[Form.IsMultiSelectAllowed|IsMultiSelectAllowed]]
|form={{Grey|Form.}}'''IsMultiSelectAllowed''':''<Режим разрешения выделения диапазонов строк в таблицах (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим разрешения выделения диапазонов строк в таблицах (вместо выделения только одной ячейки).
}}
{{function entry
|name=[[Form.MultiSelectMode|MultiSelectMode]]
|form={{Grey|Form.}}'''MultiSelectMode''':''<Тип режима выделения диапазонов (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет тип режима выделения диапазонов строк в таблицах.
}}
{{function entry
|name=[[Form.ContainsPeriodicalValues|ContainsPeriodicalValues]]
|form={{Grey|Form.}}'''ContainsPeriodicalValues''':''<Флаг того, что элемент содержит периодические значения (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет флаг того, что элемент (таблица) содержит периодические значения. При установке такого флага, форма получает признак того, что в ней используются периодические элементы и в заголовке будет выведена дата отображения элементов формы. Флаг обычно устанавливается автоматически при инициализации формы, однако, при использовании функции [[Form.BindToProperty|BindToProperty]], возможно необходимо установить этот флаг программно.
}}
{{function entry
|name=[[Form.PartialLoadingModeColumns|PartialLoadingModeColumns]]
|form={{Grey|Form.}}'''PartialLoadingModeColumns''':''<Список реквизитов для частичной загрузки объектов таблицы (STRING)>''
|type=0
|status=0
|visual=1
|description=Атрибут получает или изменяет список реквизитов для частичной загрузки объектов таблицы. Реквизиты перечисляются через запятую.
}}
{{function entry
|name=[[Form.BevelShape|BevelShape]]
|form={{Grey|Form.}}'''BevelShape''':''<Форма объемного региона оформления (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет форму объемного региона оформления (горизонтальная линия, вертикальная линия, ящик, рамка).
}}
{{function entry
|name=[[Form.BevelStyle|BevelStyle]]
|form={{Grey|Form.}}'''BevelStyle''':''<Стиль объемного региона оформления (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет стиль объемного региона оформления (вдавленный, выпуклый).
}}
{{function entry
|name=[[Form.TrackbarMode|TrackbarMode]]
|form={{Grey|Form.}}'''TrackbarMode''':''<Режим отображения бегунка и выделения (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим отображения бегунка и выделения для элемента выбор бегунком.
}}
{{function entry
|name=[[Form.TicksMode|TicksMode]]
|form={{Grey|Form.}}'''TicksMode''':''<Режим отображения отметок (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим отображения отметок для элемента выбора бегунком.
}}
{{function entry
|name=[[Form.OnChangeMode|OnChangeMode]]
|form={{Grey|Form.}}'''OnChangeMode''':''<Режим изменения бегунка (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим выполнения и отображения изменений бегунка пользователем для элемента выбора бегунком.
}}
{{function entry
|name=[[Form.LinesFrequency|LinesFrequency]]
|form={{Grey|Form.}}'''LinesFrequency''':''<Частота отображения отметок на элементе (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет частоту (в точках) отображения отметок для элемента выбора бегунком.
}}
{{function entry
|name=[[Form.LineSize|LineSize]]
|form={{Grey|Form.}}'''LineSize''':''<Шаг бегунка стрелками (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет величину увеличения или уменьшения значения бегунка для элемента выбора бегунком при использовании стрелок на клавиатуре.
}}
{{function entry
|name=[[Form.PageSize|PageSize]]
|form={{Grey|Form.}}'''PageSize''':''<Шаг бегунка кнопками PgUp, PgDown (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет величину увеличения или уменьшения значения бегунка для элемента выбора бегунком при использовании кнопок PageUp / PageDown на клавиатуре.
}}
{{function entry
|name=[[Form.MinValue|MinValue]]
|form={{Grey|Form.}}'''MinValue''':''<Минимальное значение элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет минимальное возможное значения элемента (для элементов выбора бегунком или индикатора выполнения).
}}
{{function entry
|name=[[Form.MaxValue|MaxValue]]
|form={{Grey|Form.}}'''MaxValue''':''<Минимальное значение элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет максимальное возможное значения элемента (для элементов выбора бегунком или индикатора выполнения).
}}
{{function entry
|name=[[Form.PaperColor|PaperColor]]
|form={{Grey|Form.}}'''PaperColor''':''<Цвет окна (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет цвет окна элемента индикатора выполнения.
}}
{{function entry
|name=[[Form.InkColor|InkColor]]
|form={{Grey|Form.}}'''InkColor''':''<Цвет заливки (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет цвет заливки элемента индикатора выполнения.
}}
{{function entry
|name=[[Form.SelectionStart|SelectionStart]]
|form={{Grey|Form.}}'''SelectionStart''':''<Начало выделенного региона (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет начало выделенного региона для элемента выбора бегунком.
}}
{{function entry
|name=[[Form.SelectionEnd|SelectionEnd]]
|form={{Grey|Form.}}'''SelectionEnd''':''<Окончание выделенного региона (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет окончание выделенного региона для элемента выбора бегунком.
}}
{{function entry
|name=[[Form.Folders|Folders]]
|form={{Grey|Form.}}'''Folders''':''<Режим отображения папок табличного элемента (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает режим отображения папок табличного элемента (отображать в общей структуре, отображать сверху списка, не отображать, отображать только папки).
}}
{{function entry
|name=[[Form.Value|Value]]
|form={{Grey|Form.}}'''Value''':''<Значение (содержимое) визуального элемента>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет значение визуального элемента. Не для всех элементов значение может быть изменено (к примеру, для таблиц или списков изменять значение нельзя). Для разных типов элементов это значение может иметь разный тип. К примеру, для поля редактирования, тип зависит от типа данных поля, для группы переключателей, это значение принимает целый числовой индекс активного в данный момент переключателя, для картинки, это значение будет представлять объект картинки. Задание OLE-объектов таким образом разрешено, однако, инициализация объектов может происходить в асинхронном режиме, поэтому, после присваивания OLE-объекту, необходимо подождать окончания его полной инициализации.
}}
{{function entry
|name=[[Form.Tag|Tag]]
|form={{Grey|Form.}}'''Tag''':''<Произвольное дополнительное значение элемента>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет произвольное дополнительное значение элемента. Значение может использоваться программно для хранения различной информации, ассоциированной с визуальным элементом.
}}
{{function entry
|name=[[Form.LayerName|LayerName]]
|form={{Grey|Form.}}'''LayerName''':''<Наименование слоя, которому принадлежит элемент (STRING)>''
|type=0
|status=1
|visual=1
|description=Атрибут получает или изменяет наименование слоя, которому принадлежит элемент. На любой форме существует по крайней мере один слой. Часть слоев может быть видимой, часть не отображаться. Для доступа к свойствам слоев формы, используется атрибут [[Form.Layers|Layers]].
}}
{{function entry
|name=[[Form.DropdownCount|DropdownCount]]
|form={{Grey|Form.}}'''DropdownCount''':''<Количество строк, показываемых полем со списком при активации списка (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет количество строк, показываемых полем со списком при активации списка.
}}
{{function entry
|name=[[Form.OutlineColor|OutlineColor]]
|form={{Grey|Form.}}'''OutlineColor''':''<Цвет контура картинки (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет количество цвет контура визуального элемента картинки. Цвет представлен 3 байтами (24 бит).
}}
{{function entry
|name=[[Form.IsHorizontal|IsHorizontal]]
|form={{Grey|Form.}}'''IsHorizontal''':''<Является ли элемент горизонтальным (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает тип элемента. 0 -- вертикальный, 1 -- горизонтальный.
}}
{{function entry
|name=[[Form.NoFoldersMode|NoFoldersMode]]
|form={{Grey|Form.}}'''NoFoldersMode''':''<Режим отображения таблицы вне структуры папок (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим отображения таблицы вне структуры папок. 0 -- таблица отображена с учетом папок (если папки поддерживаются), 1 -- папки отражены в общей структуре, как обычные элементы.
}}
{{function entry
|name=[[Form.Buttons|Buttons]]
|form={{Grey|Form.}}'''Buttons''':(''<Идентификатор кнопки-связанного элемента (INT)>'',''<Тип свойства кнопки-связанного элемента (STRING)>''{{Optional|,<Новое значение свойства кнопки-связанного элемента>}}):''<Текущее значение свойства кнопки-связанного элемента>''
|type=1
|status=2
|visual=1
|description=Функция позволяет получить доступ к связанным элементам (кнопкам), определенным для текущего визуального элемента. Кнопка задается по цифровому идентификатору. Для получения или изменения доступны следующие типы свойств: '''Font''', '''Caption''', '''IsDisabled''', '''Hint''', '''Color'''.
}}
{{function entry
|name=[[Form.OLE|OLE]]
|form={{Grey|Form.}}'''OLE''':''<OLE-объект визуального элемента (OLE)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет значение OLE-объекта визуального элемента. При изменении объекта, в визуальном элементе создается его копия со всеми текущими настройками, присваиваемый объект не будет тем же самым объектом, что и объект, отображаемый на форме. Инициализация объектов может происходить в асинхронном режиме, поэтому, после присваивания OLE-объекту, необходимо подождать окончания его полной инициализации.
}}
{{function entry
|name=[[Form.Picture|Picture]]
|form={{Grey|Form.}}'''Picture''':''<Объект картинки визуального элемента (PICTURE)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает объект картинки визуального элемента. Атрибут используется только для визуальных элементов типа картинка. Применяя функции объекта картинки к полученном объекту, его можно изменить, загрузить с диска и пр. См. статью [[Картинка]].
}}
{{function entry
|name=[[Form.SetFocus|SetFocus]]
|form={{Grey|Form.}}'''SetFocus'''()
|type=1
|status=2
|visual=1
|description=Функция позволяет активизировать текущий визуальный элемент (т.е., элемент получает фокус).
}}
{{function entry
|name=[[Form.SetFilter|SetFilter]]
|form={{Grey|Form.}}'''SetFilter'''(''<Наименование фильтра (STRING)>''{{Optional|,<Значение фильтра>}})
|type=1
|status=2
|visual=1
|description=Функция работает для табличных элементов, связанных с базой данных и позволяет установить или сбросить один фильтр по его наименованию, остальные фильтры, применяемые к таблице, не будут изменены. Начальные фильтры могут быть заданы в Студии при редактировании формы. Фильтры позволяют отображать содержимое таблицы в требуемом разрезе. Если второй аргумент отсутствует, фильтр будет удален. В наименование фильтра можно включать дополнительные признаки (префиксы), позволяющие задавать способ применения фильтра. Для более полной информации см. статью [[Стандартные фильтры]] (простой режим). Пример: <code>Form.MainTab.SetFilter("<>@Status",1)</code>. Табличный элемент будет обновлен после каждого применения функции, если необходимо установить несколько фильтров, предпочтительнее пользоваться функциями [[Form.SetFilters|SetFilters]] или [[Form.SetFiltersAndPositionOnElement|SetFiltersAndPositionOnElement]].
}}
{{function entry
|name=[[Form.SetFilters|SetFilters]]
|form={{Grey|Form.}}'''SetFilters'''(''<Наименования фильтров через запятые (STRING)>''{{Optional|,<Значение фильтра 1>,<Значение фильтра 2>...}})
|type=1
|status=2
|visual=1
|description=Функция работает для табличных элементов, связанных с базой данных и позволяет установить фильтры таблицы. Фильтры, не указанные в списке фильтров, будут удалены. Начальные фильтры могут быть заданы в Студии при редактировании формы. Фильтры позволяют отображать содержимое таблицы в требуемом разрезе. В наименование фильтра можно включать дополнительные признаки (префиксы), позволяющие задавать способ применения фильтра. Для более полной информации см. статью [[Стандартные фильтры]] (простой режим). Пример: <code>Form.MainTab.SetFilters("<>@Status,>=DocDate,<DocDate",1,'01.01.2025','01.02.2025')</code>. Если необходимо изменить или добавить один фильтр таблицы и не трогать остальные, можно воспользоваться функцией [[Form.SetFilter|SetFilter]].
}}
{{function entry
|name=[[Form.GetFilters|GetFilters]]
|form={{Grey|Form.}}'''GetFilters'''():''<Список текущих фильтров таблицы и их значений (LIST)>''
|type=1
|status=2
|visual=1
|description=Функция работает для табличных элементов, и позволяет получить текущие фильтры таблицы. Имена элементов полученного списка будут представлять имена столбцов таблицы и операции над ними (к примеру, <code><=DocDate</code>). Значениями будут являться значения фильтров. Данная функция включает как быстрые текстовые фильтры над столбцами таблицы, так и внутренние фильтры (фильтры режима показа по папкам и т.п.), однако, не все режимы могут полностью поддерживаться.
}}
{{function entry
|name=[[Form.PositionOnElement|PositionOnElement]]
|form={{Grey|Form.}}'''PositionOnElement'''(''<Объект позиционирования>''{{Optional|,<Дождаться окончания загрузки и позиционирования в таблице (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=1
|description=Функция используется для обновления содержимого табличного элемента из базы данных и позиционировании его на указанном объекте. Функция может применяться к таблице, дереву или списку, которые привязаны к базе данных. При необходимости, функция может дождаться окончания загрузки и позиционирования, однако, подобный вызов из обработчиков событий может привести к непредсказуемым последствиям, рекомендуется подходить к этому режиму с осторожностью.
}}
{{function entry
|name=[[Form.SetFiltersAndPositionOnElement|SetFiltersAndPositionOnElement]]
|form={{Grey|Form.}}'''SetFiltersAndPositionOnElement'''({{Optional|<Элемент для позиционирования>}},''<Наименования фильтров через запятые (STRING)>''{{Optional|,<Значение фильтра 1>,<Значение фильтра 2>...}})
|type=1
|status=2
|visual=1
|description=Функция работает для табличных элементов, связанных с базой данных и позволяет установить фильтры таблицы. Фильтры, не указанные в списке фильтров, будут удалены. Начальные фильтры могут быть заданы в Студии при редактировании формы. Фильтры позволяют отображать содержимое таблицы в требуемом разрезе. В наименование фильтра можно включать дополнительные признаки (префиксы), позволяющие задавать способ применения фильтра. Для более полной информации см. статью [[Стандартные фильтры]] (простой режим). Пример: <code>Form.MainTab.SetFiltersAndPositionOnElement(aEl,"<>@Status,>=DocDate,<DocDate",1,'01.01.2025','01.02.2025')</code>. В отличие от функции [[Form.SetFilters|SetFilters]], данная функция не только устанавливает фильтры таблицы, но и позиционируется на требуемом элементе таблицы за одно обновление, тем самым включая в нее функцию [[Form.PositionOnElement|PositionOnElement]].
}}
{{function entry
|name=[[Form.SortString|SortString]]
|form={{Grey|Form.}}'''SortString''':''<Порядок сортировки таблицы, связанной с базой данных (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет порядок визуальной сортировки таблицы. Порядок сортировки представляет собой перечисление реквизитов (столбцов) сортировки через запятую с суффиксами направления сортировки. См. также статью [[DB.UseOrder|UseOrder]].
}}
{{function entry
|name=[[Form.QuickFilters|QuickFilters]]
|form={{Grey|Form.}}'''QuickFilters''':''<Список с текущими быстрыми фильтрами столбцов таблицы, связанной с базой данных (LIST)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает список, наименованиями элементов которого являются столбцы таблицы, в которых пользователь ввел значения в быстрый фильтр отбора (быстрые фильтры отображаются в заголовках столбиков таблицы, к которым они были применены), значения элементов заполнены текстовыми значениями фильтров.
}}
{{function entry
|name=[[Form.HeadElement|HeadElement]]
|form={{Grey|Form.}}'''HeadElement''':''<Объект, которому принадлежит строчная часть, отображаемая в текущей таблице (DB)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет объект, которому принадлежит строчная часть, отображаемая в текущей таблице. Если таблица не отображает строчную часть, использование атрибута не имеет смысла. Изменять объект можно только для строчных частей, которые не привязаны к объекту, открытому в данный момент на форме (см. [[Form.Object|Object]]). Т.е., таблица строчной части должна быть свободной, не принадлежащей объекту формы.
}}
{{function entry
|name=[[Form.FolderElement|FolderElement]], '''Folder'''
|form={{Grey|Form.}}'''FolderElement''':''<Папка, для которой отображается содержимое текущей таблицы (DB)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет папку (объект), для которой отображается содержимое текущей таблицы (таблица может отображать, к примеру, справочник с папками или строчную часть с папками). При изменении объекта, в таблице будет отображено содержимое указанной папки (произойдет перепозиционирование таблицы).
}}
{{function entry
|name=[[Form.ParentElement|ParentElement]], '''Parent'''
|form={{Grey|Form.}}'''ParentElement''':''<Родительский элемент текущей таблицы (DB)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет родительский элемент справочника (объект), которому подчинены элементы текущей таблицы. Изменять атрибут можно только для таблиц, которые не привязаны к объекту, открытому в данный момент на форме (см. [[Form.Object|Object]]). Т.е., таблица должна быть свободной, не принадлежащей объекту формы.
}}
{{function entry
|name=[[Form.SelectedElement|SelectedElement]]
|form={{Grey|Form.}}'''SelectedElement'''():''<Выбранный в данный момент элемент таблицы или дерева, связанных с базой данных (DB)>''
|type=1
|status=2
|visual=1
|description=Функция получает выбранный в данный момент элемент таблицы или дерева (т.е., элемент на котором установлен курсор). Функция не работает для таблиц, содержащих строчные части (так как строка строчной части не является элементом). Если ни один из элементов не выбран, атрибут возвращает пустое значение. Атрибут заменяет более сложную конструкцию (пример дан для таблиц, без доп. проверок): <code>aTab.Get(aTab.SelectedLine,"@ELEMENT")</code>.
}}
{{function entry
|name=[[Form.SelectedLine|SelectedLine]]
|form={{Grey|Form.}}'''SelectedLine''':''<Выбранная в данный момент строка таблицы (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает выбранную в данный момент строку таблицы (см. [[Tab.SelectedLine]]). Используется, как сокращение конструкции <code>aTab.Value.SelectedLine</code>.
}}
{{function entry
|name=[[Form.SelectedColumn|SelectedColumn]]
|form={{Grey|Form.}}'''SelectedColumn''':''<Индекс выбранного в данный момент столбца таблицы (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает индекс выбранного в данный момент столбца таблицы (см. [[Tab.SelectedColumn]]). Используется, как сокращение конструкции <code>aTab.Value.SelectedColumn</code>.
}}
{{function entry
|name=[[Form.SelectedColumnName|SelectedColumnName]]
|form={{Grey|Form.}}'''SelectedColumnName''':''<Наименование выбранного в данный момент столбца таблицы (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает наименование выбранного в данный момент столбца таблицы (см. [[Tab.SelectedColumnName]]). Используется, как сокращение конструкции <code>aTab.Value.SelectedColumnName</code>.
}}
{{function entry
|name=[[Form.Reload|Reload]]
|form={{Grey|Form.}}'''Reload'''()
|type=1
|status=2
|visual=1
|description=Функция производит обновление свободной таблицы, связанной с базой данных из базы данных, сохраняя текущую позицию курсора в ней, если это возможно. Обновление выполняется только для таблиц, которые не привязаны к объекту, открытому в данный момент на форме (см. [[Form.Object|Object]]). Т.е., таблица должна быть свободной, не принадлежащей объекту формы.
}}
{{function entry
|name=[[Form.Reinit|Reinit]]
|form={{Grey|Form.}}'''Reinit'''()
|type=1
|status=0
|visual=1
|description=Функция помечает все элементы таблицы, как не участвовавшие в визуальном обновлении. В дальнейшем для них будет вызвано одно из визуальных событий ''OnInitLine'' или ''OnShowLine''. Функция используется, как простая альтернатива функции [[Form.InvokeEvent|InvokeEvent]].
}}
{{function entry
|name=[[Form.RereadValue|RereadValue]]
|form={{Grey|Form.}}'''RereadValue'''({{Optional|<Новое значение редактирования>}})
|type=1
|status=2
|visual=1
|description=Функция используется для таблицы, в ячейке которой происходит редактирование, функция обновляет содержимое редактора ячейки текущим значением ячейки таблицы (как будто пользователь нажал ''ESC'' и отказался от введенного значения, однако, функция не закрывает редактор). При наличии аргумента, функция заменяет редактируемое значение на указанное, а не на оригинальное значение ячейки таблицы. Функцию удобно использовать как результат нажатия на связанный элемент. Это позволяет, к примеру, не выходя из режима редактирования ячейки, выбрать объект редактирования с помощью связанного элемента, либо вернуть значение по умолчанию при нажатии на очистку значения редактирования и пр.
}}
{{function entry
|name=[[Form.PasteText|PasteText]]
|form={{Grey|Form.}}'''PasteText'''(''<Текст для добавления (STRING)>''{{Optional|,<Способ добавления (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=1
|description=Функция используется для поля редактирования и позволяет добавить или вставить произвольный текст в поле. В зависимости от способа добавления текст может быть вставлен в начало существующего текста, в его конец или начиная с позиции, где установлен курсор.
}}
{{function entry
|name=[[Form.UpdateValue|UpdateValue]]
|form={{Grey|Form.}}'''UpdateValue'''()
|type=1
|status=2
|visual=1
|description=Функция используется для поля редактирования, активного в данный момент, функция обновляет содержимое поля редактируемым значением (текстовые поля могут задерживать обновление до потери фокуса, данная функция форсирует это обновление). Таким образом можно получить значение поля, редактируемого в данный момент. Функцию удобно использовать, если поле текстовое или числовое, для получения значения поля, пока оно все еще активно.
}}
{{function entry
|name=[[Form.BindToProperty|BindToProperty]]
|form={{Grey|Form.}}'''BindToProperty'''(''<Наименование реквизита объекта (STRING)>''):''<Операция выполнена успешно (INT)>''
|type=1
|status=2
|visual=1
|description=Функция используется для привязки текущего визуального элемента к реквизиту редактируемого в данный момент на форме объекта. Визуальный элемент может быть следующих типов: поле редактирования, флажок, группа переключателей, поле со списком. Визуальный элемент должен быть свободным и не привязанным к какому-либо реквизиту. Функция может использоваться, к примеру, в формах макросов, чтобы привязать визуальный элемент формы макроса к определенному реквизиту, вне зависимости от того, где этот макрос будет использован.
}}
{{function entry
|name=[[Form.BindToObject|BindToObject]]
|form={{Grey|Form.}}'''BindToObject'''(''<Наименование объекта (STRING)>''):''<Операция выполнена успешно (INT)>''
|type=1
|status=1
|visual=1
|description=Функция используется для привязки текущего табличного элемента (на данный момент только дерева) к определенному объекту проекта. Визуальный элемент должен быть свободным и не привязанным к строчной части объекта. Функция может использоваться, к примеру, в формах макросов, чтобы привязать визуальный элемент формы макроса к определенному объекту. Наименование объекта записывается в стандартном виде <code><Тип объекта>.<Вид объекта></code>.
}}
{{function entry
|name=[[Form.SetType|SetType]]
|form={{Grey|Form.}}'''SetType'''({{Optional|<Устанавливаемый тип поля редактирования (STRING)>}}):''<Текущий тип поля редактирования (STRING)>''
|type=1
|status=2
|visual=1
|description=Функция используется для полей редактирования, имеющих сложный составной тип или несколько типов данных. Функция получает текущий тип поля, либо задает его, если указан первый аргумент. Если тип данных поля задан, пользователю не придется выбирать его из списка при начале редактирования поля. Тип данных записывается в стандартном виде <code><Тип объекта>.<Вид объекта></code>. (см. [[Tab.Column.DataType|DataType]]).
}}
{{function entry
|name=[[Form.Lock|Lock]]
|form={{Grey|Form.}}'''Lock'''()
|type=1
|status=2
|visual=1
|description=Функция запрещает выполнения обновления визуальной таблицы или списка при их любом изменении до тех пор, пока не будет вызвана функция [[Form.Unlock|Unlock]]. Для таблицы функция аналогична [[Tab.Lock]] и используется, как сокращение конструкции <code>aTab.Value.Lock()</code>.
}}
{{function entry
|name=[[Form.Unlock|Unlock]]
|form={{Grey|Form.}}'''Unlock'''()
|type=1
|status=2
|visual=1
|description=Функция разрешает запрещенное ранее функцией [[Form.Lock|Lock]] выполнения обновления визуальной таблицы или списка при их любом изменении. Для таблицы функция аналогична [[Tab.Unlock]] и используется, как сокращение конструкции <code>aTab.Value.Unlock()</code>.
}}
{{function entry
|name=[[Form.IsLocked|IsLocked]]
|form={{Grey|Form.}}'''IsLocked'''():''<Обновление запрещено (INT)>''
|type=1
|status=2
|visual=1
|description=Функция проверяет, запрещено ли в данный момент обновление таблицы или списка при их изменении, инициированное с помощью функции [[Form.Lock|Lock]]. Для таблицы функция аналогична [[Tab.IsLocked]] и используется, как сокращение конструкции <code>aTab.Value.IsLocked()</code>.
}}
{{function footer}}

===Функции и атрибуты группы страниц с закладками===
Функции и атрибуты этой группы применяются к визуальному объекту группы страниц с закладками и позволяют изменять свойства страниц, активировать страницы, прятать или делать их недоступными.
{{function header}}
{{function entry
|name=[[Form.Pages|Pages]]
|form={{Grey|Form.}}'''Pages''':''<Объект свойств группы страниц с закладками (FORM)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает объект свойств группы страниц с закладками.
}}
{{function entry
|name=[[Form.Pages.PagesCount|PagesCount]]
|form={{Grey|Form.Pages.}}'''PagesCount''':''<Количество страниц (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает количество страниц в группе страниц с закладками. В подсчет включаются невидимые закладки.
}}
{{function entry
|name=[[Form.Pages.SelectedPage|SelectedPage]]
|form={{Grey|Form.Pages.}}'''SelectedPage''':''<Индекс активной страницы (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет выбранную в данный момент (активную) страницу визуального объекта группы страниц с закладками.
}}
{{function entry
|name=[[Form.Pages.Page|Page]]
|form={{Grey|Form.Pages.}}'''Page'''(''<Индекс или идентификатор страницы (INT,STRING)>''):''<Объект страницы группы страниц с закладками (FORM)>''
|type=1
|status=2
|visual=1
|description=Функция получает объект страницы группы страниц с закладками.
}}
{{function entry
|name=[[Form.Page.IsDisabled|IsDisabled]]
|form={{Grey|Form.Page.}}'''IsDisabled''':''<Признак недоступности страницы (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет признак недоступности страницы группы страниц с закладками.
}}
{{function entry
|name=[[Form.Page.IsInvisible|IsInvisible]]
|form={{Grey|Form.Page.}}'''IsInvisible''':''<Признак отображения страницы (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет признак отображения страницы группы страниц с закладками.
}}
{{function entry
|name=[[Form.Page.Caption|Caption]]
|form={{Grey|Form.Page.}}'''Caption''':''<Заголовок страницы (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет заголовок страницы группы страниц с закладками.
}}
{{function entry
|name=[[Form.Page.Hint|Hint]]
|form={{Grey|Form.Page.}}'''Hint''':''<Всплывающая подсказка страницы (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет всплывающую подсказку при наведении курсора мыши на заголовок страницы группы страниц с закладками.
}}
{{function entry
|name=[[Form.Page.Name|Name]]
|form={{Grey|Form.Page.}}'''Name''':''<Идентификатор страницы (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает идентификатор страницы группы страниц с закладками.
}}
{{function entry
|name=[[Form.Page.PageIndex|PageIndex]]
|form={{Grey|Form.Page.}}'''PageIndex''':''<Индекс (номер) текущей страницы группы страниц (INT)>''
|type=0
|status=0
|visual=1
|description=Атрибут используется совместно с объектом страницы группы страниц и возвращает индекс этой страницы.
}}
{{function footer}}

===Функции и атрибуты слоев формы, макроса или группы страниц с закладками===
Функции и атрибуты этой группы работают со слоями. Слои позволяют прятать и показывать группы элементов. Их удобно использовать, когда использование группы страниц с закладками неудобно. Слои задаются в Студии в общем для формы или для объектов подчиненных форм, такими объектами на данный момент являются [[Студия/Пользовательский компонент интерфейса|Макросы редактора форм]] и страницы группы страниц с закладками.
{{function header}}
{{function entry
|name=[[Form.Layers|Layers]]
|form={{Grey|Form.}}'''Layers''':''<Объект свойств слоев формы, макроса или группы страниц с закладками (FORM)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает объект свойств слоев формы, макроса или группы страниц с закладками. Для группы страниц с закладками, атрибут применяется к объекту выбранной страницы.
}}
{{function entry
|name=[[Form.Layers.DoesLayerExist|DoesLayerExist]]
|form={{Grey|Form.Layers.}}'''DoesLayerExist'''(''<Идентификатор слоя (STRING)>''):''<Существует ли слой с указанным идентификатором (INT)>''
|type=1
|status=2
|visual=1
|description=Функция проверяет наличие слоя по его идентификатору.
}}
{{function entry
|name=[[Form.Layers.GetLayers|GetLayers]]
|form={{Grey|Form.Layers.}}'''GetLayers''':''<Список идентификаторов активных (видимых) в данный момент слоев через запятую (STRING)>''
|type=1
|status=2
|visual=1
|description=Функция получает список идентификаторов активных (видимых) в данный момент слоев через запятую. Пример: <code>Form.оЗакладки.Pages.Page("Основное").Layers.GetLayers()</code>.
}}
{{function entry
|name=[[Form.Layers.SetLayers|SetLayers]]
|form={{Grey|Form.Layers.}}'''SetLayers'''(''<Активировать слои по списку идентификаторов через запятую (STRING)>'')
|type=1
|status=2
|visual=1
|description=Функция делает видимыми слои по списоку их идентификаторов через запятую. Слои, не указанные в списке будут скрыты. Пример: <code>Form.оЗакладки.Pages.Page("Основное").Layers.SetLayers("Main,Контрагент,Услуга")</code>.
}}
{{function footer}}

==Функции и атрибуты объекта главного меню==
Функции и атрибуты этой группы позволяют работать с главным меню. В Студии можно задать несколько меню, каждое из которых можно в любой момент показать в клиенте. Таким образом, для разных операторов клиента может быть использовано разное меню. Система также позволяет изменять свойства отдельных пунктов меню программно. Функция [[Menu.Invoke|Invoke]] также позволяет вызвать различные системные диалоги и функции, не доступные для вызова другими способами.
{{function header}}
{{function entry
|name=[[Menu.Initialize|Initialize]]
|form={{Grey|Menu.}}'''Initialize'''(''<Идентификатор или индекс (INT,STRING)>'')
|type=1
|status=2
|visual=1
|description=Функция активирует главное меню по его идентификатору (заданному при редактировании проекта), либо его индексу среди всех главных меню. Предыдущее главное меню будет удалено. Функция применима только для визуального клиента.
}}
{{function entry
|name=[[Menu.GetCurrentMenuID|GetCurrentMenuID]]
|form={{Grey|Menu.}}'''GetCurrentMenuID'''():''<Идентификатор, загруженного в данный момент меню (STRING)>''
|type=1
|status=2
|visual=1
|description=Функция получает идентификатор, загруженного в данный момент главного меню. Функция применима только для визуального клиента.
}}
{{function entry
|name=[[Menu.Count|Count]]
|form={{Grey|Menu.}}'''Count'''():''<Количество главных меню в системе (INT)>''
|type=1
|status=2
|visual=1
|description=Функция получает общее количество главных меню, заданных при редактировании проекта. Функция применима только для визуального клиента.
}}
{{function entry
|name=[[Menu.MenuName|MenuName]]
|form={{Grey|Menu.}}'''MenuName'''(''<Индекс меню (INT)>''):''<Идентификатор меню с указанным индексом (STRING)>''
|type=1
|status=2
|visual=1
|description=Функция возвращает идентификатор (наименование) меню по его индексу
}}
{{function entry
|name=[[Menu.ItemCount|ItemCount]]
|form={{Grey|Menu.}}'''ItemCount'''({{Optional|<Индекс меню (INT)>}}):''<Количество верхних пунктов указанного меню (INT)>''
|type=1
|status=2
|visual=1
|description=Функция получает количество верхних пунктов меню, указываемого индексом.
}}
{{function entry
|name=[[Menu.Invoke|Invoke]]
|form={{Grey|Menu.}}'''Invoke'''(''<Идентификатор или код стандартного действия (INT,STRING)>''{{Optional|,<Параметры>}})
|type=1
|status=2
|visual=1
|description=Функция выполняет стандартное действие главного меню (к примеру, вывод калькулятора или вызов административной панели). Действие может быть задано в виде числового идентификатора или строки-кода. См. описание.
}}
{{function entry
|name=[[Menu.Item|Item]]
|form={{Grey|Menu.}}'''Item'''(''<Идентификатор или индекс верхнего пункта меню (INT,STRING)>''{{Optional|,<Идентификатор или индекс меню (INT,STRING)>}}):''<Искомый пункт меню (MENUITEM)>''
|type=1
|status=2
|visual=1
|description=Функция получает ссылку на пункт меню по его индексу или идентификатору. Если второй аргумент не задан, пункт ищется в активном в данный момент меню, иначе в меню заданном индексом или идентификатором.
}}
{{function entry
|name=[[Menu.Item.Name|Name]]
|form={{Grey|Menu.Item.}}'''Name''':''<Идентификатор текущего пункта меню (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает идентификатор текущего пункта меню.
}}
{{function entry
|name=[[Menu.Item.Caption|Caption]]
|form={{Grey|Menu.Item.}}'''Caption''':''<Текст текущего пункта меню (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет текст текущего пункта меню.
}}
{{function entry
|name=[[Menu.Item.Check|Check]]
|form={{Grey|Menu.Item.}}'''Check''':''<Пометка текущего пункта меню (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет пометку (галочку) текущего пункта меню.
}}
{{function entry
|name=[[Menu.Item.Icon|Icon]]
|form={{Grey|Menu.Item.}}'''Icon''':''<Иконка текущего пункта меню (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет иконку текущего пункта меню.
}}
{{function entry
|name=[[Menu.Item.IsCheckable|IsCheckable]]
|form={{Grey|Menu.Item.}}'''IsCheckable''':''<Автоматически ставить галочку на пункте меню (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает или изменяет режим, когда галочка ставится или снимается автоматически при выборе пользователем текущего пункта меню.
}}
{{function entry
|name=[[Menu.Item.Count|Count]]
|form={{Grey|Menu.Item.}}'''Count'''():''<Количество подпунктов текущего пункта меню (INT)>''
|type=1
|status=2
|visual=1
|description=Функция получает количество подчиненных пунктов (подменю) текущего пункта меню.
}}
{{function entry
|name=[[Menu.Item.Child|Child]]
|form={{Grey|Menu.Item.}}'''Child'''(''<Идентификатор или индекс подчиненного пункта меню (INT,STRING)>''):''<Искомый пункт меню (MENUITEM)>''
|type=1
|status=2
|visual=1
|description=Функция получает подпункт текущего пункта меню по его индексу или идентификатору.
}}
{{function entry
|name=[[Menu.Item.Parent|Parent]]
|form={{Grey|Menu.Item.}}'''Parent'''():''<Родительский пункт меню или пустое значение (MENUITEM,NOTHING)>''
|type=1
|status=2
|visual=1
|description=Функция получает родительский пункт текущего пункта меню, если текущий пункт меню является верхним, функция отдает пустое значение.
}}
{{function entry
|name=[[Menu.Item.Add|Add]]
|form={{Grey|Menu.Item.}}'''Add'''({{Optional|<Индекс вставки пункта меню (INT)>,<Идентификатор пункта меню (STRING)>}},''<Текст пункта меню (STRING)>''{{Optional|,<Программа для исполнения при выборе пункта меню (STRING)>,<Иконка пункта меню (INT)>,<Режим автоматической установки галочки на пункте меню (INT)>}}):''<Новый пункт меню (MENUITEM)>''
|type=1
|status=2
|visual=1
|description=Функция добавляет или вставляет новый пункт меню в массив пунктов, подчиненных текущему.
}}
{{function entry
|name=[[Menu.Item.Remove|Remove]]
|form={{Grey|Menu.Item.}}'''Remove'''(''<Идентификатор или индекс пункта меню (STRING,INT)>'')
|type=1
|status=2
|visual=1
|description=Функция удаляет пункт меню, подчиненный текущему по его индексу или идентификатору.
}}
{{function footer}}

==Функции и атрибуты объекта меню кнопки панели задач==
Функции и атрибуты этой группы позволяют работать с меню кнопки панели задач. При нажатии правой кнопки мыши выводится стандартное меню, которое можно изменить. Любые пункты нового меню при активации будут вызывать визуальное событие ''OnTaskbarMenuClick'' заданное в свойствах формы (см. [[Студия/Визуальные события|Визуальные события]]).
{{function header}}
{{function entry
|name=[[Form.TaskbarMenu|TaskbarMenu]]
|form={{Grey|Form.}}'''TaskbarMenu''':''<Объект меню кнопки панели задач второго уровня (FORM)>''
|type=0
|status=2
|visual=1
|description=Атрибут получает объект меню кнопки панели задач второго уровня текущей формы.
}}
{{function entry
|name=[[Form.GlobalTaskbarMenu|GlobalTaskbarMenu]]
|form={{Grey|Form.}}'''GlobalTaskbarMenu''':''<Объект меню кнопки панели задач первого уровня (FORM)>''
|type=0
|status=0
|visual=1
|description=Атрибут получает объект меню кнопки панели задач первого уровня (кнопки панели задач потока).
}}
{{function entry
|name=[[Form.TaskbarMenu.Clear|Clear]]
|form={{Grey|Form.TaskbarMenu.}}'''Clear'''()
|type=1
|status=2
|visual=1
|description=Функция применяется к объекту меню кнопки панели задач, и производит очистку меню (меню заменяется на стандартное).
}}
{{function entry
|name=[[Form.TaskbarMenu.IsPresent|IsPresent]]
|form={{Grey|Form.TaskbarMenu.}}'''IsPresent'''():''<Задано дополнительное меню (INT)>''
|type=1
|status=2
|visual=1
|description=Функция применяется к объекту меню кнопки панели задач, возвращает 1, если меню задано, 0, в ином случае (стандартное меню).
}}
{{function entry
|name=[[Form.TaskbarMenu.LoadFromList|LoadFromList]]
|form={{Grey|Form.TaskbarMenu.}}'''LoadFromList'''(''<Список с пунктами меню (LIST)>'')
|type=1
|status=2
|visual=1
|description=Функция применяется к объекту меню кнопки панели задач, и производит загрузку меню из списка значений, меню, существовавшее до этого, будет очищено. Список может быть многоуровневым (содержать элементы, являющиеся списками). Для элементов меню будут использованы следующие свойства значений списка: представление значения списка (наименование), статус галочки значения списка, иконка значения списка. Если пользователь активирует новый пункт меню, будет вызвано визуальное событие ''OnTaskbarMenuClick''.
}}
{{function entry
|name=[[Form.TaskbarMenu.SaveToList|SaveToList]]
|form={{Grey|Form.TaskbarMenu.}}'''SaveToList'''():''<Список для сохранения пунктов меню (LIST)>''
|type=1
|status=2
|visual=1
|description=Функция применяется к объекту меню кнопки панели задач, и получает текущее заданное меню в виде списка. Многоуровневое меню будет представлено в виде подчиненных списков.
}}
{{function entry
|name=[[Form.TaskbarMenu.Hint|Hint]]
|form={{Grey|Form.TaskbarMenu.}}'''Hint'''({{Optional|<Новая всплывающая подсказка (STRING)>}}):''<Текущая всплывающая подсказка (STRING)>''
|type=1
|status=2
|visual=1
|description=Функция применяется к объекту меню кнопки панели задач, и получает или изменяет всплывающую подсказку, показываемую при наведении курсора мыши на кнопку панели задач.
}}
{{function footer}}

{{Объекты}}

Таблица

2025-12-27T17:09:00Z

Admin: 1 revision imported

{{infobox object
|image=tab.png
|visual=[[Студия/Таблица значений|Таблица значений]]
|object=Tab
|status=2
|create=[[Tab.Create|Create]]}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]}}
Объект '''таблица''' позволяет хранить большие объемы данных любого типа в виде таблиц, а также сортировать их, объединять таблицы, задавать определенные типы данных столбцам таблицы, хранить информацию о флажках или иконках. Таблицы представлены на формах [[Студия/Таблица значений|таблицами значений]], результаты запросов представлены таблицами, таблицы используются в разнообразных функциях и объектах и являются неотъемлемой частью системы. Функции работы с таблицами имеют ряд оптимизаций, доступных разработчикам.
Таблица имеет три внутренних указателя:
* Текущая строка (''CurLine'') -- внутренний указатель, использующийся при изменении ячеек таблицы по наименованию столбца (к примеру, <code>aTab.<Столбец>:=<Значение></code>). Указатель меняется при добавлении, удалении или сдвиге строк, а также при выборке строк таблицы с помощью функции [[Tab.Select|Select]], поиске значений и пр. Нумерация строк начинается с единицы.
* Выбранная строка (''SelectedLine'') -- внутренний указатель, совпадающий с положением курсора (выделенной ячейки) внутри таблицы, когда она представлена на экране в виде элемента формы. Изменение указателя автоматически перемещает курсор. Использование указателя для невизуальных таблиц не запрещено. Нумерация строк начинается с единицы.
* Выбранный столбец (''SelectedColumn'') -- внутренний указатель, совпадающий с положением курсора (выделенного столбца) внутри таблицы, когда она представлена на экране в виде элемента формы. Изменение указателя автоматически перемещает курсор. Использование указателя для невизуальных таблиц не запрещено. Нумерация столбцов начинается с единицы.

== Атрибуты и функции==
{{function header}}
{{function entry
|name=[[Tab.Array|[<Индекс столбца (INT,STRING)>]]], [[Tab.Array|[<Индекс столбца (INT,STRING)>,<Индекс строки (INT)>]]]
|form={{Grey|Tab}}'''[<Индекс или наименование столбца (INT,STRING)>{{Optional|,<Индекс строки (INT)>}}]''':''<Значение>''
|type=0
|status=2
|visual=0
|description=Использование синтаксиса массивов позволяет получить или изменить значение таблицы по индексу (аргументом является число) или наименованию (аргументом является строка) его столбца для текущей строки таблицы, если не задан второй аргумент, иначе для строки таблицы заданной индексом, указанным во втором аргументе.
}}
{{function entry
|name=[[Tab.ColumnName|<Имя столбца>]]
|form={{Grey|Tab.}}'''<Имя столбца>''':''<Значение ячейки>''
|type=0
|status=2
|visual=0
|description=Получить значение таблицы, находящееся в столбце ''<Имя столбца>'' и строке с индексом CurLine
}}
{{function entry
|name=[[Tab.CurLine|CurLine]]
|form={{Grey|Tab.}}'''CurLine''':''<Индекс текущей строки (INT)>''
|type=0
|status=2
|visual=0
|description=Получить индекс текущей строки таблицы (первая строка=1). Текущая строка и выбранная пользователем строка визуального объекта, привязанного к таблице, могут иметь разные значения. Текущая строка используется в функциях выборки строк таблицы [[Tab.Select|Select]] и пр.
}}
{{function entry
|name=[[Tab.SelectedLine|SelectedLine]]
|form={{Grey|Tab.}}'''SelectedLine''':''<Индекс выбранной строки (INT)>''
|type=0
|status=2
|visual=1
|description=Получить индекс выбранной строки визуального объекта (первая строка=1). Текущая строка и выбранная пользователем строка визуального объекта, привязанного к таблице, могут иметь разные значения.
}}
{{function entry
|name=[[Tab.SelectedColumn|SelectedColumn]]
|form={{Grey|Tab.}}'''SelectedColumn''':''<Индекс выбранного столбца (INT)>''
|type=0
|status=2
|visual=1
|description=Получить индекс выбранного столбца визуального объекта (первый столбец=1). Скрытые в визуальной таблице столбцы также участвуют в подсчете индекса.
}}
{{function entry
|name=[[Tab.SelectedColumnName|SelectedColumnName]]
|form={{Grey|Tab.}}'''SelectedColumnName''':''<Наименование выбранного столбца (STRING)>''
|type=0
|status=2
|visual=1
|description=Получить наименование выбранного столбца визуального объекта, как оно было заданно в Студии. Наименование всегда хранится в верхнем регистре.
}}
{{function entry
|name=[[Tab.MultiSelection|MultiSelection]]
|form={{Grey|Tab.}}'''MultiSelection''':''<Таблица с выбранными регионами (TAB)>''
|type=0
|status=2
|visual=1
|description=Получить таблицу, описывающую все регионы, выделенные пользователем, для визуальных таблиц с возможностью выделения регионов. Таблица не будет содержать ни одной строки, если таблица не привязана к визуальному объекту, либо в объекте не выбрана ни одна строка.
}}
{{function entry
|name=[[Tab.IsEditorActive|IsEditorActive]]
|form={{Grey|Tab.}}'''IsEditorActive''':''<Статус редактора ячейки (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут проверяет, активен ли редактор ячейки таблицы в данный момент.
}}
{{function entry
|name=[[Tab.Create|Create]]
|form={{Grey|Tab.}}'''Create'''({{Optional|<Список столбцов через запятую (STRING)>}}):''<Новый объект (TAB)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает новый объект типа [[Таблица]], создавая столбцы с заданными именами, если необходимо.
}}
{{function entry
|name=[[Tab.Column|Column]]
|form={{Grey|Tab.}}'''Column'''(''<Наименование или индекс столбца (INT,STRING)>''):''<Объект столбца таблицы (TAB)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает подчиненный объект типа [[Таблица#Объект столбца таблицы|столбец таблицы]]. Доступ к свойствам столбцов таким образом опасен для многопоточных объектов. Необходимо использовать функции [[LockObject]] и [[UnlockObject]], когда объект используется в нескольких потоках.
}}
{{function entry
|name=[[Tab.Size|Size]], '''Lines'''
|form={{Grey|Tab.}}'''Size'''({{Optional|<Новое количество строк (INT)>}}):''<Текущее количество строк в таблице (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает или/и изменяет количество строк в таблице.
}}
{{function entry
|name=[[Tab.Columns|Columns]]
|form={{Grey|Tab.}}'''Columns'''({{Optional|<Новое количество столбцов (INT)>}}):''<Текущее количество столбцов в таблице (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает или/и изменяет количество столбцов в таблице.
}}
{{function entry
|name=[[Tab.AddColumn|AddColumn]]
|form={{Grey|Tab.}}'''AddColumn'''({{Optional|<Наименование столбца (STRING)>,<Заголовок столбца (STRING)>,<Тип данных столбца (STRING)>,<Ширина столбца (INT)>,<Режим выравнивания столбца (INT)>,<Видимость столбца (INT)>}})
|type=1
|status=2
|visual=0
|description=Функция добавляет столбец в таблицу, устанавливая его свойства, если необходимо. Если количество строк в таблице больше нуля, ячейки столбца заполняются пустым значением, либо принимают неинициализированное значение в соответствии с типом данных столбца, если последний задан.
}}
{{function entry
|name=[[Tab.InsertColumn|InsertColumn]]
|form={{Grey|Tab.}}'''InsertColumn'''(''<Индекс вставляемого столбца (INT)>''{{Optional|,<Наименование столбца (STRING)>,<Заголовок столбца (STRING)>,<Тип данных столбца (STRING)>,<Ширина столбца (INT)>,<Режим выравнивания столбца (INT)>,<Видимость столбца (INT)>}})
|type=1
|status=2
|visual=0
|description=Функция добавляет столбец в таблицу с указанным индексом, устанавливая его свойства, если необходимо. Если количество строк в таблице больше нуля, ячейки столбца заполняются пустым значением, либо принимают неинициализированное значение в соответствии с типом данных столбца, если последний задан.
}}
{{function entry
|name=[[Tab.RemoveColumn|RemoveColumn]]
|form={{Grey|Tab.}}'''RemoveColumn'''(''<Наименование или индекс столбца (INT,STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция удаляет столбец с указанным индексом или наименованием из таблицы.
}}
{{function entry
|name=[[Tab.SetColumn|SetColumn]]
|form={{Grey|Tab.}}'''SetColumn'''(''<Наименование или индекс столбца (INT,STRING)>''{{Optional|,<Заголовок столбца (STRING)>,<Тип данных столбца (STRING)>,<Ширина столбца (INT)>,<Режим выравнивания столбца (INT)>,<Видимость столбца (INT)>}})
|type=1
|status=2
|visual=0
|description=Функция изменяет свойства столбца с указанным индексом или наименование. Если новый тип данных столбца задан, все существующие ячейки таблицы в данном столбце будут приведены к новому типу данных.
}}
{{function entry
|name=[[Tab.GetColumnIndex|GetColumnIndex]]
|form={{Grey|Tab.}}'''GetColumnIndex'''(''<Наименование столбца (STRING)>''):''<Индекс столбца (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает индекс столбца с заданным наименованием. Если столбец не существует, функция возвращает ноль.
}}
{{function entry
|name=[[Tab.GetColumnName|GetColumnName]]
|form={{Grey|Tab.}}'''GetColumnName'''(''<Индекс столбца (INT)>''):''<Наименование столбца таблицы (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает наименование столбца с заданным индексом. Наименования столбцов всегда хранятся в верхнем регистре.
}}
{{function entry
|name=[[Tab.NewLine|NewLine]]
|form={{Grey|Tab.}}'''NewLine'''({{Optional|<Индекс новой строки (INT)>}})
|type=1
|status=2
|visual=0
|description=Функция добавляет в конец таблицы новую строку и помечает ее как текущую. Строка также может быть вставлена в таблицу по определенному индексу, если он задан.
}}
{{function entry
|name=[[Tab.AddLine|AddLine]]
|form={{Grey|Tab.}}'''AddLine'''(''<Наименования столбцов через запятую (STRING)>''{{Optional|,<Значение столбца 1>,<Значение столбца 2>...}})
|type=1
|status=2
|visual=0
|description=Функция добавляет в конец таблицы новую строку и помечает ее как текущую. Указанные в первом аргументе столбцы таблицы, в добавленной строке будут заполнены значениями, заданными последующими аргументами.
}}
{{function entry
|name=[[Tab.AddLineSorted|AddLineSorted]]
|form={{Grey|Tab.}}'''AddLineSorted'''(''<Наименования столбцов сортировки через запятую (STRING)>'',''<Наименования столбцов добавления через запятую (STRING)>''{{Optional|,<Значение столбца 1>,<Значение столбца 2>...}})
|type=1
|status=2
|visual=0
|description=Функция добавляет новую строку и помечает ее как текущую. Указанные во втором аргументе столбцы таблицы, в добавленной строке будут заполнены значениями, заданными последующими аргументами. Строка вставляется в таблицу таким образом, чтобы не нарушить сортировку, заданную наименованиями столбцов первого аргумента.
}}
{{function entry
|name=[[Tab.UpdateLineEx|UpdateLineEx]]
|form={{Grey|Tab.}}'''UpdateLineEx'''(''<Наименования столбцов поиска через запятую (STRING)>''{{OptionalByRef|,''<Начальный индекс поиска, результирующий индекс (INT)>''}}{{Optional|,<Значение столбца поиска 1>,<Значение столбца поиска 2>...,<Таблица сортирована по столбцам поиска (INT)>,<Наименования столбцов обновления через запятую (STRING)>,<Значение обновления столбца 1>,<Значение обновления столбца 2>...}}):''<0, если строка добавлена, иначе количество обновленных строк (INT)>''
|type=1
|status=2
|visual=0
|description=Функция обновляет строки, заданные аргументами для поиска или добавляет новую строку. Поиск начинается со строки, заданной вторым аргументом. Для всех строк, удовлетворящих условиям поиска, значения в столбцах, заданных аргументов с наименования столбцов обновления, будут изменены на аргументы, идущие за аргументом с наименованиями. Если ни одна строка не найдена, будет добавлена одна новая строка. Если применяется сортированный поиск (аргумент сортироки равен 1), строка вставляется в таблицу таким образом, чтобы не нарушить сортировку, заданную наименованиями столбцов первого аргумента. Если второй аргумент является переменной, в ней будет возвращен индекс добавленной строки или общее количество найденных и измененных строк в соотвествии с результатами поиска. Данная функция не использует текущую строку таблицы, что позволяет ее применять при работе с нескольми потоками (thread-safe).
}}
{{function entry
|name=[[Tab.InsertLine|InsertLine]]
|form={{Grey|Tab.}}'''InsertLine'''(''<Индекс добавляемой строки (INT)>'',''<Наименования столбцов через запятую (STRING)>''{{Optional|,<Значение столбца 1>,<Значение столбца 2>...}})
|type=1
|status=2
|visual=0
|description=Функция вставляет строку в таблицу по указанному индексу и помечает ее как текущую. Указанные в первом аргументе столбцы таблицы, в добавленной строке будут заполнены значениями, заданными последующими аргументами.
}}
{{function entry
|name=[[Tab.CopyLine|CopyLine]]
|form={{Grey|Tab.}}'''CopyLine'''({{Optional|<Индекс копируемой строки (INT)>,<Индекс новой строки (INT)>,<Количество добавляемых строк (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=0
|description=Функция добавляет новую строку по указанному во втором аргументе индексу (или в конец таблицы, если второй аргумент опущен) и заполняет ее значениями из строки, указанной в первом аргументе (или текущей строки, если первый аргумент опущен).
}}
{{function entry
|name=[[Tab.Remove|Remove]]
|form={{Grey|Tab.}}'''Remove'''(''<Индекс удаляемой строки (INT)>''{{Optional|,<Количество удаляемых строк (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=0
|description=Функция удаляет указанное количество строк (либо одну строку, если второй аргумент опущен), начиная с индекса, заданного первым аргументом.
}}
{{function entry
|name=[[Tab.ClearLines|ClearLines]]
|form={{Grey|Tab.}}'''ClearLines'''()
|type=1
|status=2
|visual=0
|description=Функция удаляет все строки из таблицы (при этом количество столбцов не изменяется).
}}
{{function entry
|name=[[Tab.Clear|Clear]]
|form={{Grey|Tab.}}'''Clear'''()
|type=1
|status=2
|visual=0
|description=Функция удаляет все строки и столбцы из таблицы.
}}
{{function entry
|name=[[Tab.Select|Select]]
|form={{Grey|Tab.}}'''Select'''():''<В таблице есть по крайней мере одна строка (INT)>''
|type=1
|status=2
|visual=0
|description=Функция начинает выборку по строкам таблицы (ее действие аналогично фрагменту <code><Таблица>.CurLine:=0</code>). Функция возвращает 1, если в выборке есть по крайней мере одна строка, иначе возвращается ноль. Функция используется в начале цикла по обходу всех строк таблицы.
}}
{{function entry
|name=[[Tab.Next|Next]]
|form={{Grey|Tab.}}'''Next'''():''<Найдена следующая строка (INT)>''
|type=1
|status=2
|visual=0
|description=Функция перемещает указатель текущей строки на следующую строку и возвращает единицу, если следующая строка существует, иначе возвращает ноль. Действие функции аналогично фрагменту <code><Таблица>.CurLine:=?(<Таблица>.CurLine=<Таблица>.Size(),<Таблица>.CurLine,<Таблица>.CurLine+1)</code>. Функция используется внутри цикла по обходу всех строк таблицы.
}}
{{function entry
|name=[[Tab.Prev|Prev]]
|form={{Grey|Tab.}}'''Prev'''():''<Найдена предыдущая строка (INT)>''
|type=1
|status=2
|visual=0
|description=Функция перемещает указатель текущей строки на предыдущую строку, если указатель больше нуля, и возвращает единицу, если предыдущая строка существует, иначе возвращает ноль. Действие функции аналогично фрагменту <code><Таблица>.CurLine:=?(<Таблица>.CurLine=0,<Таблица>.CurLine,<Таблица>.CurLine-1)</code>.
}}
{{function entry
|name=[[Tab.Goto|Goto]]
|form={{Grey|Tab.}}'''Goto'''(''<Индекс строки (INT)>'')
|type=1
|status=2
|visual=0
|description=Функция перемещает указатель текущей строки на строку с указанным индексом. Действие функции аналогично фрагменту <code><Таблица>.CurLine:=<Индекс></code>
}}
{{function entry
|name=[[Tab.Move|Move]]
|form={{Grey|Tab.}}'''Move'''(''<Индекс перемещаемой строки (INT)>'',''<Расстояние перемещения (INT)>'')
|type=1
|status=2
|visual=0
|description=Функция сдвигает строку с индексом, задаваемым первым аргументом, внутри таблицы на указанное количество строк. Расстояние сдвига может быть отрицательным числом. При положительном сдвиге, строка из конца таблицы переходит в ее начало, при отрицательном сдвиге строка с начала таблицы переходит в конец.
}}
{{function entry
|name=[[Tab.Set|Set]]
|form={{Grey|Tab.}}'''Set'''({{Optional|<Индекс строки (INT)>}},''<Наименование или индекс столбца (INT,STRING)>'',''<Устанавливаемое значение>'')
|type=1
|status=2
|visual=0
|description=Функция устанавливает значение ячейки с наименованием или индексом столбца, заданным вторым аргументом, индекс строки ячейки задается первым аргументом или используется текущая строка, если первый аргумент не задан.
}}
{{function entry
|name=[[Tab.Get|Get]]
|form={{Grey|Tab.}}'''Get'''({{Optional|<Индекс строки (INT)>}},''<Наименование или индекс столбца (INT,STRING)>''):''<Значение ячейки таблицы>''
|type=1
|status=2
|visual=0
|description=Функция получает значение ячейки с наименованием или индексом столбца, заданным вторым аргументом, индекс строки ячейки задается первым аргументом или используется текущая строка, если первый аргумент не задан.
}}
{{function entry
|name=[[Tab.Find|Find]]
|form={{Grey|Tab.}}'''Find'''(''<Значение поиска>''{{OptionalByRef|,<Начальный индекс поиска, результирующий индекс (INT)>,<Наименование или индекс столбца поиска, индекс результирующего столбца (STRING,INT)>}}{{Optional|,<Таблица сортирована по столбцу поиска (INT)>}}):''<Значение найдено 1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск значения в таблице, с возможным указанием начального индекса поиска, возможным указанием столбца поиска. Поиск может принимать во внимание факт того, что таблица сортирована по указанному столбцу по неубыванию, что может значительно ускорить нахождение значения. Если значение найдено, индекс строки или/и столбца, где оно было найдено, возвращается в переменных второго и третьего аргументов.
}}
{{function entry
|name=[[Tab.FindAndGoto|FindAndGoto]]
|form={{Grey|Tab.}}'''FindAndGoto'''(''<Значение поиска>''{{OptionalByRef|,<Начальный индекс поиска, результирующий индекс (INT)>,<Наименование или индекс столбца поиска, индекс результирующего столбца (STRING,INT)>}}{{Optional|,<Таблица сортирована по столбцу поиска (INT)>}}):''<Значение найдено 1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск значения в таблице, с возможным указанием начального индекса поиска, возможным указанием столбца поиска. Поиск может принимать во внимание факт того, что таблица сортирована по указанному столбцу по неубыванию, что может значительно ускорить нахождение значения. Если значение найдено, индекс строки или/и столбца, где оно было найдено, возвращается в переменных второго и третьего аргументов, функция также автоматически изменяет индекс текущей строки на индекс строки найденного значения, текущая строка не изменяется, если значение не найдено.
}}
{{function entry
|name=[[Tab.FindAndGet|FindAndGet]]
|form={{Grey|Tab.}}'''FindAndGet'''(''<Наименование или индекс столбца значения результата (STRING,INT)>'',''<Значение поиска>''{{OptionalByRef|,<Начальный индекс поиска, результирующий индекс (INT)>,<Наименование или индекс столбца поиска, индекс результирующего столбца (STRING,INT)>}}{{Optional|,<Таблица сортирована по столбцу поиска (INT)>}}):''<Полученное значение или пустое значение>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск значения в таблице, с возможным указанием начального индекса поиска, возможным указанием столбца поиска. Поиск может принимать во внимание факт того, что таблица сортирована по указанному столбцу по неубыванию, что может значительно ускорить нахождение значения. Если значение найдено, индекс строки или/и столбца, где оно было найдено, возвращается в переменных третьего и четвертого аргументов. Функция возвращает значение в столбце, заданном первым аргументом, из строки, в которой было найдено значение поиска, либо возвращает пустое значение, если поиск не был завершен успешно.
}}
{{function entry
|name=[[Tab.FindInLine|FindInLine]]
|form={{Grey|Tab.}}'''FindInLine'''(''<Значение поиска>''{{Optional|,<Индекс строки поиска (INT)>}}{{OptionalByRef|,<Наименование или индекс начального столбца поиска, индекс результирующего столбца (STRING,INT)>}}):''<Значение найдено 1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск значения в таблице в текущей строке или строке с заданным индексом, возможным указанием начального индекса столбца поиска. Если значение найдено, индекс столбца, где оно было найдено, возвращается в переменной третьего аргумента.
}}
{{function entry
|name=[[Tab.Locate|Locate]]
|form={{Grey|Tab.}}'''Locate'''(''<Список наименований столбцов поиска через запятую (STRING)>''{{Optional|,<Значение поиска столбца 1>,<Значение поиска столбца 2>...,<Таблица сортирована по столбцам поиска (INT)>}}):''<Индекс найденной строки таблицы (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск заданного списком столбцов количества значений в таблице. Поиск всегда начинается с первой строки таблицы. Поиск может принимать во внимание факт того, что таблица сортирована по всем столбцам поиска по неубыванию, что может значительно ускорить нахождение значения. Если значение найдено, индекс строки где оно было найдено, возвращается в результате функции, иначе функция возвращает ноль.
}}
{{function entry
|name=[[Tab.LocateEx|LocateEx]]
|form={{Grey|Tab.}}'''LocateEx'''(''<Список наименований столбцов поиска через запятую (STRING)>''{{OptionalByRef|,<Начальный индекс поиска, результирующий индекс (INT)>}}{{Optional|,<Значение поиска столбца 1>,<Значение поиска столбца 2>...,<Таблица сортирована по столбцам поиска (INT)>}}):''<Индекс найденной строки таблицы (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск заданного списком столбцов количества значений в таблице. Поиск начинается со строки, указанной в переменной второго аргумента или с первой строки, если аргумент пропущен. Поиск может принимать во внимание факт того, что таблица сортирована по всем столбцам поиска по неубыванию, что может значительно ускорить нахождение значения. Если значение найдено, индекс строки где оно было найдено, возвращается в результате функции и в переменной второго аргумента, если она задана. Если значение не было найдено, функция возвращает ноль и переменная не изменяется.
}}
{{function entry
|name=[[Tab.LocateAndGoto|LocateAndGoto]]
|form={{Grey|Tab.}}'''LocateAndGoto'''(''<Список наименований столбцов поиска через запятую (STRING)>''{{Optional|,<Значение поиска столбца 1>,<Значение поиска столбца 2>...,<Таблица сортирована по столбцам поиска (INT)>}}):''<Индекс найденной строки таблицы (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск заданного списком столбцов количества значений в таблице. Поиск всегда начинается со строки таблицы, следующей за текущей строкой (чтобы поиск начинался с начала таблицы, можно выполнить операцию <code><Таблица>.CurLine:=0</code>). Поиск может принимать во внимание факт того, что таблица сортирована по всем столбцам поиска по неубыванию, что может значительно ускорить нахождение значения. Если значение найдено, индекс строки где оно было найдено, возвращается в результате функции и обновляет текущую строку таблицы, иначе функция возвращает ноль.
}}
{{function entry
|name=[[Tab.Sort|Sort]]
|form={{Grey|Tab.}}'''Sort'''(''<Наименование столбцов сортировки с суффиксами через запятую (STRING)>''{{Optional|,<Алгоритм сортировки (INT)>{{Default|{{Eq}}1}}}})
|type=1
|status=2
|visual=0
|description=Функция выполняет сортировку строк таблицы по значениям указанных столбцов (направление сортировки может быть выбрано для каждого из столбцов в отдельности).
}}
{{function entry
|name=[[Tab.Sum|Sum]]
|form={{Grey|Tab.}}'''Sum'''(''<Наименование или индекс столбца (INT,STRING)>''{{Optional|,<Строки превращать в числа (INT)>{{Default|{{Eq}}0}},<Индекс начальной строки (INT)>{{Default|{{Eq}}0}},<Индекс конечной строки (INT)>{{Default|{{Eq}}<Последняя строка таблицы>}},<Округление при суммировании (INT)>{{Default|{{Eq}}-1}}}}):''<Результирующая сумма (NUMBER)>''
|type=1
|status=2
|visual=0
|description=Функция находит сумму значений указанного столбца таблицы в указанном диапазоне строк таблицы. Значения, представленные строками, могут быть превращены в числа при сложении, если необходимо. Для исключения накопления неточности при сложении вещественных чисел, можно указать требуемое количество цифр после точки.
}}
{{function entry
|name=[[Tab.Compute|Compute]]
|form={{Grey|Tab.}}'''Compute'''(''<Наименование или индекс столбца (INT,STRING)>''{{Optional|,<Тип операции (STRING)>{{Default|{{Eq}}"SUM"}},<Строки превращать в числа (INT)>{{Default|{{Eq}}0}},<Индекс начальной строки (INT)>{{Default|{{Eq}}0}},<Индекс конечной строки (INT)>{{Default|{{Eq}}<Последняя строка таблицы>}},<Округление при суммировании или нахождении среднего (INT)>{{Default|{{Eq}}-1}}}}):''<Результат вычисления (NUMBER)>''
|type=1
|status=2
|visual=0
|description=Функция выполняет одну из следующих операций на значениях указанного столбца таблицы в указанном диапазоне строк таблицы: сумма, минимум, максимум, среднее, количество значений. Значения, представленные строками, могут быть превращены в числа при сложении, если необходимо. Для исключения накопления неточности при сложении вещественных чисел, можно указать требуемое количество цифр после точки.
}}
{{function entry
|name=[[Tab.SumLine|SumLine]]
|form={{Grey|Tab.}}'''SumLine'''(''<Индекс строки суммирования (INT)>''{{Optional|,<Строки превращать в числа (INT)>{{Default|{{Eq}}0}},<Округление при суммировании (INT)>{{Default|{{Eq}}-1}}}}):''<Результирующая сумма (NUMBER)>''
|type=1
|status=2
|visual=0
|description=Функция находит сумму значений указанной строки таблицы. Значения, представленные строками, могут быть превращены в числа при сложении, если необходимо. Для исключения накопления неточности при сложении вещественных чисел, можно указать требуемое количество цифр после точки.
}}
{{function entry
|name=[[Tab.Fill|Fill]]
|form={{Grey|Tab.}}'''Fill'''(''<Значение для заполнения>''{{Optional|,<Индекс начальной строки (INT)>,<Индекс конечной строки (INT)>,<Индекс или наименование столбца (INT,STRING)>}})
|type=1
|status=2
|visual=0
|description=Функция выполняет заполнение ячеек в указанном столбце таблицы для строк таблицы в указанном диапазоне указанным значением.
}}
{{function entry
|name=[[Tab.Copy|Copy]]
|form={{Grey|Tab.}}'''Copy'''():''<Новая таблица (TAB)>''
|type=1
|status=2
|visual=0
|description=Функция создает новый объект таблицы и заполняет ее столбцами, строками и значениями из текущей таблицы.
}}
{{function entry
|name=[[Tab.CopyTo|CopyTo]]
|form={{Grey|Tab.}}'''CopyTo'''({{ByRef|''<Объект в который происходит копирование>''}}{{Optional|,<Индекс начальной строки (INT)>,<Количество строк для копирования (INT)>,<Наименования столбцов копирования через запятую (STRING)>,<Наименования столбцов для фильтрации (STRING)>,<Фильтр столбца 1>,<Фильтр столбца 2>...}})
|type=1
|status=2
|visual=0
|description=Функция позволяет произвести копирование ячеек указанного столбца из текущей таблицы в заданный список, либо ячеек, указанных столбцов из текущей таблицы в заданную таблицу. Строки для копирования могут быть ограничены определенным диапазоном и выбраны с помощью заданного фильтра.
}}
{{function entry
|name=[[Tab.Group|Group]]
|form={{Grey|Tab.}}'''Group'''({{Optional|<Наименования столбцов группировки через запятую (STRING)>,<Наименования столбцов для агрегации с типами операций (STRING)>,<Округление при суммировании (INT)>{{Default|{{Eq}}-1}}}})
|type=1
|status=2
|visual=0
|description=Функция производит группировку таблицы по указанным столбцам, строки, где совокупность значений столбцов группировки повторяется, будут удалены, при этом над столбцами агрегации для всех строк дублей и строки, оставшейся в таблице, будет произведена указанная операция агрегации. Столбцы, не перечисленные в столбцах группировки и столбцах агрегации, будут удалены. Для исключения накопления неточности при сложении вещественных чисел, можно указать требуемое количество цифр после точки при выполнении операций агрегации. После выполнения операции, в таблице сохраняется порядок следования строк, существовавший до операции.
}}
{{function entry
|name=[[Tab.InnerJoin|InnerJoin]], '''Join'''
|form={{Grey|Tab.}}'''InnerJoin'''(''<Таблица, с которой объединяется текущая (TAB)>''{{Optional|,<Наименования столбцов группировки через запятую (STRING)>,<Наименования столбцов для агрегации с типами операций (STRING)>,<Округление при суммировании (INT)>{{Default|{{Eq}}-1}}}})
|type=1
|status=2
|visual=0
|description=Функция оставляет в текущей таблице только строки, для которых присутствуют эквивалентные в указанной таблице (эквивалентной считается строка, для которой значения всех столбцов группировки в обеих таблицах будет одинаковым). При этом ячейки в столбцах агрегации будут представлять результат операции агрегации над оставленными строками исходной таблицы и всеми эквивалентными строками указанной таблицы. Для исключения накопления неточности при сложении вещественных чисел, можно указать требуемое количество цифр после точки при выполнении операций агрегации. После выполнения операции, в таблице сохраняется порядок следования строк, существовавший до операции.
}}
{{function entry
|name=[[Tab.LeftOuterJoin|LeftOuterJoin]], '''LeftJoin'''
|form={{Grey|Tab.}}'''LeftOuterJoin'''(''<Таблица, с которой объединяется текущая (TAB)>''{{Optional|,<Наименования столбцов группировки через запятую (STRING)>,<Наименования столбцов для агрегации с типами операций (STRING)>,<Округление при суммировании (INT)>{{Default|{{Eq}}-1}}}})
|type=1
|status=2
|visual=0
|description=Функция выполняет агрегацию строк текущей таблицы с эквивалентными строками указанной таблицы (эквивалентной считается строка, для которой значения всех столбцов группировки в обеих таблицах будет одинаковым). При этом ячейки в столбцах агрегации будут представлять результат операции агрегации над строками исходной таблицы и всеми эквивалентными строками указанной таблицы. Для исключения накопления неточности при сложении вещественных чисел, можно указать требуемое количество цифр после точки при выполнении операций агрегации. После выполнения операции, в таблице сохраняется порядок следования строк, существовавший до операции.
}}
{{function entry
|name=[[Tab.FullOuterJoin|FullOuterJoin]], '''FullJoin'''
|form={{Grey|Tab.}}'''FullOuterJoin'''(''<Таблица, с которой объединяется текущая (TAB)>''{{Optional|,<Наименования столбцов группировки через запятую (STRING)>,<Наименования столбцов для агрегации с типами операций (STRING)>,<Округление при суммировании (INT)>{{Default|{{Eq}}-1}}}})
|type=1
|status=2
|visual=0
|description=Функция выполняет агрегацию строк текущей таблицы с эквивалентными строками указанной таблицы (эквивалентной считается строка, для которой значения всех столбцов группировки в обеих таблицах будет одинаковым), строки указанной таблицы, для которых нет эквивалента в текущей таблице, будут добавлены в последнюю с конца таблицы. При этом ячейки в столбцах агрегации будут представлять результат операции агрегации над строками исходной таблицы и всеми эквивалентными строками указанной таблицы. Для исключения накопления неточности при сложении вещественных чисел, можно указать требуемое количество цифр после точки при выполнении операций агрегации. После выполнения операции, в таблице сохраняется порядок следования строк, существовавший до операции.
}}
{{function entry
|name=[[Tab.Combine|Combine]]
|form={{Grey|Tab.}}'''Combine'''(''<Таблица для выполнения операции (TAB)>'',''<Наименования или индексы столбцов для сравнения (STRING)>''{{Optional|,<Тип операции (STRING)>{{Default|{{Eq}}"ADD"}},<Таблица сортирована по столбцам поиска (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция выполняет операцию объединения, заданную вторым аргументом, над текущей таблицей и таблицей, заданной первым аргументом. Результат операции сохраняется в текущей таблице. Аргегаьных операций не выполняется. Функцией удобно пользоваться, когда нет необходимости выполнять аргегатные операции, она проще и быстрее чем функции группы ''Join''.
}}
{{function entry
|name=[[Tab.RemoveLocated|RemoveLocated]]
|form={{Grey|Tab.}}'''RemoveLocated'''({{Optional|<Наименования столбцов поиска через запятую (STRING)>,<Значение столбца 1>,<Значение столбца 2>...,<Таблица сортирована по столбцам поиска (INT)>}}):''<Удален по крайней мере один элемент (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск заданного списком столбцов количества значений в таблице. Строки, подходящие под фильтр поиска, будут удалены из таблицы. Поиск начинается со строки таблицы, следующей за текущей. Поиск может принимать во внимание факт того, что таблица сортирована по всем столбцам поиска по неубыванию, что может значительно ускорить операцию.
}}
{{function entry
|name=[[Tab.RemoveLocatedEx|RemoveLocatedEx]]
|form={{Grey|Tab.}}'''RemoveLocatedEx'''({{Optional|<Наименования столбцов поиска через запятую (STRING)>,{{OptionalByRef|<Начальный индекс поиска, результирующий индекс (INT)>}},<Значение столбца 1>,<Значение столбца 2>...,<Таблица сортирована по столбцам поиска (INT)>}}):''<Удален по крайней мере один элемент (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит поиск заданного списком столбцов количества значений в таблице. Строки, подходящие под фильтр поиска, будут удалены из таблицы. Поиск начинается со строки таблицы, заданной вторым аргументом. Поиск может принимать во внимание факт того, что таблица сортирована по всем столбцам поиска по неубыванию, что может значительно ускорить операцию. Строка за последним найденным значением будет возвращена в переменной, заданной вторым аргументом, если таковая присутствует. В отличие от [[Tab.RemoveLocatedEx|RemoveLocatedEx]] функция не использует текущую строку, что позволяет ее применять при работе с нескольми потоками (thread-safe).
}}
{{function entry
|name=[[Tab.Compare|Compare]]
|form={{Grey|Tab.}}'''Compare'''(''<Таблица для сравнения (TAB)>''{{Optional|,<Столбцы для сравнения (STRING)>}}):''<Сравниваемая таблица совпадает с текущей (INT)>''
|type=1
|status=2
|visual=0
|description=Функция сравнивает текущую таблицу с заданной по указанным правилам, и возвращает 1, если таблицы эквивалентны.
}}
{{function entry
|name=[[Tab.RescaleColumns|RescaleColumns]]
|form={{Grey|Tab.}}'''RescaleColumns'''({{Optional|<Процент использования ширины таблицы (INT)>{{Default|{{Eq}}100}}}})
|type=1
|status=2
|visual=1
|description=Функция выполняет изменение размеров видимых столбцов таблицы таким образом, чтобы они занимали всю ширину таблицы на экране, либо ее требуемую часть, если задан первый аргумент.
}}
{{function entry
|name=[[Tab.FixedLines|FixedLines]]
|form={{Grey|Tab.}}'''FixedLines'''({{Optional|<Новое количество закрепленных строк (INT)>}}):''<Текущее количество закрепленных строк (INT)>''
|type=1
|status=2
|visual=1
|description=Функция производит закрепление заданного количества строк в верхней части визуального представления таблицы. Вне зависимости от положения курсора внутри таблицы, выбранные строки всегда будут показаны на экране.
}}
{{function entry
|name=[[Tab.FixedColumns|FixedColumns]]
|form={{Grey|Tab.}}'''FixedColumns'''({{Optional|<Новое количество закрепленных столбцов (INT)>}}):''<Текущее количество закрепленных столбцов (INT)>''
|type=1
|status=0
|visual=1
|description=Функция производит закрепление заданного количества столбцов в верхней части визуального представления таблицы. Вне зависимости от положения курсора внутри таблицы, выбранные столбцы всегда будут показаны на экране.
}}
{{function entry
|name=[[Tab.Check|Check]]
|form={{Grey|Tab.}}'''Check'''(''<Индекс строки галочки (INT)>'',''<Индекс или наименование столбца галочки (INT,STRING)>''{{Optional|,<Новое состояние галочки (INT)>}}):''<Текущее состояние галочки (INT)>''
|type=1
|status=2
|visual=1
|description=Функция считывает или устанавливает значение галочки в указанном столбце таблицы. Функция может использоваться также для невизуальных таблиц.
}}
{{function entry
|name=[[Tab.Icon|Icon]]
|form={{Grey|Tab.}}'''Icon'''(''<Индекс строки иконки (INT)>''{{Optional|,<Индекс или наименование столбца иконки (INT,STRING)>,<Новый индекс иконки (INT)>}}):''<Текущий индекс иконки (INT)>''
|type=1
|status=2
|visual=1
|description=Функция считывает или устанавливает значение индекса иконки в указанном столбце таблицы. Функция может использоваться также для невизуальных таблиц.
}}
{{function entry
|name=[[Tab.BackgroundColor|BackgroundColor]]
|form={{Grey|Tab.}}'''BackgroundColor'''({{Optional|<Индекс строки ячейки (INT)>,<Индекс или наименование столбца ячейки (INT,STRING)>,<Новый цвет фона ячейки (INT)>}}):''<Текущий цвет фона ячейки (INT)>''
|type=1
|status=2
|visual=1
|description=Функция считывает или устанавливает значение цвета фона ячейки в указанном столбце таблицы. Если столбец таблицы не указан цвет меняется для всей строки, если строка не указана для всех строк столбца или для всей таблицы, если не указана ни строка ни столбец. Функция может использоваться также для невизуальных таблиц.
}}
{{function entry
|name=[[Tab.FontColor|FontColor]]
|form={{Grey|Tab.}}'''FontColor'''(''<Индекс строки ячейки (INT)>''{{Optional|,<Индекс или наименование столбца ячейки (INT,STRING)>,<Новый цвет текста ячейки (INT)>}}):''<Текущий цвет текста ячейки (INT)>''
|type=1
|status=2
|visual=1
|description=Функция считывает или устанавливает значение цвета текста в указанном столбце таблицы. Если столбец таблицы не указан цвет меняется для всей строки. Функция может использоваться также для невизуальных таблиц.
}}
{{function entry
|name=[[Tab.FontStyle|FontStyle]]
|form={{Grey|Tab.}}'''FontStyle'''(''<Индекс строки ячейки (INT)>''{{Optional|,<Индекс или наименование столбца ячейки (INT,STRING)>,<Новый стиль текста ячейки (INT)>}}):''<Текущий стиль текста ячейки (INT)>''
|type=1
|status=2
|visual=1
|description=Функция считывает или устанавливает значение стиля текста в указанном столбце таблицы. Если столбец таблицы не указан стиль меняется для всей строки. Функция может использоваться также для невизуальных таблиц.
}}
{{function entry
|name=[[Tab.HighlightMode|HighlightMode]]
|form={{Grey|Tab.}}'''HighlightMode'''(''<Режим подсветки таблиц по умолчанию (INT)>''{{Optional|,<Цвет нечетных строк (INT)>,<Процент цвета нечетных строк (INT)>,<Цвет выделения строки или столбца курсора (INT)>,<Процент цвета выделения строки или столбца курсора (INT)>}})
|type=1
|status=2
|visual=1
|description=Функция изменяет режим подсветки строк текущей таблицы. Для глобального изменения подсветки всех таблиц см. функцию [[DefaultHighlightMode]].
}}
{{function entry
|name=[[Tab.StartEdit|StartEdit]]
|form={{Grey|Tab.}}'''StartEdit'''({{Optional|<Индекс строки ячейки (INT)>,<Индекс или наименование столбца ячейки (INT,STRING)>}}):''<Редактирование инициировано (INT)>''
|type=1
|status=0
|visual=1
|description=Функция производит попытку запустить редактор ячейки таблицы для указанной ячейки таблицы.
}}
{{function entry
|name=[[Tab.FinishEdit|FinishEdit]]
|form={{Grey|Tab.}}'''FinishEdit'''({{Optional|<Режим окончания редактирования (INT)>,<Индекс выделенного столбца после окончания редактирования или ноль (INT,STRING)>}})
|type=1
|status=2
|visual=1
|description=Функция инициирует окончание редактирования ячейки таблицы в указанном режиме.
}}
{{function entry
|name=[[Tab.Lock|Lock]]
|form={{Grey|Tab.}}'''Lock'''()
|type=1
|status=2
|visual=1
|description=Функция запрещает выполнения обновления визуальной таблицы при любом ее изменении до тех пор, пока не будет вызвана функция [[Tab.Unlock|Unlock]]. Функция может использоваться перед большим количеством обновлений или заполнении большой таблицы для получения значительного ускорения операции. Функцию необходимо использовать совместно с конструкцией <code>Try .. Finally</code> для исключения вероятности появления нерабочей таблицы на форме.
}}
{{function entry
|name=[[Tab.Unlock|Unlock]]
|form={{Grey|Tab.}}'''Unlock'''()
|type=1
|status=2
|visual=1
|description=Функция разрешает запрещенное ранее функцией [[Tab.Lock|Lock]] выполнения обновления визуальной таблицы при любом ее изменении. См. функцию [[Tab.Lock|Lock]].
}}
{{function entry
|name=[[Tab.IsLocked|IsLocked]]
|form={{Grey|Tab.}}'''IsLocked'''():''<Обновление запрещено (INT)>''
|type=1
|status=2
|visual=1
|description=Функция проверяет, запрещено ли в данный момент обновление таблицы при ее изменении, запрет инициируется с помощью функции [[Tab.Lock|Lock]].
}}
{{function footer}}

== Объект столбца таблицы ==
Подчиненный объект, ссылающийся на таблицу, используется для доступа к свойствам столбцов таблицы. Так как объект будет ссылаться на определенный столбец таблицы, существует вероятность удаления этого столбца в другом потоке до того, как программа закончит работу с объектом, это может создать ошибочную ситуацию. Чтобы обойти проблему, необходимо либо убедиться, что объект будет использоваться только в одном потоке, столбцы не будут удаляться в других потоках или использовать функции [[LockObject]] и [[UnlockObject]] (однако, их нельзя использовать с визуальными объектами). Функции, типа [[TypeStr]] будут возвращать такие же значения для этого объекта, как и для объекта основной таблицы.

{{function header}}
{{function entry
|name=[[Tab.Column.Name|Name]]
|form={{Grey|Tab.Column.}}'''Name''':''<Имя столбца (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут позволяет получать или изменять имя столбца таблицы. Имена столбцов всегда хранятся в верхнем регистре.
}}
{{function entry
|name=[[Tab.Column.Caption|Caption]]
|form={{Grey|Tab.Column.}}'''Caption''':''<Заголовок столбца (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять заголовок столбца таблицы.
}}
{{function entry
|name=[[Tab.Column.DataType|DataType]]
|form={{Grey|Tab.Column.}}'''DataType''':''<Тип данных столбца (STRING)>''
|type=0
|status=2
|visual=0
|description=Атрибут позволяет получать или изменять тип данных столбца таблицы. При изменении типа данных всех существующие ячейки таблицы в данном столбце, будут преобразованы в новый тип данных.
}}
{{function entry
|name=[[Tab.Column.Width|Width]]
|form={{Grey|Tab.Column.}}'''Width''':''<Ширина столбца (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять ширину столбца таблицы в пикселях.
}}
{{function entry
|name=[[Tab.Column.Align|Align]]
|form={{Grey|Tab.Column.}}'''Align''':''<Режим выравнивания столбца (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять режим выравнивания при выводе текста в столбце таблицы.
}}
{{function entry
|name=[[Tab.Column.Mask|Mask]]
|form={{Grey|Tab.Column.}}'''Mask''':''<Шаблон редактирования столбца (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять шаблон маски редактирования ячеек столбца таблицы.
}}
{{function entry
|name=[[Tab.Column.IsVisible|IsVisible]]
|form={{Grey|Tab.Column.}}'''IsVisible''':''<Видимость столбца (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать состояние или изменять видимость столбца на экране.
}}
{{function entry
|name=[[Tab.Column.Value|Value]]
|form={{Grey|Tab.Column.}}'''Value''':''<Значение столбца в строке CurLine (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут позволяет получать или изменять значение ячейки столбца в текущей строке таблицы.
}}
{{function entry
|name=[[Tab.Column.ShowCheckboxes|ShowCheckboxes]]
|form={{Grey|Tab.Column.}}'''ShowCheckboxes''':''<Показывать галки в столбце (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать состояние или изменять видимость галочек в столбце таблицы.
}}
{{function entry
|name=[[Tab.Column.ShowIcons|ShowIcons]]
|form={{Grey|Tab.Column.}}'''ShowIcons''':''<Показывать иконки в столбце (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать состояние или изменять видимость иконок в столбце таблицы.
}}
{{function entry
|name=[[Tab.Column.RedNegative|RedNegative]]
|form={{Grey|Tab.Column.}}'''RedNegative''':''<Выделять отрицательные числа красным в столбце (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать состояние или изменять режим выделения красным ячеек таблицы, содержащих отрицательные числа в столбце таблицы.
}}
{{function entry
|name=[[Tab.Column.Hint|Hint]]
|form={{Grey|Tab.Column.}}'''Hint''':''<Всплывающая подсказка для столбца (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять строку подсказки при наведении мышью на заголовок столбца таблицы.
}}
{{function entry
|name=[[Tab.Column.IsEditable|IsEditable]]
|form={{Grey|Tab.Column.}}'''IsEditable''':''<Данные в столбце можно редактировать (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять разрешение редактирования столбца таблицы.
}}
{{function entry
|name=[[Tab.Column.IsSortable|IsSortable]]
|form={{Grey|Tab.Column.}}'''IsSortable''':''<Режим сортировки столбца (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять разрешение визуальной сортировки столбца таблицы.
}}
{{function entry
|name=[[Tab.Column.IsInEnterChain|IsInEnterChain]]
|form={{Grey|Tab.Column.}}'''IsInEnterChain''':''<Столбец находить в Enter-цепочке (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять режим участия ячеек столбца таблицы в визуальной цепочке ввода.
}}
{{function entry
|name=[[Tab.Column.IsReadonly|IsReadonly]]
|form={{Grey|Tab.Column.}}'''IsReadonly''':''<Столбец имеет атрибут только для чтения (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять режим только для чтения при редактировании ячеек столбца таблицы.
}}
{{function entry
|name=[[Tab.Column.MinWidth|MinWidth]]
|form={{Grey|Tab.Column.}}'''MinWidth''':''<Минимальная ширина столбца (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять минимальную ширину столбца таблицы в пикселях.
}}
{{function entry
|name=[[Tab.Column.MaxWidth|MaxWidth]]
|form={{Grey|Tab.Column.}}'''MaxWidth''':''<Максимальная ширина столбца (INT)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать или изменять максимальную ширину столбца таблицы в пикселях.
}}
{{function entry
|name=[[Tab.Column.Filter|Filter]]
|form={{Grey|Tab.Column.}}'''Filter''':''<Текущий визуальный фильтр столбца (STRING)>''
|type=0
|status=2
|visual=1
|description=Атрибут позволяет получать текущий визуальный фильтр столбца таблицы (строку, введенную пользователем в этом столбце, для быстрого фильтрования элементов таблицы).
}}
{{function entry
|name=[[Tab.Column.ForbidMassLoad|ForbidMassLoad]]
|form={{Grey|Tab.Column.}}'''ForbidMassLoad''':''<Запретить загрузку столбца функцией Massload (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут позволяет получать или изменять режим запрета загрузки элементов ячеек столбца таблицы из базы данных при вызове функции [[MassLoadObjects]].
}}
{{function footer}}

{{Объекты}}

Студия/Кнопка

2025-12-27T17:08:57Z

Admin: 1 revision imported

{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общая информация и интерфейс Студии]]
* [[Студия/Редактор форм|Редактор форм]]}}
<gallery widths=599px heights=33px>
Studio Button 1.png||Пример набора кнопок в нижней части формы документа
</gallery>

Кнопки используются для закрытия формы, принятия и сохранения изменений, вывода отчетов и запуска обработок, т.е., везде, где необходимо осуществить какие-либо программно заданное действие. Кнопки не имеют привязки к базе данных и не содержат значений. С точки зрения системы не связанная с другими элементами кнопка отличается от связанных элементов-кнопок (для дополнительной информации по ним см. выше параграф "Связанные визуальные элементы"). Кнопки имеют следующие визуальные свойства:
* Закладка '''Визуальные''':
** '''Caption''' (заголовок) -- задает текст, который будет выведен на этой кнопке.
** '''Anchor''' (якоря) -- задает якоря визуального элемента.
** '''Top''', '''Left''' (координата верхнего левого угла) -- задает координату (в точках) верхнего левого угла элемента относительно начала формы.
** '''Width''', '''Height''' (высота и ширина) -- задает высоту и ширину (в точках) элемента.
** '''MaxWidth''', '''MaxHeight''' (максимальная высота и ширина) -- задает максимальную высоту и ширину (в точках) элемента. Иногда бывает необходимо ограничить увеличение размера элемента вместе с размерами формы, так как излишнее увеличение может ухудшить читаемость и осложнить работу с элементом. К примеру, слишком длинное поле редактирования неудобно для чтения и т.п. Максимальные размеры позволяют ограничить увеличение элементов до приемлемых величин.
** '''Layer''' (слой формы) -- задает слой формы, которому принадлежит текущий элемент. Для описания редактора слоев, см. [[Студия/Редактор свойств#Редактор слоев|следующую статью]].
** '''Font''' (шрифт элемента) -- задает шрифт, размер и цвет текста элемента. Для описания редактора шрифтов, см. [[Студия/Редактор свойств#Редактор шрифтов|следующую статью]].
** '''FontColor''' (цвет текста элемента) -- задает цвет текста элемента. Для описания редактора цветов, см. [[Студия/Редактор свойств#Диалог выбора цветов|следующую статью]].
** '''Color''' (цвет фона элемента) -- задает цвет фона элемента. Для описания редактора цветов, см. [[Студия/Редактор свойств#Диалог выбора цветов|следующую статью]].
** '''IsDisabled''' (недоступность элемента) -- устанавливает режим недоступности элемента. При установке режима на кнопку, она становится недоступной для нажатия, изменяется ее вид.
** '''IsInvisible''' (невидимость элемента) -- элемент (и его связанных элементы) становится невидимым в рабочем режиме. В режиме редактирования в Студии, элемент по-прежнему отображен.
** '''HasNoFocus''' (отсутствие фокуса) -- кнопка не может получить фокус (может использоваться на формах без элементов с фокусом, к примеру, для сенсорных экранов), она становится плоской и такие свойства, как ''IsDefault'' не будут применимы к ней. Кнопка также исключается из цепочки обхода (Enter-цепочка).
** '''IsAsyncMode''' (режим выполнения) -- событие, связанное с нажатием на кнопку, будет выполняться как прерывающее, а не асинхронное.
** '''NoDisable''' (запрет недоступности) -- кнопка не будет недоступна в режиме только для чтения формы или при использовании DisableControls (обычно для кнопок, вызывающих помощь).
** '''IsDefault''' (кнопка по умолчанию) -- задает эту кнопку, как кнопку по умолчанию на текущей форме. Кнопка будет выделена дополнительно и при использовании комбинации ''Ctrl+Enter'', если эта комбинация не задана на других элементах, эта кнопка будет автоматически активирована. На форме обычно разрешается наличие только одной кнопки по умолчанию.
** '''IfResizeWithParentX''', '''IfResizeWithParentY''' (привязка размеров к группе элементов) -- Особые установки, работающие совместно с ''MaxWidth'' и ''MaxHeight'', если последние заданы для группы элементов, на которой находится текущий элемент, его размеры будут привязаны не к самой форме, а к элементу группы. Без такого условия, невозможно было бы использовать ''MaxWidth'' и ''MaxHeight'' для форм со сложным расположением элементов.
** '''Picture''' (картинка) -- определяет наличие на кнопке картинки из библиотеки картинок (см. [[Студия/Библиотека картинок|Библиотека картинок]]).
** '''Hint''' (всплывающая подсказка) -- определяет текст всплывающей подсказки при наведении курсора мыши на элемент. Если свойство не задано (пустая строка), подсказка не будет выводиться.
* Закладка '''Данные''':
** '''Name''' (наименование) -- задает наименование элемента, с помощью которого к нему можно будет обращаться из программных модулей. Если свойства элемента не будут изменяться программно, наименование можно оставить пустым.
** '''IsInEnterChain''' (включение в Enter-цепочку) -- задает режим включения данного элемента в цепочку обхода элементов с помощью клавиши Enter. При вводе информации на форме, когда требуется это сделать быстро, возникает необходимость использовать только клавиатуру, так как использовании мыши может замедлить ввод. Обычно без использования мыши, оператор может активировать элемент с помощью комбинации клавиш ''Tab'' или ''Shift-Tab'', однако, эти комбинации последовательно активируют все элементы формы, для которых возможно редактирование. В формах ввода, которые используются очень часто, удобно пропускать элементы, которые обычно не участвуют в редактировании. Для этого существует особая очередь элементов, которые будут последовательно активированы с помощью клавиши ''Enter'', так называемая Enter-цепочка. Такая очередь позволяет оператору быстро обойти нужные элементы при вводе информации и сохранить содержимое формы с тем, чтобы начать ввод новой. См. [[Студия/Редактор форм#Редактор Enter-цепочки|редактор Enter-цепочки]].
** '''HotKey''' (комбинация клавиш для активации элемента) -- задает комбинация клавиш для мгновенной активации элемента. Для описания редактора горячих клавиш см. [[Студия/Редактор свойств#Редактор горячих клавиш|следующую статью]].
* Закладка '''События''' предоставляет доступ к следующим событиям (см. [[Студия/Визуальные события|Визуальные события]]):
** [[Студия/OnGetCaption|'''OnGetCaption''']] -- событие получает заголовок кнопки при любом обновлении.
** [[Студия/OnClick|'''OnClick''']] -- событие, возникающее при кнопке по полю мышью или нажатии ''Enter''.
** [[Студия/OnRightClick|'''OnRightClick''']] -- событие, возникающее при правом клике по полю мышью.

Дополнительная информация:
* Для работы со свойствами объектов формы из программы, см. статью [[Форма]].

Строковые функции

2025-12-27T17:08:55Z

Admin: 1 revision imported

{{infobox object
|image=
|visual=
|object=
|status=2
|create=
}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]}}
__TOC__
Строковые функции работают со строками, их модификацией и превращением в разные кодировки и пр. Важно понимать, что в системе есть два вида строковых объектов -- однобайтовый (ANSI) и многобайтовый (Unicode). Более подробно см. [[Строки]].

== Основные функции ==
{{function header}}
{{function entry
|name=[[Str]]
|form='''Str'''(''<Аргумент>''{{Optional|,''<Тип>''{{Default|{{Eq}}0}}}}):''<Строковое представление (STRING)>''
|type=1
|status=2
|visual=0
|description=Превращение объекта в строковое представление с возможностью указания типа получаемой строки.
}}
{{function entry
|name=[[StringTypeStr]]
|form='''StringTypeStr'''(''<Аргумент>''):''<Тип строкового аргумента (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает строку "ANSI", в случае, если строковое представление аргумента использует однобайтовую кодировку (ANSI), иначе будет возвращена строка "UNICODE"
}}
{{function entry
|name=[[Length]]
|form='''Length'''(''<Аргумент>''):''<Длина строки в символах (INT)>''
|type=1
|status=2
|visual=0
|description=Нахождение длины строки
}}
{{function entry
|name=[[IsBlankString]]
|form='''IsBlankString'''(''<Аргумент>''):''<1 или 0 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, является ли аргумент пустой строкой (в строке позволяются пробелы, знаки табуляции и знаки перевода строки)
}}
{{function entry
|name=[[TrimL]]
|form='''TrimL'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция убирает пробелы, знаки табуляции и знаки переноса строки с начала строки строкового аргумента.
}}
{{function entry
|name=[[TrimR]]
|form='''TrimR'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция убирает пробелы, знаки табуляции и знаки переноса строки с конца строки строкового аргумента.
}}
{{function entry
|name=[[Trim]]
|form='''Trim'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция убирает пробелы, знаки табуляции и знаки переноса строки с начала и с конца строки строкового аргумента.
}}
{{function entry
|name=[[Left]]
|form='''Left'''(''<Аргумент>'',''<Количество символов (INT)>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает левую часть строки аргумента с указанным размером
}}
{{function entry
|name=[[Right]]
|form='''Right'''(''<Аргумент>'',''<Количество символов (INT)>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает правую часть строки аргумента с указанным размером
}}
{{function entry
|name=[[Mid]]
|form='''Mid'''(''<Аргумент>'',''<Индекс начального символа (INT)>''{{Optional|,<Количество символов (INT)>}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает произвольную часть строки аргумента
}}
{{function entry
|name=[[Pos]]
|form='''Pos'''(''<Подстрока поиска>'',''<Строка в которой происходит поиск>''{{Optional|,<Индекс начального символа (INT)>}}):''<Индекс в строке поиска (INT)>''
|type=1
|status=2
|visual=0
|description=Находит вхождение подстроки в указанную строку поиска, начиная с указанной позиции, если подстрока не найдена, возвращает ноль
}}
{{function entry
|name=[[PosNoCase]]
|form='''PosNoCase'''(''<Подстрока поиска>'',''<Строка в которой происходит поиск>''{{Optional|,<Индекс начального символа (INT)>}}):''<Индекс в строке поиска (INT)>''
|type=1
|status=0
|visual=0
|description=Находит вхождение подстроки в указанную строку поиска, начиная с указанной позиции, если подстрока не найдена, возвращает ноль. Поиск ведется без учета регистра
}}
{{function entry
|name=[[RightPos]]
|form='''RightPos'''(''<Подстрока поиска>'',''<Строка в которой происходит поиск>''{{Optional|,<Индекс начального символа (INT)>}}):''<Индекс в строке поиска (INT)>''
|type=1
|status=2
|visual=0
|description=Находит вхождение подстроки в указанную строку поиска, начиная с указанной позиции, если подстрока не найдена, возвращает ноль. Поиск производится справа-налево.
}}
{{function entry
|name=[[RightPosNoCase]]
|form='''RightPosNoCase'''(''<Подстрока поиска>'',''<Строка в которой происходит поиск>''{{Optional|,<Индекс начального символа (INT)>}}):''<Индекс в строке поиска (INT)>''
|type=1
|status=0
|visual=0
|description=Находит вхождение подстроки в указанную строку поиска, начиная с указанной позиции, если подстрока не найдена, возвращает ноль. Поиск производится справа-налево. Поиск ведется без учета регистра
}}
{{function entry
|name=[[Replace]]
|form='''Replace'''(''<Строка в которой происходит замена>'',''<Подстрока поиска>'',''<Подстрока замены>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Заменяет все вхождения строки второго аргумента в строке первого аргумента на строку третьего аргумента. Третий аргумент может содержать в себе строку второго аргумента.
}}
{{function entry
|name=[[ReplaceCharacters]]
|form='''ReplaceCharacters'''(''<Строка в которой происходит замена>'',''<Заменяемые символы>'',''<Заменяющие символы>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция производит множественную замену определенных символов на другие и возвращает ее результат.
}}
{{function entry
|name=[[ReplaceNoCase]]
|form='''ReplaceNoCase'''(''<Строка в которой происходит замена>'',''<Подстрока поиска>'',''<Подстрока замены>''):''<Результат (STRING)>''
|type=1
|status=0
|visual=0
|description=Заменяет все вхождения строки второго аргумента в строке первого аргумента на строку третьего аргумента. Третий аргумент может содержать в себе строку второго аргумента. Поиск ведется без учета регистра
}}
{{function entry
|name=[[RepeatStr]]
|form='''RepeatStr'''(''<Аргумент>'',''<Количество повторений (INT)>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Повторяет строковое представление аргумента указанное количество раз
}}
{{function entry
|name=[[Reverse]]
|form='''Reverse'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Получает строку набранную с конца до начала строкого представления аргумента
}}
{{function entry
|name=[[StrCount]]
|form='''StrCount'''(''<Подстрока поиска>'',''<Строка в которой происходит поиск>''):''<Количество вхождений (INT)>''
|type=1
|status=2
|visual=0
|description=Находит количество вхождений подстроки поиска в строку, представленную вторым аргументом. После нахождения вхождения индекс поиска сдвигается на размер строки поиска.
}}
{{function entry
|name=[[LinesCount]]
|form='''LinesCount'''(''<Аргумент>''):''<Количество строк (INT)>''
|type=1
|status=2
|visual=0
|description=Находит количество вхождений знака перевода строки в строковое представление аргумента и увеличивает результат на единицу
}}
{{function entry
|name=[[GetLine]]
|form='''GetLine'''(''<Аргумент>'',''<Номер строки (INT)>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=В строковом представлении аргумента, разделенного знаками перевода строки, находит и возвращает подстроку с указанным индексом.
}}
{{function entry
|name=[[UpperCase]]
|form='''UpperCase'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Возвращает строковое представление аргумента, переведенное в верхний регистр
}}
{{function entry
|name=[[LowerCase]]
|form='''LowerCase'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Возвращает строковое представление аргумента, переведенное в нижний регистр
}}
{{function entry
|name=[[Capitalize]]
|form='''Capitalize'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает строковое представление аргумента, переводя первый его символ в верхний регистр.
}}
{{function entry
|name=[[RemoveNonPrintableChars]]
|form='''RemoveNonPrintableChars'''(''<Аргумент>''{{Optional|,''<Оставить символы перевода строки (INT)>''{{Default|{{Eq}}0}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Удаляет из текстового представления аргумента непечатные символы (символы с кодом <32), оставляя символы перевода строки при необходимости
}}
{{function entry
|name=[[Chr]]
|form='''Chr'''(''<Код символа (INT)>''{{Optional|,''<Тип (INT)>''{{Default|{{Eq}}0}}}}):''<Символ (STRING)>''
|type=1
|status=2
|visual=0
|description=Возвращает строку, состоящую из одного символа по указанному коду в ANSI или UTF-16 кодировке.
}}
{{function entry
|name=[[Asc]]
|form='''Asc'''(''<Аргумент>''):''<Код символа (INT)>''
|type=1
|status=2
|visual=0
|description=Возвращает код первого символа строкового представления аргумента.
}}
{{function entry
|name=[[ContainsOnlyCharacters]]
|form='''ContainsOnlyCharacters'''(''<Аргумент>'',''<Набор символов>''):''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Проверяет, содержит ли строковое представление первого аргумента только символы, указанные в строковом представлении второго аргумента.
}}
{{function entry
|name=[[CompareStrings]]
|form='''CompareStrings'''(''<Аргумент 1>'',''<Аргумент 2>''{{Optional|,''<Метод (INT)>''{{Default|{{Eq}}1}}}}{{OptionalByRef|,''<Ошибка>''{{Default|{{Eq}}""}}}}):''<0, 1 или -1 (INT)>''
|type=1
|status=2
|visual=0
|description=Сравнивает две строки, используя указанный метод, возвращает -1, если первая строка меньше второй, 0, если строки равны и 1 в ином случае.
}}
{{function entry
|name=[[IsUnicode]]
|form='''IsUnicode'''(''<Аргумент>''):''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Проверяет, является ли строковое представление аргумента строкой UTF-16 или ANSI (см. [[Строки]])
}}
{{function entry
|name=[[Unicode]]
|form='''Unicode'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Безусловно переводит строковое представление аргумента в строку UTF-16
}}
{{function entry
|name=[[UnicodeToUTF8]]
|form='''UnicodeToUTF8'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Превращает строковое представление аргумента (не обязательно строку в формате UTF-16) в строку ANSI с закодированным текстом в формате UTF-8
}}
{{function entry
|name=[[UTF8ToUnicode]]
|form='''UTF8ToUnicode'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Превращает перекодирует результат из формата UTF-8 в формат UTF-16.
}}
{{function entry
|name=[[Ansi]]
|form='''Ansi'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Безусловно переводит строковое представление аргумента в строку ANSI, используя системную кодовую страницу.
}}
{{function entry
|name=[[OemToAnsi]]
|form='''OemToAnsi'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Производит перекодировку строкового представления аргумента из кодовой страницы OEM в ANSI, используя системную кодовую страницу.
}}
{{function entry
|name=[[AnsiToOem]]
|form='''AnsiToOem'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Производит перекодировку строкового представления аргумента из кодовой страницы ANSI в OEM, используя системную кодовую страницу.
}}
{{function entry
|name=[[AnsiToUTF8]]
|form='''AnsiToUTF8'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Производит перекодировку строкового представления аргумента из кодовой страницы ANSI в UTF-8, используя системную кодовую страницу.
}}
{{function entry
|name=[[UTF8ToAnsi]]
|form='''UTF8ToAnsi'''(''<Аргумент>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Производит перекодировку строкового представления аргумента из UTF-8 в кодовую страницу ANSI, используя системную кодовую страницу.
}}
{{function entry
|name=[[TranslateFrom]]
|form='''TranslateFrom'''(''<Аргумент>'',''<Кодовая страница (INT)>''{{Optional|,''<Удалять BOM (INT)>''{{Default|{{Eq}}1}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Производит перекодировку строкового представления аргумента из кодовой страницы, заданной вторым аргументом в UTF-16, при необходимости удаляет BOM
}}
{{function entry
|name=[[TranslateTo]]
|form='''TranslateTo'''(''<Аргумент>'',''<Кодовая страница (INT)>''{{Optional|,''<Добавить BOM (INT)>''{{Default|{{Eq}}0}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Производит перекодировку строкового представления аргумента из UTF-16 в кодовую страницу, заданную вторым аргументом, при необходимости добавляя BOM
}}
{{function entry
|name=[[Translate]]
|form='''Translate'''(''<Аргумент>'',''<Кодовая страница источник (INT)>'',''<Кодовая страница приемник (INT)>''{{Optional|,''<Удалять и добавлять BOM (INT)>''{{Default|{{Eq}}0}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Производит перекодировку строкового представления аргумента из кодовой страницы, заданной вторым аргументом в кодовую страницу, заданную третьим аргументом, при необходимости удаляя и добавляя BOM
}}
{{function entry
|name=[[FormatDate]]
|form='''FormatDate'''(''<Дата>''{{Optional|,<Шаблон форматирования (STRING)>,<Язык форматирования (STRING)>}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Производит перекодировку даты и времени в строковой формат по указанному шаблону, используя указанный язык
}}
{{function entry
|name=[[FormatPeriod]]
|form=
|type=1
|status=0
|visual=0
|description=Производит перекодировку периода между двумя датами в строковой формат по указанному шаблону, используя указанный язык
}}
{{function entry
|name=[[FormatNumber]]
|form='''FormatNumber'''(''<Число>''{{Optional|,''<Нули пустой строкой (INT)>''{{Default|{{Eq}}1}}}}{{Optional|,''<Разделитель тысяч (STRING)>''{{Default|{{Eq}}"'"}}}}{{Optional|,''<Точность после точки (INT)>''{{Default|{{Eq}}2}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Производит перекодировку и формирование числа в строковой формат, используя указанные установки
}}
{{function entry
|name=[[SpellNumber]]
|form='''SpellNumber'''(''<Число>''{{Optional|,''<Язык кодирования (STRING)>''}}{{Optional|,''<Род результата (STRING)>''{{Default|{{Eq}}"М"}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Превращает число в его прописное представление, используя указанный язык и грамматический род результата
}}
{{function entry
|name=[[FormatCurrency]]
|form='''FormatCurrency'''(''<Число>''{{Optional|,''<Режим (INT)>''{{Default|{{Eq}}0}}}}{{Optional|,''<Тип валюты (STRING)>''{{Default|{{Eq}}"USD"}}}}{{Optional|,''<Язык форматирования (STRING)>''}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Создает прописное представление денежной номинации по указанным правилам, для указанной валюты, используя указанный язык
}}
{{function entry
|name=[[TearStr]]
|form='''TearStr'''({{ByRef|''<Строка>''}}{{Optional|,''<Подстрока-разделитель>''{{Default|{{Eq}}"@"}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Производит деление исходного строкового представления на две строки, разделенные вторым аргументом, возвращая в результате первую подстроку, и обновляя значение переменной первого аргумента второй строкой, если первый аргумент был переменной.
}}
{{function entry
|name=[[GetSubStr]]
|form='''GetSubStr'''(''<Строка>'',{{ByRef|''<Индекс (INT)>''}}{{Optional|,''<Подстрока-разделитель>''{{Default|{{Eq}}"@"}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Получает подстроку исходной строки, начиная с индекса символа, указанного во втором аргументе до следуюшего вхождения строки-разделителя в исходную строку. Индекс обновляется до позиции, непосредственно за найденной строкой-разделителем.
}}
{{function entry
|name=[[AppendStringToBufferedString]]
|form='''AppendStringToBufferedString'''({{ByRef|''<Строка>''}},''<Добавляемая строка>''{{Optional|,''<Шаг увеличения буфера (INT)>''}})
|type=1
|status=2
|visual=0
|description=Добавляет к строке в указанной в переменной, следующей первым аргументом, строку, заданную вторым аргументом. Используется для оптимизации скорости выполнения для длинных строк с большим количеством приращений.
}}
{{function entry
|name=[[FileToString]]
|form='''FileToString'''(''<Имя файла>''{{Optional|,''<Кодовая страница (INT)>''{{Default|{{Eq}}0}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Загружает указанный файл в строку, используя указанную кодовую страницу. Результирующая строка будет перекодирована в UTF-16, если кодовая страница равна нулю и присутвует [[BOM]] или больше нуля
}}
{{function entry
|name=[[StringToFile]]
|form='''StringToFile'''(''<Строка>'',''<Имя файла>''{{Optional|,''<Кодовая страница (INT)>''{{Default|{{Eq}}0}}}}{{Optional|,''<Добавить BOM (INT)>''{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Сохраняет строку в файл, при необходимости перекодируя ее в нужную кодировку и добавляя BOM. Вызывает исключение при ошибке.
}}
{{function entry
|name=[[AppendStringToFile]]
|form='''AppendStringToFile'''(''<Строка>'',''<Имя файла>'')
|type=1
|status=2
|visual=0
|description=Дополняет содержимое файла указанной строкой. Строка добавляется без перекодировки, если нужна определенная кодовая страница, строку необходимо предварительно подготовить. Функция вызывает исключение при ошибке.
}}
{{function entry
|name=[[EncodeXMLString]]
|form='''EncodeXMLString'''(''<Строка>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Перекодирует знаки, запрещенные в теле файлов в XML формате, в разрешенную форму (к примеру "&" превращается в <code>&amp;</code>)
}}
{{function entry
|name=[[DecodeXMLString]], '''DecodeHTMLString'''
|form='''DecodeXMLString'''(''<Строка>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Перекодирует текст в HTML/XML нотации в обычный текст, т.е. последовательности типа <code>&amp;</code> или <code>&#9829;</code> в соответствующие знаки
}}
{{function entry
|name=[[EncodeHTMLString]]
|form='''EncodeXMLString'''(''<Строка>''):''<Результат (STRING)>''
|type=1
|status=0
|visual=0
|description=Перекодирует знаки, запрещенные в теле файлов в HTML формате, в разрешенную форму (к примеру "&" превращается в <code>&amp;</code>). В отличии от XML версии, производится перекодировка большего количества знаков, которые разрешены в XML, однако, запрещены в HTML.
}}
{{function entry
|name=[[CreateGUID]]
|form='''CreateGUID'''():''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Формирует новый GUID идентификатор системным медотом
}}
{{function entry
|name=[[ReformatXML]]
|form='''ReformatXML'''(''<Строка или текст (STRING,TEXT)>''{{Optional|,''<Режимы (INT)>''{{Default|{{Eq}}3}}}}):''<Результат (STRING)>''
|type=1
|status=1
|visual=0
|description=Приводит текст в XML нотации к каноническому простому виду с тем, чтобы его можно было разобрать обычными текстовыми функциями. Позволяет настроить глубину упрощения текста
}}
{{function entry
|name=[[LoadJSONFromString]]
|form='''LoadJSONFromString'''({{ByRef|<Строка (STRING)>}}{{Optional|,''<Тип возвращаемого объекта (INT)>''{{Default|{{Eq}}0}}}}):''<Результат (TREE,LIST)>''
|type=1
|status=2
|visual=0
|description=Функция загружает часть текста или весь текст в формате JSON и возвращает его представление в виде объекта дерева или списка.
}}
{{function entry
|name=[[SaveJSONToString]]
|form='''SaveJSONToString'''(''<Объект дерева, ветки или списка (STRING)>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция превращает объект дерева, ветки или списка в текст JSON.
}}
{{function entry
|name=[[EncodeString]]
|form='''EncodeString'''(''<Строка или буфер (STRING,BUFFER)>''{{Optional|,''<Формат кодирования (STRING)>''{{Default|{{Eq}}"INTERNAL"}}}}{{Optional|,''<Параметры кодирования (STRING)>''}}):''<Результат (STRING)>''
|type=1
|status=1
|visual=0
|description=Производит кодирование строки в указанный формат (к примеру, "Base64" или "UUE"). Могут кодироваться как ANSI, так и Unicode строки, информация также может получаться из буфера.
}}
{{function entry
|name=[[DecodeString]]
|form='''DecodeString'''(''<Строка (STRING)>''{{Optional|,''<Формат декодирования (STRING)>''{{Default|{{Eq}}"INTERNAL"}}}}{{Optional|,''<Результат в формате UTF-16 (INT)>''{{Default|{{Eq}}0}}}}{{Optional|,''<Параметры декодирования (STRING)>''}}):''<Результат (STRING)>''
|type=1
|status=1
|visual=0
|description=Производит декодирование строки из указанного формата (к примеру, "Base64" или "UUE"). Могут декодироваться как ANSI, так и Unicode строки.
}}
{{function footer}}

== Функции строк-массивов значений ==
Функции можно использовать для массивов строк, хранящихся в одной большой строке и разделенных строками-разделителями. Строки могут быть произвольного размера и содержать строку-префикс. Данный подход хранения очень компактен в памяти, но из-за того, что каждой из функций приходится создавать индекс до начала работы, имеет ограниченную применимость из-за более медленной работы по сравнению с таблицами или списками. Фактически одна строка-массив будет интерпретироваться как таблица с двумя столбцами -- индексным (само значение) и произвольного назначения (префикс). Подобная группа функций существует и для сервера, когда другие пользователи и потоки также имеют доступ к строке-массиву (см. [[Функции_общего_назначения#Глобальные функции строк-массивов значений|глобальные строки-массивы]]), однако, имеет несколько другой функционал.

{{function header}}
{{function entry
|name=[[AssertStringValues]]
|form='''AssertStringValues'''(''<Аргумент 1>'',''<Аргумент 2>'',''<Строка-разделитель>'',''<Тип операции (INT)>''{{Optional|,''<Разделитель префикса>''{{Default|{{Eq}}""}}}})
|type=1
|status=2
|visual=0
|description=Производит проверку двух строк-массивов значений, имеющих префиксы, если необходимо, указанным методом. Если проверка неудачна, создает исключение.
}}
{{function entry
|name=[[JoinStringValues]]
|form='''JoinStringValues'''(''<Аргумент 1>'',''<Аргумент 2>'',''<Строка-разделитель>'',''<Тип операции (STRING)>''{{Default|{{Eq}}"OR"}}{{Optional|,''<Разделитель префикса>''{{Default|{{Eq}}""}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Выполняет указанную логическую операцию над двумя строками-массивами значений, имеющих префиксы, если необходимо. Возвращает результирующую строку-массив значений.
}}
{{function entry
|name=[[GetStringValuesByPrefix]]
|form='''GetStringValuesByPrefix'''(''<Аргумент>'',''<Строка-разделитель (STRING)>'',''<Разделитель префикса (STRING)>'',''<Значение префикса>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Возвращает строку-массив значений, состоящую только из значений строки-массива значений аргумента с указанным префиксом
}}
{{function entry
|name=[[GroupStringValues]]
|form='''GroupStringValues'''(''<Аргумент>'',''<Строка-разделитель>''{{Optional|,''<Разделитель префикса>''{{Default|{{Eq}}""}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Возвращает строку-массив значений, которая содержит только уникальные значения исходной строки-массива значений.
}}
{{function entry
|name=[[SortStringValues]]
|form='''SortStringValues'''(''<Аргумент>'',''<Строка-разделитель>''{{Optional|,''<Направление (INT)>''{{Default|{{Eq}}0}}}}{{Optional|,''<Разделитель префикса>''{{Default|{{Eq}}""}}}}):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Возвращает строку-массив значений, полученную путем регистро-зависимой сортировки в указанном направлении значений исходной строки-массива значений.
}}
{{function entry
|name=[[GetPrefixesFromStringValues]]
|form='''GetPrefixesFromStringValues'''(''<Аргумент>'',''<Строка-разделитель>'',''<Разделитель префикса>''):''<Результат (STRING)>''
|type=1
|status=2
|visual=0
|description=Возвращает строку-массив значений, состоящую только из префиксов исходной строки-массива значений.
}}
{{function entry
|name=[[CopyStringValuesTo]]
|form='''CopyStringValuesTo'''(''<Аргумент>'',''<Строка-разделитель>'',''<Разделитель префикса>'',''<Объект для заполнения (LIST,TAB)>'')
|type=1
|status=2
|visual=0
|description=Функция производит копирование массива значений из строки-массива в список или таблицу.
}}
{{function footer}}

== Функции для работы с регулярными выражениями (regular expressions, RegExp) ==
Функции этой группы позволяют использовать регулярные выражения для поиска, замены или разделения строк. Функции всегда работают с UTF-16 строками (если строка имеет формат ANSI, она будет превращена в UTF-16 перед работой, если строка имеет формат UTF-8, ее необходимо превратить в UTF-16 с помощью функции [[UTF8ToUnicode]]). Следует также понимать, что разбор длинной строки с помощью функций [[TearStr]] или подобных будет всегда быстрее, чем применение регулярных выражений (так как регулярные выражения подразумевают перебор, а не прямой поиск). Также важно учесть, что переводы строки в строке поиска должны состоять из последовательности (<Code>Chr(13)+Chr(10)</Code>, т.е. ''_NEWLINE''), иначе специальные символы '''^''' и '''$''' не будут работать корректно.

Система имеет свою интерпретацию синтаксиса регулярных выражений, она близка к JavaScript с дополнениями, присущими другим языкам. Ниже дана таблица конструкций и последовательностей символов в шаблоне регулярных выражений, которые понимаются системой, а также краткое описание каждой записи:

{|class="wikitable sortable" style="border-collapse:collapse;font-size:80%;width=95%;"
! width=10%|Тип
! width=10%|Последовательность
! Описание
|-
|-align="left"
|Спец. символы
|'''\n'''
|Символ перевода строки, Chr(10).
|-align="left"
|Спец. символы
|'''\r'''
|Символ перевода каретки, Chr(13).
|-align="left"
|Спец. символы
|'''\t'''
|Символ табуляции, Chr(9).
|-align="left"
|Спец. символы
|'''\v'''
|Символ Chr(11).
|-align="left"
|Спец. символы
|'''\h'''
|Любой из знаков пробела (любой из символов юникода со следующими кодами: <code>32, 9, 160, 5760, 6158, 8192-8202, 8239, 8287, 12288</code>).
|-align="left"
|Спец. символы
|'''\H'''
|Любой символ, кроме знаков пробела (любой из символов, кроме символов юникода со следующими кодами: <code>32, 9, 160, 5760, 6158, 8192-8202, 8239, 8287, 12288</code>).
|-align="left"
|Спец. символы
|'''\f'''
|Символ разделения страниц, Chr(12).
|-align="left"
|Спец. символы
|'''[\b]'''
|Символ забоя, Chr(8) (используется только внутри набора символов).
|-align="left"
|Спец. символы
|'''\0'''
|Символ Chr(0).
|-align="left"
|Спец. символы
|'''\R'''
|Набор символов перевода строки, соответствует любой из следующих комбинаций: <code>Chr(10), Chr(11), Chr(12), Chr(13), Chr(133), Chr(13)+Chr(10)</code>.
|-align="left"
|Спец. символы
|'''\N'''
|Обратно ''\R''. соответствует любому символу, кроме последовательностей из следующих комбинаций: <code>Chr(10), Chr(11), Chr(12), Chr(13), Chr(133), Chr(13)+Chr(10)</code>.
|-align="left"
|Кодирование символов
|'''\cX'''
|''X'' может принимать значения от '''A''' до '''Z'''. Соответствует символу с кодом, равным позиции буквы латинского алфавита, заданной после ''\c''. То есть, <code>\cA</code> будет соответствовать символу с кодом ''1'', тогда как <code>\cZ</code>, символу с кодом ''26''.
|-align="left"
|Кодирование символов
|'''\x??'''
|Соответствует символу с кодом, заданным шестнадцатеричным числом <code>??</code>. К примеру, <code>\x20</code> (пробел).
|-align="left"
|Кодирование символов
|'''\u????'''
|Соответствует символу с кодом, заданным шестнадцатеричным числом <code>????</code>. К примеру, <code>\x042F</code> (буква '''Я'''). Нужно заметить, что коды символов здесь не могут превышать 65535.
|-align="left"
|Кодирование символов
|'''\u{N}''', '''\x{N}'''
|Соответствует символу с кодом, заданным шестнадцатеричным числом <code>??????</code>. К примеру, <code>\u{1F642}</code> (символ эмоции '''🙂'''). '''N''' может находиться в диапазоне '''0'''..'''10FFFF'''.
|-align="left"
|Кодирование символов
|'''\?'''
|Символ экранирования '''\''' может использоваться для вставки символов, которые иначе трактовались бы как особые последовательности или спец. символы. К примеру <code>\\</code> (задает сам символ ''\'') или <code>\[</code> (задает сам символ ''[''). '''?''' может быть любым символом из набора: " ".."@", "[", "\", "]", "^", "_", "`", "{" и далее до конца таблицы юникода.
|-align="left"
|Кодирование символов
|'''\Q ... \E'''
|Экранирование группы символов "..." начинается с помощью последовательности ''\Q'' и заканчивается последовательностью ''\E'', все символы внутри не будут трактоваться как особые последовательности или спец. символы. К примеру <code>\Q+*\E</code> (задает два символа ''+*'').
|-align="left"
|Наборы символов
|'''[...]'''
|Конструкция задает набор символов, символ сравниваемого текста будет соответствовать, если он будет равен любому символу из списка, представленного данным набором. Внутри конструкции можно использовать не только символы, но и последовательности символов (<code>A-Z</code>), конструкции экранирования ''\Q ... \E'' и ''\?'', конструкции кодирования символов (''\x??'' и пр.), спец. символы (''\n'' и пр.), спец. наборы (''\d'' или ''\D'') и наборы юникода (''\p{Decimal_Digit_Number}'' и пр.).
|-align="left"
|Наборы символов
|'''[^...]'''
|Конструкция задает набор символов, символ сравниваемого текста будет соответствовать, если он не будет равен ни одному символу из списка, представленного данным набором. Внутри конструкции можно использовать не только символы, но и последовательности символов (<code>A-Z</code>), конструкции экранирования ''\Q ... \E'' и ''\?'', конструкции кодирования символов (''\x??'' и пр.), спец. символы (''\n'' и пр.), спец. наборы (''\d'' или ''\D'') и наборы юникода (''\p{Decimal_Digit_Number}'' и пр.).
|-align="left"
|Наборы символов
|'''.'''
|Специальный символ соответствует любому символу текста, кроме набора [\r\n\u2028\u2029].
|-align="left"
|Наборы символов
|'''\C'''
|Конструкция соответствует коду символа, полученному из двух байтов текста -- data point (каждый UTF-16 символ может быть представлен как двумя, так и четырьмя знаками см. [[Строки]]). Не рекомендуется к использованию.
|-align="left"
|Наборы символов
|'''\d'''
|Конструкция задает набор числовых символов, соответствующий набору <code>[0-9]</code>.
|-align="left"
|Наборы символов
|'''\D'''
|Конструкция задает набор нечисловых символов, соответствующий набору <code>[^0-9]</code>.
|-align="left"
|Наборы символов
|'''\w'''
|Конструкция задает набор числовых и литерных символов, соответствующий набору <code>[A-Za-z0-9_]</code>.
|-align="left"
|Наборы символов
|'''\W'''
|Конструкция задает набор не числовых и не литерных символов, соответствующий набору <code>[^A-Za-z0-9_]</code>.
|-align="left"
|Наборы символов
|'''\s'''
|Конструкция задает набор символов пробела и невидимых символов, соответствующий набору <code>[\f\n\r\t\v\u0020\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]</code>.
|-align="left"
|Наборы символов
|'''\S'''
|Конструкция задает набор символов, не соответствующих символам пробела и невидимым символам. Соответствует набору <code>[^\f\n\r\t\v\u0020\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]</code>.
|-align="left"
|Наборы символов
|'''\p?'''
|Конструкция задает набор символов, соответствующих одной из групп таблицы юникода. '''?''' может соответствовать символам: '''L''' -- буквенные символы (letter), '''M''' -- символы разметки (mark), '''N''' -- числовые символы (number), '''P''' -- символы пунктуации (punctuation), '''S''' -- рисунки и прочие символы (symbol), '''Z''' -- символы разделителей (separator), '''C''' -- остальные коды (other). Подробнее см. сл. [https://www.fileformat.info/info/unicode/category/index.htm таблицу].
|-align="left"
|Наборы символов
|'''\P?'''
|Конструкция задает набор символов, не соответствующих одной из групп таблицы юникода, и является обратной по отношению к '''\p?'''.
|-align="left"
|Наборы символов
|'''\p{Group}'''
|Конструкция задает набор символов, соответствующих разнообразным группам таблицы юникода. '''Group''' чувствительна к регистру и может соответствовать комбинациям: <code>L, Letter, Ll, Lowercase_Letter, Lu, Uppercase_Letter, Lt, Titlecase_Letter, L&, Cased_Letter, Lm, Modifier_Letter, Lo, Other_Letter, M, Mark, Mn, Non_Spacing_Mark, Mc, Spacing_Combining_Mark, Me, Enclosing_Mark, Z, Separator, Zs, Space_Separator, Zl, Line_Separator, Zp, Paragraph_Separator, S, Symbol, Sm, Math_Symbol, Sc, Currency_Symbol, Sk, Modifier_Symbol, So, Other_Symbol, N, Number, Nd, Decimal_Digit_Number, Nl, Letter_Number, No, Other_Number, P, Punctuation, Pd, Dash_Punctuation, Ps, Open_Punctuation, Pe, Close_Punctuation, Pi, Initial_Punctuation, Pf, Final_Punctuation, Pc, Connector_Punctuation, Po, Other_Punctuation, C, Other, Cc, Control, Cf, Format, Co, Private_Use, Cs, Surrogate, Cn, Unassigned, InBasic_Latin, InLatin-1_Supplement, InLatin_Extended-A, InLatin_Extended-B, InIPA_Extensions, InSpacing_Modifier_Letters, InCombining_Diacritical_Marks, InGreek_and_Coptic, InCyrillic, InCyrillic_Supplementary, InArmenian, InHebrew, InArabic, InSyriac, InThaana, InDevanagari, InBengali, InGurmukhi, InGujarati, InOriya, InTamil, InTelugu, InKannada, InMalayalam, InSinhala, InThai, InLao, InTibetan, InMyanmar, InGeorgian, InHangul_Jamo, InEthiopic, InCherokee, InUnified_Canadian_Aboriginal_Syllabics, InOgham, InRunic, InTagalog, InHanunoo, InBuhid, InTagbanwa, InKhmer, InMongolian, InLimbu, InTai_Le, InKhmer_Symbols, InPhonetic_Extensions, InLatin_Extended_Additional, InGreek_Extended, InGeneral_Punctuation, InSuperscripts_and_Subscripts, InCurrency_Symbols, InCombining_Diacritical_Marks_for_Symbols, InLetterlike_Symbols, InNumber_Forms, InArrows, InMathematical_Operators, InMiscellaneous_Technical, InControl_Pictures, InOptical_Character_Recognition, InEnclosed_Alphanumerics, InBox_Drawing, InBlock_Elements, InGeometric_Shapes, InMiscellaneous_Symbols, InDingbats,InMiscellaneous_Mathematical_Symbols-A, InSupplemental_Arrows-A,InBraille_Patterns, InSupplemental_Arrows-B, InMiscellaneous_Mathematical_Symbols-B, InSupplemental_Mathematical_Operators, InMiscellaneous_Symbols_and_Arrows, InCJK_Radicals_Supplement, InKangxi_Radicals, InIdeographic_Description_Characters, InCJK_Symbols_and_Punctuation, InHiragana, InKatakana, InBopomofo, InHangul_Compatibility_Jamo, InKanbun, InBopomofo_Extended, InKatakana_Phonetic_Extensions, InEnclosed_CJK_Letters_and_Months, InCJK_Compatibility, InCJK_Unified_Ideographs_Extension_A, InYijing_Hexagram_Symbols, InCJK_Unified_Ideographs, InYi_Syllables, InYi_Radicals, InHangul_Syllables, InHigh_Surrogates, InHigh_Private_Use_Surrogates, InLow_Surrogates, InPrivate_Use_Area, InCJK_Compatibility_Ideographs, InAlphabetic_Presentation_Forms, InArabic_Presentation_Forms-A, InVariation_Selectors, InCombining_Half_Marks, InCJK_Compatibility_Forms, InSmall_Form_Variants, InArabic_Presentation_Forms-B, InHalfwidth_and_Fullwidth_Forms, InSpecials</code>. Для дополнительной информации, см. [https://www.fileformat.info/info/unicode/category/index.htm таблицу простых наборов], [https://www.regular-expressions.info/unicode.html#category описание категорий и диапазонов] или [http://www.unicode.org/Public/UNIDATA/UnicodeData.txt полную таблицу выделенных символов юникода].
|-align="left"
|Наборы символов
|'''\P{Group}'''
|Конструкция задает набор символов, не соответствующих одной из групп таблицы юникода, заданных словом ''Group'', и является обратной по отношению к '''\p{Group}'''.
|-align="left"
|Конструкции проверки позиции
|'''^'''
|Конструкция соответствует положению в тексте, перед началом всего текста или любой строки (строки разделяются двумя символами \x0D\x0A). Поведение можно модифицировать (не включать начало каждой строки с помощью аргумента ''Флаги'' функций для работы с регулярными выражениями).
|-align="left"
|Конструкции проверки позиции
|'''\A'''
|Конструкция соответствует положению в тексте, перед началом всего текста (в отличие ''^'' не модифицируется).
|-align="left"
|Конструкции проверки позиции
|'''$'''
|Конструкция соответствует положению в тексте, после окончания всего текста или после последнего символа любой строки (строки разделяются двумя символами \x0D\x0A). Поведение можно модифицировать (не включать конец каждой строки с помощью аргумента ''Флаги'' функций для работы с регулярными выражениями).
|-align="left"
|Конструкции проверки позиции
|'''\Z'''
|Конструкция соответствует положению в тексте, после окончания всего текста, но перед последним символов перевод строки (\x0D\x0A), если таковой присутствует.
|-align="left"
|Конструкции проверки позиции
|'''\z'''
|Конструкция соответствует положению в тексте, после окончания всего текста.
|-align="left"
|Конструкции проверки позиции
|'''\b'''
|Конструкция "граница слов" соответствует положению в тексте, где предыдущий и последующий символы принадлежат разным группам из наборов <code>[A-Za-z0-9_]</code> и <code>[^A-Za-z0-9_]</code>.
|-align="left"
|Конструкции проверки позиции
|'''\B'''
|Конструкция "не граница слов" соответствует положению в тексте, где предыдущий и последующий символы принадлежат одинаковым группам из наборов <code>[A-Za-z0-9_]</code> и <code>[^A-Za-z0-9_]</code>.
|-align="left"
|Конструкция перечисления
|'''<nowiki>...|...|... ...</nowiki>'''
|Конструкция перечисления соответствует месту в тексте, которому соответствует любое из выражений внутри ее. Конструкция может работать как для всего регулярного выражения, так и для конкретной группы. Каждое выражение конструкции может быть произвольным регулярным выражением. Примеры: <code><nowiki>red|green</nowiki></code>, <code><nowiki>\b(red|green|blue)\b</nowiki></code>.
|-align="left"
|Группы проверки
|'''<nowiki>(?=...)</nowiki>'''
|Положительная группа проверки вперед соответствует положению в тексте после которого будет следовать кусок текста, соответствующий регулярному выражению в группе. Проверка не передвигает позицию сравнения, она остается на прежнем месте. Пример: <code><nowiki>\S+\s+(?=XVI?)[IVX]+</nowiki></code> найдет "Людовик XV" в строке "Людовик XV — король Франции c 1 сентября 1715 года".
|-align="left"
|Группы проверки
|'''<nowiki>(?!...)</nowiki>'''
|Отрицательная группа проверки вперед соответствует положению в тексте после которого не будет следовать кусок текста, соответствующий регулярному выражению в группе. Проверка не передвигает позицию сравнения, она остается на прежнем месте. Пример: <code><nowiki>\S+\s+(?!XVI)[VXI]+</nowiki></code> найдет "Людовик XV" в строке "Людовик XV — король Франции c 1 сентября 1715 года", однако, не найден ничего в строке "Людовик XVI — король Франции c 4 сентября 1791 года".
|-align="left"
|Группы проверки
|'''<nowiki>(?<=...)</nowiki>'''
|Положительная группа проверки назад соответствует положению в тексте перед которым должен находиться кусок текста, соответствующий регулярному выражению в группе. Проверка не передвигает позицию сравнения, она остается на прежнем месте. Пример: <code><nowiki>\S+(?<=Людовик)\s+[IVX]+</nowiki></code> найдет "Людовик XV" в строке "Людовик XV — король Франции c 1 сентября 1715 года".
|-align="left"
|Группы проверки
|'''<nowiki>(?<=...)</nowiki>'''
|Отрицательная группа проверки назад соответствует положению в тексте перед которым не должен находиться кусок текста, соответствующий регулярному выражению в группе. Проверка не передвигает позицию сравнения, она остается на прежнем месте. Пример: <code><nowiki>\S+(?<!Луи)\s+[IVX]+</nowiki></code> найдет "Людовик XV" в строке "Людовик XV — король Франции c 1 сентября 1715 года".
|-align="left"
|Группы выражений
|'''(...)'''
|Группа, содержащая произвольное регулярное выражение. Используется для удобства квантификации с символами типа "*", "+" и пр., для конструкций перечисления, а также возвращает последний найденный результат в соответствующих режимах функции [[MatchRE]]. Внутри групп разрешено использование других групп. Каждая группа имеет свой индекс, нумерация начинается с 1 и задается в последовательности левых открывающихся скобок (это имеет значение только для вложенных групп).
|-align="left"
|Группы выражений
|'''(<Group>...)'''
|Именованная группа, отличается от '''(...)''' только тем, что имеет кроме номера еще и имя. При обращении к результатам групп (к примеру с помощью '''\g{?}''') можно указывать, как номер группы, так и наименование. При возврате результатов групп в функции [[MatchRE]] для именованных групп будет использовано имя, а для безымянных -- индекс.
|-align="left"
|Группы выражений
|'''(?:...)'''
|Группа без результата, отличается от '''(...)''' только тем, что не будет присутствовать в результатах функции [[MatchRE]] и также не будет иметь индекса группы, т.е., к ней нельзя будет обратиться к помощью конструкций '''\g{?}''' или подобных.
|-align="left"
|Группа комментария
|'''(?#...)'''
|Текст внутри данной группы не будет разбираться и участвовать в поиске результата.
|-align="left"
|Ссылки на группы
|'''\N''', '''\gN''', '''\g{N}'''
|Число '''N''' задает индекс обычной или именованной группы, текущий из результатов которой будет использован для поиска для текущей позиции сравнения. Фактически является ссылкой на результат группы. Нумерация групп начинается с 1 и задается в последовательности левых открывающихся скобок (это имеет значение только для вложенных групп).
|-align="left"
|Ссылки на группы
|'''\k<Group>''', '''\g{Group}'''
|'''Group''' задает имя именованной группы, текущий из результатов которой будет использован для поиска для текущей позиции сравнения. Фактически является ссылкой на результат группы по ее имени.
|-align="left"
|Ссылки на группы
|'''\g{-N}'''
|Число '''N''' задает индекс обычной или именованной группы по отношению к последней заданной группе на данном этапе разбора шаблона, текущий из результатов которой будет использован для поиска для текущей позиции сравнения. Фактически является ссылкой на результат группы относительно к последней заданной. Нумерация групп начинается с 1 и задается в последовательности левых открывающихся скобок (это имеет значение только для вложенных групп).
|-align="left"
|Ссылки на группы
|'''\g<N>''', '''\g<Group>''', '''\g<-N>'''
|Текст шаблона группы, заданной индексом, именем или индексом отношения будет использован, начиная с текущей позиции шаблона. Фактически является ссылкой на шаблон группы, для упрощения общего шаблона, если в нем есть несколько одинаковых по описанию групп. Нумерация групп начинается с 1 и задается в последовательности левых открывающихся скобок (это имеет значение только для вложенных групп). Пример: <code><nowiki>(\S+) и (\g<1>)</nowiki></code> найдет "мам и пап" в строке "мам и пап", значение группы 1 будет равно "мам", а значение группы 2 будет равно "пап". Ссылка создает копию группы без результата, поэтому в примере, она добавлена в еще одну группу с результатом, чтобы показать разницу между ''\g{N}'' и ''\g<N>''.
|-align="left"
|Условия в шаблоне
|'''<nowiki>(?(N)...|...)</nowiki>'''
|Число '''N''' задает индекс обычной или именованной группы, если группа вернула какое-либо значение (группа могла не вернуть значение, если она не была выполнена из-за предыдущего условия, либо не задавала квантификацию с количеством ноль), для дальнейшего поиска будет использован первый из шаблонов внутри конструкции, иначе -- второй (после знака ''<nowiki>|</nowiki>''). Пример: <code><nowiki>(а)?(?(1)ма|па)</nowiki></code> найдет "ама" и два раза "па" в строке "мама и папа".
|-align="left"
|Условия в шаблоне
|'''<nowiki>(?(?=...)...|...)</nowiki>''', '''<nowiki>(?(?!...)...|...)</nowiki>''', '''<nowiki>(?(?<=...)...|...)</nowiki>''', '''<nowiki>(?(?<!...)...|...)</nowiki>'''
|Внутри условия задается одна из четырех групп проверки (см. выше), при поиске результата, если группа поиска нашла значение, для дальнейшего поиска будет использован первый из шаблонов внутри конструкции, иначе -- второй (после знака ''<nowiki>|</nowiki>''). Пример: <code><nowiki>(?(?<=а)м|п)</nowiki></code> найдет "м" с позицией 3 и "п" с позицией 8 в строке "мама и папа".
|-align="left"
|Квантификаторы
|'''?''' (жадная конструкция, greedy)
|Проверяет текст с текущей позиции поиска на совпадение с предыдущим символом (если указан после символа), группой (если указан после группы) или конструкции (перечисления, проверки позиции и т.д.), если указан после конструкции. Если совпадение не найдено, не передвигает позицию поиска, иначе передвигает ее. Иными словами, ищет 0 или 1 совпадений с предыдущим шаблоном.
|-align="left"
|Квантификаторы
|'''*''' (жадная конструкция, greedy)
|Проверяет текст с текущей позиции поиска на совпадение с предыдущим символом (если указан после символа), группой (если указан после группы) или конструкцией (перечисления, проверки позиции и т.д.), если указан после конструкции. Если совпадение не найдено, не передвигает позицию поиска, иначе пытается найти как можно больше последовательных совпадений, и передвигает позицию поиска за последним найденным. Иными словами, ищет 0 или более совпадений с предыдущим шаблоном.
|-align="left"
|Квантификаторы
|'''+''' (жадная конструкция, greedy)
|Проверяет текст с текущей позиции поиска на совпадение с предыдущим символом (если указан после символа), группой (если указан после группы) или конструкцией (перечисления, проверки позиции и т.д.), если указан после конструкции. Если совпадение не найдено, поиск для данной позиции будет завершен неудачей, иначе пытается найти как можно больше последовательных совпадений, и передвигает позицию поиска за последним найденным. Иными словами, ищет 1 или более совпадений с предыдущим шаблоном.
|-align="left"
|Квантификаторы
|'''{N}''', '''{N,}''', '''{N,M}''' (жадные конструкции, greedy)
|Находит максимально возможное количество последовательных совпадений текста в диапазоне от ''N'' до ''M'' с текущей позиции поиска с предыдущим символом (если указан после символа), группой (если указан после группы) или конструкцией (перечисления, проверки позиции и т.д.), если указан после конструкции. Если совпадения не найдены, поиск для данной позиции будет завершен неудачей, позицию поиска передвигается за последним найденным. Для конструкции ''{N}'' ищется точное ''N'' совпадений, для ''{N,}'' -- максимальное количество, но не меньше ''N'', для ''{N,M}'' -- максимальное количество из диапазона [''N''..''M'']. Иными словами, ищет от ''N'' до ''M'' совпадений с предыдущим шаблоном.
|-align="left"
|Квантификаторы
|'''??''', '''*?''', '''+?''', '''{N}?''', '''{N,}?''', '''{N,M}?''' (ленивые конструкции, lazy)
|В отличие от жадных квантификаторов (см. выше), данные находят минимальное возможное количество совпадений.
|-align="left"
|Квантификаторы
|'''?+''', '''*+''', '''++''', '''{N}+''', '''{N,}+''', '''{N,M}+''' (собственнические конструкции, possessive)
|В отличие от жадных квантификаторов (см. выше), данные находят максимально возможное количество совпадений, и не отдают результата, если для него требуется меньшее, чем максимальное найденное количество совпадений. Использование таких квантификаторов совместно с жадными или ленивыми в объемном тексте может привести с многократному замедлению поиска (до многих порядков), так как системе придется перебирать гораздо большее количество шагов, поэтому использовать их нужно с осторожностью (к примеру <code>.+(.++)ы+</code> для сравнительно небольшого текста будет являться причиной миллионов итераций).
|}

{{function header}}
{{function entry
|name=[[MatchRE]], '''PosRE'''
|form='''MatchRE'''(''<Выражение (STRING)>'',''<Строка, в которой происходит поиск (STRING)>''{{Optional|,''<Позиция начала поиска (INT)>''{{Default|{{Eq}}0}}}}{{OptionalByRef|,<Длина найденного (INT)>}}{{Optional|,<Режим поиска (INT)>{{Default|{{Eq}}0}},<Флаги поиска (INT)>{{Default|{{Eq}}0}}}}):''<Позиция, список или таблица (INT,LIST,TAB)>''
|type=1
|status=2
|visual=0
|description=Производит проверку шаблона регулярных выражений, заданного первым аргументом в тексте, заданным вторым аргументом. В зависимости от режима поиска может возвратить найденную позицию или ноль, список найденных значений (и значений групп поиска), либо таблицу позиций найденных значений (и значений групп поиска).
}}
{{function entry
|name=[[ReplaceRE]]
|form='''ReplaceRE'''(''<Строка, в которой происходит поиск (STRING)>'',''<Выражение (STRING)>'',''<Шаблон для замены (STRING)>''{{Optional|,''<Позиция начала поиска (INT)>''{{Default|{{Eq}}0}},<Максимальное количество замен (INT)>''{{Default|{{Eq}}0}},<Флаги поиска (INT)>{{Default|{{Eq}}0}}}}):''<Текст результата (STRING)>''
|type=1
|status=2
|visual=0
|description=Производит проверку шаблона регулярных выражений, заданного вторым аргументом в тексте, заданном первым аргументом. Возвращает текст, с заменой найденных в нем значений на текст или шаблон, заданный третьим аргументом.
}}
{{function entry
|name=[[TearStrRE]]
|form='''TearStrRE'''(''<Строка, в которой происходит поиск (STRING)>'',''<Выражение (STRING)>''{{Optional|,<Максимальное количество результатов для деления (INT)>''{{Default|{{Eq}}0}},<Флаги поиска (INT)>{{Default|{{Eq}}0}}}}):''<Список результатов деления (LIST)>''
|type=1
|status=2
|visual=0
|description=Производит проверку шаблона регулярных выражений, заданного вторым аргументом в тексте, заданном первым аргументом. Возвращает список отрывков текста, находившихся между найденными выражениями. Останавливает процесс деления текста при достижении максимального количества делений, последний отрезок текста (для которого, возможно, проверка не была закончена), также добавляется в результирующий список.
}}
{{function footer}}

{{Объекты}}