DeepCopy (ScreenField function): Difference between revisions
Jump to navigation
Jump to search
m (AllowNullObject methods) |
m (match syntax table to syntax template, tags and edits) |
||
| Line 1: | Line 1: | ||
{{Template:ScreenField:DeepCopy subtitle}} | {{Template:ScreenField:DeepCopy subtitle}} | ||
The <var>DeepCopy</var> method returns a <var>ScreenField</var> object that is a deep copy of the method object. Since a <var>ScreenField</var> cannot exist without its underlying <var>Screen</var>, a <var>ScreenField</var> is deep copyable only, and no <var>Copy</var> method exists for a <var>ScreenField</var>. | |||
==Syntax== | ==Syntax== | ||
{{Template:ScreenField:DeepCopy syntax}} | {{Template:ScreenField:DeepCopy syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th><var>%outSfield</var></th> | ||
<td>A declared ScreenField object. </td></tr> | <td>A declared <var>ScreenField</var> object.</td></tr> | ||
<tr><th> | <tr><th><var>sfield</var></th> | ||
<td>A reference to an instance of a ScreenField object, which may be <var>Null</var>.</td></tr> | <td>A reference to an instance of a <var>ScreenField</var> object, which may be <var>Null</var>.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>The method object (<var class="term">%sField</var>) may be <var>null</var>. The output of a copy of a <var>null</var> object is a <var>null</var> object. | |||
</ul> | |||
==See also== | ==See also== | ||
<ul><li>For further information about copyability, see [[Copying objects|"Copying objects"]]. | |||
</ul> | |||
{{Template:ScreenField:DeepCopy footer}} | {{Template:ScreenField:DeepCopy footer}} | ||
Revision as of 08:08, 26 June 2011
Return a deep copy of a screenfield object (ScreenField class)
The DeepCopy method returns a ScreenField object that is a deep copy of the method object. Since a ScreenField cannot exist without its underlying Screen, a ScreenField is deep copyable only, and no Copy method exists for a ScreenField.
Syntax
%outSfield = sfield:DeepCopy
Syntax terms
| %outSfield | A declared ScreenField object. |
|---|---|
| sfield | A reference to an instance of a ScreenField object, which may be Null. |
Usage notes
- The method object (%sField) may be null. The output of a copy of a null object is a null object.
See also
- For further information about copyability, see "Copying objects".