Value (ScreenField property): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 5: | Line 5: | ||
{{Template:ScreenField:Value syntax}} | {{Template:ScreenField:Value syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th>%sfield</th> | ||
< | <td>A reference to an instance of a ScreenField object. </td></tr> | ||
< | <tr><th>newvalue</th> | ||
< | <td>The string value to assign to %sfield. </td></tr> | ||
< | <tr><th>%string</th> | ||
< | <td>A User Language string variable to contain the returned %sfield data.</td></tr> | ||
</ | </table> | ||
==Usage notes== | ==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. | After a Read method (&#x201C;Read function&#x201D; 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. | For an example using Value to set field display data, see &#x201C;[[Screen class example]]&#x201D;. 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== | ==See also== | ||
{{Template:ScreenField:Value footer}} | {{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.