Versions Compared

Old Version 4

changes.mady.by.user Ekaterina Marchenko

Saved on

compared with

New Version Current

changes.mady.by.user Ekaterina Marchenko

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. In the manager station, go to Options > Printing > Documents and Layouts.
    In our example, we will edit the receipt layout, but you may edit any other layout.
  2. Go to the Client payment section. Right-click on the Receipt layout and select New (as copy) Printing Layout.
  3. Name the new layout and change the status to Active. Save the changes.
  4. In the Basic section, click on the Layout line, then on three dots image2021-12-24_13-8-34.png
  5. The layout editor will open.
    Let's take a closer look at what the check layout consists of:
    1. A Sheet is a page on which all the receipt elements are located. Elements are shown in different colours only in the editor, the receipt is printed in black and white.
    2. A Band is a section with a specific dataset. Inside the band, you can operate only with data from the dataset.
    3. A Memo is an active element where various data can be added. You can add a simple text or a variable from a dataset. Variables areenclosed in square brackets. A memo is placed inside a band.
      The sizes of bends and memos can be changed by dragging and dropping their borders. Also, you can move the band by holding it down with the left mouse button and dragging it to the desired location.
      We will describe the properties of each element in more detail below.

      There are two tabs on the right side of the layout editor:
      • Assistant — displays available datasets
      • Properties — displays the properties of the selected layout element.
  6. Now you can go directly to editing the layout:
Expand
titleLayout Editing Scenario
  1. Let's try to display the table name in a separate line of the receipt. To create a band, right-click on a free area and select Create band
  2. When adding a band to a sheet, you can create an object of 5 types. What each of them serves for is clear from their names. The main band type, where data is displayed directly, is virtual.
    Select Virtual Band and click Ok.

    By holding down the left mouse button on the band's edge, you can move its borders.
  3. Now, add two memos.
    Right-click on the bend and select Create memo. Change its size as you wish. Repeat the same steps for the second memo.
     
  4. Now specify what data should be displayed in the memo.
    Switch to the Content editor by double-clicking the left mouse button on the memo window. Then enter the text you want, for example: Table number. Click Ok.

    The written phrase is a constant, it will be printed on every receipt, regardless of the table name.
  5. Add the variable to the second memo. Double-click on the memo window to open the editor. Select the image2021-12-27_10-39-37.png button on the top bar. A window will open with a list of available attributes.
    Go to Orders > Table > Main and click once on the Name field, then the Ok button.

    A variable with the table name will appear in the window. Click Ok again to exit the memo editor.

    We have created a variable, and now the name of the table for which the receipt is being made will be printed in these lines.
  6. Click Ok in the lower right corner to close the layout editor.
  7. Editing the layout is complete. Now you need to apply the layout, i.e. to tell the system what layout to print. Find the instruction in the article on editing and using a layout.

...

Anchor
Properties
Properties
Element Properties

The layout editor is equipped with a built-in script editor, which has a syntax similar to Pascal with some limitations. Scripts can be applied to a memo (the lower part of the memo editor), sheet, band, depending on where the script is placed (it affects the code triggering time): the sheet is executed first, then the band, and then the memo of this band.

Properties

...

Common for

...

All Elements

  • Visible
    To show object or not. The script is executed regardless of whether the object is visible or not.
  • Name
    The name of the object. This name is used to access the object in scripts.
  • Tag
    This property has no predefined purpose. Used at the discretion of layout developers in scripts.
  • Script
    The script text. It is written in a Pascal-like language, the syntax is that of Pascal. It has no access to arrays and pointers. The script can contain local variables, which are declared at the beginning of the script using the var construction. The script has access to all layout objects — pages, bands, and memos. The script can change the properties of layout objects. The data source fields are accessed by means of the [DateSet.FieldName] construction. Each script is executed twice: the first time at the stage of the layout preliminary calculation, the second at the stage of generation. You can find out at what stage you are now using the Report.Stage variable, which takes the following values: stPrecalc (preliminary calculation), stShowing (generation).

...

The report layout consists of one or more sheets. Sheets are processed and printed sequentially, independently of each other, the order of output is from left to right. Each sheet contains its own set of service bands: Report title, Header, Footer, and Report summary.

Sheet

...

Properties

  • Fixed Height
    A fixed paper height. Specifies the maximum number of lines on the printed page. After reaching this number of lines, a new page will be started. In the case of a slip-on printer, a message about inserting a new sheet of paper will appear. In the case of a roller printer, the paper will be cut.
  • Variables
    A list of variables common for all layout sheets. This editor describes the global variables of the layout. Global variables can be accessed from any layout script, in contrast to local variables, which are available only within the script where they are declared.
  • Parameters
    A list of parameters common for all layout sheets. Datasets initially contain data for all stations, waiters, cashiers, etc. Parameters are used in order to build a report only for a specific employee. Before printing the report at the cash station, the user is asked to set values ​​for parameters, and the report is built taking into account these restrictions. Report parameters work like filters for datasets. When developing a layout, a list of its parameters is set. Each parameter is described by the following properties:

...

  • New Page
    If true, then after the printing of all the page bends is completed, the paper cut command will be inserted (for roller printers only; for slip printers, this command is ignored).
  • Two Passes
    If true, then when building the layout, the scripts are executed twice: the first time with Report.Stage = stPrecalc, the second with Report.Stage = stShowing. Two passes are needed for the script to make such report changes that will require the report regeneration. For example, when you change the grouping or sorting of the band from this band script.

...

Band

...

As mentioned above, each band has its own dataset. After creating a band, using a double click, you can bind the required dataset to it, with which you can later work within this band.

Bands are placed on sheets or nested in other bands. Bands are divided into bands with data sources and bands without data sources (service bands). Service bands include the following types:

...

A band can modify the content of its data source by sorting, filtering, and rearranging it. This is done by using the Filter, Group, and Sort properties. The order of properties processing: first, a filter is applied to the data source — a band filter and a filter based on the report parameters — and after that the resulting data source is grouped and then sorted.

Band

...

Properties

  • DataSet Name
    The data source linked with the band
  • Filter
    The script text, used to apply the filter to the data source. It is written in a pascal-like language. The script is applied to every line of the data source. The essence of the script is to set the Filter variable to true for those rows of the data source that should remain in the final dataset. Example: Filter: = ([Exclude Income] = 1). Only those rows will remain in the data source where the Excl.Income field was 1.
  • Sort Order
    The set of fields by which the sorting of the data source linked with the band is performed
  • Grouping
    Grouping specifies the set of fields by which the original data source is grouped. Summation is performed for the rest of the fields, i.e. aggregates are counted.

...

It is important to understand that variables from a dataset can only be used within its own band.

Memo

...

Properties

  • Alignment
    Specifies whether the text is aligned left, right, or centered.
  • Content
    Contains the text to be printed. To print fields from a data source, the field names must be enclosed in square brackets: [FieldName]. To print a field from another data source that is not linked to the band in which the memo is placed, you need to use the [DataSourceName.FieldName] construction. To print escape sequences, you need to use the <EscapeCommand> construct. The list of escape commands will be given below. The number of fields that can be displayed using one memo is not limited.
  • Format
    Specifies the variable format (number, date, time, other).
  • Hide zeros
  • Alternative language
  • Word wrap
    Enable auto-wrap.
  • XML Attributes
    XML class
    XML tag

...