Screen methods syntax

From m204wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

The syntax for each of the Screen class methods is shown below.

Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of Screen methods.

%key = screen:ActionKey

[%sfield =] screen:AddField[( [Row= number], [Column= number], - [Width= number], [Color= fieldColor], - [Protected= boolean], [Highlight= highlight], - [Numeric= boolean], [Modified= boolean], - [Invisible= boolean], [Autoskip= boolean], - [Itemid= number], [Strip= boolean], - [Value= string])]

%number = screen:Columns

%outScreen = screen:Copy

%currentNumber = screen:CursorColumn screen:CursorColumn = newNumber

[%number =] screen:CursorItemId

%currentNumber = screen:CursorRow screen:CursorRow = newNumber

%outScreen = screen:DeepCopy

%currentActionKey = screen:MaxActionKey screen:MaxActionKey = newActionKey

%screen = [%(Screen):]New

%currentNumber = screen:NewFieldColumn screen:NewFieldColumn = newNumber

%currentNumber = screen:NewFieldRow screen:NewFieldRow = newNumber

%currentFieldColor = screen:ProtectedColor screen:ProtectedColor = newFieldColor

%currentHighlight = screen:ProtectedHighlight screen:ProtectedHighlight = newHighlight

[%key =] screen:Read Throws ScreenReadError

%number = screen:Rows

%currentFieldColor = screen:UnprotectedColor screen:UnprotectedColor = newFieldColor

%currentHighlight = screen:UnprotectedHighlight screen:UnprotectedHighlight = newHighlight