DIALOG Item Attributes
From STX Wiki
< Programmer Guide | Shell Items | Dialog
Jump to navigationJump to search
DIALOG Item Attributes
The dialog item (also know for historical reasons as 'menu item') has the following attributes, which can be accessed using the following syntax:
$#dialog[!ATTRIBUTE]
e.g. if you want to assign the number of controls to a local variable, do the following:
#nControls := $#dialog[!CONTROLS]
- !BACKGROUNDCOLOR
- This is not implemented; the value is always set to *
- !CONTROLS
- The index of first free dialog control, can be used to construct sub-dialogs (pseudo property sheets) (i.e. the number of controls).
- !DIALOGMODE
- The mode of dialog window (NOWINDOW = not created). One of the following values:
NOWINDOW
HIDDEN
VISIBLE
ENABLED
- !DIALOGONLY
- Returns
1
if the display only contains a dialog (i.e. no graphs), otherwise it returns0
.
- !DISPLAY
- The name of the display object which owns the dialog.
- !EDITING
#beingEdited := $#dialog[!EDITING,$#controlId]
- The
!EDITING
attribute returns1
if the control with the id$#controlId
is a listview and is currently being edited.
- The attribute returns
0
if the control with the id$#controlId
is a listview and is *not* being edited.
- The attribute returns an asterisk (
*
) if the control$#controlId
does not exist, or exists, but is not a listview control.
- !FOCUS
- Returns the index of the control which has currently the focus in the following format:
index_of_focus_control
- !FOREGROUND
- The dialog item attribute
!FOREGROUND
returns1
if the dialog window is in the foreground,0
if it is not and-1
if the command fails in some way.
- !MODE
- This attribute is read from the display item containing the dialog and not from the dialog item itself. See section "display item attributes" for details.
- !NFREE
- Returns the number of controls which can be added to the dialog in the following format:
number_of_free:_controls
- !PARENT
- Not implemented; the value is always set to *
- !STYLE
- This attribute is read from the display item containing the dialog and not from the dialog item itself. See section "display item attributes" for details.
- !TITLE
- This attribute is read from the display item containing the dialog and not from the dialog item itself. See section "display item attributes" for details.
- !WINDOW
- This attribute is read from the display item containing the dialog and not from the dialog item itself. See section "display item attributes" for details.