|
|
| (3 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| {{Template:AddToRecordError:New subtitle}}
| | #REDIRECT [[AddToRecordError class#New constructor|New constructor]] |
| Each argument to <var>New</var> sets the value of the corresponding property of the newly constructed <var>[[AddToRecordError_class|AddToRecordError]]</var> object.
| | [[Category:AddToRecordError methods|New property]] |
| ==Syntax==
| |
| {{Template:AddToRecordError:New syntax}}
| |
| ===Syntax terms===
| |
| <table class="syntaxTable">
| |
| <tr><th>%addToRecordError</th>
| |
| <td>An <var>AddToRecordError</var> object.
| |
| </td></tr>
| |
| <tr><th><var>Reason</var></th>
| |
| <td>This <var>[[Methods#Named parameters|name required]]</var> parameter specifies the <var>AddToRecordErrorReason</var> enumeration value to be assigned to the exception object's <var class="term>[[Reason (AddToRecordError property)|Reason]]</var> property. <var class="term">Reason</var> is a required parameter.
| |
| </td></tr>
| |
| <tr><th><var>Description</var></th>
| |
| <td>This <var>Name-Required</var> parameter specifies the string value to be assigned to the object's <var>[[Description (AddToRecordError property)|Description]]</var> property. <var class="term">Description</var> is an optional parameter; the default value is the null string.
| |
| </td></tr>
| |
| <tr><th><var>UntranslatableHexValue</var></th>
| |
| <td>This <var>Name-Required</var> parameter specifies the string value to be assigned to the object's <var>[[UntranslatableHexValue (AddToRecordError property)|UntranslatableHexValue]]</var> property. <var class="term">UntranslatableHexValue</var> is an optional parameter; the default value is the null string and, if supplied, it must be a valid hexadecimal string.
| |
| </td></tr>
| |
| <tr><th><var>FieldOrFieldgroupName</var></th>
| |
| <td>This <var>Name-Required</var> parameter specifies the string value to be assigned to the object's <var>[[FieldOrFieldgroupName (AddToRecordError property)|FieldOrFieldgroupName]]</var> property. <var class="term">FieldOrFieldgroupName</var> is an optional parameter; the default value is the null string.
| |
| </td></tr>
| |
| <tr><th><var>NodeName</var></th>
| |
| <td>This <var>Name-Required</var> parameter specifies the string value to be assigned to the object's <var>[[NodeName (AddToRecordError property)|NodeName]]</var> property. <var class="term">NodeName</var> is an optional parameter; the default value is the null string.
| |
| </td></tr>
| |
| <tr><th><var>NodeType</var></th>
| |
| <td>This <var>Name-Required</var> parameter specifies the <var>XmlNodeType</var> enumeration value to be assigned to the object's <var>[[NodeType (AddToRecordError property)|NodeType]]</var> property. <var class="term">NodeType</var> is an optional parameter; the default value is Null.
| |
| </td></tr>
| |
| <tr><th><var>Value</var></th>
| |
| <td>This <var>Name-Required</var> parameter specifies the string value to be assigned to the object's <var>[[Value (AddToRecordError property)|Value]]</var> property. <var class="term">Value</var> is an optional parameter; the default value is the null string.
| |
| </td></tr>
| |
| <tr><th><var>InputRecordNumber</var></th>
| |
| <td>This <var>Name-Required</var> parameter specifies the numeric value to be assigned to the object's <var>[[InputRecordNumber (AddToRecordError property)|InputRecordNumber]]</var> property. <var class="term">InputRecordNumber</var> is an optional parameter; the default value is 0.
| |
| </td></tr></table>
| |
| | |
| ==Usage Notes==
| |
| <ul>
| |
| <li><var>New</var> is available in <var class="product">[[Sirius Mods]]</var> Version 7.8 and later.
| |
| </ul>
| |
| | |
| ==See also==
| |
| {{Template:AddToRecordError:New footer}}
| |