Invisible (ScreenField property): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (match syntax table to syntax template; edits, tags and links) |
||
| Line 1: | Line 1: | ||
{{Template:ScreenField:Invisible subtitle}} | {{Template:ScreenField:Invisible subtitle}} | ||
The <var>Invisible</var> property sets or gets the Invisible attribute for a <var>ScreenField</var>. If this value is <code>True</code>, any data in the field will not be displayed on the terminal. This is typically used for password prompts or other private data. | |||
This attribute is initially set for a field by the <var>[[Screen class#AddField function|AddField]]</var>) method. If <code>False</code>, the screenfield data is displayed on the terminal. | |||
==Syntax== | ==Syntax== | ||
| Line 7: | Line 8: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th> | <tr><th>%currentBoolean</th> | ||
<td>A Boolean enumeration. Valid values are True and False (the default). </td></tr> | <td>A <var>[[Boolean_enumeration|Boolean enumeration]]</var> to get the current value of the <var>Invisible</var> attribute. Valid values are <code>True</code> and <code>False</code> (the default).</td></tr> | ||
<tr><th> | <tr><th>sfield</th> | ||
<td>A reference to an instance of a ScreenField object.</td></tr> | <td>A reference to an instance of a <var>ScreenField</var> object.</td></tr> | ||
<tr><th>newBoolean</th> | |||
<td>A <var>Boolean enumeration</var> to set the new value of the <var>Invisible</var> attribute. Valid values are <code>True</code> and <code>False</code> (the default).</td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>The <var>Invisible</var> attribute does not encrypt or suppress transmission of data over the network. It is intended to minimize theft of private data at terminals situated in nonprivate areas. | |||
<li>The <var>Invisible</var> attribute can be applied to protected or to non-protected fields. | |||
</ul> | |||
==See also== | ==See also== | ||
{{Template:ScreenField:Invisible footer}} | {{Template:ScreenField:Invisible footer}} | ||
Revision as of 10:54, 28 June 2011
Set or return the invisible attribute for screenfield (ScreenField class)
The Invisible property sets or gets the Invisible attribute for a ScreenField. If this value is True, any data in the field will not be displayed on the terminal. This is typically used for password prompts or other private data.
This attribute is initially set for a field by the AddField) method. If False, the screenfield data is displayed on the terminal.
Syntax
%currentBoolean = sfield:Invisible sfield:Invisible = newBoolean
Syntax terms
| %currentBoolean | A Boolean enumeration to get the current value of the Invisible attribute. Valid values are True and False (the default). |
|---|---|
| sfield | A reference to an instance of a ScreenField object. |
| newBoolean | A Boolean enumeration to set the new value of the Invisible attribute. Valid values are True and False (the default). |
Usage notes
- The Invisible attribute does not encrypt or suppress transmission of data over the network. It is intended to minimize theft of private data at terminals situated in nonprivate areas.
- The Invisible attribute can be applied to protected or to non-protected fields.