%AX_TKWIN

Create a Toolkit container window

window_id = %AX_TKWIN(tk_container_name, rows, columns[, ax_container_id][, font_id])

Return value

window_id

On Windows, %AX_TKWIN returns the Toolkit window ID. On Unix and OpenVMS, this routine returns false. (^VAL)

Arguments

tk_container_name

A string that contains the name of the Toolkit container window. This can be up to 15 characters. (a)

rows

The height of the window in character rows. (n)

columns

The width of the window in character columns. (n)

ax_container_id

(optional) Returned with the ActiveX container ID. (n)

font_id

(optional) The name of a font palette entry, a font handle, or one of the following: (a or n)

DF_CURRENT

Current font.

DF_DEFAULT

Global font.

DF_ALTERNATE

Alternate font.

DF_DEBUGGER

Debugger font.

Discussion

%AX_TKWIN creates two windows: a standard UI Toolkit window and an ActiveX container that is “slaved” to it. The ActiveX container is placed within the Toolkit window with an initial size that’s exactly the same size as the Toolkit window.

%AX_TKWIN also sets up the necessary control structures to use the window with AX_INPUT and then to control the mapping of keys as either accelerators or characters destined for the control or the Synergy application (via AX_WANTSKEY).

Because the outer container is a Toolkit window, you can perform all the Toolkit’s standard window-related functions (place, remove, delete, resize, and so forth, including border and title manipulation) by referencing the Toolkit window ID returned by %AX_TKWIN. Similarly, you can perform all the ActiveX-related functions (load a control, get a property value, set a property value, and so on) by referencing ax_container_id.

If you pass a null string (“”) for tk_container_name, Toolkit assigns a unique window name in the form _W_nnn, where nnn is the window ID.

Font_id enables you to specify a font for the container window as you create it. Changing the font later, after %AX_TKWIN has returned, may change the size of the container window. Therefore the size of the ActiveX control may need to be changed as well.