Value (ScreenField property): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:ScreenField:Value subtitle}} | |||
This property sets or returns the value of a ScreenField. The value is set from or copied to a User Language string, and it may be from 0-255 characters in length. | This property sets or returns the value of a ScreenField. The value is set from or copied to a User Language string, and it may be from 0-255 characters in length. | ||
==Syntax== | ==Syntax== | ||
{{Template:ScreenField:Value syntax}} | |||
===Syntax terms=== | ===Syntax terms=== | ||
<dl> | <dl> | ||
| Line 11: | Line 14: | ||
</dl> | </dl> | ||
==Usage | ==Usage notes== | ||
After a Read method ( | After a Read method (“Read function” on page 904) on the Screen object, you use the Value method to get any user-entered data for a non-protected field. | ||
For an example using Value to set field display data, see | For an example using Value to set field display data, see “[[Screen class example]]”. For an example using Value to get user-entered data, see the example below. | ||
See also the [[Screen class#AddField function|AddField method]], whose Value parameter can set display data when the ScreenField is instantiated. | See also the [[Screen class#AddField function|AddField method]], whose Value parameter can set display data when the ScreenField is instantiated. | ||
==See also== | |||
{{Template:ScreenField:Value footer}} | |||
Revision as of 20:32, 18 March 2011
Set or return the value of a screenfield (ScreenField class)
This property sets or returns the value of a ScreenField. The value is set from or copied to a User Language string, and it may be from 0-255 characters in length.
Syntax
%currentString = sfield:Value sfield:Value = newString
Syntax terms
- %sfield
- A reference to an instance of a ScreenField object.
- newvalue
- The string value to assign to %sfield.
- %string
- A User Language string variable to contain the returned %sfield data.
Usage notes
After a Read method (“Read function” on page 904) on the Screen object, you use the Value method to get any user-entered data for a non-protected field.
For an example using Value to set field display data, see “Screen class example”. For an example using Value to get user-entered data, see the example below.
See also the AddField method, whose Value parameter can set display data when the ScreenField is instantiated.