<doc>

<legacy_id>1469</legacy_id>

<name>clipboard</name>

<type>function</type>

<syntax>

<example>the clipboard</example>

<example>clipboard()</example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>User Interaction</category>

</classification>

<references>

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

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

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

</references>

<history>

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

<changed version="2.0"></changed>

</history>

<platforms>

<mac/>

<windows/>

<linux/>

</platforms>

<classes>

<desktop/>

<web/>

</classes>

<security>

</security>

<summary><glossary tag="return">Returns</glossary> the type of information on the <function tag="clipboard">clipboard</function>.</summary>

<examples>

<example>if the clipboard is "text" then paste</example>

<example>if the clipboard is empty then answer "Nothing to paste!"</example>

</examples>

<description>

<p>Check the <b>clipboard</b> <control_st tag="function">function</control_st> before using the <command tag="paste">paste</command> <glossary tag="command">command</glossary>, to ensure that you're pasting the right kind of data.</p><p/><p><b>Value:</b></p><p>The <b>clipboard</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> text, image, objects, or empty.</p><p/><p><b>Comments:</b></p><p>The value of the <b>clipboard</b> <control_st tag="function">function</control_st> is a <keyword tag="string">string</keyword> describing what kind of data is on the <function tag="clipboard">clipboard</function>. LiveCode can paste text that has been cut or copied, or picture content from an image, one or more <glossary tag="object">objects</glossary> that have been cut or copied.</p><p/><p>If the clipboard has nothing in it, or the contents of the clipboard is a type of data that is not text, image data, or objects, the <b>clipboard</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> empty.</p><p/><p><img src="202651"/> <b>Tip:</b> To get or change the data on the <function tag="clipboard">clipboard</function>, use the <property tag="clipboardData">clipboardData</property> <glossary tag="property">property</glossary>.</p><p/><p><b>Changes:</b></p><p>The ability to sense image data on the clipboard was added in version 2.0.</p>

</description>

</doc>