<doc>
  <legacy_id>1206</legacy_id>
  <name>multiply</name>
  <type>command</type>
  <syntax>
    <example>multiply [<i>chunk</i> of] <i>container</i> by <i>number</i></example>
    <example>multiply <i>arrayContainer</i> by {<i>number</i> | <i>array</i>}</example>
  </syntax>
  <library></library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Math, Logic, &amp; Dates</category>
  </classification>
  <references>
    <operator tag="*">* Operator</operator>
    <command tag="add">add Command</command>
    <command tag="divide">divide Command</command>
    <function tag="matrixMultiply">matrixMultiply Function</function>
    <property tag="numberFormat">numberFormat Property</property>
    <command tag="subtract">subtract Command</command>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
    <changed version="1.1"></changed>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
    <ios/>
    <android/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
    <mobile/>
  </classes>
  <security>
  </security>
  <summary>Multiplies a number by a <glossary tag="container">container</glossary> and places the resulting <function tag="value">value</function> in the <glossary tag="container">container</glossary>.</summary>
  <examples>
    <example>multiply field 17 by it</example>
    <example>multiply yearlyTotals by yearlyPercentages</example>
    <example>multiply line thisLine of myVariable by theFactor</example>
  </examples>
  <description>
    <p>Use the <b>multiply</b> <glossary tag="command">command</glossary> to multiply a <glossary tag="container">container</glossary> or a portion of a <glossary tag="container">container</glossary> by a number, or to multiply two <glossary tag="array">arrays</glossary> containing numbers.</p><p/><p><b>Parameters:</b></p><p>The <i>chunk</i> is a <glossary tag="chunk expression">chunk expression</glossary> specifying a portion of the <i>container</i>.</p><p/><p>The <i>container</i> is a <keyword tag="field">field</keyword>, <keyword tag="button">button</keyword>, or <glossary tag="variable">variable</glossary>, or the <keyword tag="message box">message box</keyword>.</p><p/><p>The <i>number</i> is any <glossary tag="expression">expression</glossary> that <glossary tag="evaluate">evaluates</glossary> to a number.</p><p/><p>The <i>arrayContainer</i> is an <glossary tag="array">array</glossary> <glossary tag="variable">variable</glossary> each of whose <glossary tag="element">elements</glossary> is a number.</p><p/><p><b>Comments:</b></p><p>The contents of the <i>container</i> (or the <i>chunk</i> of the <glossary tag="container">container</glossary>) must be a number or an <glossary tag="expression">expression</glossary> that <glossary tag="evaluate">evaluates</glossary> to a number.</p><p/><p>If an <i>arrayContainer</i> is multiplied by a <i>number</i>, each element is multiplied by the <i>number</i>. If an <i>arrayContainer</i> is multiplied by an <i>array</i>, both <glossary tag="array">arrays</glossary> must have the same number of <glossary tag="element">elements</glossary> and the same dimension, and each <keyword tag="element">element</keyword> in the <i>arrayContainer</i> is multiplied by the corresponding <keyword tag="element">element</keyword> of the <i>array</i>.</p><p/><p>If the <i>container</i> or an <keyword tag="element">element</keyword> of the <i>arrayContainer</i> is empty, the <b>multiply</b> <glossary tag="command">command</glossary> treats its contents as zero.</p><p/><p>If <i>container</i> is a <keyword tag="field">field</keyword> or <keyword tag="button">button</keyword>, the <function tag="format">format</function> of the result is determined by the <property tag="numberFormat">numberFormat</property> <glossary tag="property">property</glossary>.</p><p/><p><b>Changes:</b></p><p>The<code> multiply <i>arrayContainer</i> </code>form was introduced in version 1.1. In previous versions, only single numbers could be used with the <b>multiply</b> <glossary tag="command">command</glossary>.</p>
  </description>
</doc>