<doc>

<legacy_id>1923</legacy_id>

<name>dropChunk</name>

<type>function</type>

<syntax>

<example>the dropChunk</example>

<example>dropChunk()</example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>User Interaction</category>

<category>Text and Data Processing</category>

</classification>

<references>

<function tag="clickChunk">clickChunk Function</function>

<function tag="dragDestination">dragDestination Function</function>

<message tag="dragDrop">dragDrop Message</message>

<function tag="mouseChunk">mouseChunk Function</function>

</references>

<history>

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

</history>

<platforms>

<mac/>

<windows/>

</platforms>

<classes>

<desktop/>

<server/>

</classes>

<security>

</security>

<summary><glossary tag="return">Returns</glossary> a <glossary tag="chunk expression">chunk expression</glossary> describing the location in the <keyword tag="field">field</keyword> where data was dropped.</summary>

<examples>

<example>the dropChunk</example>

<example>select the dropChunk</example>

</examples>

<description>

<p>Use the <b>dropChunk</b> <control_st tag="function">function</control_st> within a <message tag="dragDrop">dragDrop</message> <glossary tag="handler">handler</glossary> to find out exactly where text was dropped into a <keyword tag="field">field</keyword>.</p><p/><p><b>Value:</b></p><p>The <b>dropChunk</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> a <glossary tag="chunk expression">chunk expression</glossary> of the form char <i>followingChar</i> to <i>precedingChar</i> of field <i>fieldNumber</i>. The <i>followingChar</i> is always one less than the <i>precedingChar</i>.</p><p/><p><b>Comments:</b></p><p>The <b>dropChunk</b> <control_st tag="function">function</control_st> only <glossary tag="return">returns</glossary> a value while a <message tag="dragDrop">dragDrop</message> <glossary tag="handler">handler</glossary> is being <glossary tag="execute">executed</glossary>: that is, you can use it in a <message tag="dragDrop">dragDrop</message> <glossary tag="handler">handler</glossary> or in a <glossary tag="handler">handler</glossary> that's called by a <message tag="dragDrop">dragDrop</message> <glossary tag="handler">handler</glossary>. If called from another <glossary tag="handler">handler</glossary>, the <b>dropChunk</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> empty.</p><p/><p>The <b>dropChunk</b> <control_st tag="function">function</control_st> designates an <glossary tag="insertion point">insertion point</glossary> rather than a run of characters. For example, if you drop text between <keyword tag="characters">characters</keyword> 3 and 4 of <keyword tag="field">field</keyword> number 1, the <function tag="dropChunk">dropChunk</function> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> "char 4 to 3 of field 1".</p>

</description>

</doc>