CSInterface.html

<!DOCTYPE html>

<html lang="en">
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width">
	<title>Adobe CEP8 API Class: CSInterface</title>

	<!--[if lt IE 9]>
	<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->
	<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">

	<link type="text/css" rel="stylesheet" href="styles/site.united.css">

</head>

<body>

<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
<div class="container">
	<div class="navbar-header">
		<a class="navbar-brand" href="index.html">Adobe CEP8 API</a>
		<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
        </button>
	</div>
	<div class="navbar-collapse collapse" id="topNavigation">
		<ul class="nav navbar-nav">
			
			<li class="dropdown">
				<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="cep.html">cep</a></li><li><a href="cep.encoding.html">cep.encoding</a></li><li><a href="cep.encoding.convertion.html">cep.encoding.convertion</a></li><li><a href="cep.fs.html">cep.fs</a></li><li><a href="cep.process.html">cep.process</a></li><li><a href="cep.util.html">cep.util</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="AgoraLib.html">AgoraLib</a></li><li><a href="ApiVersion.html">ApiVersion</a></li><li><a href="AppSkinInfo.html">AppSkinInfo</a></li><li><a href="ColorType.html">ColorType</a></li><li><a href="ContextMenuItemStatus.html">ContextMenuItemStatus</a></li><li><a href="CSEvent.html">CSEvent</a></li><li><a href="CSInterface.html">CSInterface</a></li><li><a href="Direction.html">Direction</a></li><li><a href="Extension.html">Extension</a></li><li><a href="GradientColor.html">GradientColor</a></li><li><a href="GradientStop.html">GradientStop</a></li><li><a href="HostCapabilities.html">HostCapabilities</a></li><li><a href="HostEnvironment.html">HostEnvironment</a></li><li><a href="MenuItemStatus.html">MenuItemStatus</a></li><li><a href="RGBColor.html">RGBColor</a></li><li><a href="Runtime.html">Runtime</a></li><li><a href="SystemPath.html">SystemPath</a></li><li><a href="UIColor.html">UIColor</a></li><li><a href="Version.html">Version</a></li><li><a href="VersionBound.html">VersionBound</a></li><li><a href="VersionRange.html">VersionRange</a></li><li><a href="Vulcan.html">Vulcan</a></li><li><a href="VulcanMessage.html">VulcanMessage</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="global.html#AgoraLibResponse">AgoraLibResponse</a></li><li><a href="global.html#CSXSWindowType">CSXSWindowType</a></li><li><a href="global.html#EvalScript_ErrMessage">EvalScript_ErrMessage</a></li><li><a href="global.html#GetValueByKey">GetValueByKey</a></li><li><a href="global.html#requiredParamsValid">requiredParamsValid</a></li><li><a href="global.html#strStartsWith">strStartsWith</a></li><li><a href="global.html#VulcanInterface">VulcanInterface</a></li>
				</ul>
			</li>
			
		</ul>
        
            <div class="col-sm-3 col-md-3">
                <form class="navbar-form" role="search">
                    <div class="input-group">
                        <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
                        <div class="input-group-btn">
                            <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
                        </div>
                    </div>
                </form>
            </div>
        
	</div>

</div>
</div>


<div class="container" id="toc-content">
<div class="row">

	
	<div class="col-md-8">
	
		<div id="main">
			

	<h1 class="page-title">Class: CSInterface</h1>
<section>

<header>
    
        <h2>
        CSInterface
        </h2>
        
            <div class="class-description"><p>CSInterface<br>This is the entry point to the CEP extensibility infrastructure.<br>Instantiate this object and use it to:</p>
<ul><br><li>Access information about the host application in which an extension is running</li><br><li>Launch an extension</li><br><li>Register interest in event notifications, and dispatch events</li><br></ul></div>
        
    
</header>


<article>
    <div class="container-overview">
    
        
<hr>
<dt>
    <h4 class="name" id="CSInterface"><span class="type-signature"></span>new CSInterface()</h4>
    
    
</dt>
<dd>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-456">line 456</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>A new CSInterface object</p>
</div>


</dd>

    
    </div>

    
        <h3 class="subsection-title">Members</h3>

        <dl>
            
<hr>
<dt class="name" id=".THEME_COLOR_CHANGED_EVENT">
    <h4 id=".THEME_COLOR_CHANGED_EVENT"><span class="type-signature">&lt;static> </span>THEME_COLOR_CHANGED_EVENT<span class="type-signature"></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>Users can add this event listener to handle native application theme color changes.<br>Callback function gives extensions ability to fine-tune their theme color after the<br>global theme color has been changed.<br>The callback function should be like below:</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-476">line 476</a>
			</li>
		</ul>
	</dd>
	

</dl>


        <h5>Example</h5>
        
    <pre class="sunlight-highlight-javascript">// event is a CSEvent object, but user can ignore it.function OnAppThemeColorChanged(event){   // Should get a latest HostEnvironment object from application.   var skinInfo = JSON.parse(window.__adobe_cep__.getHostEnvironment()).appSkinInfo;   // Gets the style information such as color info from the skinInfo,   // and redraw all UI controls of your extension according to the style info.}</pre>


</dd>

        
<hr>
<dt class="name" id="hostEnvironment">
    <h4 id="hostEnvironment"><span class="type-signature"></span>hostEnvironment<span class="type-signature"></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The host environment data object.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-479">line 479</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        </dl>
    

        <h3 class="subsection-title">Methods</h3>

        <dl>
            
<hr>
<dt>
    <h4 class="name" id="addEventListener"><span class="type-signature"></span>addEventListener(type, listener, obj)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Registers an interest in a CEP event of a particular type, and<br>assigns an event handler.<br>The event infrastructure notifies your extension when events of this type occur,<br>passing the event object to the registered handler function.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>The name of the event type of interest.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>listener</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>The JavaScript handler function or method.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>obj</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>Optional, the object containing the handler method, if any.<br>        Default is null.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-588">line 588</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="closeExtension"><span class="type-signature"></span>closeExtension()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Closes this extension.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-493">line 493</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="dispatchEvent"><span class="type-signature"></span>dispatchEvent(event)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Triggers a CEP event programmatically. Yoy can use it to dispatch<br>an event of a predefined type, or of a type you have defined.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>event</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>A CSEvent object.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-567">line 567</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="dumpInstallationInfo"><span class="type-signature"></span>dumpInstallationInfo()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Writes installation information to a file.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-708">line 708</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The file path.</p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="evalScript"><span class="type-signature"></span>evalScript(script, callback)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Evaluates a JavaScript script, which can use the JavaScript DOM<br>of the host application.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>script</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>The JavaScript script.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>Optional. A callback function that receives the result of execution.<br>         If execution fails, the callback function receives the error message EvalScript_ErrMessage.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-528">line 528</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getApplicationID"><span class="type-signature"></span>getApplicationID()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Retrieves the unique identifier of the application.<br>in which the extension is currently running.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-543">line 543</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The unique ID string.</p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getCurrentApiVersion"><span class="type-signature"></span>getCurrentApiVersion()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Retrieves current API version.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>4.2.0</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-869">line 869</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>ApiVersion object.</p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getExtensionID"><span class="type-signature"></span>getExtensionID()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Retrieves extension ID.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>4.2.0</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-824">line 824</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>extension ID.</p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getExtensions"><span class="type-signature"></span>getExtensions(extensionIds)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Retrieves the list of extensions currently loaded in the current host application.<br>The extension list is initialized once, and remains the same during the lifetime<br>of the CEP session.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>extensionIds</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>Optional, an array of unique identifiers for extensions of interest.<br>         If omitted, retrieves data for all extensions.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-632">line 632</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>Zero or more #Extension objects.</p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getHostCapabilities"><span class="type-signature"></span>getHostCapabilities()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Retrieves host capability information for the application<br>in which the extension is currently running.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-555">line 555</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>A #HostCapabilities object.</p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getHostEnvironment"><span class="type-signature"></span>getHostEnvironment()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Retrieves information about the host environment in which the<br> extension is currently running.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-486">line 486</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>A #HostEnvironment object.</p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getNetworkPreferences"><span class="type-signature"></span>getNetworkPreferences()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Retrieves network-related preferences.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-646">line 646</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>A JavaScript object containing network preferences.</p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getOSInformation"><span class="type-signature"></span>getOSInformation()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Retrieves version information for the current Operating System,<br>See http://www.useragentstring.com/pages/Chrome/ for Chrome navigator.userAgent values.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-721">line 721</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>A string containing the OS version, or &quot;unknown Operation System&quot;.<br>If user customizes the User Agent by setting CEF command parameter &quot;--user-agent&quot;, only<br>&quot;Mac OS X&quot; or &quot;Windows&quot; will be returned.</p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getScaleFactor"><span class="type-signature"></span>getScaleFactor()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Retrieves the scale factor of screen.<br>On Windows platform, the value of scale factor might be different from operating system's scale factor,</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>4.2.0</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-843">line 843</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>One of the following float number.<br>     <ul><br>         <li> -1.0 when error occurs </li><br>         <li> 1.0 means normal screen </li><br>         <li> &gt;1.0 means HiDPI screen </li><br>     </ul></p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getSystemPath"><span class="type-signature"></span>getSystemPath(pathType)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Retrieves a path for which a constant is defined in the system.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>pathType</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>The path-type constant defined in #SystemPath ,</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-505">line 505</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The platform-specific system path string.</p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getWindowTitle"><span class="type-signature"></span>getWindowTitle()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Get the title of the extension window.<br>This function works with modal and modeless extensions in all Adobe products, and panel extensions in Photoshop, InDesign, InCopy, Illustrator, Flash Pro and Dreamweaver.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>6.1.0</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-1196">line 1196</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The window title.</p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="initResourceBundle"><span class="type-signature"></span>initResourceBundle()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Initializes the resource bundle for this extension with property values<br>for the current application and locale.<br>To support multiple locales, you must define a property file for each locale,<br>containing keyed display-string values for that locale.<br>See localization documentation for Extension Builder and related products.</p>
<p>Keys can be in the<br>form <code>key.value=&quot;localized string&quot;</code>, for use in HTML text elements.<br>For example, in this input element, the localized key.value string is displayed<br>instead of the empty value string:</p>
<p><code><input type="submit" value="" data-locale="key"/></code></p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-670">line 670</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>An object containing the resource bundle information.</p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="isWindowVisible"><span class="type-signature"></span>isWindowVisible()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Get the visibility status of an extension window.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>6.0.0</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-1085">line 1085</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>true if the extension window is visible; false if the extension window is hidden.</p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="openURLInDefaultBrowser"><span class="type-signature"></span>openURLInDefaultBrowser(url)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Opens a page in the default system browser.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>The URL of the page/file to open, or the email address.<br>Must use HTTP/HTTPS/file/mailto protocol. For example:<br>  &quot;http://www.adobe.com&quot;<br>  &quot;https://github.com&quot;<br>  &quot;file:///C:/log.txt&quot;<br>  &quot;mailto:test@adobe.com&quot;</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>4.2.0</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-812">line 812</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>One of these error codes:<br>     <ul><br>         <li>NO_ERROR - 0</li><br>         <li>ERR_UNKNOWN - 1</li><br>         <li>ERR_INVALID_PARAMS - 2</li><br>         <li>ERR_INVALID_URL - 201</li><br>     </ul></p>
</div>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="registerInvalidCertificateCallback"><span class="type-signature"></span>registerInvalidCertificateCallback(callback)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Register the invalid certificate callback for an extension.<br>This callback will be triggered when the extension tries to access the web site that contains the invalid certificate on the main frame.<br>But if the extension does not call this function and tries to access the web site containing the invalid certificate, a default error page will be shown.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last"><p>the callback function</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>6.1.0</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-1122">line 1122</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="registerKeyEventsInterest"><span class="type-signature"></span>registerKeyEventsInterest(keyEventsInterest)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Register an interest in some key events to prevent them from being sent to the host application.</p>
<p>This function works with modeless extensions and panel extensions.<br>Generally all the key events will be sent to the host application for these two extensions if the current focused element is not text input or dropdown.<br>If you want to intercept some key events and want them to be handled in the extension, please call this function<br>in advance to prevent them being sent to the host application.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>keyEventsInterest</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#JSON_String">JSON_String</a></span>


            </td>

            
            <td class="description last"><p>A JSON string describing those key events you are interested in. A null object or an empty string will lead to removing the interest</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>6.1.0</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-1170">line 1170</a>
			</li>
		</ul>
	</dd>
	

</dl>


        <h5>Example</h5>
        
    <pre class="sunlight-highlight-javascript">An example JSON string:[    {        &quot;keyCode&quot;: 48    },    {        &quot;keyCode&quot;: 123,        &quot;ctrlKey&quot;: true    },    {        &quot;keyCode&quot;: 123,        &quot;ctrlKey&quot;: true,        &quot;metaKey&quot;: true    }]</pre>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="removeEventListener"><span class="type-signature"></span>removeEventListener(type, listener, obj)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Removes a registered event listener.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>The name of the event type of interest.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>listener</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>The JavaScript handler function or method that was registered.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>obj</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>Optional, the object containing the handler method, if any.<br>         Default is null.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-601">line 601</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="requestOpenExtension"><span class="type-signature"></span>requestOpenExtension(extensionId, startupParams)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Loads and launches another extension, or activates the extension if it is already loaded.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>extensionId</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>The extension's unique identifier.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>startupParams</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>Not currently used, pass &quot;&quot;.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-617">line 617</a>
			</li>
		</ul>
	</dd>
	

</dl>


        <h5>Example</h5>
        
    <pre class="sunlight-highlight-javascript">To launch the extension &quot;help&quot; with ID &quot;HLP&quot; from this extension, call:&lt;code&gt;requestOpenExtension(&quot;HLP&quot;, &quot;&quot;); &lt;/code&gt;</pre>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="resizeContent"><span class="type-signature"></span>resizeContent(width, height)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Resize extension's content to the specified dimensions.</p>
<ol>
<li>Works with modal and modeless extensions in all Adobe products.</li>
<li>Extension's manifest min/max size constraints apply and take precedence. </li>
<li>For panel extensions<br>3.1 This works in all Adobe products except:<pre class="prettyprint source"><code>* Premiere Pro
* Prelude
* After Effects</code></pre>3.2 When the panel is in certain states (especially when being docked),<pre class="prettyprint source"><code>it will not change to the desired dimensions even when the
specified size satisfies min/max constraints.</code></pre></li>
</ol>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last"><p>The new width</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last"><p>The new height</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>6.0.0</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-1108">line 1108</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="setContextMenu"><span class="type-signature"></span>setContextMenu(menu, callback)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Set context menu by XML string.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>menu</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>A XML string which describes menu structure.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last"><p>The callback function which is called when a menu item is clicked. The only parameter is the returned ID of clicked menu item.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>5.2.0<br />There are a number of conventions used to communicate what type of menu item to create and how it should be handled.<ul>   <li>an item without menu ID or menu name is disabled and is not shown.</li>   <li>if the item label is "---" (three hyphens) then it is treated as a separator. The menu ID in this case will always be NULL.</li>   <li>checkable attribute takes precedence over Checked attribute.</li>   <li>a PNG icon. For optimal display results please supply a 16 x 16px icon as larger dimensions will increase the size of the menu item.</li>   <li>the items with icons and checkable items cannot coexist on the same menu level. The former take precedences over the latter.</li></ul>The Chrome extension <a href="https://developer.chrome.com/extensions/contextMenus">contextMenus API</a> was taken as a reference.</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-972">line 972</a>
			</li>
		</ul>
	</dd>
	

</dl>


        <h5>Example</h5>
        
    <pre class="sunlight-highlight-javascript">An example menu XML:&#x27;&lt;Menu&gt;  &lt;MenuItem Id=&quot;menuItemId1&quot; Label=&quot;TestExample1&quot; Enabled=&quot;true&quot; Checkable=&quot;true&quot; Checked=&quot;false&quot; Icon=&quot;./image/small_16X16.png&quot;/&gt;  &lt;MenuItem Id=&quot;menuItemId2&quot; Label=&quot;TestExample2&quot;&gt;    &lt;MenuItem Id=&quot;menuItemId2-1&quot; Label=&quot;TestExample2-1&quot; &gt;      &lt;MenuItem Id=&quot;menuItemId2-1-1&quot; Label=&quot;TestExample2-1-1&quot; Enabled=&quot;false&quot; Checkable=&quot;true&quot; Checked=&quot;true&quot;/&gt;    &lt;/MenuItem&gt;    &lt;MenuItem Id=&quot;menuItemId2-2&quot; Label=&quot;TestExample2-2&quot; Enabled=&quot;true&quot; Checkable=&quot;true&quot; Checked=&quot;true&quot;/&gt;  &lt;/MenuItem&gt;  &lt;MenuItem Label=&quot;---&quot; /&gt;  &lt;MenuItem Id=&quot;menuItemId3&quot; Label=&quot;TestExample3&quot; Enabled=&quot;false&quot; Checkable=&quot;true&quot; Checked=&quot;false&quot;/&gt;&lt;/Menu&gt;&#x27;</pre>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="setContextMenuByJSON"><span class="type-signature"></span>setContextMenuByJSON(menu, callback)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Set context menu by JSON string.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>menu</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>A JSON string which describes menu structure.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last"><p>The callback function which is called when a menu item is clicked. The only parameter is the returned ID of clicked menu item.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>6.0.0<br />There are a number of conventions used to communicate what type of menu item to create and how it should be handled.<ul>   <li>an item without menu ID or menu name is disabled and is not shown.</li>   <li>if the item label is "---" (three hyphens) then it is treated as a separator. The menu ID in this case will always be NULL.</li>   <li>checkable attribute takes precedence over Checked attribute.</li>   <li>a PNG icon. For optimal display results please supply a 16 x 16px icon as larger dimensions will increase the size of the menu item.</li>   <li>the items with icons and checkable items cannot coexist on the same menu level. The former take precedences over the latter.</li></ul>The Chrome extension <a href="https://developer.chrome.com/extensions/contextMenus">contextMenus API</a> was taken as a reference.</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-1053">line 1053</a>
			</li>
		</ul>
	</dd>
	

</dl>


        <h5>Example</h5>
        
    <pre class="sunlight-highlight-javascript">An example menu JSON:{      &quot;menu&quot;: [         {             &quot;id&quot;: &quot;menuItemId1&quot;,             &quot;label&quot;: &quot;testExample1&quot;,             &quot;enabled&quot;: true,             &quot;checkable&quot;: true,             &quot;checked&quot;: false,             &quot;icon&quot;: &quot;./image/small_16X16.png&quot;         },         {             &quot;id&quot;: &quot;menuItemId2&quot;,             &quot;label&quot;: &quot;testExample2&quot;,             &quot;menu&quot;: [                 {                     &quot;id&quot;: &quot;menuItemId2-1&quot;,                     &quot;label&quot;: &quot;testExample2-1&quot;,                     &quot;menu&quot;: [                         {                             &quot;id&quot;: &quot;menuItemId2-1-1&quot;,                             &quot;label&quot;: &quot;testExample2-1-1&quot;,                             &quot;enabled&quot;: false,                             &quot;checkable&quot;: true,                             &quot;checked&quot;: true                         }                     ]                 },                 {                     &quot;id&quot;: &quot;menuItemId2-2&quot;,                     &quot;label&quot;: &quot;testExample2-2&quot;,                     &quot;enabled&quot;: true,                     &quot;checkable&quot;: true,                     &quot;checked&quot;: true                 }             ]         },         {             &quot;label&quot;: &quot;---&quot;         },         {             &quot;id&quot;: &quot;menuItemId3&quot;,             &quot;label&quot;: &quot;testExample3&quot;,             &quot;enabled&quot;: false,             &quot;checkable&quot;: true,             &quot;checked&quot;: false         }     ] }</pre>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="setPanelFlyoutMenu"><span class="type-signature"></span>setPanelFlyoutMenu(menu)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Set panel flyout menu by an XML.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>menu</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>An XML string which describes menu structure.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>5.2.0<br/>Register a callback function for <code>"com.adobe.csxs.events.flyoutMenuClicked"</code> to get notified when a menu item is clicked.The <code>"data"</code> attribute of event is an object which contains <code>"menuId"</code> and <code>"menuName"</code> attributes. Register callback functions for <code>"com.adobe.csxs.events.flyoutMenuOpened"</code> and <code>"com.adobe.csxs.events.flyoutMenuClosed"</code>respectively to get notified when flyout menu is opened or closed.</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-903">line 903</a>
			</li>
		</ul>
	</dd>
	

</dl>


        <h5>Example</h5>
        
    <pre class="sunlight-highlight-javascript">An example menu XML:&#x27;&lt;Menu&gt;  &lt;MenuItem Id=&quot;menuItemId1&quot; Label=&quot;TestExample1&quot; Enabled=&quot;true&quot; Checked=&quot;false&quot;/&gt;  &lt;MenuItem Label=&quot;TestExample2&quot;&gt;    &lt;MenuItem Label=&quot;TestExample2-1&quot; &gt;      &lt;MenuItem Label=&quot;TestExample2-1-1&quot; Enabled=&quot;false&quot; Checked=&quot;true&quot;/&gt;    &lt;/MenuItem&gt;    &lt;MenuItem Label=&quot;TestExample2-2&quot; Enabled=&quot;true&quot; Checked=&quot;true&quot;/&gt;  &lt;/MenuItem&gt;  &lt;MenuItem Label=&quot;---&quot; /&gt;  &lt;MenuItem Label=&quot;TestExample3&quot; Enabled=&quot;false&quot; Checked=&quot;false&quot;/&gt;&lt;/Menu&gt;&#x27;</pre>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="setScaleFactorChangedHandler"><span class="type-signature"></span>setScaleFactorChangedHandler(handler)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Set a handler to detect any changes of scale factor. This only works on Mac.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>handler</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>The function to be called when scale factor is changed.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>4.2.0</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-856">line 856</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="setWindowTitle"><span class="type-signature"></span>setWindowTitle(title)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Set the title of the extension window.<br>This function works with modal and modeless extensions in all Adobe products, and panel extensions in Photoshop, InDesign, InCopy, Illustrator, Flash Pro and Dreamweaver.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>title</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>The window title.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>6.1.0</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-1183">line 1183</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="updateContextMenuItem"><span class="type-signature"></span>updateContextMenuItem(menuItemID, enabled, checked)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Updates a context menu item by setting the enabled and selection status.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>menuItemID</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>The menu item ID.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>enabled</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
            <td class="description last"><p>True to enable the item, false to disable it (gray it out).</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>checked</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
            <td class="description last"><p>True to select the item, false to deselect it.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>5.2.0</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-1072">line 1072</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="updatePanelMenuItem"><span class="type-signature"></span>updatePanelMenuItem(menuItemLabel, enabled, checked)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Updates a menu item in the extension window's flyout menu, by setting the enabled<br>and selection status.</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>menuItemLabel</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>The menu item label.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>enabled</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
            <td class="description last"><p>True to enable the item, false to disable it (gray it out).</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>checked</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
            <td class="description last"><p>True to select the item, false to deselect it.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-since method-doc-label method-doc-details-label">Since:</dt>
	<dd class="tag-since">
		<ul class="dummy">
			<li>5.2.0</li>
		</ul>
	</dd>
	

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="CSInterface.js.html">CSInterface.js</a>,
				 <a href="CSInterface.js.html#sunlight-1-line-928">line 928</a>
			</li>
		</ul>
	</dd>
	

	<dt class="tag-see method-doc-label method-doc-details-label">See:</dt>
	<dd class="tag-see">
		<ul>
			<li>HostCapabilities.EXTENDED_PANEL_MENU</li>
			</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>false when the host application does not support this functionality (<code>HostCapabilities.EXTENDED_PANEL_MENU</code> is false).<br>        Fails silently if menu label is invalid.</p>
</div>


</dd>

        </dl>
    

</article>

</section>


		</div>
	</div>

	<div class="clearfix"></div>

	
		<div class="col-md-3">
			<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
		</div>
	

</div>
</div>


    <div class="modal fade" id="searchResults">
      <div class="modal-dialog">
        <div class="modal-content">
          <div class="modal-header">
            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
            <h4 class="modal-title">Search results</h4>
          </div>
          <div class="modal-body"></div>
          <div class="modal-footer">
            <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
          </div>
        </div><!-- /.modal-content -->
      </div><!-- /.modal-dialog -->
    </div>


<footer>


	<span class="copyright">
	DocStrap Copyright © 2012-2018 The contributors to the JSDoc3 and DocStrap projects.
 CEP Resources © 2013 Adobe Systems Incorporated.
	</span>

<span class="jsdoc-message">
	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
	
		on Thu Apr 12th 2018
	
	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>

<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>

    <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>


<script>
$( function () {
	$( "[id*='$']" ).each( function () {
		var $this = $( this );

		$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
	} );

	$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
		var $this = $( this );

		var example = $this.find( "code" );
		exampleText = example.html();
		var lang = /{@lang (.*?)}/.exec( exampleText );
		if ( lang && lang[1] ) {
			exampleText = exampleText.replace( lang[0], "" );
			example.html( exampleText );
			lang = lang[1];
		} else {
			var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
			lang = langClassMatch ? langClassMatch[1] : "javascript";
		}

		if ( lang ) {

			$this
			.addClass( "sunlight-highlight-" + lang )
			.addClass( "linenums" )
			.html( example.html() );

		}
	} );

	Sunlight.highlightAll( {
		lineNumbers : true,
		showMenu : true,
		enableDoclinks : true
	} );

	$.catchAnchorLinks( {
        navbarOffset: 10
	} );
	$( "#toc" ).toc( {
		anchorName  : function ( i, heading, prefix ) {
			return $( heading ).attr( "id" ) || ( prefix + i );
		},
		selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
		showAndHide : false,
		smoothScrolling: true
	} );

	$( "#main span[id^='toc']" ).addClass( "toc-shim" );
	$( '.dropdown-toggle' ).dropdown();

    $( "table" ).each( function () {
      var $this = $( this );
      $this.addClass('table');
    } );

} );
</script>


<!--Navigation and Symbol Display-->


<!--Google Analytics-->


    <script type="text/javascript">
        $(document).ready(function() {
            SearcherDisplay.init();
        });
    </script>


</body>
</html>