09/04/2007

Jorge Lopez
Original Author

E-Mail:
jorge.lopez@jrl-e.com

Using the Dockable ActiveX Control Container

The documentation is updated for use with AutoCAD 2007 or newer versions.

Using the Command Line

The application provides the “DOCKABLE_CONTAINER” command to create the docking ActiveX control container window. This command requires the ProgID or CLSID string of the ActiveX control to proceed. The ProgID is a string that uniquely identifies the ActiveX control.

For example, using the Microsoft Calendar control registered on your system:

Command: DOCKABLE_CONTAINER

ProgID of control: mscal.calendar

NOTE: The ActiveX control needs to be installed and registered with the system.

Using the Automation API

The figure above shows the relationship between the container window and the ActiveX control. The container window sizes the ActiveX control to fit its client area minus the grip bar if docked. The container window then makes available an Automation interface (IAcadDockableContainer) for the ActiveX control to have programmatic access to its properties and methods. If an ActiveX control wants access to this Automation interface, then it must implement the IRetrieveDockableContainer interface.

The container window will ask the ActiveX control for its IRetrieveDockableContainer interface immediately after it creates the control but before displaying it. If the control accepts the request, then the container calls the SetDockContainer() method of the interface and passes in an IAcadDockableContainter interface. The control can then keep this interface around if it wants to access the containers properties / methods at a later time or use it for initialization and discard it.

Below is an example of a VB implemented IRetrieveDockableContainer:

‘ Global variable so the interface can be used at a later time if needed.
Dim dockContainer As AcadDockableContainer
Implements IRetrieveDockableContainer

Private Sub IRetrieveDockableContainer_SetDockContainer(ByVal newVal As IAcadDockableContainer)
    ‘ Keep this interface around by assigning it to a global variable.
    Set dockContainer = newVal

    ‘ Allow docking only on the left and right sides of AutoCAD
    dockContainer.EnableDockPositions = acDockLeft + acDockRight

    ‘ We want the window to appear as a floating window the very first time.
    ‘ The size of the floating window is specified below.
    Dim rect(0 To 3) As Integer
    rect(0) = 50    ' left
    rect(1) = 50    ' top
    rect(2) = 300   ' right
    rect(3) = 300   ' bottom

    dockContainer.SetPreferredDockPosition acFloating, rect
End Sub

As the code sample shows, the implementation of SetDockContainer() is a great place to call EnableDockPositions and SetPreferredDockPosition(). This is because it is called only once after the ActiveX control is created and before it is displayed for the first time.

Included with this application are two sample ActiveX controls (DOCKTEST.OCX) which were created using Visual Basic 6.0. The entire source code for these controls are also included for reference. Use REGSVR32.EXE if you want to sample the controls without rebuilding the OCX. The two ProgIDs serviced by DOCKTEST.OCX are “Docktest.TestControl” and “Docktest.Dockbars.”

Automation API Reference

IAcadDockableContainer

Used by the ActiveX control to set / get property values or call methods on the ActiveX control container window.

IAcadDockableMenu

Used to add and remove items from the context menu.

IRetrieveDockableContainer

Used to retrieve the Automation interface for the dockable container window. Implemented by the ActiveX Control author.

IAcadDockableContainers

Used by the ActiveX control to set / get property values or call methods on the ActiveX control container window.

Constants

Disclaimer

THIS PROGRAM IS PROVIDED "AS IS" AND WITH ALL FAULTS. YOU ASSUME ALL RESPONSIBILITY WITH REGARDS TO THIS PROGRAM AND SOURCE CODE BY USING IT.

AutoCAD 2000 through 2008

Permission to use, copy, modify, and distribute this software in object code form for any purpose and without fee is hereby granted, provided that it does not break existing users of Accont.arx, Accont16.arx, Accont17.arx, Accont18.arx. You do this by changing the ARX and TLB file names, the registered command name, the registry key entries (both demand loading and COM support), and all the guids used.