OleBox

OleBox

OleBox(name~aliasName, flags, x, y, w, h, type)

Parameters

Parameters		Description
name	*	Identifier or CLASS::expr
aliasName		an additional identifier
flags		Flags
x	*	Position X (in minicells)
y	*	Position Y (in Minicells)
w	*	Width (in minicells)
h	*	Height (in minicells)
Type		Permissible OLE types (ProgID)

• - Required parameter

The tuple (class, access expression) defines an image on model data (see FillWindow, DrainWindow). Objects of type CX_COM_OBJECT and CX_MULTIPLE_COM_OBJECT are supported. If a CX_MULTIPLE_COM_OBJECT is filled into an OleBox, only the currently set language is displayed.

To display an OLE object, a suitable OLE server must be installed on the computer.

An OleBox accepts drops of OLE objects. For example, you can drag an MS Word file or a section of an MS Excel spreadsheet into an OleBox. By specifying a type in the OleBox statement, you can limit the types of documents allowed. If no type is specified, every OLE object is accepted. OleTypes correspond to the Prog IDs in the registry, e.g. "Word.Document" or "Excel.Sheet.8". If a version-independent specification is made as type, all objects of this type are accepted regardless of the version number. Thus, for example, objects of the type "Word.Document.8" or "Word.Document.9" are accepted if the type is specified as "Word.Document".

By double-clicking on a displayed OLE object, the corresponding application is started and the OLE object can be edited in it.

The following messages are sent by an OleBox:

Message	Description
ALERT	Data has been changed, see general ALERTinstruction
DOUBLE_CLICK	Double click with left mouse button
OLE_WRONG_TYPE	An attempt was made to fill an OLE object of the wrong type into the OleBox (Drag & Drop)
OLE_SAVE	The OLE document was saved by the server application (e.g. when the save button was pressed)

Flags

Flag	Description
AUTODRAIN	If an OLE object is filled into the OleBox using FillWindow or Put and the AUTODRAIN flag is set, all changes to this object are automatically written to the original object. If the original object is persistent, a transaction is opened automatically. If AUTODRAIN is not specified, the OleBox creates a copy of the transferred object and works on it.
HIDDEN	The OleBox will remain invisible until the Show instruction makes it appear on the screen.
MIN_HEIGHT(h)	The height of the widget never falls below the value h (specified in minicells). This is especially useful in combination with attachments.
MIN_WIDTH(w)	Width of the widget never falls below the value w (specified in minicells). This is especially useful in combination with attachments.
TOOLTIP(mlString)	The specified string is displayed as a tooltip or, if an event TOOLTIP is also defined, is passed to it. The tooltip is automatically triggered by the system after a certain period of time when the mouse cursor remains over the window object. The string can be multilingual. The current language is passed to the event.
HELP(anchor) Help("file~anchor")	connects the window object with online help in HTML format. If no file name is specified, the HTML file specified in the module applies.
HELP(s)	If you prefer to use the platform's help system (OS/2 PM, MS Windows), enter an integer n which refers to the corresponding help window. Where n must be < 40000. Note: HTML is recommended as the online help for InstantView® application for portability reasons.