Jak utworzyć serwer RealTimeData dla programu Excel

  • Artykuł
  • Dotyczy:
    Microsoft Excel

Podsumowanie

Program Microsoft Excel udostępnia nową funkcję arkusza RTD, która umożliwia wywoływanie serwera automatyzacji modelu obiektów składników (COM) w celu pobierania danych w czasie rzeczywistym. W tym artykule opisano sposób używania języka Visual Basic do tworzenia serwera RealTimeData do użycia z funkcją RTD programu Excel.

Więcej informacji

Funkcja arkusza RTD ma następującą składnię:

=RTD(ProgID,Server,String1,[String2],...)

Pierwszy argument, ProgID, reprezentuje identyfikator programowy (ProgID) serwera RealTimeData. Argument Serwer wskazuje nazwę maszyny, na której jest uruchamiany serwer RealTimeData; Ten argument może być ciągiem o wartości null lub pominiętym, jeśli serwer RealTimeData ma być uruchamiany lokalnie. Pozostałe argumenty po prostu reprezentują parametry do wysłania na serwer RealTimeData; Każda unikatowa kombinacja tych parametrów reprezentuje jeden "temat", który ma skojarzony "identyfikator tematu". Parametry uwzględniają wielkość liter. Na przykład poniżej przedstawiono wywołania serwera RTD, które mogłyby spowodować utworzenie trzech oddzielnych identyfikatorów tematów:

=RTD("ExcelRTD.RTDFunctions",,"AAA", "10")

=RTD("ExcelRTD.RTDFunctions",,"AAA", "5")

=RTD("ExcelRTD.RTDFunctions",,"aaa", "5")

Aby serwer automatyzacji COM był serwerem RealTimeData do użycia z funkcją RTD programu Excel, musi zaimplementować interfejs IRTDServer. Serwer musi zaimplementować wszystkie metody IRTDServer:

  • ServerStart: wywoływane, gdy program Excel żąda pierwszego tematu RTD dla serwera. Program ServerStart powinien zwracać wartość 1 w przypadku powodzenia i wartość ujemną lub wartość 0 w przypadku niepowodzenia. Pierwszym parametrem metody ServerStart jest obiekt wywołania zwrotnego używany przez serwer RealTimeData do powiadamiania programu Excel o konieczności zbierania aktualizacji z serwera RealTimeData.

  • ServerTerminate: wywoływane, gdy program Excel nie wymaga już tematów RTD z serwera RealTimeData.

  • ConnectData: wywoływane za każdym razem, gdy program Excel zażąda nowego tematu RTD z serwera RealTimeData.

  • DisconnectData: wywoływane za każdym razem, gdy program Excel nie wymaga już określonego tematu.

  • Puls: wywoływany przez program Excel, jeśli od czasu ostatniego powiadomienia programu Excel o aktualizacjach z serwera RealTimeData upłynął określony interwał.

  • RefreshData: wywoływane, gdy program Excel żąda odświeżenia w tematach. Funkcja RefreshData jest wywoływana po tym, jak serwer powiadomi program Excel o istnieniu aktualizacji i zwróci liczbę tematów do zaktualizowania wraz z identyfikatorem tematu i wartością dla każdego tematu.

Tworzenie przykładowego serwera RealTimeData

W poniższym przykładzie pokazano, jak utworzyć serwer RealTimeData i używać go w programie Microsoft Excel 2002. Ten serwer po prostu udostępnia licznik, który jest aktualizowany co 10 sekund w arkuszu. Serwer akceptuje maksymalnie dwa ciągi tematów. Pierwszy ciąg tematu może być AAA, BBB i CCC; dowolny inny ciąg tematu jest uznawany za nieprawidłowy, a serwer zwraca #VALUE! do funkcji RTD. Drugi ciąg to wartość liczbowa reprezentująca sposób zwiększania wartości zwracanej. Jeśli drugi ciąg zostanie pominięty, wartość inkrementacji zostanie domyślnie ustawiona na 1. Jeśli drugi ciąg nie jest liczbowy, serwer zwraca #NUM! do funkcji RTD.

  1. Uruchom nowy projekt biblioteki DLL ActiveX w visual basic.

  2. W menu Projekt kliknij pozycję Odwołania, wybierz bibliotekę obiektów dla swojej wersji programu Excel, a następnie kliknij przycisk OK. Na przykład wybierz jedną z następujących opcji:

    • W przypadku programu Microsoft Office Excel 2007 wybierz pozycję Biblioteka obiektów programu Microsoft Excel 12.0.
    • W przypadku programu Microsoft Office Excel 2003 wybierz pozycję Biblioteka obiektów programu Microsoft Excel 11.0.
    • W przypadku programu Microsoft Excel 2002 wybierz pozycję Biblioteka obiektów programu Microsoft Excel 10.0.

  3. W menu Project (Projekt) kliknij pozycję Project1 Properties (Właściwości projektu 1). Zmień nazwę projektu na ExcelRTD, a następnie kliknij przycisk OK.

  4. Zmień właściwość Nazwa modułu klasy Class1 na RTDFunctions. Dodaj następujący kod do funkcji RTDFunctions:

    Option Explicit

Implements IRtdServer  'Interface allows Excel to contact this RealTimeData server

Private m_colTopics As Collection

Private Function IRtdServer_ConnectData(ByVal TopicID As Long, Strings() As Variant, GetNewValues As Boolean) As Variant
    '** ConnectData is called whenever a new RTD topic is requested

'Create a new topic class with the given TopicId and string and add it to the
    'm_colTopics collection
    Dim oTopic As New Topic
    m_colTopics.Add oTopic, CStr(TopicID)
    oTopic.TopicID = TopicID
    oTopic.TopicString = Strings(0)
    If UBound(Strings) >= 1 Then oTopic.SetIncrement Strings(1)

'For this example, the initial value for a new topic is always 0
    IRtdServer_ConnectData = oTopic.TopicValue

Debug.Print "ConnectData", TopicID
End Function

Private Sub IRtdServer_DisconnectData(ByVal TopicID As Long)
   '** DisconnectData is called whenever a specific topic is not longer needed

'Remove the topic from the collection
   m_colTopics.Remove CStr(TopicID)

Debug.Print "DisconnectData", TopicID
End Sub

Private Function IRtdServer_Heartbeat() As Long
    '** Called by Excel if the heartbeat interval has elapsed since the last time
    '   Excel was called with UpdateNotify.
    Debug.Print "HeartBeat"
End Function

Private Function IRtdServer_RefreshData(TopicCount As Long) As Variant()
    '** Called when Excel is requesting a refresh on topics. RefreshData will be called
    '   after an UpdateNotify has been issued by the server. This event should:
    '   - supply a value for TopicCount (number of topics to update)
    '   - return a two dimensional variant array containing the topic ids and the
    '     new values of each.

Dim oTopic As Topic, n As Integer
    ReDim aUpdates(0 To 1, 0 To m_colTopics.Count - 1) As Variant
    For Each oTopic In m_colTopics
        oTopic.Update
        aUpdates(0, n) = oTopic.TopicID
        aUpdates(1, n) = oTopic.TopicValue
        n = n + 1
    Next
    TopicCount = m_colTopics.Count
    IRtdServer_RefreshData = aUpdates

Debug.Print "RefreshData", TopicCount & " topics updated"
End Function

Private Function IRtdServer_ServerStart(ByVal CallbackObject As Excel.IRTDUpdateEvent) As Long
    '** ServerStart is called when the first RTD topic is requested

Set oCallBack = CallbackObject
    Set m_colTopics = New Collection
    g_TimerID = SetTimer(0, 0, TIMER_INTERVAL, AddressOf TimerCallback)
    If g_TimerID > 0 Then IRtdServer_ServerStart = 1       'Any value <1 indicates failure.

Debug.Print "ServerStart"
End Function

Private Sub IRtdServer_ServerTerminate()
    '** ServerTerminate is called when no more topics are needed by Excel.

KillTimer 0, g_TimerID

'** Cleanup any remaining topics. This is done here since 
    '   IRtdServer_DisconnectData is only called if a topic is disconnected 
    '   while the book is open. Items left in the collection when we terminate
    '   are those topics left running when the workbook was closed.

Dim oTopic As Topic
    For Each oTopic In m_colTopics
        m_colTopics.Remove CStr(oTopic.TopicID)
        Set oTopic = Nothing
    Next

Debug.Print "ServerTerminate"

End Sub

  5. W menu Project (Projekt) kliknij pozycję Dodaj moduł klasy. Zmień właściwość Nazwa modułu klasy na Temat i zmień właściwość Instancing na Prywatna. Dodaj następujący kod do modułu Klasa tematu:

    Option Explicit

Private m_TopicID As Long
Private m_TopicString As String
Private m_Value As Variant
Private m_IncrementVal As Long

Private Sub Class_Initialize()
    m_Value = 0
    m_IncrementVal = 1
End Sub

Friend Property Let TopicID(ID As Long)
    m_TopicID = ID
End Property

Friend Property Get TopicID() As Long
    TopicID = m_TopicID
End Property

Friend Property Let TopicString(s As String)
    s = UCase(s)
    If s = "AAA" Or s = "BBB" Or s = "CCC" Then
        m_TopicString = s
    Else
        m_Value = CVErr(xlErrValue) 'Return #VALUE if not one of the listed topics
    End If
End Property

Friend Sub Update()
    On Error Resume Next 'the next operation will fail if m_Value is an error (like #NUM or #VALUE)
    m_Value = m_Value + m_IncrementVal
End Sub

Friend Sub SetIncrement(v As Variant)
    On Error Resume Next
    m_IncrementVal = CLng(v)
    If Err <> 0 Then
        m_Value = CVErr(xlErrNum) 'Return #NUM if Increment value is not numeric
    End If
End Sub

Friend Property Get TopicValue() As Variant
    If Not (IsError(m_Value)) Then
        TopicValue = m_TopicString & ": " & m_Value
    Else
        TopicValue = m_Value
    End If
End Property

  6. W menu Project (Projekt) wybierz pozycję Dodaj moduł. Dodaj następujący kod do nowego modułu:

    Public Declare Function SetTimer Lib "user32" (ByVal hWnd As Long, _
ByVal nIDEvent As Long, ByVal uElapse As Long, ByVal lpTimerFunc As Long) As Long

Public Declare Function KillTimer Lib "user32" (ByVal hWnd As Long, ByVal nIDEvent As Long) As Long

Public Const TIMER_INTERVAL = 5000
Public oCallBack As Excel.IRTDUpdateEvent
Public g_TimerID As Long

Public Sub TimerCallback(ByVal hWnd As Long, ByVal uMsg As Long, ByVal idEvent As Long, ByVal dwTime As Long)
    oCallBack.UpdateNotify
End Sub

  7. W menu Plik kliknij pozycję Utwórz ExcelRTD.dll, aby skompilować składnik.

Korzystanie z serwera RTD w programie Excel

  1. Uruchom nowy skoroszyt w programie Microsoft Excel.

  2. W komórce A1 wprowadź następującą formułę, a następnie naciśnij klawisz ENTER:

    =RTD("ExcelRTD.RTDFunctions",,"AAA", 5)

    Początkowa wartość zwracana to "AAA: 0". Po pięciu sekundach wartość zostanie zaktualizowana do wartości "AAA: 10" i po 10 sekundach wartość zostanie zaktualizowana do wartości "AAA:15" itd.

  3. W komórce A2 wprowadź następującą formułę i naciśnij klawisz ENTER:

    =RTD("ExcelRTD.RTDFunctions",,"BBB", 3)

    Początkowa wartość zwracana to "BBB: 0". Co pięć sekund wartość komórki zwiększa się o 3.

  4. W komórce A3 wprowadź następującą formułę i naciśnij klawisz ENTER:

    =RTD("ExcelRTD.RTDFunctions",,"AAA", 5)

    Początkowa wartość zwracana jest zgodna z zawartością komórki A1, ponieważ jest to ten sam "temat", który jest używany w A1.

  5. W komórce A4 wprowadź następującą formułę i naciśnij klawisz Enter: =RTD("ExcelRTD.RTDFunctions",,"AAA", 10)

    Początkowa wartość zwracana to "AAA: 0." Co pięć sekund wartość komórki zwiększa się podobnie jak inne komórki. Zwróć uwagę, że zwracana wartość nie jest zgodna z zawartością komórki A1 lub A3, ponieważ kombinacja parametrów przekazywanych do serwera jest inna.

Na tej ilustracji skompilowano serwer RTD, a program Excel używał wersji składnika w czasie wykonywania. Na potrzeby debugowania serwery RTD można uruchamiać z poziomu środowiska IDE języka Visual Basic.

Aby uruchomić w trybie debugowania:

  1. Zamknij program Microsoft Excel i przejdź do projektu w visual basic.
  2. Naciśnij klawisz F5, aby uruchomić składnik. Jeśli zostanie wyświetlone okno dialogowe Właściwości projektu, kliknij przycisk OK, aby wybrać domyślną opcję Poczekaj na utworzenie składników.
  3. Upewnij się, że jest wyświetlane okno Natychmiastowe w języku Visual Basic. Podczas wprowadzania formuł w komórkach i podczas aktualizowania komórek sprawdź zawartość okna Natychmiastowe w języku Visual Basic, aby zobaczyć, które akcje wyzwalają różne zdarzenia.

Uwaga

W odniesieniu do zdarzenia DisconnectData

Program Excel jest subskrybentem serwera RTD, ale wyzwala zdarzenie DisconnectData, gdy nie potrzebuje już tematu (na przykład po usunięciu lub usunięciu formuły RTD w komórce). Jednak program Excel nie wywołuje funkcji DisconnectData w każdym temacie dla serwera RTD po zamknięciu skoroszytu lub zakończeniu działania programu Excel; Zamiast tego program Excel wywołuje tylko parametr ServerTerminate. Podczas tworzenia serwera RTD należy zakodować wszelkie niezbędne oczyszczanie tematów lub innych obiektów podczas wyzwalania zdarzenia ServerTerminate.

(c) Microsoft Corporation 2001, Wszelkie prawa zastrzeżone. Wkład Lori B. Turner, Microsoft Corporation.