<doc>

<legacy_id>1783</legacy_id>

<name>export</name>

<type>command</type>

<syntax>

<example>export [<i>format</i>] [with metadata <i>metadata</i>] to {file <i>filePath </i>| <i>container</i>} [with mask <i>maskFile</i>]</example>

<example>export <i>image</i> [with metadata <i>metadata</i>] to {file <i>filePath </i>|<i>container</i>} [as <i>format</i>] [with mask <i>maskFile</i>]</example>

</syntax>

<synonyms>

</synonyms>

<summary><glossary tag="export">Exports</glossary> the <property tag="selected">selected</property> <keyword tag="image">image</keyword> as a <glossary tag="PBM">PBM</glossary>, <glossary tag="JPEG">JPEG</glossary>, <glossary tag="GIF">GIF</glossary>, <glossary tag="BMP">BMP</glossary> or <glossary tag="PNG">PNG</glossary> <keyword tag="file">file</keyword>.</summary>

<examples>

<example>export paint to file &quot;Picture&quot; with mask &quot;../circlemask&quot;</example>

<example>export JPEG to URL &quot;binfile:next.jpg&quot;</example>

<example><p>export image &quot;Parachute&quot; to myVariable as GIF</p></example>

<example>export image thisImage to file &quot;Thumbnail&quot; as PNG </example>

</examples>

<history>

<introduced version="1.0">Added.</introduced>

<deprecated version=""></deprecated>

<removed version=""></removed>

<changed version="6.7">Optional metadata added</changed>

<changed version="4.5">4.5</changed>

<changed version="1.1">1.1</changed>

</history>

<objects>

</objects>

<platforms>

<mac/>

<windows/>

<linux/>

<ios/>

<android/>

</platforms>

<classes>

<desktop/>

<web/>

<mobile/>

</classes>

<security>

<disk/>

</security>

<classification>

</classification>

<references>

<command tag="export snapshot">export snapshot Command</command>

<command tag="import">import Command</command>

<property tag="JPEGQuality">JPEGQuality Property</property>

<keyword tag="as">as Keyword</keyword>

<keyword tag="paint">paint Keyword</keyword>

</references>

<description>Use the <b>export</b> <glossary tag="command">command</glossary> to <command tag="export">export</command> an <keyword tag="image">image</keyword> to a <keyword tag="file">file</keyword> or <glossary tag="container">container</glossary>.<p></p><p><b>Parameters:</b></p><p>The <i>format</i> is one of the following:<code tag=""> paint</code>,<code tag=""> JPEG</code>,<code tag=""> GIF</code>, BMP or<code tag=""> PNG</code>.</p><p></p><p>The <i>filePath</i> specifies the <glossary tag="file path">name and location</glossary> of the <keyword tag="file">file</keyword> you want to <command tag="export">export</command> to. If you specify a name but not a location, the <keyword tag="file">file</keyword> is created in the <property tag="defaultFolder">defaultFolder</property>.</p><p></p><p>The <i>container</i> is a reference to a <glossary tag="container">container</glossary>, usually another <keyword tag="image">image</keyword> or a <keyword tag="URL">URL</keyword>.</p><p></p><p>The <i>maskFile</i> specifies the <glossary tag="file path">name and location</glossary> of a <keyword tag="file">file</keyword> to <command tag="export">export</command> as an <keyword tag="image">image</keyword> <glossary tag="mask">mask</glossary>. You can use a <i>maskFile</i> only when exporting in <glossary tag="PBM">PBM</glossary> <function tag="format">format</function> (<code tag="">paint</code>).</p><p></p><p>The <i>image</i> is a reference to an <keyword tag="image">image</keyword>. The <i>metadata</i> is an array of metadata. Currently the only key supported is "density" with a value in pixels per inch (ppi).</p><p></p><p><b>Comments:</b></p><p>If you use the form<code tag=""> export </code><i>format</i> to..., the selected <keyword tag="image">image</keyword> is exported.</p><p></p><p>The<code tag=""> export paint </code>form exports the image as a PBM, PGM, or PPM file, depending on the image's colors. (Optionally, you can specify a location for the mask file.) The<code tag=""> export JPEG </code>form exports as a JPEG file, the<code tag=""> export PNG </code>form exports as a PNG file and the export BMP form exports as a BMP. If you don't specify a <i>format</i>, the file is exported as <glossary tag="PBM">PBM</glossary>, PGM, or <glossary tag="PPM">PPM</glossary>.</p><p></p><p></p><change><p>The GIF export option was introduced in version 1.1. In previous versions, it was not possible to export GIFs.</change><p></p><p>The<code tag=""> export </code><i>image</i> form was introduced in version 1.1. In previous versions, only the selected <keyword tag="image">image</keyword> could be <glossary tag="export">exported</glossary>.</p><p></p><p>The<code tag=""> export to container </code>form was introduced in version 1.1. In previous versions, an image could be exported only to a file.</p><p></p><p>The BMP export option was introduced in 4.5. In previous versions it was not possible to export BMPs.</p></description>

</doc>