::InstallAPI::SetVirtualText

Set the value of a virtual text variable in a given language.

Supported Platforms

All

Returns

The new value of the virtual text.

Options

-action <action ID or alias>

The ID or alias of an action that should be executed anytime the value of the given virtual text changes.

-command <Tcl command>

A Tcl command or proc that should be executed anytime the value of the given virtual text changes.

-language <Language or None>

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.

-object <object ID or alias>

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.

-value <new value>

The value to set in the virtual text variable.

-virtualtext <virtual text name> (required)

The virtual text variable name to set (without <% and %>).

Example

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.

::InstallAPI::SetVirtualText -virtualtext Foo -value Bar