Como criar um servidor RealTimeData para Excel

O Microsoft Excel fornece uma função de folha de cálculo nova, RTD, que lhe permite chamar um servidor de automatização COM (Component Object Model) com o objectivo de obter dados em tempo real. Este artigo descreve como utilizar o Visual Basic para criar um servidor RealTimeData para utilização com a função RTD do Excel.

A função de folha de cálculo RTD tem a seguinte sintaxe: O primeiro argumento, ProgID , representa o identificador de programação (ProgID) do servidor RealTimeData. O argumento Server indica o nome do computador no qual é executado o servidor RealTimeData; este argumento pode ser uma cadeia nula ou omitido se o servidor RealTimeData estiver a executar localmente. Os restantes argumentos representam simplesmente parâmetros para enviar para o servidor RealTimeData; cada combinação única destes parâmetros representa um "tópico, id do tópico"que tem uma associada"." Os parâmetros são sensíveis a maiúsculas e minúsculas. Por exemplo, o seguinte ilustra as chamadas para o servidor RTD que resultaria em três ID de tópico separado: De forma a um servidor de automatização COM que seja um servidor RealTimeData para utilização com a função RTD do Excel, tem implementa a interface IRTDServer . O servidor tem de implementar todos os métodos de IRTDServer :

ServerStart ServerTerminate ConnectData DisconnectData heartBeat RefreshData

Criar um servidor de RealTimeData exemplo

O exemplo seguinte demonstra como criar e utilizar um servidor RealTimeData com o Microsoft Excel 2002. Este servidor fornece simplesmente um contador é actualizado a cada 10 segundos numa folha de cálculo. O servidor aceita até duas cadeias de tópico. A primeira cadeia de tópico pode ser AAA, BBB e NIB; qualquer cadeia de tópico é considerada inválida e o servidor devolve # valor! para a função RTD. A segunda cadeia é um valor numérico representa como o valor devolvido deve ser incrementado. Se a segunda cadeia for omitida, o valor do incremento predefinida para 1. Se a segunda cadeia não for numérica, o servidor devolve # núm! para a função RTD.

1. Inicie um novo projecto ActiveX DLL no Visual Basic.
2. No menu projecto , clique em References , seleccione a biblioteca de objectos para a versão do Excel e, em seguida, clique em OK . Por exemplo, seleccione um dos seguintes procedimentos:
   • Para o Microsoft Office Excel 2007, seleccione Microsoft Excel 12.0 Object Library .
   • Para Microsoft Office Excel 2003, seleccione Microsoft Excel 11.0 Object Library .
   • Para o Microsoft Excel 2002, seleccione Microsoft Excel 10.0 Object Library .
3. No menu projecto , clique em Propriedades do projeto1 . Alterar o Nome do projecto para ExcelRTD e, em seguida, clique em OK .
4. Altere a propriedade nome do módulo de classe Aula1 para RTDFunctions . Adicione o seguinte código para 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. No menu projecto , clique em Adicionar módulo de classe . Altere o módulo de classe propriedade Name ao tópico e altere a propriedade Instancing para privada . Adicione o seguinte código ao módulo de classe de tópico :

   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. No menu Project , seleccione Add Module . Adicione o seguinte código ao módulo novo:

   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. No menu ficheiro , clique em Criar ExcelRTD.dll para criar o componente.

Utilizar o servidor RTD no Excel

1. Inicie um novo livro no Microsoft Excel.
2. Na célula A1, introduza a seguinte fórmula e, em seguida, prima a tecla ENTER:
   = RTD("ExcelRTD.RTDFunctions",,"AAA", 5)
   O valor de retorno inicial é "AAA: 0". Depois de cinco segundos, o valor actualizado para "AAA: 10" e depois de 10 segundos, o valor actualizado para "AAA:15" e assim sucessivamente.
   
   
3. Na célula A2, introduza a seguinte fórmula e prima ENTER:
   = RTD("ExcelRTD.RTDFunctions",,"BBB", 3)
   O valor de retorno inicial é "BBB: 0". O valor da célula de cinco em cinco segundos incrementa por 3.
   
   
4. Na célula A3, introduza a seguinte fórmula e prima ENTER:
   = RTD("ExcelRTD.RTDFunctions",,"AAA", 5)
   O valor de retorno inicial igual ao conteúdo da célula A1, porque este é o mesmo "tópico" que é utilizado em A1.
   
   
5. Na célula A4, introduza a seguinte fórmula e prima ENTER:
   = RTD("ExcelRTD.RTDFunctions",,"AAA", 10)
   O valor de retorno inicial é "AAA: 0." cada cinco segundos os incrementos de valor de célula, tal como as outras células. Tenha em atenção que o valor devolvido não corresponde ao conteúdo da célula A1 ou A3 porque a combinação de parâmetros passados para o servidor é diferente.

Nesta ilustração, o servidor RTD foi compilado e Excel foi utilizar a versão run-time do componente. Para fins, RTD de depuração podem ser executados servidores a partir do IDE do Visual Basic.

Para executar em modo de depuração:

1. Saia do Microsoft Excel e mude para o projecto no Visual Basic.
2. Prima F5 para iniciar o componente. Se for apresentada a caixa de diálogo Propriedades do projecto , clique em OK para seleccionar a opção predefinida de esperar por componentes a serem criados .
3. Certifique-se de que a janela Immediate no Visual Basic é apresentada. Como introduzir fórmulas nas células e como as células são actualizadas, examine o conteúdo da janela Immediate no Visual Basic para ver quais as acções são accionar os eventos diferentes.

Nota Regarding eventos DisconnectData

Enquanto Excel for um subscritor para o servidor RTD, activa o evento de DisconnectData quando já não precisa de um tópico (por exemplo, se eliminar ou limpar uma fórmula RTD numa célula). No entanto, Excel não chama DisconnectData em cada tópico para o servidor RTD quando o livro é fechado ou o Excel é encerrado; em vez disso, o Excel chama apenas ServerTerminate . Quando estiver a criar um servidor RTD, deve código para quaisquer limpeza necessária dos tópicos ou outros objectos quando o evento ServerTerminate é accionado.

(c) Microsoft Corporation 2001, todos os direitos reservados. Contribuições de Lori B. Turner, Microsoft Corporation.

Para obter informações adicionais, clique no número de artigo que se segue para visualizar o artigo na Microsoft Knowledge Base: