New (Stringlist constructor): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 1: Line 1:
{{Template:Stringlist:New subtitle}}
{{Template:Stringlist:New subtitle}}


This method returns a new instance of a Stringlist.  
This method returns a new instance of a <var>Stringlist</var>.  


New is a constructor and as such can be called with no object, with an explicit class name, or with an object variable, even if that object is null:
New is a constructor and as such can be called with no object, with an explicit class name, or with an object variable, even if that object is null:
Line 10: Line 10:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%sl </th>
<tr><th>%sl </th>
<td>A Stringlist object that is set to a new Stringlist object reference. </td></tr>
<td>A <var>Stringlist</var> object that is set to a new <var>Stringlist</var> object reference. </td></tr>
<tr><th>imagename </th>
<tr><th>imagename </th>
<td>A string that contains the name of an image to be "associated" or "bound" to the '''%sl''' Stringlist. This is an optional argument.  ''This argument is case sensitive''. That is, in the likely event the User Language was written in mixed case, with automatic upper-casing in effect, the image name should be in uppercase (see [[Mixed-case User Language]].</td></tr>
<td>A string that contains the name of an image to be "associated" or "bound" to the '''%sl''' <var>Stringlist</var>. This is an optional argument.  ''This argument is case sensitive''. That is, in the likely event the User Language was written in mixed case, with automatic upper-casing in effect, the image name should be in uppercase (see [[Mixed-case User Language]].</td></tr>
</table>
</table>


Line 31: Line 31:
</pre>
</pre>


For more information about the association or binding of an image to a Stringlist, see [[Bindiamge (Stringlist function)]].</ul>
For more information about the association or binding of an image to a <var>Stringlist</var>, see [[Bindiamge (Stringlist function)]].</ul>


[[Category:Stringlist methods|New constructor]]
[[Category:Stringlist methods|New constructor]]

Revision as of 21:33, 18 January 2011

Create new Stringlist instance (Stringlist class)


This method returns a new instance of a Stringlist.

New is a constructor and as such can be called with no object, with an explicit class name, or with an object variable, even if that object is null:

Syntax

%sl = [%(Stringlist):]New[( [imageName])]

Syntax terms

%sl A Stringlist object that is set to a new Stringlist object reference.
imagename A string that contains the name of an image to be "associated" or "bound" to the %sl Stringlist. This is an optional argument. This argument is case sensitive. That is, in the likely event the User Language was written in mixed case, with automatic upper-casing in effect, the image name should be in uppercase (see Mixed-case User Language.

Usage notes

  • All errors in New result in request cancellation.
  • Specifying an image name on the New method is identical to using a simple New with no parameters followed by a BindImage method on the new object:
    %list = new('IMAGENAME')
    

    is equivalent to

    %list = new
    %list:bindImage('IMAGENAME')
    
    For more information about the association or binding of an image to a Stringlist, see Bindiamge (Stringlist function).