Formular&Script 2020

Formular&Script / Anweisungen und Konstanten zur Formularsteuerung

Bereichsdefinitionen

Bereiche sind Abschnitte innerhalb des Formular-Skripts. Sie dienen der übersichtlichen Gestaltung und logischen Gliederung des Skripts.

Darüber hinaus erfüllt jeder Bereich bestimmte Funktionen, der Tabellenbereich dient beispielsweise dazu, die Daten einer Tabelle auszugeben. 

Es gibt sowohl notwendige als auch optionale Bereiche. 

Die notwendigen Bereiche sind:

  • BeginDocument
  • BeginHeader
  • BeginGraphicsText
  • BeginFooter

Die optionalen Bereiche sind:

  • BeginBackground
  • BeginPage
  • BeginTableBreak
  • BeginTableFooter
  • BeginTableHeader
  • BeginTableRow

Einige Bereiche können innerhalb eines Formulars beliebig oft definiert werden. Eine Bereichsdefiniton beginnt immer mit einem Rautezeichen, z. B. #BeginDocument.

 

BeginDocument

 

Syntax

#BeginDocument 

Beschreibung

Definiert den Beginn des Dokumentbereichs. In diesem Bereich werden die Dokumenteigenschaften festgelegt. Der Bereich ist der erste Bereich, der ausgeführt wird, und dient dazu, den Rand des Dokuments festzulegen sowie Konstanten und Variablen zu definieren. 

In diesem Bereich muss die Definition der Dokumenteigenschaften mit der Anweisung SetDocument erfolgen. Fehlt diese Anweisung, so wird kein Text und keine Grafik ausgegeben. Der Bereich muss im Skript enthalten sein, darf aber nur einmal angegeben werden. 

Beispiel

 

BeginHeader

 

Syntax

#BeginHeader 

Beschreibung

Definiert den Beginn des Kopfbereichs. In diesem Bereich kann die grafische Ausgabe für die Kopfzeile festgelegt werden. Der Kopfbereich ist der oberste Bereich auf der Seite für eine grafische Ausgabe. 

Für diesen Bereich muss mit der Anweisung SetArea eine Höhe definiert werden. Der Bereich ist optional, darf aber nur einmal definiert werden. 

Beispiel

 

BeginGraphicsText

 

Syntax

#BeginGraphicsText 

Beschreibung

Definiert den Beginn des grafischen Textbereichs. In diesem Bereich können beliebige Texte und Grafiken ausgegeben werden. Der Text bzw. die Grafiken sind in diesem Bereich frei positionierbar. 

Für diesen Bereich muss mit der Anweisung SetArea eine Höhe definiert werden. Die definierte Höhe stellt die maximale Höhe des Bereichs dar und kann an den Inhalt angepasst (nur verkleinert) werden. Die Anpassung der Höhe erfolgt in der Anweisung SetArea durch den Parameter AUTOSIZE

Bei einem Seitenumbruch wird immer der gesamte Bereich, der nicht mehr auf die Seite passt, auf der nächsten Seite ausgegeben. Der Bereich kann im Skript vor oder nach einem Tabellenbereich beliebig oft definiert werden. 

Beispiel

 

BeginFooter

 

Syntax

#BeginFooter 

Beschreibung

Definiert den Beginn des Fussbereichs. Der Fussbereich ist der letzte Bereich einer Seite, der gezeichnet wird. 

Für diesen Bereich muss mit der Anweisung SetArea eine feste Höhe definiert werden. Der Bereich ist optional, darf aber nur einmal definiert werden. 

Beispiel

 

Die optionalen Bereiche:

 

BeginBackground

 

Syntax

#BeginBackground 

Beschreibung 

Definiert den Beginn des Hintergrundbereichs. Hier kann der Hintergrund für alle oder spezielle Seiten definiert werden.  Der Background-Bereich ist der erste Bereich, der gezeichnet wird. Der Bereich ist optional, darf aber nur einmal definiert werden. 

Beispiel

 

BeginPage

 

Syntax

#BeginPage 

Beschreibung

Definiert den Beginn des Seitenbereichs und wird immer vor den grafischen Ausgabebereichen ausgeführt. In diesem Bereich können keine grafischen Ausgaben definiert werden. Der Bereich wird auf jeder Seite ausgeführt und dient dazu, Berechnungen durchzuführen, Variablen zu definieren und Werte zuzuweisen. Dadurch kann beispielsweise eine individuelle Seitengestaltung erfolgen. Der Bereich ist optional, kann aber nur einmal pro Seite definiert werden. 

Beispiel

 

BeginTableBreak

 

Syntax

#BeginTableBreak 

Beschreibung

Definiert den Beginn des Tabellenumbruchbereichs. In diesem Bereich können Texte und Grafiken beim Seitenumbruch einer Tabelle vor dem Seitenumbruch ausgegeben werden, z. B. Zwischensummen. 

Eine Tabelle muss immer mindestens die Bereiche BeginTableHeader und BeginTableFooter enthalten. Die Bereiche BeginTableRow und BeginTableBreak können optional zwischen diesen Bereichen eingefügt werden. 

Für diesen Bereich muss mit der Anweisung SetArea eine feste Höhe definiert werden. Der Bereich BeginTableBreak darf nur einmal pro Tabellenbereich angegeben werden.

Beispiel

 

BeginTableFooter

 

Syntax

#BeginTableFooter 

Beschreibung

Definiert den Beginn des Tabellenfussbereichs. In diesem Bereich können Texte und Grafiken am Ende einer Tabelle ausgegeben werden, z. B. Endsummen. Der Tabellenfussbereich wird nur am Ende der Tabelle ausgegeben, auch bei längeren Tabellen mit Seitenumbrüchen.

Eine Tabelle muss immer mindestens die Bereiche BeginTableHeader und BeginTableFooter enthalten.

Für diesen Bereich muss mit der Anweisung SetArea eine Höhe definiert werden. Die definierte Höhe stellt die maximale Höhe des Bereichs dar und kann an den Inhalt angepasst (nur verkleinert) werden. Die Anpassung der Höhe erfolgt in der Anweisung SetArea durch den Parameter autoSize

Der Bereich darf nur einmal pro Tabellenbereich angegeben werden. Nach dem Bereich BeginTableFooter kann ein weiterer kompletter Tabellenbereich definiert werden.

Beispiel

 

BeginTableHeader

 

Syntax

#BeginTableHeader 

Beschreibung

Definiert den Beginn des Tabellenkopfbereichs. In diesem Bereich können beliebige Texte und Grafiken am Anfang der Tabelle ausgegeben werden. 

Eine Tabelle muss immer mindestens die Bereiche BeginTableHeader und BeginTableFooter enthalten. Nach dem Bereich BeginTableHeader kann der Bereich BeginTableRow definiert werden. 

Um auf den Inhalt also die Felder einer bestimmten Tabelle zugreifen zu können, muss die Tabelle in diesem Bereich mit SetCurrentTable ausgewählt werden. Für diesen Bereich muss mit der Anweisung SetArea eine feste Höhe definiert werden. Der Bereich darf nur einmal pro Tabellenbereich angegeben werden. Bei Seitenumbrüchen innerhalb einer Tabelle wird der Tabellenkopf auf jeder Seite neu ausgegeben.

Beispiel

 

BeginTableRow

 

Syntax

#BeginTableRow 

Beschreibung

Definiert den Beginn des Tabellenzeilenbereichs. In diesem Bereich können die Inhalte der im Bereich BeginTableHeader angegebenen Tabelle als Texte und Grafiken ausgegeben werden. 

Eine Tabelle muss immer mindestens die Bereiche BeginTableHeader und BeginTableFooter enthalten. Die Bereiche BeginTableRow und BeginTableBreak können optional zwischen diesen Bereichen eingefügt werden. 

Für diesen Bereich muss mit der Anweisung SetArea eine Höhe definiert werden. Die definierte Höhe stellt die maximale Höhe des Bereichs dar und kann an den Inhalt angepasst (nur verkleinert) werden. Die Anpassung der Höhe erfolgt in der Anweisung SetArea durch den Parameter autoSize. Mit der Anweisung SetAreaMin kann eine Mindesthöhe für eine Tabellenposition definiert werden. 

Der Bereich wird entsprechend der Zeilenanzahl der ausgewählten Tabelle wiederholt. Der Seitenumbruch erfolgt automatisch. Wenn eine Zeile- (ein Durchlauf von BeginTableRow - nicht mehr vollständig auf eine Seite passt, wird die Zeile (beziehungsweise die restliche Tabelle) auf der nächsten Seite ausgegeben. 

Der Bereich BeginTableRow darf nur einmal pro Tabellenbereich angegeben werden.

Beispiel