3.6 The DUIM-OLE-SERVER module

<embeddable-frame>

Open abstract class

Summary

The class of DUIM applications that can be used as OLE compound document servers.

Superclasses

<simple-frame>

Init-keywords

class-id:

The COM Class ID that identifies the object the server provides. Required. This ID can be represented either as a string of 32 hexadecimal digits in the following format

"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"

That is, where each x is a hexadecimal digit. For example:

"{e90f09e0-43db-11d0-8a04-02070119f639}"

Alternatively, the ID can be a <REFCLSID>, as returned from make-GUID.

You can get the ID value by generating a GUID with Functional Developer's create-id utility. See "Creating GUID numbers" on page 129.

object-title:

If the container application has an Insert Object dialog, this optional string argument will be used as the title of the COM object that your application serves. If this argument is not provided, the inherited DUIM frame title: is used instead.

At least one of title: and object-title: must be supplied for the application to be able to register itself. The object title should be unique, since if two servers are registered with the same title, only one will be accessible from the Insert Object dialog box.

short-title:

A string used as the program name in container menus and the Links dialog box. It must not be more than 15 characters long. If not specified, it defaults to the shorter of title: or object-title:, truncated to 15 characters if necessary.

prog-id:

The server application's programmatic identifier (prog ID). The prog ID is a string which is used internally and is only visible in the Registry Editor. If specified, it must start with a letter; it cannot contain any spaces or punctuation except period; and it must not be more than 39 characters long. It must be different from the ID of any other application. If not specified, a default value is created automatically using portions of the title and class ID.

Library

duim-ole-server

Module

duim-ole-server

Description

The class of DUIM applications that can be used as OLE compound document servers. Use it as the superclass of your DUIM application.

The three optional keyword parameters are used only during self-registration. You can override them by entering different values into the Windows registry by hand. If you need more control over registration, write override methods on the generic functions frame-register-server and frame-unregister-server; each takes the frame instance as its single argument.

None of this information is used to register OLE Controls written with the DUIM-OLE-Control library, since registration and instantiation is not controlled by the frame.