Packages
 Comm
 DB
 Debug
 Extension
 Input
 Interface
 Module
 Token
 User

Objects
 bitmapwidget
 databasenode
 dragdata
 textbasecontrol
 textwidget
 tokeninstance
 widget
 widgetcontainer
 windowcontrol
 windowinstance

Controls
 buttoncontrol
 buttonfield
 categoryselectioncontrol
 chatentry
 chatwindow
 databasecontrol
 diecontrol
 diefield
 formattedtextcontrol
 formattedtextfield
 genericcontrol
 imagecontrol
 numbercontrol
 numberfield
 portraitselectioncontrol
 scrollbarcontrol
 scrollercontrol
 stringcontrol
 stringfield
 subwindow
 tokenbag
 tokencontrol
 tokenfield
 windowlist
 windowreferencecontrol
 windowreferencefield

Assets and Settings
 announcement
 categoryselectionsettings
 characterdbroot
 customdie
 description
 desktopframe
 die
 diebox
 distance
 font
 framedef
 hotkeybar
 icon
 imageupdatefolder
 imagesettings
 importinfo
 importruleset
 includefile
 panel
 pollbox
 portraitset
 properties
 replaces
 script
 string
 template
 textsettings
 tokenroot
 tooltip
 windowclass
getValue
onInstanceCreated
setValue



Inherits windowcontrol
Context windowinstance

This control is a container and viewing port for a windowinstance object. The created window will always have the same data source as the parent window. By default, the windowinstance object will not be instantiated until the control is visible on screen. (See fastinit tag below)

Using the positioning and sizing functions for the contained windowinstance may have unpredictable results. If resizing of the windowinstance is desired, the size of the parent subwindow control should be changed instead.

A reference to the contained windowinstance object is available from the script environment of the parent subwindow control through the variable subwindow. In the other direction, a reference to the parent subwindow control is available from the contained windowinstance object through the parentcontrol variable.



Definition

<subwindow name="..." >
<class > ... </class> The name of the window class used to create the window
<activate /> If specified, show the control. By default, the control is hidden.
<fastinit /> If specified, instantiate the windowinstance when this control is created. Otherwise, the windowinstance will not be instantiated until control is drawn on screen.
</subwindow>


Interface


getValue

function getValue()

Returns data about the child window class and data source.

Return values

(string)
If child window exists, return the name of the windowclass used by the child window. Otherwise, return an empty string.
(string)
If child window exists, return the database path used by the child window. Otherwise, return an empty string.

onInstanceCreated

function onInstanceCreated()

If present, this function is executed when the window instance contained in the subwindow has been created.


setValue

function setValue([class], [recordname])

Sets the window class and data source to be shown in the subwindow control.

If a child window already exists, it will be closed.

Parameters

class   (string)   [optional]

The name of the windowclass to be used for the new child window. If this parameter is omitted, no new child window will be created and the subwindow will remain empty.

recordname   (string)   [optional]

The database path to be used for the new child window. If this parameter is omitted, the window will have no data source.



'Fantasy Grounds' is a trademark of SmiteWorks Ltd. All other trademarks are the property of their respective owners.
© 2004-2010 SmiteWorks Ltd. ALL RIGHTS RESERVED.
Privacy policy