ToXmlDoc (UserStatistics function) - Revision history

JAL at 22:15, 20 November 2012

2012-11-20T22:15:18Z

← Older revision		Revision as of 22:15, 20 November 2012
Line 1:		Line 1:
	{{Template:UserStatistics:ToXmlDoc subtitle}}		{{Template:UserStatistics:ToXmlDoc subtitle}}
	<var>ToXmlDoc</var> returns in a <var class="product">[[Janus SOAP]]</var> <var>[[XmlDoc_class\|XmlDoc]]</var> object the values of the statistics in the method <var>UserStatistics</var> object. By default, it will only return those statistics with non-zero values; but, ~~optionally~~, may return all (including zero) statistics.		<var>ToXmlDoc</var> returns in a <var class="product">[[Janus SOAP]]</var> <var>[[XmlDoc_class\|XmlDoc]]</var> object the values of the statistics in the method <var>UserStatistics</var> object. By default, it will only return those statistics with non-zero values; but, as an option, it may return all (including zero) statistics.

	==Syntax==		==Syntax==
Line 8:		Line 8:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%doc</th>		<tr><th>%doc</th>
	<td>An XmlDoc object variable to contain the listing of the values of the statistics. </td></tr>		<td>An <var>XmlDoc</var> object variable to contain the listing of the values of the statistics. </td></tr>

	<tr><th>userStatistics</th>		<tr><th>userStatistics</th>
	<td>A <var>UserStatistics</var> object variable. </td></tr>		<td>A <var>UserStatistics</var> object variable. </td></tr>

	<tr><th><var>Zeros</var></th>		<tr><th><var>Zeros</var></th>
	<td>This ~~<var>~~[[~~Methods~~#Named parameters\|~~NameRequired~~]]~~</var>~~ argument ~~(<var>Zeros</var>)~~ is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values. </td></tr>		<td>This [[Notation conventions for methods#Named parameters\|name required]] argument is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values. </td></tr>

	<tr><th><var>AttributeValues</var></th>		<tr><th><var>AttributeValues</var></th>
	<td>This ~~<var>NameRequired</var>~~ argument ~~(<var>AttributeValues</var>)~~ is a <var>Boolean</var> value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example:		<td>This name required argument is a <var>Boolean</var> value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example:
	<code><DKRD>1107</DKRD></code> is text format, and <code><DKRD value="1107"/></code> is attribute value format. The default value is <var>False</var>, which produces text format.</td></tr>		<code><DKRD>1107</DKRD></code> is text format, and <code><DKRD value="1107"/></code> is attribute value format.
			<p>
			The default value is <var>False</var>, which produces text format.</p></td></tr>

	<tr><th><var>AttributeNames</var></th>		<tr><th><var>AttributeNames</var></th>
	<td>This ~~<var>NameRequired</var>~~ argument ~~(<var>AttributeNames</var>)~~ is a <var>Boolean</var> value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a "name" attribute. For example:		<td>This name required argument is a <var>Boolean</var> value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a "name" attribute. For example:
	<code><DKRD>1107</DKRD></code> is element-name format, and the following is name-as-attribute format: <p class="code"><stat name="DKRD"> 1107 </stat></p>		<code><DKRD>1107</DKRD></code> is element-name format, and the following is name-as-attribute format: <p class="code"><stat name="DKRD"> 1107 </stat></p>
	The default value is <var>False</var>, which produces element-name format. </td></tr>
			<p>
			The default value is <var>False</var>, which produces element-name format. </p></td></tr>

	<tr><th><var>NamesToLower</var></th>		<tr><th><var>NamesToLower</var></th>
	<td>This ~~<var>NameRequired</var>~~ argument ~~(<var>NamesToLower</var>)~~ is a <var>Boolean</var> value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <var>False</var>.</td></tr>		<td>This name required argument is a <var>Boolean</var> value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <var>False</var>.</td></tr>
	</table>		</table>

	==Examples==		==Examples==
	The following display of non-zero ~~<var>~~[[UserStatistics_class#login\|Login]]~~</var>~~ and ~~<var>~~[[UserStatistics_class#request\|Request]]~~</var>~~ statistics is produced by a sequence of statements like the following:		The following display of non-zero [[UserStatistics_class#login\|Login]] and [[UserStatistics_class#request\|Request]] statistics is produced by a sequence of statements like the following:
	<p class="code">%doc is object xmldoc		<p class="code">%doc is object xmldoc
	%ustat is object userstatistics		%ustat is object userstatistics
	. . .		...
	%doc = %ustat:ToXmlDoc		%doc = %ustat:ToXmlDoc
	%doc:print		%doc:print
Line 69:		Line 78:
	==See also==		==See also==
	<ul>		<ul>
	<li><var>[[DifferenceToXmlDoc (UserStatistics function)\|DifferenceToXmlDoc]]</var> returns, to an <var>XmlDoc</var> object, the difference in values between the ~~<var>~~Login~~</var>~~ statistics in one <var>UserStatistics</var> object and another.		<li><var>[[DifferenceToXmlDoc (UserStatistics function)\|DifferenceToXmlDoc]]</var> returns, to an <var>XmlDoc</var> object, the difference in values between the Login statistics in one <var>UserStatistics</var> object and another.
	</ul>		</ul>
	{{Template:UserStatistics:ToXmlDoc footer}}		{{Template:UserStatistics:ToXmlDoc footer}}

JALWiccan: 1 revision

2011-05-24T20:32:19Z

1 revision

← Older revision	Revision as of 20:32, 24 May 2011
(No difference)

JAL2 at 20:32, 24 May 2011

2011-05-24T20:32:18Z

← Older revision		Revision as of 20:32, 24 May 2011
Line 12:		Line 12:
	<td>A <var>UserStatistics</var> object variable. </td></tr>		<td>A <var>UserStatistics</var> object variable. </td></tr>
	<tr><th><var>Zeros</var></th>		<tr><th><var>Zeros</var></th>
	<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var>Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values. </td></tr>		<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var>Zeros</var>) is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values. </td></tr>
	<tr><th><var>AttributeValues</var></th>		<tr><th><var>AttributeValues</var></th>
	<td>This <var>NameRequired</var> argument (<var>AttributeValues</var>) is a <var>Boolean</var> value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example:		<td>This <var>NameRequired</var> argument (<var>AttributeValues</var>) is a <var>Boolean</var> value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example:

JAL2 at 00:52, 3 May 2011

2011-05-03T00:52:30Z

JALWiccan: 1 revision

2011-05-03T00:31:41Z

1 revision

← Older revision	Revision as of 00:31, 3 May 2011
(No difference)

JAL2: /* Syntax terms */

2011-05-03T00:31:40Z

Syntax terms

← Older revision		Revision as of 00:31, 3 May 2011
Line 11:		Line 11:
	<tr><th>userStatistics</th>		<tr><th>userStatistics</th>
	<td>A <var>UserStatistics</var> object variable. </td></tr>		<td>A <var>UserStatistics</var> object variable. </td></tr>
	<tr><th>Zeros</th>		<tr><th><var>Zeros</var></th>
	<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var class="term">Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var class="term">Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values. </td></tr>		<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var class="term">Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var class="term">Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values. </td></tr>
	<tr><th>AttributeValues</th>		<tr><th><var>AttributeValues</var></th>
	<td>This <var>NameRequired</var> argument (<var class="term">AttributeValues</var>) is a <var>Boolean</var> value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example:		<td>This <var>NameRequired</var> argument (<var class="term">AttributeValues</var>) is a <var>Boolean</var> value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example:
	<p class="output"><DKRD>1107</DKRD></p> is text format, and <p class="output"><DKRD value="1107"/></p> is attribute value format. The default value is <var>False</var>, which produces text format.</td></tr>		<p class="output"><DKRD>1107</DKRD></p> is text format, and <p class="output"><DKRD value="1107"/></p> is attribute value format. The default value is <var>False</var>, which produces text format.</td></tr>
	<tr><th>AttributeNames</th>		<tr><th><var>AttributeNames</var></th>
	<td>This <var>NameRequired</var> argument (<var class="term">AttributeNames</var>) is a <var>Boolean</var> value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a "name" attribute. For example:		<td>This <var>NameRequired</var> argument (<var class="term">AttributeNames</var>) is a <var>Boolean</var> value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a "name" attribute. For example:
	<p class="output"><DKRD>1107</DKRD></p> is element-name format, and the following is name-as-attribute format: <p class="output"><stat name="DKRD"> 1107 </stat></p>The default value is <var>False</var>, which produces element-name format. </td></tr>		<p class="output"><DKRD>1107</DKRD></p> is element-name format, and the following is name-as-attribute format: <p class="output"><stat name="DKRD"> 1107 </stat></p>The default value is <var>False</var>, which produces element-name format. </td></tr>
	<tr><th>NamesToLower</th>		<tr><th><var>NamesToLower</var></th>
	<td>This <var>NameRequired</var> argument (<var class="term">NamesToLower</var>) is a <var>Boolean</var> value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <var>False</var>.</td></tr>		<td>This <var>NameRequired</var> argument (<var class="term">NamesToLower</var>) is a <var>Boolean</var> value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <var>False</var>.</td></tr>
	</table>		</table>

JAL2: /* Syntax terms */

2011-04-13T02:40:58Z

Syntax terms

← Older revision		Revision as of 02:40, 13 April 2011
Line 12:		Line 12:
	<td>A <var>UserStatistics</var> object variable. </td></tr>		<td>A <var>UserStatistics</var> object variable. </td></tr>
	<tr><th>Zeros</th>		<tr><th>Zeros</th>
	<td>This <var>[[Methods#Named parameters\|~~Name-Required~~]]</var> argument (<var class="term">Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var class="term">Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values. </td></tr>		<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var class="term">Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var class="term">Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values. </td></tr>
	<tr><th>AttributeValues</th>		<tr><th>AttributeValues</th>
	<td>This <var>~~Name-Required~~</var> argument (<var class="term">AttributeValues</var>) is a <var>Boolean</var> value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example:		<td>This <var>NameRequired</var> argument (<var class="term">AttributeValues</var>) is a <var>Boolean</var> value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example:
	<p class="output"><DKRD>1107</DKRD></p> is text format, and <p class="output"><DKRD value="1107"/></p> is attribute value format. The default value is <var>False</var>, which produces text format.</td></tr>		<p class="output"><DKRD>1107</DKRD></p> is text format, and <p class="output"><DKRD value="1107"/></p> is attribute value format. The default value is <var>False</var>, which produces text format.</td></tr>
	<tr><th>AttributeNames</th>		<tr><th>AttributeNames</th>
	<td>This <var>~~Name-Required~~</var> argument (<var class="term">AttributeNames</var>) is a <var>Boolean</var> value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a "name" attribute. For example:		<td>This <var>NameRequired</var> argument (<var class="term">AttributeNames</var>) is a <var>Boolean</var> value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a "name" attribute. For example:
	<p class="output"><DKRD>1107</DKRD></p> is element-name format, and the following is name-as-attribute format: <p class="output"><stat name="DKRD"> 1107 </stat></p>The default value is <var>False</var>, which produces element-name format. </td></tr>		<p class="output"><DKRD>1107</DKRD></p> is element-name format, and the following is name-as-attribute format: <p class="output"><stat name="DKRD"> 1107 </stat></p>The default value is <var>False</var>, which produces element-name format. </td></tr>
	<tr><th>NamesToLower</th>		<tr><th>NamesToLower</th>
	<td>This <var>~~Name-Required~~</var> argument (<var class="term">NamesToLower</var>) is a <var>Boolean</var> value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <var>False</var>.</td></tr>		<td>This <var>NameRequired</var> argument (<var class="term">NamesToLower</var>) is a <var>Boolean</var> value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <var>False</var>.</td></tr>
	</table>		</table>

Goff: match syntax table to syntax template, tags and edits

2011-04-01T03:24:17Z

match syntax table to syntax template, tags and edits

← Older revision		Revision as of 03:24, 1 April 2011
Line 1:		Line 1:
	{{Template:UserStatistics:ToXmlDoc subtitle}}		{{Template:UserStatistics:ToXmlDoc subtitle}}
			<var>ToXmlDoc</var> returns in a <var class="product">[[Janus SOAP]]</var> <var>[[XmlDoc_class\|XmlDoc]]</var> object the values of the statistics in the method <var>UserStatistics</var> object. By default, it will only return those statistics with non-zero values; but, optionally, may return all (including zero) statistics.
	~~This method~~ returns in a [[Janus SOAP]] XmlDoc object the values of the statistics
	in the method UserStatistics object.
	~~It returns all~~ statistics with non-zero values ~~(by default)~~, ~~or it returns~~
	all ~~statistics~~ (~~as an option~~).
	==Syntax==		==Syntax==
	{{Template:UserStatistics:ToXmlDoc syntax}}		{{Template:UserStatistics:ToXmlDoc syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th~~><i~~>%doc~~</i>~~</th>		<tr><th>%doc</th>
	<td>An XmlDoc object variable to contain the listing of the values of the statistics. </td></tr>		<td>An XmlDoc object variable to contain the listing of the values of the statistics. </td></tr>
	<tr><th>~~<i>%ustat</i>~~</th>		<tr><th>userStatistics</th>
	<td>A UserStatistics object variable. </td></tr>		<td>A <var>UserStatistics</var> object variable. </td></tr>
	<tr><th~~><b~~>Zeros= </b><i>~~bool~~</i></th>		<tr><th>Zeros</th>
	~~<td>This name required~~ argument (<tt>Zeros</tt>) is a ~~boolean~~ value that indicates whether statistics with a zero value should be included in the returned data. Zeros is an optional argument that defaults to <tt>False</tt>, which results in the inclusion of only statistics with non-zero values. </td></tr>		<td>This <var>[[Methods#Named parameters\|Name-Required]]</var> argument (<var class="term">Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var class="term">Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values. </td></tr>
	<tr><th~~><b~~>AttributeValues= </b><i>~~bool~~</i></~~th>~~		<tr><th>AttributeValues</th>
	~~<td~~>~~This name required~~ argument (<tt>AttributeValues</tt>) is a ~~boolean~~ value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example, <tt><DKRD>1107</DKRD></tt> is text format, and <tt><DKRD value="1107"/></tt> is attribute value format. The default value is <tt>False</tt>, which produces text format. </td></tr>		<td>This <var>Name-Required</var> argument (<var class="term">AttributeValues</var>) is a <var>Boolean</var> value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example:
	<tr><th~~><b~~>AttributeNames= </b><i>~~bool~~</i></th>		<p class="output"><DKRD>1107</DKRD></p> is text format, and <p class="output"><DKRD value="1107"/></p> is attribute value format. The default value is <var>False</var>, which produces text format.</td></tr>
	~~<td>This name required~~ argument (<tt>AttributeNames</tt>) is a ~~boolean~~ value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a ~~&amp;ldquo;~~name~~&amp;rdquo;~~ attribute. For example, <tt><DKRD>1107</DKRD></tt> is element-name format, and the following is name-as-attribute format: <p class="~~code~~"><stat name="DKRD"> 1107 </stat> </p> The default value is <tt>False</tt>, which produces element-name format. </td></tr>		<tr><th>AttributeNames</th>
	<tr><th~~><b~~>NamesToLower= </b><i>~~bool~~</i></th>		<td>This <var>Name-Required</var> argument (<var class="term">AttributeNames</var>) is a <var>Boolean</var> value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a "name" attribute. For example:
	~~<td>This name required~~ argument (<tt>NamesToLower</tt>) is a ~~boolean~~ value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <tt>False</tt>.</td></tr>		<p class="output"><DKRD>1107</DKRD></p> is element-name format, and the following is name-as-attribute format: <p class="output"><stat name="DKRD"> 1107 </stat></p>The default value is <var>False</var>, which produces element-name format. </td></tr>
			<tr><th>NamesToLower</th>
			<td>This <var>Name-Required</var> argument (<var class="term">NamesToLower</var>) is a <var>Boolean</var> value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <var>False</var>.</td></tr>
	</table>		</table>
	~~==Usage notes==~~
	~~<ul>~~
	~~<li>The [[DifferenceToXmlDoc (UserStatistics function)\|DifferenceToXmlDoc]] function returns~~
	~~to an XmlDoc object the difference in values between one~~
	~~UserStatistics object and another for the Login statistics.~~
	~~</ul>~~
	==Examples==		==Examples==
			<ol><li>The following display of non-zero <var>[[UserStatistics_class#login\|Login]]</var> and <var>[[UserStatistics_class#request\|Request]]</var> statistics is produced by a sequence of statements like the following:
	The display of non-zero Login and Request statistics ~~below~~ is produced
	by a sequence of statements like the following:
	<p class="code">%doc is object xmldoc		<p class="code">%doc is object xmldoc
	%ustat is object userstatistics		%ustat is object userstatistics
	. . .		. . .
	%doc = %ustat:ToXmlDoc		%doc = %ustat:ToXmlDoc
	%doc:~~Print~~		%doc:print
	</p>		</p>

	The following are sample results:		The following are sample results:
	<p class="~~code~~"~~><nowiki~~><UserStatistics id="40" time=20080902203110278		<p class="output"><UserStatistics id="40" time=20080902203110278
	userNumber="6" loginTime="20080902094309010">		userNumber="6" loginTime="20080902094309010">
	<login>		<login>
Line 71:		Line 63:
	</request>		</request>
	</UserStatistics>		</UserStatistics>
	</~~nowiki~~></p>		</p>
			<li>Using<p class="code">%doc = %ustat:ToXmlDoc(Zeros=true)</p> statement would return all the statistics, including those with a <code>0</code> value.</oL>
	A <code>%doc = %ustat:ToXmlDoc(Zeros=true)</~~code~~> statement would
	return all the statistics, including those with a <code>0</code> value.
	==See also==		==See also==
			<ul>
			<li><var>[[DifferenceToXmlDoc (UserStatistics function)\|DifferenceToXmlDoc]]</var> returns, to an <var>XmlDoc</var> object, the difference in values between the <var>Login</var> statistics in one <var>UserStatistics</var> object and another.
			</ul>
	{{Template:UserStatistics:ToXmlDoc footer}}		{{Template:UserStatistics:ToXmlDoc footer}}

DmeWiccan: 1 revision

2011-03-14T20:42:32Z

1 revision

← Older revision	Revision as of 20:42, 14 March 2011
(No difference)

DmeWiccan: 1 revision

2011-03-14T20:42:30Z

1 revision

← Older revision		Revision as of 20:42, 14 March 2011
Line 8:		Line 8:
	{{Template:UserStatistics:ToXmlDoc syntax}}		{{Template:UserStatistics:ToXmlDoc syntax}}
	===Syntax terms===		===Syntax terms===
	<dl>		<table class="syntaxTable">
	<dt><i>%doc</i>		<tr><th><i>%doc</i></th>
	<dd>An XmlDoc object variable to contain the listing of the values of the		<td>An XmlDoc object variable to contain the listing of the values of the statistics. </td></tr>
	statistics.		<tr><th><i>%ustat</i></th>
	<dt><i>%ustat</i>		<td>A UserStatistics object variable. </td></tr>
	<dd>A UserStatistics object variable.		<tr><th><b>Zeros= </b><i>bool</i></th>
	<dt><b>Zeros= </b><i>bool</i>		<td>This name required argument (<tt>Zeros</tt>) is a boolean value that indicates whether statistics with a zero value should be included in the returned data. Zeros is an optional argument that defaults to <tt>False</tt>, which results in the inclusion of only statistics with non-zero values. </td></tr>
	<dd>This name required argument (<tt>Zeros</tt>) is a boolean value		<tr><th><b>AttributeValues= </b><i>bool</i></th>
	that indicates whether statistics with a zero value should be included		<td>This name required argument (<tt>AttributeValues</tt>) is a boolean value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example, <tt><DKRD>1107</DKRD></tt> is text format, and <tt><DKRD value="1107"/></tt> is attribute value format. The default value is <tt>False</tt>, which produces text format. </td></tr>
	in the returned data.		<tr><th><b>AttributeNames= </b><i>bool</i></th>
	Zeros is an optional argument that defaults to <tt>False</tt>, which		<td>This name required argument (<tt>AttributeNames</tt>) is a boolean value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a &amp;ldquo;name&amp;rdquo; attribute. For example, <tt><DKRD>1107</DKRD></tt> is element-name format, and the following is name-as-attribute format: <p class="code"><stat name="DKRD"> 1107 </stat> </p> The default value is <tt>False</tt>, which produces element-name format. </td></tr>
	results in the inclusion of only statistics with non-zero values.		<tr><th><b>NamesToLower= </b><i>bool</i></th>
	<dt><b>AttributeValues= </b><i>bool</i>		<td>This name required argument (<tt>NamesToLower</tt>) is a boolean value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <tt>False</tt>.</td></tr>
	<dd>This name required argument (<tt>AttributeValues</tt>) is a boolean value		</table>
	that indicates whether
	statistic values are to be displayed as text or as value attributes within
	their XML document elements.

	For example, <tt><DKRD>1107</DKRD></tt> is text format,
	and <tt><DKRD value="1107"/></tt> is attribute value format.

	The default value is <tt>False</tt>, which produces text format.
	<dt><b>AttributeNames= </b><i>bool</i>
	<dd>This name required argument (<tt>AttributeNames</tt>) is a boolean value
	that indicates whether statistic names are to be displayed
	within their XML document elements
	as the element name or as the value of a &ldquo;name&rdquo; attribute.

	For example, <tt><DKRD>1107</DKRD></tt> is element-name format,
	and the following is name-as-attribute format:
	<p class="code"><stat name="DKRD">
	1107
	</stat>
	</p>

	The default value is <tt>False</tt>, which produces element-name format.
	<dt><b>NamesToLower= </b><i>bool</i>
	<dd>This name required argument (<tt>NamesToLower</tt>) is a boolean value
	that indicates whether statistic names are to be displayed in lowercase
	characters.
	The default value is <tt>False</tt>.

	</dl>
	==Usage notes==		==Usage notes==
	<ul>		<ul>

← Older revision		Revision as of 00:52, 3 May 2011
Line 12:		Line 12:
	<td>A <var>UserStatistics</var> object variable. </td></tr>		<td>A <var>UserStatistics</var> object variable. </td></tr>
	<tr><th><var>Zeros</var></th>		<tr><th><var>Zeros</var></th>
	<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var ~~class="term"~~>Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var ~~class="term"~~>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values. </td></tr>		<td>This <var>[[Methods#Named parameters\|NameRequired]]</var> argument (<var>Zeros</var>) is a <var>[[Boolean]]</var> value that indicates whether statistics with a zero value should be included in the returned data. <var>Zeros</var> is an optional argument that defaults to <var>False</var>, which results in the inclusion of only statistics with non-zero values. </td></tr>
	<tr><th><var>AttributeValues</var></th>		<tr><th><var>AttributeValues</var></th>
	<td>This <var>NameRequired</var> argument (<var ~~class="term"~~>AttributeValues</var>) is a <var>Boolean</var> value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example:		<td>This <var>NameRequired</var> argument (<var>AttributeValues</var>) is a <var>Boolean</var> value that indicates whether statistic values are to be displayed as text or as value attributes within their XML document elements. For example:
	<~~p class="output"~~><DKRD>1107</DKRD></p> is text format, and <~~p class="output"~~><DKRD value="1107"/></p> is attribute value format. The default value is <var>False</var>, which produces text format.</td></tr>		<code><DKRD>1107</DKRD></code> is text format, and <code><DKRD value="1107"/></code> is attribute value format. The default value is <var>False</var>, which produces text format.</td></tr>
	<tr><th><var>AttributeNames</var></th>		<tr><th><var>AttributeNames</var></th>
	<td>This <var>NameRequired</var> argument (<var ~~class="term"~~>AttributeNames</var>) is a <var>Boolean</var> value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a "name" attribute. For example:		<td>This <var>NameRequired</var> argument (<var>AttributeNames</var>) is a <var>Boolean</var> value that indicates whether statistic names are to be displayed within their XML document elements as the element name or as the value of a "name" attribute. For example:
	<~~p class="output"~~><DKRD>1107</DKRD></p> is element-name format, and the following is name-as-attribute format: <p class="~~output~~"><stat name="DKRD"> 1107 </stat></p>The default value is <var>False</var>, which produces element-name format. </td></tr>		<code><DKRD>1107</DKRD></code> is element-name format, and the following is name-as-attribute format: <p class="code"><stat name="DKRD"> 1107 </stat></p>
			The default value is <var>False</var>, which produces element-name format. </td></tr>
	<tr><th><var>NamesToLower</var></th>		<tr><th><var>NamesToLower</var></th>
	<td>This <var>NameRequired</var> argument (<var ~~class="term"~~>NamesToLower</var>) is a <var>Boolean</var> value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <var>False</var>.</td></tr>		<td>This <var>NameRequired</var> argument (<var>NamesToLower</var>) is a <var>Boolean</var> value that indicates whether statistic names are to be displayed in lowercase characters. The default value is <var>False</var>.</td></tr>
	</table>		</table>

	==Examples==		==Examples==
	~~<ol><li>~~The following display of non-zero <var>[[UserStatistics_class#login\|Login]]</var> and <var>[[UserStatistics_class#request\|Request]]</var> statistics is produced by a sequence of statements like the following:		The following display of non-zero <var>[[UserStatistics_class#login\|Login]]</var> and <var>[[UserStatistics_class#request\|Request]]</var> statistics is produced by a sequence of statements like the following:
	<p class="code">%doc is object xmldoc		<p class="code">%doc is object xmldoc
	%ustat is object userstatistics		%ustat is object userstatistics
Line 64:		Line 65:
	</UserStatistics>		</UserStatistics>
	</p>		</p>
	~~<li>~~Using<~~p class="~~code">%doc = %ustat:ToXmlDoc(Zeros=true)</p> statement would return all the statistics, including those with a <code>0</code> value.~~</oL>~~		Using a <code>%doc = %ustat:ToXmlDoc(Zeros=true)</code> statement would return all the statistics, including those with a <code>0</code> value.

	==See also==		==See also==