Screen.GetProperties

table Screen.GetProperties ( 

 )

Description

Gets the properties of the currently displayed screen.

Parameters

None.

Returns

(table) A table containing the following information:

KEY

TYPE

DESCRIPTION

WindowHandle

number

The window handle of the current screen.

ScreenName

string

The name of the current screen.

ScreenType

number

The type of screen (see table below).

Controls

table

A numerically indexed (1-based) table of the controls on the screen.  Each table item is itself a table, containing the values outlined below.

 

Screen Types:

VALUE

SCREEN TYPE

100

Static Text.

105

Scrolling Text.

110

Select Install Folder.

115

Select Shortcut Folder.

120

Edit Fields.

125

Licence Agreement.

130

Progress Bar.

135

Radio Buttons.

140

Combo Boxes.

145

Select Packages.

150

CheckBoxes.

155

Scrolling Text Progress.

160

ListBox.

165

Buttons.

 

Controls Table:

KEY

TYPE

DESCRIPTION

WindowHandle

number

The window handle of the current screen.
Note:
StaticText controls do not have a window handle and will return 0 for this value.

Type

number

The type of control (see table below).

CtrlID

number

The Control ID.

 

Control Types:

VALUE

SCREEN TYPE

1

Button.

2

Static Text.

3

Scrolling Text.

4

ComboBox.

5

Radio Button.

6

Edit Field.

7

Progress Bar.

8

Select Package Tree.

9

Category.

10

CheckBox.

11

ListBox.

 

ResultVariable

When adding an action with the action editor, you can use this field to specify a variable that the return value will be stored in.

See also:  Related Actions