DeepDiscard (ScreenField subroutine): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{Template:ScreenField:DeepDiscard subtitle}}
{{Template:ScreenField:DeepDiscard subtitle}}


This page is [[under construction]]
Although a generic <var>[[Object variables#Discarding explicitly|Discard]]</var> of an <var>XmlNode</var> is not allowed, you can use the <var>DeepDiscard</var> method to explicitly discard an <var>XmlNode</var> object.
<p>'''Note:''' <var>DeepDiscard</var> explicitly discards the method object as well as the <var>[[Screen classes|Screen]]</var> object with which it is associated.</p>
 
==Syntax==
==Syntax==
{{Template:ScreenField:DeepDiscard syntax}}
{{Template:ScreenField:DeepDiscard syntax}}
Line 9: Line 11:
<td>A <var>ScreenField</var> object, which may be <var>Null</var>.</td></tr>
<td>A <var>ScreenField</var> object, which may be <var>Null</var>.</td></tr>
</table>
</table>
==Usage notes==
 
<ul>
<li>Like the generic <var>[[Object variables#Discarding explicitly|Discard]]</var> method, <var>DeepDiscard</var> explicitly discards the method object. But, unlike
<var>Discard</var>, it also explicitly discards all objects that are referenced by the object being discarded.
</ul>
==See also==
==See also==
{{Template:ScreenField:DeepDiscard footer}}
{{Template:ScreenField:DeepDiscard footer}}

Revision as of 20:12, 23 August 2011

Do deep discard of a ScreenField object (ScreenField class)

[Introduced in Sirius Mods 8.0]


Although a generic Discard of an XmlNode is not allowed, you can use the DeepDiscard method to explicitly discard an XmlNode object.

Note: DeepDiscard explicitly discards the method object as well as the Screen object with which it is associated.

Syntax

sfield:DeepDiscard

Syntax terms

sfield A ScreenField object, which may be Null.

See also