Как создать надстройку автоматизации в реальном времени в C# с помощью RtdServer?

Мне было поручено написать надстройку для автоматизации Excel в режиме реального времени на C#, используя RtdServer для работы. Я сильно полагался на знания, с которыми я столкнулся в Stack Overflow. Я решил выразить свою благодарность, написав, как документ, который связывает воедино все, что я узнал. RTD-серверы Excel Кенни Керра : статья о минимальной реализации C# помогла мне начать работу. Особенно полезными оказались комментарии Mike Rosenblum и Govert.

Источник

3 ответа

Решение

(В качестве альтернативы подходу, описанному ниже, вам следует рассмотреть возможность использования Excel-DNA. Excel-DNA позволяет вам создать RTD-сервер без регистрации. COM-регистрация требует административных привилегий, которые могут привести к головным болям при установке. При этом код ниже работает отлично.)

Чтобы создать надстройку автоматизации в реальном времени в C# с помощью RtdServer:

1) Создайте проект библиотеки классов C# в Visual Studio и введите следующее:

using System;
using System.Threading;
using System.Collections.Generic;
using System.Runtime.InteropServices;
using Microsoft.Office.Interop.Excel;

namespace Stackru
{
    public class Countdown
    {
        public int CurrentValue { get; set; }
    }

    [Guid("EBD9B4A9-3E17-45F0-A1C9-E134043923D3")]
    [ProgId("Stackru.RtdServer.ProgId")]
    public class RtdServer : IRtdServer
    {
        private readonly Dictionary<int, Countdown> _topics = new Dictionary<int, Countdown>();
        private Timer _timer;

        public int ServerStart(IRTDUpdateEvent rtdUpdateEvent)
        {
            _timer = new Timer(delegate { rtdUpdateEvent.UpdateNotify(); }, null, TimeSpan.Zero, TimeSpan.FromSeconds(5));
            return 1;
        }

        public object ConnectData(int topicId, ref Array strings, ref bool getNewValues)
        {
            var start = Convert.ToInt32(strings.GetValue(0).ToString());
            getNewValues = true;

            _topics[topicId] = new Countdown { CurrentValue = start };

            return start;
        }

        public Array RefreshData(ref int topicCount)
        {
            var data = new object[2, _topics.Count];
            var index = 0;

            foreach (var entry in _topics)
            {
                --entry.Value.CurrentValue;
                data[0, index] = entry.Key;
                data[1, index] = entry.Value.CurrentValue;
                ++index;
            }

            topicCount = _topics.Count;

            return data;
        }

        public void DisconnectData(int topicId)
        {
            _topics.Remove(topicId);
        }

        public int Heartbeat() { return 1; }

        public void ServerTerminate() { _timer.Dispose(); }

        [ComRegisterFunctionAttribute]
        public static void RegisterFunction(Type t)
        {
            Microsoft.Win32.Registry.ClassesRoot.CreateSubKey(@"CLSID\{" + t.GUID.ToString().ToUpper() + @"}\Programmable");
            var key = Microsoft.Win32.Registry.ClassesRoot.OpenSubKey(@"CLSID\{" + t.GUID.ToString().ToUpper() + @"}\InprocServer32", true);
            if (key != null)
                key.SetValue("", System.Environment.SystemDirectory + @"\mscoree.dll", Microsoft.Win32.RegistryValueKind.String);
        }

        [ComUnregisterFunctionAttribute]
        public static void UnregisterFunction(Type t)
        {
            Microsoft.Win32.Registry.ClassesRoot.DeleteSubKey(@"CLSID\{" + t.GUID.ToString().ToUpper() + @"}\Programmable");
        }
    }
}

2) Щелкните правой кнопкой мыши по проекту и выберите "Добавить"> "Новый элемент"> "Класс установщика". Переключитесь в режим просмотра кода и введите следующее:

using System.Collections;
using System.ComponentModel;
using System.Diagnostics;
using System.Runtime.InteropServices;

namespace Stackru
{
    [RunInstaller(true)]
    public partial class RtdServerInstaller : System.Configuration.Install.Installer
    {
        public RtdServerInstaller()
        {
            InitializeComponent();
        }

        [System.Security.Permissions.SecurityPermission(System.Security.Permissions.SecurityAction.Demand)]
        public override void Commit(IDictionary savedState)
        {
            base.Commit(savedState);

            var registrationServices = new RegistrationServices();
            if (registrationServices.RegisterAssembly(GetType().Assembly, AssemblyRegistrationFlags.SetCodeBase))
                Trace.TraceInformation("Types registered successfully");
            else
                Trace.TraceError("Unable to register types");
        }

        [System.Security.Permissions.SecurityPermission(System.Security.Permissions.SecurityAction.Demand)]
        public override void Install(IDictionary stateSaver)
        {
            base.Install(stateSaver);

            var registrationServices = new RegistrationServices();
            if (registrationServices.RegisterAssembly(GetType().Assembly, AssemblyRegistrationFlags.SetCodeBase))
                Trace.TraceInformation("Types registered successfully");
            else
                Trace.TraceError("Unable to register types");
        }

        public override void Uninstall(IDictionary savedState)
        {
            var registrationServices = new RegistrationServices();
            if (registrationServices.UnregisterAssembly(GetType().Assembly))
                Trace.TraceInformation("Types unregistered successfully");
            else
                Trace.TraceError("Unable to unregister types");

            base.Uninstall(savedState);
        }
    }
}

3) Щелкните правой кнопкой мыши свойства проекта и отметьте следующее: Приложение> Информация о сборке...> Сделать сборку видимой и сделать сборку> Зарегистрироваться для взаимодействия COM

3.1) Щелкните правой кнопкой мыши на проекте Add Reference...>.NET tab> Microsoft.Office.Interop.Excel

4) Построить решение (F6)

5) Запустите Excel. Перейдите в Параметры Excel> Надстройки> Управление надстройками Excel> Автоматизация и выберите "Stackru.RtdServer"

6) Введите "=RTD("Stackru.RtdServer.ProgId",,200)" в ячейку.

7) Скрестите пальцы и надейтесь, что это работает!

Источник

Вызов UpdateNotify из потока таймера в конечном итоге приведет к странным ошибкам или отключениям от Excel.

Метод UpdateNotify() должен вызываться только из того же потока, который вызывает ServerStart(). Это не документировано в справке RTDServer, но это ограничение COM.

Исправить это просто. Используйте DispatcherSynchronizationContext для захвата потока, который вызывает ServerStart, и используйте его для отправки вызовов UpdateNotify:

public class RtdServer : IRtdServer
{
    private IRTDUpdateEvent _rtdUpdateEvent;
    private SynchronizationContext synchronizationContext;

    public int ServerStart( IRTDUpdateEvent rtdUpdateEvent )
    {
        this._rtdUpdateEvent = rtdUpdateEvent;
        synchronizationContext = new DispatcherSynchronizationContext();
        _timer = new Timer(delegate { PostUpdateNotify(); }, null, TimeSpan.Zero, TimeSpan.FromSeconds(5));
        return 1;
    }


    // Notify Excel of updated results
    private void PostUpdateNotify()
    {
        // Must only call rtdUpdateEvent.UpdateNotify() from the thread that calls ServerStart.
        // Use synchronizationContext which captures the thread dispatcher.
        synchronizationContext.Post( delegate(object state) { _rtdUpdateEvent.UpdateNotify(); }, null);
    }

    // etc

}

Источник

После двух предыдущих ответов для RTD-сервера у меня сработало. Однако, я столкнулся с проблемой, когда на машине x64 работает Excel x64. В моем случае, пока я не переключил "целевую платформу" проекта на x64, Excel всегда показывал #N/A.

Источник
Другие вопросы по тегам