Руководство разработчика

Объектный тип ОТЧЕТ

Реализует интерфейсы: И_ФОРМА, И_КОМАНДЫ_ФОРМЫ.

Физический объектный тип c закрытой моделью.

Тип ОТЧЕТ предназначен для создания табличных отчетов различного вида и содержания. Типом ОТЧЕТ можно пользоваться для создания переменных, либо для определения производных типов.

Поля

Тип Поле Описание Значение по умолчанию
ЦЕЛОЕ левыйПоложение левого края окна отчета на экране в пикселях. Игнорируется при показе отчета в дочернем MDI-окне или окне верхнего уровня, а также при установке поля центр равным ДА.150
ЦЕЛОЕ верхнийПоложение верхнего края окна отчета на экране в пикселях. Игнорируется при показе отчета в дочернем MDI-окне или окне верхнего уровня, а также при установке поля центр равным ДА.70
ЦЕЛОЕ ширинаШирина окна отчета на экране в пикселях. Игнорируется при показе отчета в дочернем MDI-окне или окне верхнего уровня при значении поля авто_размер равном ДА.500
ЦЕЛОЕ высотаВысота окна отчета на экране в пикселях. Игнорируется при показе отчета в дочернем MDI-окне или окне верхнего уровня при значении поля авто_размер равном ДА.400
ЛОГИКА центрЦентрировать отчет относительно главного окна. Применяется только для всплывающих окон (popup), а для дочерних MDI-окон и окон верхнего уровня - игнорируется. ДА
ЛОГИКА авто_размерПрименяется только для дочерних MDI-окон и окон верхнего уровня. Включает автоматический выбор размера окна по размеру доступной области родительского окна или рабочего стола. Иначе используется значения полей ширина и высота. ДА
ЛОГИКА видимыйПризнак видимости отчета на экране. ДА
СТРОКА идентИдентификатор отчета, который может использоваться для сохранения настроек.
СТРОКА заголовокЗаголовок окна отчета.
ИКОНКА иконкаИконка окна отчета.
СТРОКА справкаСсылка на топик файла справки прикладной разработки.
ПАРАМ_ПЕЧАТИ парам_печатиПараметры вывода отчета на печать: поля, ориентация страницы и т.п.
ШАПКА верх_шапкаОтображение верхней шапки отчета.
ШАПКА ниж_шапкаОтображение нижней шапки отчета.
ЛОГИКА многоуровнОпределяет, является отчет одно- или многоуровневым. ДА – отчет является многоуровневым. НЕТ – отчет определяется как одноуровневый, и никакие методы для добавления групп и работы с ними выполняться не будут.
ЛОГИКА строка_состОпределяет наличие строки состояния окна отчета. ДА
ЛОГИКА редактируемыйВ контекстное меню отчета добавляются пункты Добавить, Изменить и Удалить. Доступность этих команд изменяется вызовом метода КОМАНДА_РАЗР (по умолчанию команды недоступны). При разрешении команды Добавить в таблице отчета отображается строка добавления с символом "+". Подробнее см. Разрешение команд редактирования и Строка добавления
ЛОГИКА подсветка_отрицательныхОтрицательные числа отображаются красным цветом. При значении ДА все отрицательные значения подсвечиваются принудительно. При значении НЕТ подсветка зависит от действующего в ячейке формата.
ШРИФТ: @[СТРОКА] шрифтыСписок шрифтов, упорядоченных по именам. Имена дополнительных шрифтов могут использоваться для шапок и колонтитулов.

Для простоты задания данных многоуровневых отчетов введено понятие текущего уровня и средства входа в подуровень и выхода из подуровня. Таким образом, можно программно перемещаться по многоуровневому отчету, подобно перемещению по таблице с помощью мыши или клавиатуры. Методы задания и получения данных работают с текущим уровнем. Имеется возможность использовать для подуровней настройки столбцов вышестоящего уровня.

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

Данные отчета задаются в текстовом виде с помощью метода ЯЧЕЙКА. Получить данные по номеру строки и столбца можно с помощью метода ТЕКСТ. Текст ячеек и заголовков столбцов может содержать переносы строк, что приведет к автоматическому пересчету высоты табличной строки отчета и вывода текста в несколько строк. Многоуровневые отчеты формируются с помощью метода ДОБАВИТЬ_ГРУППУ. Перемещение по уровням отчета производится с помощью методов ВВЕРХ и ВНИЗ. С помощью метода СОРТИРОВКА можно отсортировать данные текущего уровня отчета по значениям указанного столбца.

Показ отчета на экране производится методом ПОКАЗАТЬ. Перерисовка отчета производится с помощью метода ОБНОВИТЬ.

Использование объектного типа ОТЧЕТ и его методов в разработке пользовательского интерфейса см. Разработка отчетов.

Методы

МетодОписание
Общие методы
ПОКАЗАТЬ Показывает отчет на экране в режиме по умолчанию.
ПОКАЗАТЬ_МДИ Показывает отчет на экране в режиме дочернего MDI-окна.
ПОКАЗАТЬ_ВЕРХНЕГО_УРОВНЯ Показывает отчет на экране в режиме окна верхнего уровня.
ПОКАЗАТЬ_МОДАЛЬНЫЙ Показывает отчет в модальном диалоге.
ЗАКРЫТЬ Закрывает отчет.
ЭКЗЕМПЛЯР Возвращает строковый идентификатор экземпляра отчета.
ОБНОВИТЬ Перерисовывает отчет.
ПОКАЗАТЬ_МЕНЮ Отображает всплывающее меню.
СТАРТ_ТАЙМЕР_ЗАДЕРЖКИ Запускает именованный таймер задержки.
СТОП_ТАЙМЕР_ЗАДЕРЖКИ Останавливает работу именованного таймера задержки.
КОМАНДА Выполняет обработку команды.
КОМАНДА_РАЗР Разрешает или запрещает стандартные команды для текущего уровня отчета.
ПЕЧАТЬ Выводит отчет на печать.
ПРОСМОТР Вызывает окно предварительного просмотра перед печатью.
ЭКСПОРТ Экспорт в офисное приложение.
Навигация по уровням отчета
УРОВЕНЬ Возвращает имя текущего уровня отчета.
ВИДИМЫЙ_УРОВЕНЬ Возвращает имя видимого на экране уровня отчета.
ВЕРХНИЙ_УРОВЕНЬ Возвращает имя уровня, вышестоящего по отношению к текущему уровню отчета.
ВВЕРХ Позволяет сделать текущим вышестоящий уровень отчета.
ВНИЗ Позволяет перейти на нижестоящий уровень указанной строки отчета.
ПЕРЕЙТИ Позволяет перейти на указанный уровень отчета.
ИТОГИ Переключает режим заполнения итоговых строк.
Формирование столбцов отчета (схемы)
ДОБАВИТЬ_СТОЛБЕЦ Позволяет добавить столбец в отчет.
ВСТАВИТЬ_СТОЛБЕЦ Позволяет добавить столбец перед указанным столбцом таблицы.
УДАЛИТЬ_СТОЛБЕЦ Удаляет из таблицы столбец с указанным именем.
ПЕРЕМЕСТИТЬ_СТОЛБЕЦ Позволяет переместить столбец с указанным именем.
НАЙТИ_СТОЛБЕЦ Возвращает номер столбца по его имени.
ИМЯ_СТОЛБЦА Возвращает имя столбца по его номеру.
КОЛ_СТОЛБЦОВ Возвращает количество видимых столбцов в таблице на текущем уровне отчета.
ОБЪЕДИНИТЬ_СТОЛБЦЫ Объединяет заданные столбцы таблицы.
СЧИТАТЬ_ОБЪЕДИНЕНИЯ_СТОЛБЦОВ Получает список всех объединений столбцов на текущем уровне отчета.
ФОРМАТ_СТОЛБЦА Возвращает формат, заданный для указанного столбца.
УСТ_ФОРМАТ_СТОЛБЦА Позволяет задать формат для указанного столбца.
ИМЯ_СХЕМЫ Возвращает имя схемы таблицы.
УСТ_ИМЯ_СХЕМЫ Позволяет задать имя схемы таблицы для текущего уровня отчета.
СЧИТАТЬ_СХЕМУ Позволяет получить для текущего уровня отчета настройки схемы таблицы.
УСТАНОВИТЬ_СХЕМУ Позволяет установить для текущего уровня отчета настройки схемы таблицы.
СХЕМА_ПО_УМОЛЧ Позволяет получить для текущего уровня отчета настройки схемы, которая ранее была установлена по умолчанию.
УСТ_СХЕМУ_ПО_УМОЛЧ Позволяет установить схему по умолчанию в качестве настроек для текущего уровня отчета.
Операции со строками
ДОБАВИТЬ_СТРОКУ Позволяет добавить строку в отчет.
ВСТАВИТЬ_СТРОКУ Позволяет добавить новую строку перед строкой с указанным номером.
УДАЛИТЬ_СТРОКУ Удаляет строку с указанным номером из таблицы.
НАЙТИ_СТРОКУ Возвращает номер строки по ее имени.
ИМЯ_СТРОКИ Возвращает имя строки по ее номеру.
КОЛ_СТРОК Возвращает количество строк в таблице на текущем уровне отчета.
ДОБАВИТЬ_ГРУППУ Позволяет создать подуровень отчета для строки с заданным номером.
УДАЛИТЬ_ГРУППУ Позволяет удалить признак группы для заданной строки отчета.
НАЙТИ_ГРУППУ Возвращает номер строки по имени уровня.
ИМЯ_ГРУППЫ Возвращает имя группы по номеру строки.
АТРИБУТ_СТРОКИ Возвращает атрибуты, заданные для строки с указанным номером.
УСТ_АТРИБУТ_СТРОКИ Позволяет задать атрибуты для указанной строки.
ФОРМАТ_СТРОКИ Возвращает формат, заданный для строки с указанным номером.
УСТ_ФОРМАТ_СТРОКИ Позволяет задать формат для указанной строки.
ВЫСОТА_СТРОКИ Возвращает высоту строки в пикселях.
УСТ_ВЫСОТУ_СТРОКИ Позволяет задать высоту строки в пикселях.
Операции с ячейками
ТЕКСТ Позволяет получить текст ячейки с заданными координатами на текущем уровне.
ЗНАЧЕНИЕ Позволяет получить значение ячейки с заданными координатами на текущем уровне.
ЯЧЕЙКА Позволяет задать текст ячейки на текущем уровне.
ЯЧЕЙКА_ПОЗ Позволяет задать текст ячейки на текущем уровне отчета.
АТРИБУТ_ЯЧЕЙКИ Позволяет получить дополнительные атрибуты указанной ячейки.
УСТ_АТРИБУТ_ЯЧЕЙКИ Позволяет задать дополнительные атрибуты указанной ячейки.
ПОДСКАЗКА_ЯЧЕЙКИ Позволяет получить текст всплывающей подсказки указанной ячейки.
УСТ_ПОДСКАЗКУ_ЯЧЕЙКИ Позволяет задать строку с текстом всплывающей подсказки для указанной ячейки.
ФОРМАТ_ЯЧЕЙКИ Возвращает формат, заданный для указанной ячейки.
УСТ_ФОРМАТ_ЯЧЕЙКИ Позволяет задать формат для указанной ячейки.
ОБЪЕДИНИТЬ_ЯЧЕЙКИ Позволяет объединить указанные ячейки в таблице.
УДАЛИТЬ_ОБЪЕДИНЕНИЕ Позволяет удалить объединение ячеек.
СЧИТАТЬ_ОБЪЕДИНЕНИЯ Получает список объединений для указанного диапазона строк.
Сортировка
ДОБ_АТР_СОРТ Позволяет добавить дополнительный атрибут сортировки для текущего уровня отчета.
УДАЛ_АТР_СОРТ Позволяет удалить ранее добавленный атрибут сортировки.
АТР_СОРТ Позволяет получить значение дополнительного атрибута сортировки.
УСТ_АТР_СОРТ Позволяет установить значение дополнительного атрибута сортировки.
СОРТИРОВКА Позволяет отсортировать данные текущего уровня отчета по тексту в указанных столбцах или по значениям дополнительных атрибутов сортировки.
УСТ_СТАБ_СОРТ Позволяет установить признак стабильной сортировки для текущего уровня отчета. .
Прочие
ОЧИСТИТЬ Удаляет все данные из отчета.
УСТ_ПАН_ИНСТР Позволяет задать панель инструментов для текущего уровня отчета.
ПОЗ_КУРСОРА Позволяет получить имя столбца и строки курсора в таблице отчета.
УСТ_ПОЗ_КУРСОРА Позволяет изменить положение курсора в таблице отчета.
ВЫДЕЛЕНИЕ Позволяет получить множественное выделение в таблице отчета.
ЯЧЕИСТЫЙ Позволяет установить вид курсора для текущего уровня отчета.
УСТ_СТОЛБЕЦ_СОСТ Позволяет задать имя столбца, текст из которого будет отражаться в строке состояния.
УСТ_СТОЛБЕЦ_ПОИСКА Позволяет задать имя столбца или дополнительного атрибута сортировки для поиска с клавиатуры.
НУМЕРАЦИЯ Позволяет установить ячейкам столбца текст, соответствующий возрастающей с номером строки нумерации.
РАЗМЕР_ОБЛАСТИ Позволяет вычислить размер видимой области таблицы отчета.

Обработчики событий

ОбработчикОписание
до_открытия Вызывается перед созданием окна отчета. Может использоваться для эффективного заполнения отчета.
открытие Вызывается перед показом окна отчета на экране.
после_открытия Вызывается после показа окна отчета на экране.
закрытие Вызывается при попытке закрытия окна отчета.
команда Вызывается при выборе пользователем пункта контекстного меню и при нажатии функциональных клавиш.
меню Вызывается при нажатии правой кнопки мыши в одной из ячеек отчета.
выбор Вызывается при выборе пользователем строки или ячейки отчета.
настройка Вызывается при нажатии кнопки настройки в левом верхнем углу отчета.
сортировка Вызывается при изменении пользователем условий сортировки по столбцам.
вход Вызывается при входе в группу.
выход Вызывается при выходе из группы.
после_входа Вызывается после входа в группу.
после_выхода Вызывается после выхода из группы.
таймер_задержки Вызывается при срабатывании именованных таймеров задержек.

См. также: