Project and Project Elements Property List
Contents Hide
This appendix is a list of all the properties for the projects, forms, and tables.
Project Property List
The BrightBuilder project properties list specifies (and allows you to edit) the characteristics of a project.
| Property Name | Description |
| About Form Name | The form to be displayed when the BrightForms user
selects the Help > About menu.
This allows you to brand your mobile applications with your own logo and about/contact details. |
| All Files | A read-only property that specifies where the project file is saved. |
| App Settings | End user application specific settings.
Each end user can have a unique Id, for example, each sales agent has a specific sales area, using the App Settings properties, the end user does not have to enter their Id or sales area code for every transaction made by the user. This has project scope, such that it is available in any of the project elements. The main difference with the Global Variables is that App Settings are persisted in a local file and is much slower as the application settings file is always updated every time the App Setting is assigned a value. Whereas Global Variables are persisted in the memory. |
| Aspects | This opens the Aspects Dialog which list all the aspect
templates that can be used within the project.
A default Pocket PC Portrait and Landscape aspects are available on the form layout. |
| Author | The person or organization who created the project |
| Default Font | Specifies the font and point size for text used in forms and form controls, will be used throughout the program. This should be set on project creation before any form controls has been added to the form layout. |
| Default Form Size | Specifies the form size that will be the default for all new forms. Initially, this value is blank, and populated with the value assigned for the first form created in the project. |
| Description | A text that describes the project. |
| Enable Background Synchroniser | Set to true if data synchronisation messages are to be sent in the background. See Chapter 9 Sync Rules for further details on synchronisation and Chapter 18 Background Synchronisation for more information on background synchronisation. |
| Enable Push Listener | Set to true to enable BrightForms to listen to unsolicited push messages. |
| File Size | A read-only property that shows the project file size. |
| Language | A read-only property which describes the language used in the project. Defaulted to English language. |
| Main Form Name | Sets the initial form that will be opened upon execution of the project. |
| Modification Time | Displays the modification date and time of the project. |
| Name | Name of the project. |
| Settings - Password | Optionally provide the password with which to access BrightForms system settings. If not specified, BrightForms will use the default BrightForms password generated daily by BrightBuilder from the Tools>Today's BrightForms Settings Password menu. |
| Settings - Password Protected | Set to true if BrightForms Setting menu needs to be password protected. |
Use Latest Look-and-Feel |
Turn this on to enable BrightForms to use the most up-to-date Look-and-Feel.. |
| Version | The version number of the project. |
| Web App Auto Resized | If this is set, in web mode, forms rendered by BrightWeb through browser clients will resize themselves proportionally as the user adjusts the browser window. This can be very handy and an easy way to create a web application that will adjust itself based on the screen size and also will utilise the available real estate to provide the user with a more meaningful view layout. |
| Web Main Form Name | Sets the initial form that will be opened upon execution of the in web mode, as it may be different with login screens etc considered. |
Web Menu Background Colour |
In web mode, background colour of the menu. |
Web Menu Font |
In web mode, font of the menu. |
Web Menu Has Image |
In web mode, whether the top of the menu should display an image. Only applies to left positioned menus. |
Web Menu Image File |
In web mode, image to display on the top of the menu. Only applies to left positioned menus. This image is displayed only if Web Menu Has Image property is selected. |
Web Menu Position |
In web mode, where to position the menu, top or left of the form |
Web Menu Text Colour |
In web mode, text colour of the menu. |
Web Menu Item Width |
In web mode, the width (in pixels) of the menu. In Left positioned menus, defines the menu width. In Top positioned menus, defines the item width. |
Web Menu Item Height |
In web mode, the height (in pixels) of the menu item. This applies to items of the menus located on top or left. |
Form Property List
The BrightBuilder form properties list specifies (and allows you to edit) the characteristics of a form.
| Property | Description |
| Action - Background Sync | Specifies an expression for when the Background Synchroniser completes a session. |
| Action - Change Tab | Specifies an expression to be executed when the form tabs are clicked. |
| Action - Close | Specifies an expression, which is triggered when the form is closed. |
| Action - Gesture | Specifies an expression for when a user performs a gesture. |
| Action - New | Specifies an expression, which is triggered when the user clicks on the New button on the cursor bar. |
| Action - Notification | Specifies an expression to be run when the system notification event occurs. |
| Action - Open | Specifies an expression, which is triggered when the form is opened. |
| Action - Orientation Changed | Specifies an expression which is triggered when the screen orientation has changed. |
| Action - Post Delete | Specifies an expression to be executed after a record is deleted in a cursor form. |
| Action - Post Save | Specifies an expression to be executed after saving a record in a cursor form. |
| Action - Pre Delete | Specifies an expression to be executed before a record is deleted in a cursor form. |
| Action - Pre Save | Specifies an expression to be executed before saving a record in a cursor form. |
| Action - Push | Specifies an expression for when unsolicited push data is received. |
| Action - Scan Complete | Specifies the expression to be executed once a barcode scan is complete. This can only be used with a Symbol or an Intermec device. |
| Action - Timer | Specifies an expression to be executed when the timer elapses. Useful for automatic synchronisation with the server. Use EnableTimer() and DisableTimer() form objects to start and stop the timer. |
| Colour | Enables the form background colour. |
| Colour - Background | Sets the form background colour. |
| Colour - Text | Default form text colour |
| Height | The vertical dimension of the form expressed in pixels. |
| Help | The text to include in the Help dialog attached to the form. |
Hide Menu Bar |
Set to true to hide the menu bar. |
| Hide Title Bar | Set to true to hide the title bar. |
| Image-Filename | Specifies the file containing the image to be used in the form background. |
| Image-Style | Specifies whether the background bitmap should be centered, stretched or tiled. |
| Maximised | Specifies whether the form will initially appear maximised. |
| Notification-Delay | The number of milliseconds to wait between the event and the notification. |
| Notification-Event | The notification event that will trigger the Action-Notification expression. |
| Read Only | Determines whether values/settings on the form can be changed or not. True or False. |
| Tab Font | Determines the font of the text that will appear on the tab attached to the form. |
| Timer Interval (ms) | The timer period in milliseconds. |
| Title | The name that will appear on the form title bar. A text string. |
| Width | The Horizontal dimension of the form expressed in pixels. An integer. |
| Web Hide Home Link | Removes the option to return to the home screen from the form in the web application. This may need to be used to maintain the application state as non-web solutions. |
| Web Hide Logout Link | Removes the option to sign out from the form in the web application. This may need to be set to be used to maintain the application state as non-web solutions. |
| Web Hide Close Link | Removes the option to close the form in the web application. This may need to be set to be used to maintain correct execution, given the web platform. |
| Window Mobile - Has Scroll Bars | Instructs to show vertical and/or horizontal scroll bar if the form is bigger than the actual device size. This property is applicable to Windows Mobile platform. Ignored on other platforms. |
Table Property List
The BrightBuilder table properties list specifies (and allows you to edit) the characteristics of a table.
| Property Name | Description |
| Auto Delete Records | Specifies whether or not the table data can be automatically updated between client and server according to Sync Rules. |
| Description | A text that describes the tablee. This text is displayed as a tool tip, on mouse over of the table's node. If no description is specified, then the text 'Table' will be displayed. |
| Notes | Additional notes or comments about the table. |
| Online Server Table | Specifies if a table is a Server table. This table will not be created or saved in the local database if set to true. |
| Synchronisable | Specifies whether the table records are automatically removed from the client or server from which the update has come. |
Query Property List
The BrightBuilder query properties list specifies and allows you to edit the characteristics of a query.
| Property Name | Description |
| Description | A text that describes the query. This text is displayed as a tool tip, on mouse over of the query's node. If no description is specified, then the text 'Query' will be displayed. |
| Lock Server Records | A reserved property, set to true if server records are to be locked for a user and modifications cannot be made by another user. |
| Online Query | Set to true if the query is to access server records without saving the result to the local database. |
| Stored Procedure | Set to true if query is using a stored procedure from the server, this will display a different query editor to assign values to the input and output parameters of the stored procedure. |
Sync Rules Property List
The BrightBuilder query properties list specifies and allows you to edit the characteristics of a sync rule.
| Property Name | Description |
| Description | A text that describes the sync rule. This text is displayed as a tool tip, on mouse over of the sync rule's node. If no description is specified, then the text 'Sync Rule' will be displayed. |
Report Property List
The BrightBuilder query properties list specifies and allows you to edit the characteristics of a query.
| Property Name | Description |
| Description | A text that describes the report. This text is displayed as a tool tip, on mouse over of the report's node. If no description is specified, then the text 'Report' will be displayed. |
| Margin - Bottom | Set the width of the margin at the bottom of each page. |
| Margin - Left | Set the width of the margin at the left of each page. |
| Margin - Top | Set the width of the margin at the top of each page. |
| Title | Title of the report. |
| Width | Set the width of the report. |