Command: wcomponent

Syntax

{<window> = } wcomponent <component>

Description

Define a window to house an external component.

Parameters

• <window>
  A window identifier whose contents are to be an embeddable external component (e.g. ActiveX control). If this is omitted, the next free window will be used.

• <component>
  The component to be housed in the window. This must be an embeddable component, e.g. an ActiveX (OLE) control.

Switches

• -at=<atable>
  An atable to be searched within callback procedures for this window. This means any identifiers within <atable> referenced in a callback do not have to be prefixed by ~<atable>. This cannot be the local atable.

• -col=<color>
  The color of the window excluding the page display area. If omitted, a default color is used.

• -dec=<n>
  A specification of the window decoration to be added by the window manager. Possible values are:
      0 (or -no_dec) for no decoration at all,
      1 for full decoration (the default),
      >1 for custom decoration, see Window Decoration.

• -dim=<screen_xy>
  Define the dimensions of the window display area. This should be a two-element numeric array giving the width and height in pixels.

• -emb=<string>
  Embed the window into a container provided by an external client. <string> is the name of an embed container created by the embed command. If the embed container does not exist or is invalid, this switch is ignored.

• -fix
  Open the window fixed size, i.e. non-resizable. The default is the value of <window>.resizable.

• -geo=<screen_box>
  The geometry of the window in screen coordinates, either its position (a two-element array) or its full rectangle geometry (a four-element array). The default is the value of <window>.outrect.

• -gh
  The window should be initially ghosted, i.e. insensitive to user-interaction. The default is the value of <window>.ghosted.

• -ic
  Open the window in iconic form. The default is the value of <window>.open.

• -inv
  Open the window invisible. The default is the value of <window>.visibility.

• -mas
  Define the window as a master window. When a master window is iconized, this also iconizes all other windows.

• -mb
  Give the window a menubar for user buttons. If omitted, the window will be created without a menubar.

• -mf=<font>
  The font to be used for menubar text. This must be a fixed font. If omitted a default fixed font is used. This option has no effect on Windows systems, where menubar font and color are controlled by the window manager.

• -num
  Include the window slot number in the window’s title. Use -no_num to suppress it. The default behavior is governed by the value of the system numeric window_numbers.

• -ocol=<color>
  The other color for use in the window, excluding the page display area, e.g. for button text. If omitted, a default color is used.

• -pos=<screen_xy>
  The position of the window in screen coordinates. This is a two-element array. The default is the value of <window>.outrect[1:2].

• -sc
  Add scrollbars to the window. If omitted, the window will be created without scrollbars.

• -sh=<string>
  A shell name for communication with X application resources. If omitted, the value component is used.

• -tb
  Display the window icon in the Windows taskbar. The default behavior is not to display it in the taskbar but only to display it on the desktop when minimized. This switch has no meaning on Unix systems.

• -tit=<string>
  Provide a title for the window. The default is the value of <window>.title.

Notes

This window type is currently available only on Windows systems.

Not all external components can be housed in a window, e.g. xml objects, created by the xmlobj function, cannot.

Deleting a component window will automatically kill the external component housed within it.

Example

Display an ActiveX component in a new window. This is in fact the Windows Media Player complete with video window, controls etc.

wcomponent oleobj('WMPlayer.ocx')

See Also