Book

copy link

The book object is a highly configurable way to represent complex data and is a superset of the reporting engine included in other development tools. Books can be shown inside the browser, in preview mode, or "printed" directly as PDF files. To create new books you can use the context menu of the form editor or form object, or you can use the context menu of a panel to create a book that prints the panel's data.

Reports tutorial
Video course: Book object
Video course: Report object

Properties

Name: represents the name of the book, as it will be identified within the Instant Developer project. If the Caption property is not changed, the name of the book will also be shown in the user interface.

Description: contains a description of the purpose of the book. The text entered will be used to compose the user manual.

Caption: represents the default value of the Caption property, used as the book's title. It is normally left blank, in which case the Name property will be used.

Unit of measure: represents the unit of measure used for the positions and sizes of the book's objects. The possible values are millimeters and inches, but it is best not to change the default setting.

Count pages before printing: if set, specifies that the book should perform an initial in-memory formatting to determine how many pages it comprises, and only after calculating, reformat the current page or reprint the required pages. This flag slows printing or representation of the book, but it allows using the NumberOfPages property with the expected value. See also: NumberOfPagesConfirmed.

Template: if set, specifies that the book can be used as a template for other books, which will inherit the structure of its master pages and reports.

Hide page borders in preview mode: when a book is shown in preview mode, the page border is displayed just as it is when the book is read in the browser. Setting this flag hides these borders, only the content of pages will be shown. This allows the book to be better integrated with other graphic elements in the form.

Visual properties: these flags enable or disable certain features of the book. They can always be modified at runtime by using the methods of the book library.

  • Use small icons: if set, the book toolbar will display icons that are smaller than normal. This is useful for books contained in static panel fields.
  • Can drag: if set, allows the user to drag the book boxes to other parts of the user interface.
  • Can drop: if set, allows the book to accept other interface objects dropped onto it. When a drop is performed, the OnGenericDrag and OnGenericDrop events will be raised to allow the operation to be handled.

Minimum size W: the minimum width the book will resize to when the form reduces its width.

Minimum size H: the minimum height the book will resize to when the form reduces its height.

Maximum size W: the maximum width the book will resize to when the form increases its width.

Maximum size H: the maximum height the book will resize to when the form increases its height.

Fixed width: setting this flag causes the book's width to remain unchanged when the form's width is resized.

Fixed height: setting this flag causes the book's height to remain unchanged when the form's height is resized.

Hide frame: if set, only the book's contents will be displayed and not its caption bar.

Show border: if set, specifies that the system will insert a border separating adjacent panels. For example, if the flag is set and a form contains two frames, one left and one right, a vertical line will be shown separating the two frames.

Code: the name of the variable representing the book within the source code. Changing this property is not recommended.

Automatic: if set, specifies that the Code property will be automatically calculated and disambiguated based on the name of the book. Changing this option is not recommended.

Add master page: adds a new Master page object to the book. A master page is a page template used by the book to show data.

Add report: adds a new Report object to the book. A report contains the definition of a query, of the database or in-memory, and of the graphical representation of this information in the master pages.

Events: this submenu allows adding procedures to handle events raised by the book. For more information on the events available, refer to the Book library.

Add folder: adds a folder inside the book, which will have no impact on the source code, but can be used to better organize the objects in the book.

Add task: creates a new task object linked to the book. It serves as a reminder for future changes or to manage group work.

Find derived objects: searches for all objects in the project derived from the book, including at multiple levels.

Find where used (object): searches for all points in the project where this book is directly referenced in any way.

Find where used (content): searches for all points in the project where this book or one of the objects it contains is directly referenced in any way.

A book can be dragged and dropped onto a/an...

Panel: associates the book with the panel. This is only valid for books that are not shown inside the form.

Code block: adds a statement that sets a property of the book or calls a method.

Statement: prepares the statement to set a property of the book or to call a method.

Other objects in the form: moves the book in the list of objects contained in the form.

creates a copy of the book and positions it next to the target object.

Folder: if the folder is at the same level as the book, then the book will simply be moved inside the folder.

positions the book before the folder at the same level of the tree.

copies the book inside the folder.

Changed on: 15/12/2022 / From version: 8.5.3800