IDocAddIn: The Document Add-in Interface

Warning: Microsoft Research reserves the right to alter, enhance or rescind any of these interfaces and capabilities at any time. Neither it nor Microsoft Corporation is liable for any loss or damages attendant to using the current interfaces nor any changes to such interfaces. All such usage is entirely unsupported.

Description

MSBNX Add-ins must implement this interface from MSBNx.exe. The interface consists of one property.

Usage

In Visual Basic:

Implements MsbnX.IDocAddIn

This syntax states that the add-in is contracted to implement the add-in interface. The name of the interface and the name(s) of the methods and properties of the declared interface will appear in the procedure drop-down lists at the top of the Visual Basic code document. For example:

Public Property Set IDocAddIn_DocIface(aDocIFace As DocIface)

Remarks

MSBNx initializes the addin by setting the DocIface property to a MSBNx document. MSBNx tells an addin that it is about to be killed by either 1) setting the DocIface property to Nothing, or 2) by having DocIface raise its Remove event.

An add-in can find its model via the DocIface property.

All other interaction is through ActiveX event interfaces. In other words, an add-in is passive. It must wait until something changes in a document, a model or the user requests a menu before it can interact with a user.

Properties

DocIface

Public Property Set DocIface(aDocIface As DocIface)

This property is used by MSBNx to give the add-in a reference to the document and, thereby, to its underlying model.