<!-- saved from url=(0014)about:internet -->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><TITLE>SetVirtualText</TITLE><meta name="generator" content="Fast-Help"><meta name="keywords" content="Set Virtual Text">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
#FHNonScroll
{padding: 6px 6px 0px 6px; border-bottom: none; background: #D1D1D1; vertical-align: top;z-index: 2; visibility: visible; position: absolute; left: 0; top: 0; width: 100%; }
#FHScroll
{left: 0; top: 0px; position: absolute; margin: 0; padding: 10px; z-index: 1; background-repeat: no-repeat; background-position: bottom right; background-attachment: fixed; }
/* ========== Text Styles ========== */
hr { color: #000000}
body, table /* Normal */
{
font-size: 10pt;
font-family: 'Arial';
font-style: normal;
font-weight: normal;
color: #000000;
text-decoration: none;
}
span.rvts1
{
font-family: 'Arial Unicode MS';
}
span.rvts2
{
font-family: 'Verdana';
color: #000000;
}
span.rvts3
{
font-family: 'Verdana';
font-weight: bold;
color: #000000;
}
span.rvts4
{
font-family: 'Courier New';
color: #993366;
}
span.rvts5
{
font-family: 'Verdana';
color: #ff0000;
}
/* ========== Para Styles ========== */
p,ul,ol /* Left */
{
text-align: left;
text-indent: 0px;
padding: 0px 0px 0px 0px;
margin: 0px 0px 0px 0px;
}
.rvps1
{
}
--></style>
<script type="text/javascript" language="JavaScript" src="FHUtilities.js"></script>
<script type="text/JavaScript" language="JavaScript">
<!-- If this page is displayed outside of the Website Help Frameset, then reload in the Frame set
if (parent.location.href == self.location.href)
{location.href = "index.html?"+extractFileNameWithoutKnownExtension(location.href);}
//--></script>
<script type="text/javascript" language="JavaScript" src="FHNonscroll.js"></script><script type="text/javascript" language="JavaScript" src="FHUtilities.js"></script></HEAD>
<body bgcolor="#FFFFFF" scroll="no"><div id="FHNonScroll"><table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td width="100%" align="left">
<font size=2 color="#000000" face="Arial">
<div><font size=5 color="#333333" face="Verdana"><b>SetVirtualText</b></font></div>
</font>
</TD><td width="120" align="right" nowrap><font face="Verdana" size="2"><a href="SetObjectProperty1.html"><img src="Images/BrowseBlueLeft.png" border="0" alt="Previous Topic"></a> <a href="SubstVirtualText.html"><img src="Images/BrowseBlueRight.png" border="0" alt="Next Topic"></a> </font></td></tr></table></div><div id="FHScroll">
<p class=rvps1><span class=rvts3>::InstallAPI::SetVirtualText</span></p>
<p class=rvps1><span class=rvts2><br></span></p>
<p class=rvps1><span class=rvts2>Set the value of a virtual text variable in a given language.</span></p>
<p class=rvps1><span class=rvts5><br></span></p>
<p class=rvps1><span class=rvts2><br></span></p>
<p class=rvps1><span class=rvts3>Supported Platforms</span></p>
<p class=rvps1><span class=rvts2>All</span></p>
<p class=rvps1><span class=rvts2><br></span></p>
<p class=rvps1><span class=rvts2><br></span></p>
<p class=rvps1><span class=rvts3>Returns</span></p>
<p class=rvps1><span class=rvts2>The new value of the virtual text.</span></p>
<p class=rvps1><span class=rvts2><br></span></p>
<p class=rvps1><span class=rvts2><br></span></p>
<p class=rvps1><span class=rvts3>Options</span></p>
<p class=rvps1><span class=rvts2><br></span></p>
<p class=rvps1><span class=rvts3>-action <action ID or alias></span></p>
<p class=rvps1><span class=rvts2>The ID or alias of an action that should be executed anytime the value of the given virtual text changes.</span></p>
<p class=rvps1><span class=rvts3><br></span></p>
<p class=rvps1><span class=rvts3>-command <Tcl command></span></p>
<p class=rvps1><span class=rvts2>A Tcl command or proc that should be executed anytime the value of the given virtual text changes.</span></p>
<p class=rvps1><span class=rvts3><br></span></p>
<p class=rvps1><span class=rvts3>-language <Language or None></span></p>
<p class=rvps1><span class=rvts2>The language to set the virtual text in. If language is None or not specified, the virtual text will be set without being associated with a language.</span></p>
<p class=rvps1><span class=rvts2><br></span></p>
<p class=rvps1><span class=rvts3>-object <object ID or alias></span></p>
<p class=rvps1><span class=rvts2>The ID or alias of an object to set this virtual text on. This option is used to set the text property of a specific object like a pane or action.</span></p>
<p class=rvps1><span class=rvts2><br></span></p>
<p class=rvps1><span class=rvts3>-value <new value></span></p>
<p class=rvps1><span class=rvts2>The value to set in the virtual text variable.</span></p>
<p class=rvps1><span class=rvts2><br></span></p>
<p class=rvps1><span class=rvts3>-virtualtext <virtual text name> (required)</span></p>
<p class=rvps1><span class=rvts2>The virtual text variable name to set (without <% and %>).</span></p>
<p class=rvps1><span class=rvts2><br></span></p>
<p class=rvps1><span class=rvts2><br></span></p>
<p class=rvps1><span class=rvts3>Example</span></p>
<p class=rvps1><span class=rvts2><br></span></p>
<p class=rvps1><span class=rvts2>The following example would give you a virtual text variable Foo that is set to Bar. This could then be accessed as <%Foo%> from within InstallJammer.</span></p>
<p class=rvps1><span class=rvts2><br></span></p>
<p class=rvps1><span class=rvts4>::InstallAPI::SetVirtualText -virtualtext Foo -value Bar</span><span class=rvts1></span></p>
</div></body></html>