Development Environment - STARIONGROUP/COMET-IME-Community-Edition GitHub Wiki

Visual Studio 2022

The CDP4-COMET-IME is developed using Visual Studio 2022.

Nuget

Nuget is used to manage the CDP4-COMET-IME dependencies. These dependencies are available on nuget.org. The CDP4-COMET-SDK, which is the foundation of the CDP4-COMET-IME is available on nuget as well.

DevExpress

Note 1: Solution will not build without configuring DevExpress NuGet feed.

Note 2: The DevExpress Component libraries must be installed using the DevExpress installer. This provides both design time editing capability in Visual Studio and registers the components in the GAC which is required for Addin development and debugging.

DevExpress is a commercial offering of UI controls. The CDP4-COMET-IME makes use of the DevExpress WPF UI Controls.

Although, you need to add your devexpress nuget feed to your global (not solution!) Sources.

  • Get your nuget feed url from your account on DevExpress.com
  • Find your global NuGet.Config here => %AppData%\Roaming\NuGet
  • Add the devepress package source.
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
    <add key="devexpress" value="https://nuget.devexpress.com/YOURTOKEN/api" protocolVersion="3" />
  </packageSources>
</configuration>

CDP4-COMET Addin Development

In order to perform Addin development the following needs to be done:

  • Make sure the DevExpress components are installed using the DevExpress installer. This will place the components in the Global Assembly Cache (GAC) which is required for the Addin to function properly.
  • Run Visual Studio as Administrator and build the complete solution. Running Visual Studio as administrator is required to register the addin in the windows registry
  • Once built, Register the CDP4AddinCE.dll using Microsoft's REGASM tool. Make sure to use either the 32 or 64 bit tool depending on the bitness of your Microsoft Office installation

When you are using 32 bit Excel: "%Windir%\Microsoft.NET\Framework\v4.0.30319\regasm" "CDP4AddinCE.dll" /tlb /codebase

When you are using 64 bit Excel: "%Windir%\Microsoft.NET\Framework64\v4.0.30319\regasm" "CDP4AddinCE.dll" /tlb /codebase

Be sure to run these commands in local Admin mode and the selected directory is the directory that contains CDP4AddinCE.dll