Parts Reference


OLE Control properties

backgroundColor
The backgroundColor property is the name of the RGB color for the background of the part.

borderWidth
The borderWidth property is the width of the border, specified in pixels, that surrounds the part on all four sides. A width of zero means that a border does not show.

On some platforms, the border width is limited to 1 pixel and any nonzero value is set to 1.

clientName
The clientName property specifies the OLE class for the OLE object contained in the part. The OLE class name is of the form application.objecttype.version or objecttype.version where:

dragDropSpec (AbtDragDropSpec)
The dragDropSpec property specifies the drag and drop information for the part.

You can tear-off the dragDropSpec property to access its properties and events. If the part has a Drag/Drop tab in its Settings window, the drag and drop properties and events will be added to the part once you have selected either Allow drag or Allow drop in the part's Settings window.

The dragDropSpec property has the following properties for specifying drag and drop information:

canBeDragSource (Boolean)
Specifies whether the part can be the source of a drag operation. The source is where the drag is started.

canBeDragTarget (Boolean)
Specifies whether the part can be the target of a drag operation. The target is the part under the cursor during the drag.

defaultDragOperations (OrderedCollection)
Specifies the following default drag operations for the array of any or all elements, with the first elements having the highest priority:
  • XmMOVE
  • XmCOPY
  • XmLINK
  • XmILLEGAL

defaultDropOperations (OrderedCollection)
Specifies the following default drop operations for the array of any or all elements, with the first elements having the highest priority:
  • XmMOVE
  • XmCOPY
  • XmLINK
  • XmILLEGAL

dropAcceptableClassList (OrderedCollection)
Specifies a list of classes where instances can be added to the part for a drop operation.

The dragDropSpec property has the following drag and drop events, which all pass a callData parameter from which it gets information about the source, target, operation, and emphasis:

dragChanged
Signals to the source that the target or operation of the drag session has changed.

dragCompleteRequested
Signals to the source that the drag session has completed and requests that the source perform any necessary actions for the operation.

dragLeave
Signals to the target that the mouse pointer has left its bounding box during a drag session. You may want to use this for changing the target emphasis.

dragOver
Signals to the target that the mouse pointer is moving over it during a drag session. The target must fill in the vote field of the callData parameter with the operation acceptable with regard to the source items. See the defaultDropOperations attribute for acceptable vote values.

dragSourceCancelled
Signals to the source that the drag operation was cancelled.

dragStartRequested
Signals to the source that the drag session has started. The source items, images and offsets must be filled in the respective fields of the callData parameter.

dragTargetCancelled
Signals to the target that the drag operation was cancelled.

dropped
Signals to the target that the dragged items have been dropped and requests that the target perform any actions necessary for the drop operation.

enabled
The enabled property specifies whether or not the part is available for selection. If true, the part's contents are available for selection.

enableVerbsMenu
The enableVerbsMenu property specifies whether a popup menu containing the valid verbs for the contained OLE Control or OLE Client is automatically hooked to the OLE Control or OLE Client. If the menu attribute is set for the part, the enableVerbsMenu has no effect.

fontName
The fontName property is the name of the font to use for the text displayed in the part.

foregroundColor
The foregroundColor property is the name of the RGB color for the foreground of the part.

framingSpec
The framingSpec property represents the values specified for the edge specifications of the part. The edge specifications determine the width, height, and position of the part.

helpFile
The helpFile property is the name of the help file associated with the part.

helpKeysId
The helpKeysId property is the ID of the keys help associated with the part. The ID can be a string or an integer value.

The ID must exist in the help file associated with the part.

helpTitle
The helpTitle property is the title of the help window associated with the part.

helpTopicId
The helpTopicId property is the ID of the help topic associated with the part. The ID can be a string or an integer value.

The ID must exist in the help file associated with the part.

licenseKey
The licenseKey property specifies the licensing key to be used when creating an OCX. If the license key is nil, an OCX is created without attempting to license it. This results in failure if licensing is required. It cannot be changed after an OLE Control is created.

partName
The partName property specifies the name you want to use to describe the part. For nonvisual parts, this text appears under the icon for the part on the free-form surface.

The name of the part can consist of alphanumeric characters, and must be different from those of all other parts on the layout surface.

If you do not specify a part name, VisualAge generates a unique name based on the class name of the part.

tabGroup
The tabGroup property specifies whether or not the part is included as a tab stop so users can use the Tab and Backtab keys to access the part.

traversalOn
The traversalOn property specifies whether users can access the part using the cursor movement keys. If the part is specified as a tab stop by using the tabGroup property, users also can use the Tab and Backtab keys to access the part.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]