SAT Display Language (SAT/DL) Parameters
S@
Home License Download Examples Contact

action

Action: Sets action for item.
Format: {name [parameter] [...]}
For example {update first_name last_name} will run the update action, with the values of the first_name and last_name items as parameters, when the action is invoked.
Used: addButton addButtons addEntries addEntry addGrid addHotKeys addMultiList addText setAction

alpha

Action: Sets entry item validation to accept alphabetic characters only.
Pattern: {^[a-zA-Z]+$}
Used: addEntries addEntry

alphanumeric|alphanum

Action: Sets entry item validation to accept alphabetic and numeric characters only.
Pattern: {^[a-zA-Z0-9]+$}
Used: addEntries addEntry

blue

Action: Sets item background/text colour to "blue".
Used: addBorder addGrid addLabel setMessage
See: black blue darkgray gray green red white yellow

buttondata

Action: Defines row layout of button items.
Format: {name options} {...}
The name and options are the same as for addButton. A null button item will display a gap of pad characters between Button Items.
Used: addButtons

cell

Action: Identifies a Grid item cell.
Format: row:column
Both the row and column are in cells. Cell numbering is indexed from zero.
Used: setItem setItemState

center

Action: Label text will be center aligned within the label area. The default alignment is left (there is no specific left align option). If more than one alignment option is specified, then the last only is used.
Used: addEntries addEntry addGrid addLabel
See: right

color(foreground/background)

Action: Sets appropriate foreground and background colour attributes for an item to foreground/background. Any colours in the Colour List may be used.
Format: foreground/background
Either foreground or background can be null, in which case the null item will display in the default colour. If one colour only is specified without using a slash ("/") the foreground colour will be set. When used with addBorder all variations will set the background colour. When used with a text item in "edit" mode the foreground and background colours work normally. When used with a text item in "read-only" mode the background colour works normally, but the foreground colour sets the foreground text colour for "links" and "actions".
Used: addBorder addButton addEntry addGrid addLabel addText
See: color(color)

color(color)

Action: Sets appropriate colour attribute for an item to color. Any colour in the Colour List may be used.
Used: addBorder addText setMessage
See: color(foreground/background)

columndata - (Entries)

Action: Defines column/row (grid) layout of entry items.
Format: {column_1_size {name ?size? options} {...}} {column_n_size {name ?size? options} {...}}
column_n_size is in the same format as the Entry Item size parameter. The label size specifed in column_n_size will be used for all Entry Items in the column.
A null entry item will display a gap equal to the size of one Entry Item in the grid.
Used: addEntries

columndata - (List)

Action: Defines column layout of Multi Column Listbox.
Format: {label,size,?justify? ...}
The column title is derived from the label (See Name Format). The column size is the width in characters. By default the column will be left aligned. The justify options are "numeric" and "right". Numeric justification lines up on the decimal point. If there is no decimal point, numbers are right aligned, text left aligned.
Used: addMultiList

confirm(message)

Action: Enables action confirmation dialog. The action confirmation dialog will "pop-up" when the action is invoked. The message text will be displayed in the dialog, together with "OK" and "Cancel" buttons. If the "OK" button is pressed the action continues. Pressing the "Cancel" button aborts the action.
Format: message
The message text must not contain spaces. Use underscores ("_") instead of spaces. For display purposes the underscores will be replaced with spaces.
Used: addButton addButtons addEntries addEntry addMenu addMultiList addText addToolbar

copy(?data_items?)

Action: Copies data from multi-list columns into data items.
Format: column_1_item,column_2_item,column_3_item,...
The data from column 1 of the multi-list is copied to the first data item in the list, and so on. If there is a column which is not to be copied to a data item, then a null data item name must be used.
Used: addMultiList

courier

Action: Sets the item font to courier.
Used: addText
See: helvetica times

courier(size)

Action: Sets the item font to size courier.
Format: size
The size must be an integer.
Used: addText
See: helvetica(size) times(size)

darkgray

Action: Sets item text/background colour to "darkgray".
Used: addBorder addGrid addLabel setMessage
See: balck blue gray green red white yellow

date

Action: Sets entry item validation to accept date format string only.
Pattern: Depends on date format.
Used: addEntries addEntry

date_format

Action: Sets date format to be used for entry item validation.
Formats: mm/dd/yy
mm/dd/yyyy
dd/mm/yy
dd/mm/yyyy
mm.dd.yy
mm.dd.yyyy
dd.mm.yy
dd.mm.yyyy
Used: setDateFormat
See: date

disabled

Action: Item update is disallowed (effectively read only). The default value is determined by the current state. Use setState to override the effect of the state.
Used: addButton addButtons addCheckButtons addEntries addEntry addGrid addMenu addPickList addRadioButtons addText addToolbar setItemState
See: normal

edit

Action: Create editable item.
Used: addText

exit

Action: Exit (logout) application.
Used: addButton addButtons addMenu addToolbar addText

filesave(file)

Action: Enables filesave dialog. The filesave dialog will "pop-up" when the action is invoked. The path/files identified by file will be displayed by default. If the "OK" button is pressed the action continues. Pressing the "Cancel" button aborts the action. If a filename is entered which identifies an existing file a warning dialog is displayed.
Format: file
The file must exist and not contain spaces.
Used: addButton addButtons addHotKey addMenu addToolbar

fileselect(file)

Action: Enables fileselect dialog. The fileselect dialog will "pop-up" when the action is invoked. The path/files identified by file will be displayed by default. If the "OK" button is pressed the action continues. Pressing the "Cancel" button aborts the action. If a filename is entered which identifies a non-existant file a warning dialog is displayed.
Format: file
The file must exist and not contain spaces.
Used: addButton addButtons addHotKey addMenu addToolbar

flat

Action: Sets relief style to "flat".
Used: addBorder addGrid addPickList setRelief

focus

Action: Gives focus (positions cursor) to the entry. If more than one entry is given focus, then the last created is used.
Used: addEntries addEntry

gray

Action: Sets item background/text colour to "gray".
Used: addBorder addGrid addLabel addPickList setMessage
See: black blue gray green red white yellow

green

Action: Sets item background/text colour to "green".
Used: addBorder addGrid addLabel setMessage
See: black blue darkgray gray red white yellow

griddata

Action: Defines layout of Grid.
Format: {{text ?options?} {} ...} {{text ?options?} {text ?options?}...} {{...}}
The text defines the text to appear on the button/label. By default a button is created. The text may be prefixed with either "!" (to create label) -or- ":" (to create icon button). The braces ("{}") around the cell text/options is not required if no cell options are being specified.
Used: addGrid

groove

Action: Sets relief style to "groove".
Used: addBorder addPickList setRelief

group

Action: Sets display item/menubar group name.
Used: newScreen setGroup

group(?groups?)

Action: Sets list of groups for which item is enabled.
Format: group_1,group_2,group_3,...
Used: addButton addCheckButtons addEntry addGrid addPickList addRadioButtons addToolbar

group(?groups?) - (Menu)

Action: Sets list of groups for which menu item is enabled.
Format: ?+|-?group_1,?+|-?group_2,?+|-?group_3,...
The optional "+" or "-" prefix specifies that the item should always be normal/disbaled regardless of the current state.
Used: addMenu

helvetica

Action: Sets the item font to helvetica.
Used: addText
See: courier times

helvetica(size)

Action: Sets the item font to size helvetica.
Format: size
The size must be an integer.
Used: addText
See: courier(size) times(size)

horizontal

Action: Line up components of item horizonally (default vertical).
Used: addCheckButtons addRadioButtons

help(message)

Action: Enables balloon help. The balloon help message text will be displayed when the mouse pointer is over the button for more than a half second. The balloon help will disappear when the mouse pointer moves away from the button.
Format: message
The message text must not contain spaces. Use underscores ("_") instead of spaces. For display purposes the underscores will be replaced with spaces.
Used: addToolbar

icon

Action: Create toolbar button with icon.
Format: icon
The icon must be chosen from the Icon Selection.
Used: addToolbar

icon(icon)

Action: Create button with icon instead of name text. When using icon buttons the button width is in pixels instead of characters.
Format: icon
The icon must be chosen from the Icon Selection.
Used: addButton

integer|int

Action: Sets entry item validation to accept numeric characters only.
Pattern: {^[0-9]+$}
Used: addEntries addEntry

inverse

Action: Sets background colour to "black" and (by default) text colour to "white".
Used: addGrid addLabel
See: inverse(colour)

inverse(colour)

Action: Sets background to colour and (by default) text colour to "white".
Format: colour
The colour may be blue|darkblue|darkgray|darkgreen|darkred|gray|green|red|yellow|white.
Used: addGrid addLabel
See: inverse

ipaddress|ip

Action: Sets entry item validation to accept internet IP address format string only.
Pattern: {^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,3}$}
Used: addEntries addEntry

item - (Menu)

Action: Sets menubar menu item name.
Used: addMenu

labels

Action: Sets list of labels to be used by command.
Format: {?+?label_1 ?+?label_2 ...}
The optional "+" label prefix is used to indicate that the Check/Radio button is activated.
Used: addCheckButtons addRadioButtons

left

Action: Left justify label/text.
Used: addEntries addBorder addMultiList

'literal'

Action: Defines a literal (constant) value.
Format: 'literal'
The value of literal will be used without being interpreted as a variable.
Used: addGrid

menu

Action: Sets menubar menu name.
Used: addMenu

modal

Action: Sets child window type to modal.
Used: newWindow

money

Action: Sets entry item validation to accept a "money" format (numeric with 2 decimal places) string only.
Pattern: {^[0-9]+[.][0-9]{2}$}
Used: addEntries addEntry

name

Action: Gives name to an item. Item names must be unique for a given display. Item labels/titles are derived from the item name (See Name Format).
Used: action addBorder addButton addCheckButtons addData addEntry addLabel addMultiList addPickList addRadioButtons addText addToolbar addValidation hide remove setAction

name - (HotKey)

Action: Gives name to a HotKey. HotKey names identify keyboard key combinations which will invoke the associated HotKey action. Case is significant in HotKey names. For example: Control-c refers to the control key combined with lowercase "c".
Format: Alt-
Control-
Shift-
F1 to F12
...and combinations...
Alt-Control-
Control-Shift-
...etc.
Used: addHotKey

noborder

Action: Sets item border to 0 (zero).
Used: addButton addButtons addLabel

normal

Action: Item update is allowed. The default value is determined by the current state. Use setState to override the effect of the state.
Used: addButton addButtons addCheckButtons addEntries addEntry addGrid addMenu addPickList addRadioButtons addText addToolbar setItemState
See: disabled

notags

Action: Disable "tag" processing.
Used: addText
See: tags

nowrap

Action: Disable automatic word-wrap.
Used: addText
See: wrap

numeric|num

Action: Sets entry item validation to accept numeric characters with/without decimal only.
Pattern: {^[0-9]+[.]?[0-9]*$}
Used: addEntries addEntry

options

Action: List of options to be used by command.
Used: addBorder addButton addCheckButtons addData addEntry addGrid addLabel addMenu addMultiList addPickList addRadioButtons addText addToolbar addTree setFocus newWindow setMessage setRelief setState setTitle

outline

Action: Draw outline around Item. The relief style can be set using setRelief. The default relief style is "groove".
Used: addButton addCheckButtons addEntry addGrid addLabel addMultiList addPickList addRadioButtons addText addTree

pad

Action: Sets pad width in characters between columns/row items.
Used: addButtons addEntry

pad(size) - (Grid)

Action: Sets the padding around grid cells to size pixels.
Format: size
The size must be an integer.
Used: addGrid

parameters

Action: Sets list of parameters to be used by command.
Used: action

pattern

Action: Sets pattern (TCL format regular expression) to be used for entry item validation.
Used: addValidation

position

Action: Sets position of top left of display item(s).
Format: xpos,ypos
The "x" position is in columns (from zero), where one column is the average width of a character in the default font used for a label. The "y" position is in rows (from zero), where one row is the line spacing in the default font used for a label.
Used: addBorder addButton addButtons addCheckButtons addEntries addEntry addLabel addMultiList addPickList addRadioButtons addText addToolbar addTree

position - (Toolbar)

Action: Sets position of toolbar item(s).
Format: ypos
The "y" position is in rows (from zero), where one row is the line spacing in the default font used for a label.
Used: addToolbar

position - (Window)

Action: Sets position of top left of child window.
Format: +xpos+ypos
The "x" and "y" positions are in pixels.
Used: newWindow placeWindow

raised

Action: Sets relief style to "raised".
Used: addBorder addGrid setRelief

red

Action: Sets item text/background colour to "red".
Used: addBorder addGrid addLabel setMessage
See: black blue darkgray gray green white yellow

return

Action: When a saved screen is restored, return the value of "this" item to an item with the same name.
Used: addData addEntries addEntry

return(item)

Action: When a saved screen is restored, return the value of "this" item to the item specified.
Format: item
The item must identify an item in the screen to be restored.
Used: addData addEntries addEntry

right

Action: Right justify label/text.
Used: addEntries addEntry addGrid addMultiList

safe

Action: Sets data item to "safe". Safe data items are not deleted by clear.
Used: addData

save

Action: Causes the command to be added to the current saved screen. If there is more than one command in the same screen/process file, then all commands generated by the scree/process are saved.
Used: addButton addCheckButtons addEntry addGrid addHotKey addLabel addMultiList addPickList addRadioButtons addToolbar

save(name)

Action: Causes a new saved screen to be created. All SAT/DL commands in the current screen file are saved.
Format: name
Identifies the name to be used for the saved screen.
Used: newScreen

secret

Action: Sets entry item to display "*" for each character entered.
Used: addEntries addEntry

selectlist

Action: Sets list of selections to be used by command.
Format: {?+?selection_1 ?+?selection_2 ...}
The optional "+" selection prefix is used to indicate that the selection set the value of the created item.
Used: addPickList

size - (Border/Screen)

Action: Sets the size (width and height) of a border/screen.
Format: widthxheight
The width is in columns, where one column is the average width of a character in the default font used for a label. The height is in rows, where one row is the line spacing in the default font used for a label.
Used: addButton addButtons

size - (Button)

Action: Sets the size (width) of a button item.
Format: width
The width is in columns, where one column is the average width of a character in the default font used for a label. If the button is set to display an icon the width is in pixels.
Used: addButton addButtons

size - (Entry)

Action: Sets the size (label/entry width) of an entry item.
Format: label,entry
Both the label and entry widths are in columns, where one column is the average width of a character in the default font used for a label.
Used: addEntries addEntry

size - (Grid)

Action: Sets the size (width) of a grid cell.
Format: width
The width is in columns, where one column is the average width of a character in the default font used for a label.
Used: addGrid

size - (Multi-list)

Action: Sets the size (lines) of a multi-list item.
Format: lines
The number of data lines to be displayed (without scrollbar).
Used: addMultiList

size - (Picklist)

Action: Sets the size (width and number of display lines) of a picklist.
Format: width,lines
The width is in columns, where one column is the average width of a character in the default font used for a label. The lines is in rows, where one row is the line spacing in the default font used for a label. A scrollbar will automatically be added if the number of lines in the picklist is greater than the display size.
Used: addPickList

state

Action: Sets item state to current state.
Used: addButton addButtons addCheckButtons addRadioButtons

style

Action: Sets toolbar style.
Format: style
The toolbar style must be chosen from the Style Selection.
Used: addToolbar

style(definition)

Action: Defines toolbar style.
Format: style(style,orient,size,position,button,separator,border,underline)
See Style definitions for details.
Used: addToolbar

sunken

Action: Sets relief style to "sunken".
Used: addBorder addGrid addPickList setRelief

tags

Action: Enable "tag" processing.
Used: addText
See: notags

text(?text?)

Action: Sets the label/title text to text.
Format: text
The text must not contain spaces. Use underscores ("_") instead of spaces. For display purposes the underscores will be replaced with spaces.
Used: addBorder addButton addCheckButtons addEntries addEntry addLabel addRadioButtons

times

Action: Sets the item font to times.
Used: addText
See: courier helvetica

times(size)

Action: Sets the item font to size times.
Format: size
The size must be an integer.
Used: addText
See: courier(size) helvetica(size)

title

Action: Displays title at top left of item. Item titles are derived from the item name (See Name Format).
Used: addBorder addCheckButtons addRadioButtons

top

Action: Add new value/line/data to the top (begining) of the item.
Used: updateItem

validate

Action: Causes all entry item validations to be performed when action is invoked.
Used: addButton addButtons addEntries addEntry addMenu addMultiList addText addToolbar

validate(?prefix?)

Action: Causes validations for all entry items prefixed with prefix to be performed when action is invoked. A null prefix will cause validation of all entry items without a prefix.
Used: addButton addButtons addEntries addEntry addMenu addMultiList addText addToolbar

validation

Action: Sets validation to be used for item. There is a selection of predefined validations (See below). Use addValidation to add additional pattern based validations.
Predefined: alpha=Alphabetic only.
alphanumeric|alphanum=Alphabetic and numbers only.
date=Valid date.
integer|int=Numbers only.
money=Number with two decimal spaces.
numeric|num=Number with or without a decimal.
ipaddress|ip=Internet IP address.
Used: addEntries addEntry

value

Action: Sets value for item.
Used: setItem setItems

white

Action: Sets item text/background colour to "white".
Used: addBorder addGrid addLabel setMessage
See: black blue darkgray gray green red yellow

window

Action: Sets child window name.
Used: clear closeWindow placeWindow setMessage setTitle setWindow

wrap

Action: Enable automatic word-wrap.
Used: addText
See: nowrap

xscroll

Action: Adds "X" direction (horizontal) scrollbar
Used: addText

xyscroll

Action: Adds "X" direction (horizontal) and "Y" direction (vertical) scrollbars
Used: addText

yscroll

Action: Adds "Y" direction (vertical) scrollbar
Used: addMultiList addText

yellow

Action: Sets item text/background colour to "yellow".
Used: addBorder addGrid addLabel setMessage
See: black blue darkgray gray green red yellow

Copyright © 2002 Adrian Davis.