Формирование отчетов средствами Fast Reports

По результатам опроса Delphi Magazine Fast Reports (fast-report.com, www.fastreport.ru) входит в тройку лидеров по популярности среди инструментов для разработки отчетов для Borland Delphi. В 2004 г. Fast Reports выбран продуктом года.

Данный пункт подготовлен М.В. Зыковым.

Компоненты отчета

frxReport- это основной компонент проекта. Один компонент TfrxReport содержит один отчет. Во время проектирования приложения двойной щелчок мышью на компоненте вызывает дизайнер отчета. Для использования дизайнера в скомпилированном проекте необходимо ис­пользовать компонент frxDesigner из палитры компонентов Fast Report, либо включить в список uses модуль frxDesign. Использование дизайнера во время выполнения дает возможность пользователю настраивать вид отчета, а также редактировать готовый отчет.

Основные свойства

Name- имя отчета.

ScriptLanguage- язык, используемый для скриптов отчета.

EngineOptions- набор свойств ядра отчета FastReport.

ConvertNulls- определяет интерпретацию генератором отчетов пустых значений (Null) полей БД. Если True, то генератор конвертирует пустое значение (Null) поля базы данных в 0 (ноль), False (ложно) или '' (пустая строка) в зависимости от типа поля (True).

SilentMode- режим «молчания». Все сообщения об ошибках будут накапливаться в свойстве TfrxReport.Errors; на экран никаких сообщений выдано не будет (False).

TempDir- путь к каталогу для хранения временных файлов.

PreviewOptions- набор свойств предварительного просмотра.

AllowEdit- разрешает/запрещает редактирование готового отчета (True).

Buttons- набор кнопок, которые будут доступны в окне просмотра (pbPrint - печать, pbLoad - загрузка из файла, pbSave - запись в файл, pbExport - экспорт, pbZoom - масштабирование, pbFind - поиск, pbOutline - включение дерева отчета, pbPageSetup - свойства страницы, pbTools - инструменты, pbEdit - редактор, pbNavigator - навигация).

PrintOptions- набор свойств печати отчета.

Copies- количество печатуемых копий (1).

Collate- разбирать ли по копиям (True).

PageNumbers- номера страниц (диапазонов страниц), которые надо напе­чатать, например: '2,4,6-9,14'.

Printer- имя принтера.

PrintPages- страницы для печатати (ppAll - все, ppOdd - нечетные, ppEven - четные).

ShowDialog- показывать ли диалог печати (True).

AllObjects - список всех объектов, содержащихся в отчете (включая страницы).

DataSets- список наборов данных, доступных для отчета.

Designer- ссылка на дизайнер отчета (актуальна, когда запущен дизайнер).

Engine- ссылка на движок отчета. Полезна в случаях, когда нужно управ­лять процессом построения отчета из кода.

Errors- список ошибок, возникших при той или иной операции.

FileName- имя файла отчета; отображается в дизайнере.

PreviewPages- ссылка на страницы готового отчета. Используется при всех операциях, связанных с готовым отчетом (печать, сохранение и пр.).

Pages- список страниц отчета. В этом списке также присутствуют страницы типа «диалоговая форма».

PagesCount- количество страниц в отчете. Свойство только для чтения.

Script- компонент fsScript, привязанный к данному отчету. Используя эту ссылку, можно добавлять свои переменные, классы, функции, которые следует ис­пользовать в скрипте отчета. Используется только для чтения.

Styles- стиль (оформление) отчета.

Variables- список переменных отчета. Используется только для чтения.

Методы

Clear- очищает отчет.

LoadFromFile(const FileName: String; ExceptionIfNotFound: Boolean = False): Boolean - загружает отчет из файла с заданным именем; если второй параметр равен True и файл не найден, то генерирует исключение. Если файл загружен успешно, возвращает True.

Пример использования метода: frxReport1.LoadFromFile('c:\1.fr3').

LoadFromStream(Stream: TStream) - загружает отчет из потока.

SaveToFile(const FileName: String) - записывает отчет в файл с заданным именем. По умолчанию форма отчета хранится вместе с формой проекта, т.е. в файле .dfm. Метод применяется, если требуется хранить форму от­чета в отдельном файле .fr3. Пример: frxReport1.SaveToFile('c:\2.fr3').

SaveToStream(Stream: TStream) - записывает отчет в поток.

DesignReport- вызывает дизайнер отчета. Дизайнер должен быть включен в проект. Пример использования метода: TfrxReport.DesignReport.

ShowReport(ClearLastReport: Boolean = True) - запускает отчет на выполнение и показывает результат в окне предварительного просмотра. Если параметр ClearLastReport равен False, то отчет добавляется к ранее построенному, иначе ранее построенный отчет очищается (True). (frxReport1.ShowReport).

PrepareReport(ClearLastReport: Boolean = True): Boolean - запускает отчет на выполнение; без окна предварительного просмотра. Если отчет был по­строен успешно, возвращает True.

ShowPreparedReport - показывает отчет, построенный ранее с помощью вызова PrepareReport (if frxReport1.PrepareReport then

frxReport1.ShowPreparedReport;).

Print- печатает отчет. (frxReport1.Print).

Export(Filter: TfrxCustomExportFilter) -экспортирует отчет, используя за­данный фильтр экспорта (frxReport1.Export(frxHTMLExport1);).