Object Properties
Prev
Next

Appendix D. Object Properties

Table of Contents

Form Properties
Form Block Properties
Report Properties
Report Block Properties
Block Header
Block Footer
Tabber
TabberPage
Button Properties
Label
CheckBox
Choice
Link
Field
Memo
Pixmap
Summary
RowMark
RichText
Table Query
Rekall Query
Free-text SQL Query

This appendix lists the properties associated with each type of object. The tables are formatted as below, showing the internal property name, the legend which appears in the property dialogs, and the description (which are the text that appears in the property dialogs when a property is being edited).

Note that there is a fair degree of duplication below. The properties that are specific to reports and forms, rather than than the blocks from which they are derived, have been separated out. However, for data controls the properties are listed in full.

NameProperty dialog legend
 Description

Form Properties

xX-position
 X coordinate of the control relative to its parent
yY-position
 Y coordinate of the control relative to its parent
wWidth
 Width of the block area in pixels
hHeight
 Height of the block area in pixels
xmodeX-mode
  This setting specified whether the control width is fixed width, whether it floats relative to the right-hand side of its block, or whether it stretches as its block width changes. The setting affects the interpretation of the width value.
ymodeY-mode
  This setting specified whether the control height is fixed width, whether it floats relative to the bottom of its block, or whether it stretches as its block height changes. The setting affects the interpretation of the height value.
bgcolorBackground colour
 Background colour
frameKBForm.frame
 KBForm.frame
showbarShow Scroll Bar
  Setting this option will show a vertical scroll bar which indicates the range of rows displayed, and allows scrolling through them.
rowcountRow count
  Number of rows of fields to be shown in this block. If set to zero then the number of calculated based on block size and row spacing.
dxX-delta
 X-offset in pixels between fields if the rowcount is greater than one
dyY-delta
 Y-offset in pixels between fields if the rowcount is greater than one
stretchStretchable
  If set the form can be stretched (resized) when it is displayed; otherwise, the form layout is fixed.
nameControl name
 Control name, used to access control from scripts
masterParent column
 Column in parent query used to link to child field in this block's query
rdonlyRead Only
  Set this option to prevent update of the displayed value by the user. Note that the control can still be updated from a script.
noupdateNo Update
  If this option is set, the database is never updated from the control (even if the contents are changed). This is useful if you wish to display a value in more that one control, and all but done are marked as read only
taborderTab order
 Tab and shift-tab cycle through controls in increasing tab order. A tab order of zero means that the control cannot be entered by tabbing.
childChild column
 Column in this block's query used to link to parent expression
autosyncAutomatic update
 Enabling this option will case field changes to be stored in the database whenever focus moves to a different row or block
configsConfiguration
  List of configuration values. These are primarily used in conjunction with reusable components.
errtextError Text
  Text used to customise various popups. Currently only used at block level by record insert/update/delete confirmation dialogs.
titleTitle
 If set, this is used as a title for the block or container, and appears in the same way as a title appears in a group box in a dialog.
sloppySloppy focus
  If set, and the block does not contain any embedded blocks, then the row which has focus can be scrolled out of view.
blkrdonlyBlock Read Only
  If set then all controls in the block are treated as read-only, irrespective of their individual settings.
tabswrapTabs wrap
  Normally, tabbing out of the last control in the tab order moves to the next record. If this option is set then focus returns to the first control without changing record. Similary for back-tab.
languageScripting language
 Scripting language to be used for script modules in this form
captionForm caption
 Caption text to be displayed when form is active
modalModal
  If set, the form will be executed modally, as if it was a dialog. Note that changes to this setting will not take affect until the form window has been closed and reopened.
hidebarsHide Menu/Tool Bars
  If set, the menu and tool bars will be hidden when the~ form is executed.
slotsSlots
  List of slots, which contain script code that can be associated with events occurring in other objects.
onenterOn enter
  Script routine to be invoked when focus enters a control. A value like #Enter invokes an external function called onItemEnter; otherwise define a function called eventFunc whose two arguments will be the control item and the query row number.
onleaveOn leave
  Script routine to be invoked when focus leaves a control. A value like #Enter invokes an external function called onItemLeave; otherwise define a function called eventFunc whose two arguments will be the control item and the query row number.
onsetOn set
  Script routine to be invoked when the value in the control is set from the database. A value like #Set invokes an external function called onItemSet; otherwise define a function called eventFunc whose three arguments will be the control item, the query row number and the value.
onactionOn action
  Script routine to be invoked when a block-level action is about to take place. A value like #Action invokes an external function called onBlockAction; otherwise define a function called eventFunc whose two arguments will be the block and the action code. A false result aborts the action.
onuncurrentOn uncurrent
  Script routine to be invoked when a record ceases to be current. A value like #UnCurrent invokes an external function called onBlockUnCurrent; otherwise define a function called eventFunc whose two arguments will be the block and the query row being left.
oncurrentOn current
  Script routine to be invoked when a record becomes current. A value like #Current invokes an external function called onBlockCurrent; otherwise define a function called eventFunc whose two arguments will be the button and the query row number.
ondisplayOn display
  Script routine to be invoked when a record is displayed. A value like #UnCurrent invokes an external function called onBlockUnCurrent; otherwise define a function called eventFunc whose two arguments will be the block and the query row being displayed.
prequeryKBForm.prequery
 KBForm.prequery
preinsertPre-Insert
  Script routine to be invoked just before a new row is inserted into a table. A value like #Insert invokes an external function called onBlockInsert; otherwise define a function called eventFunc whose two arguments will be the block and the query row number. Insert is aborted unless the function returns true.
preupdatePre-Update
  Script routine to be invoked just before a row is updated in a table. A value like #Update invokes an external function called onBlockUpdate; otherwise define a function called eventFunc whose two arguments will be the block and the query row number. Update is aborted unless the function returns true.
predeletePre-Delete
  Script routine to be invoked jusst before a row is deleted from a table. A value like #Delete invokes an external function called onBlockDelete; otherwise define a function called eventFunc whose two arguments will be the block and the query row number. Deletion is aborted unless the function returns true.
postqueryPost-Query
  Script routine to be invoked just after a select query has been issued, but before any data is displayed. A value like #PostQuery invokes an external function called onBlockPostQuery; otherwise define a function called eventFunc whose argument will be the block.
postsyncPost-Sync
  Script routine to be invoked just after an insert, update or delete query has been issued A value like #PostSync invokes an external function called onBlockPostSync; otherwise define a function called eventFunc whose four arguments will be the block, the query row, the action and the primary key of the affected row.
onchangeOn change
  Script routine to be invoked when the value in the field is changed by the user. A value like #Change invokes an external function called onBlockChange; otherwise define a function called eventFunc whose three arguments will be the control item, the query row number and the new value.
onloadOn Load
  Script routine to be invoked when the form is loaded. A value like #Init invokes an external function called onFormInit; otherwise define a function called eventFunc whose single argument is the form.
onunloadOn UnLoad
  Script routine to be invoked when the form is closed. A value like #Cleanup invokes an external function called onFormCleanup; otherwise define a function called eventFunc whose single argument is the form.
oncloseKBForm.onclose
 KBForm.onclose
notesNotes
  The Notes setting may be used for any arbitrary notes, for instance for documentation. Rekall does nothing with the value, other than to preserve it.

Remaining properties are as for form blocks.

Prev
Next
Home