The IAddin Interface

.NET Customisation User Guide

.NET Customisation : How to Write a CAF Addin : The IAddin Interface

What distinguishes an addin from any other .NET assembly is that an addin must contain a class which implements the IAddin interface. When the CAF loads and starts an addin it interrogates the assembly for the class which implements this interface, creates an instance of this class and calls the IAddin.Start method.

The following code is a simple example of a class which implements the IAddin interface.

This is the AttributeBrowserAddin.cs file which is part of the AttributeBrowserAddin sample project which can be found in the samples directory. The Start method performs the initialization of the Addin.

using System;

using System.Collections.Generic;

using System.Text;

// Add additional using statements

using Aveva.ApplicationFramework;

using Aveva.ApplicationFramework.Presentation;

namespace Aveva.Presentation.AttributeBrowserAddin

{

    public class AttributeBrowserAddin : IAddin

{

        #region IAddin Members

        public string Description

{

get

{

                return "Provides a simple attribute browser";

}

}

        public string Name

{

get

{

                return "AttributeBrowserAddin";

}

}

        public void Start(ServiceManager serviceManager)

{

            // Create Addins Windows

            // Get the WindowManager service

            WindowManager windowManager = (WindowManager)serviceManager.GetService(typeof(WindowManager));

            // Create a docked window to host an AttributeListControl

            DockedWindow attributeListWindow = windowManager.CreateDockedWindow("Aveva.AttributeBrowser.AttributeList", "Attributes", new AttributeListControl(), DockedPosition.Right);

            // Docked windows created at addin start should ensure their layout is saved between sessions.

            attributeListWindow.SaveLayout = true;

            // Create and register addins commands

            // Get the CommandManager

            CommandManager commandManager = (CommandManager)serviceManager.GetService(typeof(CommandManager));

            ShowAttributeBrowserCommand showCommand = new ShowAttributeBrowserCommand(attributeListWindow);

            commandManager.Commands.Add(showCommand);

}

        public void Stop()

{

}

        #endregion

}

}

Figure 2:2.

AttributeBrowserAddin Sample - AttributeBrowserAddin.cs