ScreenField methods syntax: Difference between revisions
Jump to navigation
Jump to search
m (Automatically generated page update) |
m (Automatically generated page update) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top:1px solid;"><span class="term">%currentFieldColor</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Color (ScreenField property)|Color]]</span> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top:1px solid;"><span class="term">%currentFieldColor</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Color (ScreenField property)|Color]]</span> | ||
<span class="term">sfield</span><span class="literal">:[[Color (ScreenField property)|Color]]</span> <span class="literal">= </span><span class="term">newFieldColor</span></p> | <span class="term">sfield</span><span class="literal">:[[Color (ScreenField property)|Color]]</span> <span class="literal">= </span><span class="term">newFieldColor</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%number</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Column (ScreenField property)|Column]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%outSfield</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[DeepCopy (ScreenField function)|DeepCopy]]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%outSfield</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[DeepCopy (ScreenField function)|DeepCopy]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">sfield</span><span class="literal">:[[DeepDiscard (ScreenField subroutine)|DeepDiscard]]</span></p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">sfield</span><span class="literal">:[[Delete (ScreenField subroutine)|Delete]]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">sfield</span><span class="literal">:[[Delete (ScreenField subroutine)|Delete]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentHighlight</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Highlight (ScreenField property)|Highlight]]</span> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentHighlight</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Highlight (ScreenField property)|Highlight]]</span> | ||
| Line 11: | Line 12: | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentBoolean</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Invisible (ScreenField property)|Invisible]]</span> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentBoolean</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Invisible (ScreenField property)|Invisible]]</span> | ||
<span class="term">sfield</span><span class="literal">:[[Invisible (ScreenField property)|Invisible]]</span> <span class="literal">= </span><span class="term">newBoolean</span></p> | <span class="term">sfield</span><span class="literal">:[[Invisible (ScreenField property)|Invisible]]</span> <span class="literal">= </span><span class="term">newBoolean</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentNumber</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Itemid (ScreenField property)|Itemid]]</span> | ||
<span class="term">sfield</span><span class="literal">:[[Itemid (ScreenField property)|Itemid]]</span> <span class="literal">= </span><span class="term"> | <span class="term">sfield</span><span class="literal">:[[Itemid (ScreenField property)|Itemid]]</span> <span class="literal">= </span><span class="term">newNumber</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentBoolean</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Modified (ScreenField property)|Modified]]</span> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentBoolean</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Modified (ScreenField property)|Modified]]</span> | ||
<span class="term">sfield</span><span class="literal">:[[Modified (ScreenField property)|Modified]]</span> <span class="literal">= </span><span class="term">newBoolean</span></p> | <span class="term">sfield</span><span class="literal">:[[Modified (ScreenField property)|Modified]]</span> <span class="literal">= </span><span class="term">newBoolean</span></p> | ||
| Line 19: | Line 20: | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentBoolean</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Protected (ScreenField property)|Protected]]</span> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentBoolean</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Protected (ScreenField property)|Protected]]</span> | ||
<span class="term">sfield</span><span class="literal">:[[Protected (ScreenField property)|Protected]]</span> <span class="literal">= </span><span class="term">newBoolean</span></p> | <span class="term">sfield</span><span class="literal">:[[Protected (ScreenField property)|Protected]]</span> <span class="literal">= </span><span class="term">newBoolean</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%number</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Row (ScreenField property)|Row]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%screen</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Screen (ScreenField function)|Screen]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">sfield</span><span class="literal">:[[SetCursor (ScreenField subroutine)|SetCursor]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Number">position</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">sfield</span><span class="literal">:[[SetCursor (ScreenField subroutine)|SetCursor]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="Number">position</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentString</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Value (ScreenField property)|Value]]</span> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%currentString</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Value (ScreenField property)|Value]]</span> | ||
<span class="term">sfield</span><span class="literal">:[[Value (ScreenField property)|Value]]</span> <span class="literal">= </span><span class="term">newString</span></p> | <span class="term">sfield</span><span class="literal">:[[Value (ScreenField property)|Value]]</span> <span class="literal">= </span><span class="term">newString</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">% | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%number</span><span class="literal"> =</span> <span class="term">sfield</span><span class="literal">:[[Width (ScreenField property)|Width]]</span></p> | ||
Latest revision as of 19:19, 23 August 2011
The syntax for each of the ScreenField 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 ScreenField methods.
%currentFieldColor = sfield:Color sfield:Color = newFieldColor
%number = sfield:Column
%outSfield = sfield:DeepCopy
sfield:DeepDiscard
sfield:Delete
%currentHighlight = sfield:Highlight sfield:Highlight = newHighlight
%currentBoolean = sfield:Invisible sfield:Invisible = newBoolean
%currentNumber = sfield:Itemid sfield:Itemid = newNumber
%currentBoolean = sfield:Modified sfield:Modified = newBoolean
%currentBoolean = sfield:Numeric sfield:Numeric = newBoolean
%currentBoolean = sfield:Protected sfield:Protected = newBoolean
%number = sfield:Row
%screen = sfield:Screen
sfield:SetCursor[( [position])]
%currentString = sfield:Value sfield:Value = newString
%number = sfield:Width