NewFromRecord (XmlDoc function): Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:XmlDoc:NewFromRecord subtitle}} | {{Template:XmlDoc:NewFromRecord subtitle}} | ||
This shared function creates a new <var>XmlDoc</var> object that contains the fields and | |||
fieldgroups from the current record. | |||
This record extraction is the | |||
same operation that is performed by the <var>[[LoadFromRecord (XmlDoc/XmlNode subroutine)|LoadFromRecord]]</var> subroutine and by the <var>[[ToXmlDoc (Record function)|ToXmlDoc]]</var> function in the <var>[[Record class|Record]]</var> class. | |||
==Syntax== | ==Syntax== | ||
| Line 9: | Line 13: | ||
<tr><th>%doc</th><td>xmlDoc</td></tr> | <tr><th>%doc</th><td>xmlDoc</td></tr> | ||
<tr><th><var>%(XmlDoc)</var></th> | <tr><th><var>%(XmlDoc)</var></th> | ||
<td>The class name in parentheses denotes a shared method | <td>The class name in parentheses denotes a shared method and is one way to invoke <var>NewFromRecord</var>. You can also use an object expression whose type is <var>XmlDoc</var> (even if the value of the expression is null).</td></tr> | ||
<tr><th><var>AttributeValues</var></th> | <tr><th><var>AttributeValues</var></th> | ||
<td>Boolean object</td></tr> | <td>Boolean object</td></tr> | ||
| Line 25: | Line 29: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li>Whether to use <var>ToXmlDoc</var>, <var>NewFromRecord</var>, or <var>LoadFromRecord</var> depends on what is | |||
most convenient for your application. | |||
If you are already using a <var>Record</var> object which references the desired record, | |||
using <var>ToXmlDoc</var> may be more convenient; if not, then either | |||
<var>NewFromRecord</var> or <var>LoadFromRecord</var> (both of which require that the method be | |||
contained in a “record loop”) may be more convenient. | |||
You must use <var>LoadFromRecord</var> if you want to add the record's content as a | |||
subtree to a non-empty <var>XmlDoc</var>; | |||
in other cases the <var>NewFromRecord</var> “factory method” may be your choice. | |||
<p> | |||
Since <var>NewFromRecord</var> and <var>ToXmlDoc</var> create new <var>XmlDoc</var> objects, they have the | |||
<var>AllowNull</var> argument for setting the created <var>XmlDoc</var>'s <var>AllowNull</var> | |||
poperty; <var>LoadFromRecord</var> does not have the <var>AllowNull</var> argument.</p> | |||
<p> | |||
As stated, both | |||
<var>NewFromRecord</var> and <var>LoadFromRecord</var> must be | |||
contained in a “record loop”, for example, an <var>FRN</var> block, and they may not be | |||
invoked within a fieldgroup context.</p> | |||
<p> | |||
Except for these considerations, <var>ToXmlDoc</var>, <var>NewFromRecord</var>, and <var>LoadFromRecord</var> | |||
all perform the same operation and have the same arguments. | |||
The discussion of the “extract from record to <var>XmlDoc</var>” operation, | |||
generally uses <var>LoadFromRecord</var>, except where one of these considerations | |||
is relevant to the discussion.</p> | |||
</ul> | |||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
{{Template:XmlDoc:NewFromRecord footer}} | {{Template:XmlDoc:NewFromRecord footer}} | ||
Revision as of 22:41, 1 June 2011
Create a new XmlDoc from the current record (XmlDoc class)
[Requires Janus SOAP]
This shared function creates a new XmlDoc object that contains the fields and fieldgroups from the current record. This record extraction is the same operation that is performed by the LoadFromRecord subroutine and by the ToXmlDoc function in the Record class.
Syntax
%doc = [%(XmlDoc):]NewFromRecord[( [AttributeValues= boolean], - [AttributeNames= boolean], - [NamesToLower= boolean], - [AllowUnreversible= boolean], - [CodepageTable= boolean], - [Base64Encode= boolean], - [CharacterMap= characterToUnicodeMap], - [Allownull= boolean], - [Recordnumber= number], [File= string])] Throws CharacterTranslationException
Syntax terms
| %doc | xmlDoc |
|---|---|
| %(XmlDoc) | The class name in parentheses denotes a shared method and is one way to invoke NewFromRecord. You can also use an object expression whose type is XmlDoc (even if the value of the expression is null). |
| AttributeValues | Boolean object |
| AttributeNames | Boolean object |
| NamesToLower | Boolean object |
| AllowUnreversible | Boolean object |
| CodepageTable | Boolean object |
| AllowNull | Boolean object |
Usage notes
- Whether to use ToXmlDoc, NewFromRecord, or LoadFromRecord depends on what is
most convenient for your application.
If you are already using a Record object which references the desired record,
using ToXmlDoc may be more convenient; if not, then either
NewFromRecord or LoadFromRecord (both of which require that the method be
contained in a “record loop”) may be more convenient.
You must use LoadFromRecord if you want to add the record's content as a
subtree to a non-empty XmlDoc;
in other cases the NewFromRecord “factory method” may be your choice.
Since NewFromRecord and ToXmlDoc create new XmlDoc objects, they have the AllowNull argument for setting the created XmlDoc's AllowNull poperty; LoadFromRecord does not have the AllowNull argument.
As stated, both NewFromRecord and LoadFromRecord must be contained in a “record loop”, for example, an FRN block, and they may not be invoked within a fieldgroup context.
Except for these considerations, ToXmlDoc, NewFromRecord, and LoadFromRecord all perform the same operation and have the same arguments. The discussion of the “extract from record to XmlDoc” operation, generally uses LoadFromRecord, except where one of these considerations is relevant to the discussion.