|
|
| (One intermediate revision by the same user not shown) |
| Line 1: |
Line 1: |
| {{Template:XmlDoc:LoadSystemMethodInfo subtitle}}
| |
| <var>LoadSystemMethodInfo</var> loads an <var>XmlDoc</var> with information about methods in classes selected by a "pattern" argument. This method is primarily intended for <var class="product">SOUL</var> products delivered by Rocket Software, and the schema of the document may change from release to release. Users of [[SoulEdit]] (V7.5 and later) can see this method in action via the INFO command which provides introspection into specified methods.
| |
|
| |
|
| ==Syntax==
| |
| {{Template:XmlDoc:LoadSystemMethodInfo syntax}}
| |
|
| |
| ===Syntax terms===
| |
| <table class="syntaxTable">
| |
| <tr><th>doc</th>
| |
| <td>An expression that points to the <var>XmlDoc</var> to contain the selected method information.</td></tr>
| |
|
| |
| <tr><th>pattern</th>
| |
| <td>A string whose case is ignored and that can have any of the following forms:
| |
| <table class="syntaxNested">
| |
|
| |
| <tr><th>methodPattern</th>
| |
| <td>This selects, from any system class, all methods that match the specified pattern.</td></tr>
| |
|
| |
| <tr><th>classPattern<var>:</var>methodPattern</th>
| |
| <td>This selects, from any system class matching <var class="term">classPattern</var>, all methods that match <var class="term">methodPattern</var>. </td></tr>
| |
|
| |
| <tr><th><var>System:</var>classPattern<var>:</var>methodPattern</th>
| |
| <td>This is the same as <var class="term">classPattern<var>:</var>methodPattern</var>. </td></tr>
| |
| </table></td></tr>
| |
|
| |
| <tr><th><var>ShowBase</var></th>
| |
| <td>A <var>[[Enumerations#Using_Boolean_enumerations|Boolean]]</var> enumeration that specifies how to handle base and extension classes:
| |
| <ul>
| |
| <li>If <var>False</var>, the default, then base classes are omitted from the output <var>XmlDoc</var>, and the methods in extension classes include methods from their base classes. </li>
| |
|
| |
| <li>If <var>True</var>, then base classes (which match the selection pattern) are included in the output <var>XmlDoc</var>, and the members of base classes are not included in extension classes. </li>
| |
| </ul>
| |
| This [[Notation conventions for methods#Named parameters|name required]] argument was new in version 7.9 of the <var class="product">Sirius Mods</var>.</td></tr>
| |
| </table>
| |
|
| |
| ==Usage notes==
| |
| <ul>
| |
| <li>The <var>New</var> method will only be displayed if either is true:
| |
| <ul>
| |
| <li>The ''methodPattern'' is the string <code>New</code>.</li>
| |
| <li>The <var>New</var> method has any arguments. </li>
| |
| </ul></li>
| |
|
| |
| <li><var>LoadSystemMethodInfo</var> will not display classes in the module LOCAL, if they are selected by a pattern (that is, ''pattern'' contains a wildcard character), or if there is no ''classPattern'' component.</li>
| |
| </ul>
| |
|
| |
| ==Examples==
| |
| The following request displays the class data for the <var>[[AddAttribute (XmlNode function)|AddAttribute]]</var> method:
| |
| <p class="code">begin
| |
| %d is object xmlDoc
| |
| %d = new
| |
| %d:loadSystemMethodInfo('AddAttribute')
| |
| %d:print
| |
| end
| |
| </p>
| |
| The example result follows:
| |
| <p class="output"><classes selection="AddAttribute">
| |
| <class name="XmlNode" system="yes" new="no" discard="no" docObject="nod">
| |
| <methods module="JSOPF" offset="00002038">
| |
| <method name="AddAttribute" type="function" callable="yes" requiredProdNum="35" desc="Add Attribute to Element node">
| |
| <result>
| |
| <type name="Object" class="XmlNode"/>
| |
| </result>
| |
| <arg docArg="name">
| |
| <type name="Unicode"/>
| |
| </arg>
| |
| <arg docArg="value">
| |
| <type name="Unicode"/>
| |
| </arg>
| |
| <arg optional="yes" docArg="uri">
| |
| <type name="Unicode"/>
| |
| </arg>
| |
| </method>
| |
| </methods>
| |
| </class>
| |
| </classes>
| |
| </p>
| |
|
| |
| ==See also==
| |
| {{Template:XmlDoc:LoadSystemMethodInfo footer}}
| |