OLEControl control
An OLEControl placed in a window can contain an object,
such as a spreadsheet or word processing document, that was created
by an OLE-aware application. The PowerBuilder application’s
user can activate the object and edit it in the application in which
it was created (the server application).
OLE controls are displayed in the OLE tab of the Browser as
Insertable Objects.
For more information about using OLE in an
application, see Application Techniques.
Properties
OLEControl property |
Datatype |
Description |
---|---|---|
String |
A description of the control and/or |
|
String |
A label that briefly describes the control, |
|
AccessibleRole (enumerated) |
Describes what kind of user interface |
|
omActivation |
Specifies how the OLE object will be |
|
Long |
Specifies the numeric value of the background |
|
BinaryIndex |
Integer |
Internal use only. |
BinaryKey |
String |
Internal use only. |
Boolean |
Specifies whether the control has a border.
|
|
BorderStyle (enumerated) |
Specifies the style of the border of
|
|
Boolean |
Specifies whether PowerBuilder moves
|
|
ClassDefinition |
PowerObject |
An object of type PowerObject containing |
ClassLongName |
String |
(Read-only) The long name for the server |
ClassShortName |
String |
(Read-only) The short name for the server |
omContentsAllowed |
Specifies whether the OLE object in the |
|
String |
User-readable name for your OLE control |
|
omDisplayType |
Specifies how the OLE object will be |
|
DocFileName |
String |
(Read-only) The name of the file containing |
Boolean |
Specifies whether PowerBuilder puts the
|
|
String |
Specifies the name of the stock icon When the user drags the control, the icon displays when the control |
|
Boolean |
Specifies whether the control is enabled
|
|
Boolean |
Specifies whether a dotted rectangle
|
|
Integer |
Specifies the height of the control, |
|
IsDragTarget |
Boolean |
Specifies whether an OLE object can be
|
LinkItem |
String |
(Read-only) The entire link name of the |
omLinkUpdate |
Specifies how a linked object in the |
|
Object |
omObject |
Used in scripts to apply server commands |
ObjectData |
Blob |
If the object is embedded, the object If the object is linked, this property contains the link information |
ParentStorage |
omStorage |
(Read-only) Specifies the parent storage. |
String |
Specifies the name of the stock pointer |
|
Boolean |
Specifies whether the control is resizable.
|
|
SizeMode |
SizeMode |
Specifies the size mode for the OLE document.
|
Integer |
Specifies tab value of the control within |
|
String |
Specifies the tag value assigned to the |
|
Boolean |
Specifies whether the control is visible.
|
|
Integer |
Specifies the width of the control, in |
|
Integer |
Specifies the X position (the distance |
|
Integer |
Specifies the Y position (the distance |
Events
OLEControl event |
Occurs |
---|---|
When the control is clicked (selected |
|
Just before a window is removed from |
|
Immediately before the Open event occurs |
|
When the server application notifies |
|
Immediately after the Close event occurs |
|
When the control is double-clicked (and |
|
When a dragged control is dropped on |
|
When a dragged control enters the control |
|
When a dragged control leaves the control |
|
When a dragged control is within the |
|
During OLE automation when an error occurs |
|
During OLE automation when the OLE server |
|
Just before the control receives focus |
|
When the user presses the F1 key or drags |
|
When the control loses focus (becomes |
|
When an operating environment message |
|
When an OLE Server supporting notifications |
|
When an OLE Server supporting notifications |
|
When the right mouse button is pressed |
|
When the server application notifies |
|
When the server application notifies |
|
When the server application saves the |
|
When the server application notifies |
Functions
OLEControl function |
Datatype returned |
Description |
---|---|---|
Integer |
Activates the object server either in |
|
String |
Returns the name assigned to the control |
|
Integer |
Releases the OLE object and deletes references |
|
Integer |
Copies the contents of the control to |
|
Integer |
Copies the contents of the control to |
|
Integer |
Executes the specified verb |
|
Integer |
Puts the object into drag mode |
|
Integer |
Creates a reference to a context-specific |
|
Integer |
Returns data in a caller-supplied format |
|
Integer |
Returns a pointer to the underlying OLE |
|
PowerObject |
Returns a reference to the name of the |
|
Integer |
Makes the control invisible |
|
Integer |
Inserts a new object created from a class |
|
Integer |
Inserts a new object where the source |
|
Integer |
Presents the user with a standard dialog |
|
Integer |
Links to a file and (optionally) an item |
|
Integer |
Moves the control to a specified location |
|
Integer |
Opens a document file and loads the object |
|
Integer |
Pastes the contents of the clipboard |
|
Integer |
Pastes a link to the contents of the |
|
Integer |
Presents a dialog box allowing the user |
|
Integer |
Returns the distance of the pointer from |
|
Integer |
Returns the distance of the pointer from |
|
Boolean |
Adds an event to the end of the message |
|
Integer |
Prints the control |
|
Integer |
Releases the pointer to the underlying |
|
Integer |
Changes the size of the control |
|
Integer |
Saves an object previously loaded from |
|
Integer |
Saves the contained object as a member |
|
Integer |
Sets the internal state of the control |
|
Integer |
Sends data in a caller-supplied format |
|
Integer |
Sets focus to the control |
|
Integer |
Specifies the position of the control |
|
Integer |
Controls automatic redrawing of the control |
|
Integer |
Makes the control visible |
|
Integer |
Triggers a specific event for the control |
|
Object |
Returns the type of the control |
|
Integer |
Invokes the OLE dialog to update link |