Activate

Description

Activates the object in an OLE container, allowing the user to work with the object using the server’s commands.

Applies to

OLE controls and OLE DWObjects (objects within a DataWindow object that is within a DataWindow control)

Syntax

objectref.Activate ( activationtype )

Argument

Description

objectref

The name of the OLE control or the fully qualified name of a OLE DWObject within a DataWindow control that contains the object you want to activate.

The fully qualified name for a DWObject has this syntax:

dwcontrol.Object.dwobjectname

activationtype (optional)

A value of the enumerated datatype omActivateType specifying where the user will work with the OLE object. Values are:

  • InPlace! – (Default) The object is activated within the control. The subset of menus provided by the server application are merged with the PowerBuilder application’s menus.

  • OffSite! – The object is activated in the server application, which gives the user access to more of the server application’s functionality.

    For the OLE control, activationtype is required.

Returns

Integer. Returns 0 if it succeeds and one of the following negative values if an error occurs:

If any argument’s value is null, Activate returns null.

Examples

Example 1

This example activates the object in ole_1 in the server application:

integer result

result = ole_1.Activate(OffSite!)

Example 2

This example activates the OLE DWObject ole_graph in the DataWindow control dw_1 in the Microsoft Graph server application:

integer result

result = dw_1.Object.ole_graph.Activate(OffSite!)

See also