<HTML>
	<HEAD>
    	<TITLE>Adobe ExtendScript Toolkit</TITLE>
		<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
		<LINK HREF="adobe.css" REL="stylesheet" TYPE="text/css">
        <LINK HREF="tabs.css" REL="stylesheet" TYPE="text/css">
 	</HEAD>
	<BODY> 
    <div class="header"><a href="http://www.adobe.com"><img src="adobelogo.jpg" alt="http://www.adobe.com"></a>&nbsp;<b>ExtendScript ToolKit</b></div>
<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    <li>
      <form action="search.php" method="get">
        <table cellspacing="0" cellpadding="0" border="0">
          <tr>
            <td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
            <td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
          </tr>
        </table>
      </form>
    </li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>SendObjectToPhotoshop Class Reference</h1><!-- doxytag: class="SendObjectToPhotoshop" -->
<p>
<a href="classSendObjectToPhotoshop-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSendObjectToPhotoshop.html#c4eb001f053d1bc3a5439fd3befbb391">SendObjectToPhotoshop</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">Boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSendObjectToPhotoshop.html#4f714e75d063e3388271c80b72e20694">run</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Functional part of this snippet.  <a href="#4f714e75d063e3388271c80b72e20694"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSendObjectToPhotoshop.html#9c8cad18e01ef2e637b48321ba3f571d">canRun</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determines whether snippet can run given current context.  <a href="#9c8cad18e01ef2e637b48321ba3f571d"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">String&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSendObjectToPhotoshop.html#f32676ef2825cee4b3b3bd7364d2b3f0">requiredContext</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The context in which this snippet can run.  <a href="#f32676ef2825cee4b3b3bd7364d2b3f0"></a><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="c4eb001f053d1bc3a5439fd3befbb391"></a><!-- doxytag: member="SendObjectToPhotoshop::SendObjectToPhotoshop" ref="c4eb001f053d1bc3a5439fd3befbb391" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void SendObjectToPhotoshop::SendObjectToPhotoshop           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4f714e75d063e3388271c80b72e20694"></a><!-- doxytag: member="SendObjectToPhotoshop::run" ref="4f714e75d063e3388271c80b72e20694" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Boolean SendObjectToPhotoshop::run           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Functional part of this snippet. 
<p>
Constructs a BridgeTalk message, which contains both the script to run in Photoshop, and the onResult callback for processing the response, then sends the message to Photoshop.<p>
The script contains a serialized JavaScript object, reconstructs and modifies it on the target side, then reserializes and sends it back as the result.<p>
The sender reconstructs the serialized object it receives as the result of the message.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the snippet ran as expected, false if Photoshop is not running, or if an error occurred sending the message. </dd></dl>

</div>
</div><p>
<a class="anchor" name="9c8cad18e01ef2e637b48321ba3f571d"></a><!-- doxytag: member="SendObjectToPhotoshop::canRun" ref="9c8cad18e01ef2e637b48321ba3f571d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Boolean SendObjectToPhotoshop::canRun           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Determines whether snippet can run given current context. 
<p>
The snippet fails if these preconditions are not met: <ul>
<li>
Photoshop must be running </li>
</ul>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if this snippet can run, false otherwise </dd></dl>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="f32676ef2825cee4b3b3bd7364d2b3f0"></a><!-- doxytag: member="SendObjectToPhotoshop::requiredContext" ref="f32676ef2825cee4b3b3bd7364d2b3f0" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">String <a class="el" href="classSendObjectToPhotoshop.html#f32676ef2825cee4b3b3bd7364d2b3f0">SendObjectToPhotoshop::requiredContext</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The context in which this snippet can run. 
<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SendObjectToPhotoshop_8jsx.html">SendObjectToPhotoshop.jsx</a></ul>
</div>
<p><img src="1ptrans.gif" /><p>
<p><img src="1ptrans.gif"  /></p>
<p><img src="asn.gif" width="114" height="45" border="0" alt="Adobe Solutions Network">Copyright&#169; 2008 Adobe Systems Incorporated. All rights reserved.</p>
<p>
    	<a href="http://www.adobe.com/misc/copyright.html">Terms of Use</a>&nbsp;
        <a href="http://www.adobe.com/misc/privacy.html">Online Privacy Policy</a>&nbsp;
        <a href="http://access.adobe.com">Adobe and accessibility</a>&nbsp;
        <a href="http://www.adobe.com/aboutadobe/antipiracy/main.html">Avoid software piracy</a>&nbsp;
        <a href="http://www.adobe.com/misc/agreement.html">Permissions and Trademarks</a>
</p>
</body>
</html>
