Объекты Report и Engine
Кроме объектов, которые содержатся в отчете, в скрипте определены две переменные: Report и Engine.
Переменная Report возвращает ссылку на текущий отчет. В таблице ниже приведен список методов объекта Report:
| Метод | Описание |
|---|---|
object Calc(string expression) |
Вычисляет выражение и возвращает значение. При вызове этого метода первый раз выражение компилируется, что требует некоторого времени. |
object GetColumnValue(string complexName) |
Возвращает значение поля источника данных. Имя должно быть представлено в форме "Источник.Поле". Если поле имеет значение null, оно преобразуется в значение по умолчанию (0, пустая строка, false и др). |
object GetColumnValueNullable(string complexName) |
Возвращает значение поля источника данных. В отличие от предыдущего метода, не выполняет преобразование null-значений. |
Parameter GetParameter(string complexName) |
Возвращает параметр отчета с указанным именем. Имя может быть составным при обращении к вложенному параметру: MainParam.NestedParam. |
object GetParameterValue(string complexName) |
Возвращает значение параметра отчета с указанным именем. |
void SetParameterValue(string complexName, object value) |
Устанавливает значение параметра отчета с указанным именем. |
object GetVariableValue(string complexName) |
Возвращает значение системной переменной, например, Date. |
object GetTotalValue(string name) |
Возвращает значение итога, определенного в окне "Данные", по его имени. |
DataSourceBase GetDataSource(string alias) |
Возвращает источник данных, определенный в отчете, по его имени. |
Объект Engine представляет собой движок, управляющий построением отчета. Используя свойства и методы движка, можно управлять процессом размещения бэндов на странице. Вы можете использовать следующие свойства объекта Engine:
| Свойство | Описание |
|---|---|
float CurX |
Текущее смещение координат по оси X. Этому свойству можно присваивать значение, чтобы смещать печатаемые объекты. |
float CurY |
Текущая позиция печати по оси Y. Этому свойству можно присваивать значение, чтобы смещать печатаемые объекты. |
int CurColumn |
Номер текущей колонки в многоколоночном отчете. Первая колонка имеет номер 0. |
int CurPage |
Номер текущей печатаемой страницы. Это значение можно получить из системной переменной Page. |
float PageWidth |
Ширина страницы минус размер левого и правого полей. |
float PageHeight |
Высота страницы минус размер верхнего и нижнего полей. |
float PageFooterHeight |
Высота подвала страницы (и всех его дочерних бэндов). |
float ColumnFooterHeight |
Высота подвала колонки (и всех ее дочерних бэндов). |
float FreeSpace |
Размер свободного места на странице. |
bool FirstPass |
Возвращает true, если выполняется первый (или единственный) проход отчета. Количество проходов можно получить из свойства Report.DoublePass. |
bool FinalPass |
Возвращает true, если выполняется последний (или единственный) проход отчета. |
На рисунке ниже представлено изображение страницы отчета и название свойств, которые возвращают то или иное измерение страницы.
Свойства Engine.PageWidth и Engine.PageHeight определяют размер области печати, которая почти всегда меньше физических размеров страницы. Размер области печати определяют поля страницы, которые задаются свойствами страницы отчета LeftMargin, TopMargin, RightMargin, BottomMargin.
Свойство Engine.FreeSpace определяет высоту свободного места на странице. Если на странице есть бэнд "Подвал страницы", его высота учитывается при вычислении FreeSpace. Следует учесть, что после вывода очередного бэнда свободное место на странице уменьшается, что учитывается при вычислении FreeSpace.
Как происходит формирование страниц готового отчета? Ядро FastReport выводит бэнды на страницу до тех пор, пока на ней остается свободное место, достаточное для вывода бэнда. Когда свободного места не остается, печатается бэнд "Подвал страницы" (если он есть) и формируется новая пустая страница. Как уже говорилось, после вывода очередного бэнда высота свободного места уменьшается. Кроме того, вывод очередного бэнда начинается с текущей позиции, которая определяется координатами по оси X и Y. Эта позиция возвращается в свойствах Engine.CurX, Engine.CurY. После печати очередного бэнда позиция CurY автоматически увеличивается на высоту напечатанного бэнда. После формирования новой страницы позиция CurY = 0. Позиция CurX изменяется при печати многоколоночных отчетов.
Свойства Engine.CurX и Engine.CurY доступны не только для чтения, но и для записи. Это значит, что можно смещать бэнды вручную, используя одно из подходящих событий. Пример использования этих свойств смотрите в разделе "Примеры".
При работе со свойствами, которые возвращают размер, учтите, что в FastReport используются единицы измерения - экранные пиксели.
В объекте Engine определены следующие методы:
| Метод | Описание |
|---|---|
void AddOutline(string text) |
Добавляет элемент в структуру отчета (см. главу "Интерактивные отчеты") и смещает текущую позицию на добавленный элемент. |
void OutlineRoot() |
Смещает текущую позицию на корень структуры. |
void OutlineUp() |
Смещает текущую позицию на уровень выше. |
void AddBookmark(string name) |
Добавляет закладку (см. главу "Интерактивные отчеты"). |
int GetBookmarkPage(string name) |
Возвращает номер страницы, на которой расположена закладка с указанным именем. |
void StartNewPage() |
Добавляет в отчет разрыв страницы. Если отчет многоколоночный, добавляется новая колонка. |
Используя методы AddOutline, OutlineRoot и OutlineUp, можно формировать структуру отчета программным способом. Обычно это делается автоматически с помощью свойства OutlineExpression, которое имеется у каждого бэнда и у страницы отчета.
Метод AddOutline добавляет к текущему узлу структуры дочерний узел и делает его текущим. С элементом ассоциируется текущая страница отчета и текущая позиция на странице. Таким образом, если несколько раз подряд вызвать AddOutline, то получится "лесенка" типа
Item1
Item2
Item3
Для управления текущим элементом служат методы OutlineUp и OutlineRoot. Первый метод перемещает указатель на элемент, расположенный уровнем выше. Так, скрипт
Engine.AddOutline("Item1");
Engine.AddOutline("Item2");
Engine.AddOutline("Item3");
Engine.OutlineUp();
Engine.AddOutline("Item4");
построит структуру вида
Item1
Item2
Item3
Item4
Метод OutlineRoot передвигает текущий элемент в корень структуры. Например, скрипт:
Engine.AddOutline("Item1");
Engine.AddOutline("Item2");
Engine.AddOutline("Item3");
Engine.OutlineRoot();
Engine.AddOutline("Item4");
построит структуру следующего вида:
Item1
Item2
Item3
Item4
Для работы с закладками используются методы AddBookmark и GetBookmarkPage объекта Engine. Обычно закладки добавляются автоматически при использовании свойства Bookmark, которое имеется у всех объектов отчета.
Используя метод AddBookmark, можно добавлять закладку программно. Этот метод создаст закладку на текущей странице, в текущей позиции печати.
Метод GetBookmarkPage возвращает номер страницы, на которой расположена закладка. Этот метод часто применяется при создании оглавлений, для отображении номеров страниц. В этом случае отчет должен быть двухпроходным.