The features described in this topic are obsolete
and should not be used in new IDL code.

Properties

Properties are used to specify the various attributes of an IDLDrawWidget, such as its color, width and height. Most properties may be set at design time by configuring the properties sheet in Visual Basic, or at runtime by executing statements in the program code.

The syntax for setting a property in the code is:

object.property = value

where

object is the name of the object you want to change (e.g. IDLDrawWidgetn where n is the number Visual Basic assigned to the IDLDrawWidget)

property is the characteristic you want to change

value is the new property setting

Note
All properties relating to window size and/or position are in pixel units unless otherwise indicated.

BackColor

This property specifies the background color of the IDL widget. BackColor may be specified at design time or runtime.

BaseName

This property names a variable that IDL will use for the pseudo base. If this property is set, the IDLDrawWidget will create an IDL variable with this name that contains the ID of the base widget. Because the base widget is a pseudo base, you should not destroy it. The BaseName property can be set at design time or at runtime prior to a call to CreateDrawWidget.

The default value is IDLDrawWidgetBase.

BufferId

The BufferId controls the type of print output you receive when printing with an Object Graphics window (when the GraphicsLevel property is set to 2).

A value of -1 will cause the graphics to print using vector output. This format is suitable for line graphs and mesh surfaces.

A value of 0 will cause the graphics to print at roughly two times the screen resolution. This format is suitable for shaded surfaces or vertex colored mesh surfaces. This is the default.

A value greater then 0 will be construed a s an IDLgrBuffer object reference whose data will be used for printing. This format allows the programmer to control the resolution of the output of the image.

For more information, see "IDLgrBuffer" (IDL Reference Guide).

Note
You must set the GRAPHICS_TREE property of the IDLgrWindow object for these print options to work.

DrawWidgetName

Returns or sets a variable that IDL will use for the draw widget. If this property is set, the IDLDrawWidget will create an IDL variable with this name that contains the ID of the draw widget. The DrawWidgetName property can be set at design time, or at runtime prior to a call to CreateDrawWidget.

The default value is IDLDrawWidget.

Enabled

Returns or sets a value that determines whether a form or control can respond to user-generated events such as mouse events.

The default value is TRUE.

GraphicsLevel (Runtime/Design time)

This property specifies the graphics level of the draw widget. Legal values are 1 or 2. If you set GraphicsLevel=1 and call the CreateDrawWidget method, the procedure will create an IDL direct graphics window. GraphicsLevel=2 results in an IDL object graphics window. The GraphicsLevel property can be set at design time or at runtime prior to a call to CreateDrawWidget.

The default value is 1.

IdlPath

This property specifies the fully qualified path to the IDL.DLL. The IdlPath property can be set at design time or at runtime prior to a call to InitIDL or SetOutputWnd.

The default value is NULL.

Renderer

This property specifies either the software or hardware renderer for object graphics windows is to be used. It has no effect if the GraphicsLevel property is set to 1. Valid values are:


0	Platform native OpenGL
1	IDL's software implementation

By default, the setting in your IDL preferences is used.

Retain (Runtime/Design time)

This property sets the retain mode of the IDLDrawWidget: 0, 1, or 2. The retain mode specifies how IDL should handle backing store for the draw widget. Retain=0 specifies no backing store. Retain=1 requests that the server or window system provide backing store. Retain=2 specifies that IDL provide backing store directly. The Retain property can be set at design time or at runtime prior to a call to CreateDrawWidget.

The default value is 1.

Visible (Runtime/Design time)

Shows or hides the IDLDrawWidget. When Visible is TRUE, the IDLDrawWidget is shown; when FALSE, the IDLDrawWidget is hidden. Hiding the IDLDrawWidget is useful when the control is used as an interface to IDL and no graphics are intended for display.

The default value is TRUE.

Xsize (Design time)

Virtual width of IDLDrawWidget. If this value is greater than the Xviewport value, scroll bars will be added.

Ysize (Design time)

Virtual height of IDLDrawWidget. If this value is greater than the Yviewport value, scroll bars will be added.