Ako Vybuduj COM doplnok bal�ka Office pomocou programu Visual Basic.NET

Microsoft Office 2000 a nesk�r podporu nov�, jednotn� dizajn architekt�ry pre budovanie uplat�ovanie doplnky na zv��enie a kontrolu Kancel�rske aplik�cie. Tieto doplnky sa ozna�uj� ako doplnky COM. Tento podrobn� �l�nok pojedn�va o doplnky Office COM a popisuje, ako vybudova� Office COM doplnok pomocou jazyka Microsoft Visual Basic.NET.

Rozhranie IDTExensibility2

COM doplnok je v procesom servera, alebo ActiveX dynamick� odkaz kni�nica (DLL), ktor� implementuje IDTExensibility2 rozhranie, ako je op�san� v typu Microsoft Add-in Designer kni�nica (Msaddndr.dll). V�etky doplnky COM dedia z tohto rozhrania a musia implementova� ka�dej z jeho piatich met�d.

OnConnection

The OnConnection udalos� po�iare kedyko�vek doplnok COM je pripojen�. Doplnok m��e by� po spusten� pripojen�, koncov� pou��vate�, alebo prostredn�ctvom Automatiz�cie. Ak OnConnection Vr�ti �spe�ne, doplnok je povedal, aby sa nalo�en�. Ak sa vr�ti chybov� hl�senie, okam�ite hostite�sk� aplik�cia vydania jeho odkaz na doplnok a objekt sa zni��.

OnConnection berie nasleduj�ce �tyri parametre:

• Uplat�ovanie -Odkaz na objekt application hostite�a.
• ConnectMode -Kon�tanta, ktor� ur�uje, ako doplnok je pripojen�. The doplnok m��e by� pripojen� nasledovn�mi sp�sobmi:
  • ext_cm_AfterStartup -Doplnok je spusten� kone�n�m u��vate�om z Doplnky COM dial�gov� okno.
  • ext_cm_CommandLine -Doplnok je pripojen� z pr�kazov�ho riadka. Pozn�mka to nevz�ahuje sa na budovan� doplnky COM pre aplik�cie bal�ka Office.
  • ext_cm_External -Doplnok je pripojen� Extern� aplik�cia prostredn�ctvom Automatiz�cie. V�imnite si, �e toto sa neuplat�uje na budovan� doplnky COM pre bal�k Office aplik�cie.
  • ext_cm_Startup -Doplnok je spusten� hostite�om pri spusten� aplik�cie. Toto spr�vanie sa riadi nastaven�m datab�zy registry.
• AddInInst -Odkaz na COMAddIn objekt, ktor� sa vz�ahuje na tento doplnok v COMAddIns zhroma��ovanie hostite�sk� aplik�cia.
• Vlastn� -Pole Variant Zadajte hodnoty, ktor� m��ete uchova� u��vate�sk� d�ta.

OnDisconnection

The OnDisconnection udalos� po�iare ke� doplnok COM odpoj� a kr� uvo�n� z pam�te. Doplnok by mali vykon�va� ak�ko�vek �istenie zdrojov v tejto udalosti a mali obnovi� v�etky zmeny vykonan� Hostite�sk� aplik�cia.

OnDisconnection berie tieto dve parametre:

• RemoveMode -Kon�tanta, ktor� ur�uje, ako doplnok bol odpojen�. The doplnok m��e by� odpojen� nasledovn�mi sp�sobmi:
  • ext_dm_HostShutdown -Doplnok je odpojen� ke� hostite�sk� aplik�cia zatvoren�.
  • ext_dm_UserClosed -Doplnok je odpojen� koncov�ho pou��vate�a alebo automatiz�cia radi�.
• Vlastn� -Pole Variant Zadajte hodnoty, ktor� m��ete uchova� u��vate�sk� d�ta.

OnAddInsUpdate

The OnAddInsUpdate udalos� po�iare, ke� s�bor registrovan� COM doplnky zmeny. In�mi slovami, kedyko�vek COM doplnok je nain�talovan� alebo odstr�nen� z hostite�a aplik�cie, t�to udalos� po�iare.

OnStartupComplete a OnBeginShutdown

Obe OnStartupComplete a OnBeginShutdown met�dy sa naz�vaj� ke� hostite�sk� aplik�cia opustil alebo vstupuje �t�t v ktor� pou��vate� interakcia by sa malo zabr�ni�, preto�e aplik�cia je zanepr�zdnen� nakl�dky alebo vykl�dky s�m z pam�te. OnStartupComplete je volan� iba ak doplnok bol pripojen� po�as spustenia, a OnBeginShutdown je volan� iba ak hostite�sk�ho odpoj� doplnok po�as vypnutia.

Preto�e pou��vate�sk�ho rozhrania Hostite�sk� aplik�cia je plne akt�vnym, ke� tieto udalosti po�iaru, m��u by� jedin� sp�sob, ako vykon�va� ur�it� �innosti, ktor� by sa inak nedostupn� z OnConnection a OnDisconnection.

Doplnok COM registr�cie

Popri be�n�ch registr�ciu COM, COM doplnok potrebuje s�m zaregistruje ka�d� aplik�cia bal�ka Office, v ktorom be��. Registrova� sama s konkr�tny aplik�cie, doplnok by mali vytvori� podk���, pomocou jeho ProgID ako n�zov k���a, pod�a nasledovn�ho umiestnenia: Doplnok m��e poskytn�� hodnoty toto k���ov� umiestnenie pre priate�sk� zobrazovan� meno a �pln� opis. Okrem toho, doplnok by mali �pecifikova� jeho po�adovan� za�a�enie spr�vania pomocou hodnotu DWORD s n�zvom . T�to hodnota ur�uje, ako doplnok na��ta� hostite�sk�ho �iadosti, a sklad� sa z kombin�cie nasleduj�cich hodn�t:

• 0 = Odpoji� - nie je zaveden�.
• 1 = Pripojen� - je na��tan�.
• 2 = Bootload - za�a�enie pri �tarte aplik�cie.
• 8 = DemandLoad - za�a�enie iba vtedy, ak o to po�iada pou��vate�.
• 16 = ConnectFirstTime - za�a�enie len raz (�alej pri spusten�).

Typick� hodnota zadan� je 0x03 (pripojen� | Bootload).

Doplnky, ktor� implementuj� IDTExtensibility2 by malo tie� vy�pecifikova� hodnotu DWORD s n�zvom na Uve�te, �i doplnky s� bezpe�n� pre oper�cie, ktor� nepodporuj� pou��vate� rozhranie. Hodnota 0x00 ozna�uje False, a hodnota 0x01 ozna�uje pravda.

Ako Vybuduj COM doplnok pomocou jazyka Visual Basic.NET

Ako u� bolo spomenut�, doplnok programu Office COM je v procese COM Server, ktor� je vyvolan� aplik�cie bal�ka Office prostredn�ctvom COM run-time vrstva. Preto sa rozv�ja COM doplnok v jazyku Visual Basic.NET vy�aduje, aby doplnok s��as� realizovan� vo.NET a potom vystaven� COM klientov (to znamen�, Kancel�rske aplik�cie) cez COM objektov�mu vrstvu.

Ak chcete vytvori� COM doplnok v jazyku Visual Basic.�IST�, postupujte nasledovne:

1. V jazyku Visual Basic.�IST�, vytvori� kni�nicu triedy projekt.
2. Prida� odkaz na druh kni�nica, ktor� implementuje IDTExtensibility2. Prim�rne objektov�mu zhroma�denia pre toto je u� k dispoz�cii pod n�zov Roz��rite�nos�.
3. Prida� odkaz na Objektov� kni�nica bal�ka Microsoft Office. The prim�rne objektov�mu zhroma�denia pre toto je u� k dispoz�cii pod n�zvom �rad.
4. Vytvori� verejn� triedy v triedy kni�nica, ktor� implementuje IDTExtensibility2.
5. Po triedy kni�nica je postaven�, zaregistrova� kni�nicu pre COM interop. Vykon�te to generova� siln�, s n�zvom mont� pre t�to triedu Kni�nica a potom ho zap�sa� s COM interop. M��ete pou�i� Regasm.exe na zaregistrova�.�IST� zlo�ky pre COM interop.
6. Vytvori� polo�ky datab�zy registry, aby aplik�cie bal�ka Office m��ete rozpozna� a na��tajte doplnok.

M��ete vybra� dokon�i� v�etky tieto kroky, alebo m��ete vytvori�.�IST� projekt typu Zdie�an� doplnok programu. Spust� Sprievodcu roz��rite�nosti, ktor� v�m pom��e vytvori� COM doplnok v.NET.

Roz��rite�nos� sprievodca vytvor� vizu�lne Z�kladn�.Projekt Kni�nica �ist� trieda spolu s Pripojte trieda, ktor� implementuje IDTExtensibility2 rozhranie. Kostra k�d, ktor� implementuje pr�zdne �lenov IDTExtensibility tie� vygenerovan�. Tento projekt m� odkazy na roz��rite�nos� a �rad zostavy. Vybudova� nastavenia projektu Zaregistrujte sa na COM Interop vybrat�. Zhroma�denie k��� (.snk) s�bor sa generuje a Odkazovan� v AssemblyKeyfile atrib�t v Assemblyinfo.vb.

Spolu s triedy projekt kni�nica, Sprievodca vytv�ra in�tala�n� projekt, ktor� m��ete pou�i� na nasadenie COM doplnok na in�ch po��ta�och. Tento projekt m��e odstr�ni�, ak po�adovan�.

Podrobn� pr�klad

1. Na S�bor menu v Microsoft Visual Studio.�IST�, kliknite Nov�, a potom kliknite na tla�idlo Projekt.
2. V Nov� projekt dial�gov� okno, rozba�te polo�ku In� projekty pod�a Projekt typy, vyberte Roz��rite�nos� projektov, a potom vyberte Zdie�an� doplnok �abl�na.
3. Typ MyCOMAddin ako n�zov doplnok a potom kliknite na tla�idlo ok.
4. Ke� sa zobraz� sprievodca roz��rite�nos�, postupujte nasledovne:
   1. Na strane 1, vyberte Vytvori� prida� v pomocou Visual Basic, a potom kliknite na tla�idlo Bud�ci.
   2. Na strane 2, vyberte nasleduj�ce hostite�a aplik�cie, a kliknite na tla�idlo Bud�ci:
      • Program Microsoft Word
      • Program Microsoft PowerPoint
      • Program Microsoft Outlook
      • Program Microsoft Excel
      • Programu Microsoft Access
   3. Na strane 3, poskytne meno a popis doplnok a potom kliknite na tla�idlo Bud�ci.
      
      Pozn�mka N�zov a opis doplnok zobrazia v Doplnok COM dial�gov� okno v aplik�cia bal�ka Office.
      
      
   4. Na strane 4, vyberte v�etky dostupn� mo�nosti, a potom kliknite na tla�idlo Bud�ci.
   5. Kliknite na tla�idlo Dokon�i�.
5. Prida� nasleduj�ce �lena, aby Pripojte trieda:

   Dim WithEvents MyButton As CommandBarButton 

6. Implementova� k�d pre v�etk�ch �lenov IDTExtensibility2 v Pripojte trieda, takto:

       Public Sub OnBeginShutdown(ByRef custom As System.Array) Implements Extensibility.IDTExtensibility2.OnBeginShutdown
           On Error Resume Next
           ' Notify the user you are shutting down, and delete the button.
           MsgBox("Our custom Add-in is unloading.")
           MyButton.Delete()
           MyButton = Nothing
   
       End Sub
   
       Public Sub OnAddInsUpdate(ByRef custom As System.Array) Implements Extensibility.IDTExtensibility2.OnAddInsUpdate
           '
       End Sub
   
       Public Sub OnStartupComplete(ByRef custom As System.Array) Implements Extensibility.IDTExtensibility2.OnStartupComplete
   
           Dim oCommandBars As CommandBars
           Dim oStandardBar As CommandBar
   
           On Error Resume Next
           ' Set up a custom button on the "Standard" command bar.
           oCommandBars = applicationObject.CommandBars
           If oCommandBars Is Nothing Then
               ' Outlook has the CommandBars collection on the Explorer object.
               oCommandBars = applicationObject.ActiveExplorer.CommandBars
           End If
   
           oStandardBar = oCommandBars.Item("Standard")
           If oStandardBar Is Nothing Then
               ' Access names its main toolbar Database.
   
               oStandardBar = oCommandBars.Item("Database")
   
           End If
   
           ' In case the button was not deleted, use the exiting one.
           MyButton = oStandardBar.Controls.Item("My Custom Button")
           If MyButton Is Nothing Then
   
               MyButton = oStandardBar.Controls.Add(1)
               With MyButton
                   .Caption = "My Custom Button"
                   .Style = MsoButtonStyle.msoButtonCaption
   
                   ' The following items are optional, but recommended. 
                   ' The Tag property lets you quickly find the control 
                   ' and helps MSO keep track of it when more than
                   ' one application window is visible. The property is required
                   ' by some Office applications and should be provided.
   
                   .Tag = "My Custom Button"
   
                   ' The OnAction property is optional but recommended. 
                   ' It should be set to the ProgID of the add-in, so that if
                   ' the add-in is not loaded when a user clicks the button,
                   ' MSO loads the add-in automatically and then raises
                   ' the Click event for the add-in to handle. 
   
                   .OnAction = "!<MyCOMAddin.Connect>"
   
                   .Visible = True
               End With
           End If
   
           ' Display a simple message to show which application you started in.
           MsgBox("Started in " & applicationObject.Name & ".")
   
   
           oStandardBar = Nothing
           oCommandBars = Nothing
   
   
       End Sub
   
       Public Sub OnDisconnection(ByVal RemoveMode As Extensibility.ext_DisconnectMode, ByRef custom As System.Array) Implements Extensibility.IDTExtensibility2.OnDisconnection
   
           On Error Resume Next
           If RemoveMode <> Extensibility.ext_DisconnectMode.ext_dm_HostShutdown Then _
              Call OnBeginShutdown(custom)
   
           applicationObject = Nothing
   
   
       End Sub
   
       Public Sub OnConnection(ByVal application As Object, ByVal connectMode As Extensibility.ext_ConnectMode, ByVal addInInst As Object, ByRef custom As System.Array) Implements Extensibility.IDTExtensibility2.OnConnection
   
   
           MsgBox("On Connection In MyAddin")
           applicationObject = application
           addInInstance = addInInst
   
   
           ' If you aren't in startup, manually call OnStartupComplete.
           If (connectMode <> Extensibility.ext_ConnectMode.ext_cm_Startup) Then _
              Call OnStartupComplete(custom)
   
       End Sub
   
   
       Private Sub MyButton_Click(ByVal Ctrl As Microsoft.Office.Core.CommandBarButton, ByRef CancelDefault As Boolean) Handles MyButton.Click
           MsgBox("Our CommandBar button was pressed!")
       End Sub
   					

7. Vybudova� a test doplnok COM. Chcete urobi�, postupujte pod�a t�chto kroky:
   1. Na Vybudova� ponuky, kliknite na tla�idlo Vybudova� MyCOMAddin. V�imnite si, �e budovanie COM doplnok registrov.�IST� trieda s COM interop.
   2. Spusti� jednu z aplik�ci� bal�ka Office, ktor� ste vybrali ako hostite�a aplik�cie pre doplnok (napr�klad Microsoft Word alebo Microsoft Excel).
   3. Po spusten� doplnok, OnConnection udalos� je pad�ka, a zobraz� sa okno s hl�sen�m. Ke� ste odmietol v okne s hl�sen�m, OnStartupComplete udalos� po�iare, a budete dost�va� druh� okno s hl�sen�m. Zamietol okno s hl�sen�m.
   4. V�imnite si, �e doplnok prid� nov� vlastn� tla�idlo s titulky "Moje vlastn� tla�idlo" na paneli s n�strojmi �tandardn�.
   5. Kliknite na tla�idlo Moje vlastn� tla�idlo. The Kliknite na tla�idlo udalos� tla�idla spracuje doplnok a dostanete okno s hl�sen�m. Zamietnu� v okne s hl�sen�m.
   6. Ukon�ite aplik�cie bal�ka Office.
   7. Ke� ukon��te aplik�ciu, OnBeginShutDownudalos� po�iare, a budete dost�va� okno s hl�sen�m. Zamietol v okne s hl�sen�m na konci demon�tr�cie.

Pre �al�ie inform�cie o p�san� doplnky COM kliknut�m na ��slo �l�nku ni��ie, ��m zobraz�te �l�nok v datab�ze Microsoft Knowledge Base: �al�ie inform�cie o v�voji rie�en� zalo�en�ch na Web pre program Microsoft Internet Explorer, n�jdete na nasledovn�ch webov�ch lokalit�ch spolo�nosti Microsoft: (c) Microsoft Corporation 2001, v�etky pr�va vyhraden�. Pr�spevky Ranjit R. Sawant, Microsoft Corporation.