Przewodnik: tworzenie pierwszego dodatku VSTO dla programu Word

  • Artykuł

W tym przewodniku wprowadzającym pokazano, jak utworzyć dodatek VSTO dla programu Microsoft Office Word. Funkcje tworzone w tym rodzaju rozwiązania są dostępne dla samej aplikacji, niezależnie od tego, które dokumenty są otwarte.

Dotyczy: informacje w tym temacie dotyczą projektów dodatków VSTO dla programu Word. Aby uzyskać więcej informacji, zobacz Funkcje dostępne przez aplikacja pakietu Office lication i typ projektu.

W instruktażu przedstawiono następujące zagadnienia:

  • Tworzenie projektu dodatku programu Word VSTO.

  • Pisanie kodu, który używa modelu obiektów programu Word do dodawania tekstu do dokumentu podczas jego zapisywania.

  • Kompilowanie i uruchamianie projektu w celu jego przetestowania.

  • Czyszczenie ukończonego projektu w taki sposób, aby dodatek VSTO nie był już uruchamiany automatycznie na komputerze dewelopera.

    Uwaga

    Na komputerze w poniższych instrukcjach mogą być wyświetlane inne nazwy i lokalizacje niektórych elementów interfejsu użytkownika programu Visual Studio. Te elementy są określane przez numer wersji Visual Studio oraz twoje ustawienia. Aby uzyskać więcej informacji, zobacz Personalizowanie środowiska IDE.

Wymagania wstępne

Następujące składniki są wymagane do przeprowadzenia tego instruktażu:

Tworzenie projektu

Aby utworzyć nowy projekt dodatku programu Word VSTO w programie Visual Studio

  1. Uruchom program Visual Studio.

  2. W menu Plik wskaż polecenie Nowy, a następnie kliknij pozycję Projekt.

  3. W okienku szablonów rozwiń węzeł Visual C# lub Visual Basic, a następnie rozwiń węzeł Office/SharePoint.

  4. W rozwiniętym węźle Office/SharePoint wybierz węzeł Dodatki pakietu Office.

  5. Na liście szablonów projektów wybierz projekt dodatku programu Word VSTO.

  6. W polu Nazwa wpisz FirstWordAddIn.

  7. Kliknij przycisk OK.

    Program Visual Studio tworzy projekt FirstWordAddIn i otwiera plik kodu ThisAddIn w edytorze.

Pisanie kodu w celu dodania tekstu do zapisanego dokumentu

Następnie dodaj kod do pliku kodu ThisAddIn. Nowy kod używa modelu obiektów programu Word do dodawania tekstu kociołowego do każdego zapisanego dokumentu. Domyślnie plik kodu ThisAddIn zawiera następujący wygenerowany kod:

  • Częściowa definicja ThisAddIn klasy. Ta klasa zapewnia punkt wejścia dla kodu i zapewnia dostęp do modelu obiektów programu Word. Aby uzyskać więcej informacji, zobacz Program VSTO Add-ins (Dodatki programu VSTO). Pozostała część ThisAddIn klasy jest zdefiniowana w ukrytym pliku kodu, którego nie należy modyfikować.

  • Programy obsługi zdarzeń ThisAddIn_Startup i ThisAddIn_Shutdown . Te programy obsługi zdarzeń są wywoływane, gdy program Word ładuje i zwalnia dodatek VSTO. Użyj tych procedur obsługi zdarzeń, aby zainicjować dodatek VSTO podczas ładowania i wyczyścić zasoby używane przez dodatek VSTO podczas jego zwolnienia. Aby uzyskać więcej informacji, zobacz Zdarzenia w projektach pakietu Office.

Aby dodać akapit tekstu do zapisanego dokumentu

  1. W pliku kodu ThisAddIn dodaj następujący kod do ThisAddIn klasy . Nowy kod definiuje program obsługi zdarzeń dla DocumentBeforeSave zdarzenia, który jest zgłaszany podczas zapisywania dokumentu.

    Gdy użytkownik zapisze dokument, program obsługi zdarzeń dodaje nowy tekst na początku dokumentu.

    void Application_DocumentBeforeSave(Word.Document Doc, ref bool SaveAsUI, ref bool Cancel)
{
    Doc.Paragraphs[1].Range.InsertParagraphBefore();
    Doc.Paragraphs[1].Range.Text = "This text was added by using code.";
}

    Uwaga

    Ten kod używa wartości indeksu 1, aby uzyskać dostęp do pierwszego akapitu w kolekcji Paragraphs . Mimo że język Visual Basic i Visual C# używają tablic opartych na 0, dolne granice tablic większości kolekcji w modelu obiektów programu Word to 1. Aby uzyskać więcej informacji, zobacz Pisanie kodu w rozwiązaniach pakietu Office.

  2. Jeśli używasz języka C#, dodaj następujący wymagany kod do procedury obsługi zdarzeń ThisAddIn_Startup . Ten kod służy do łączenia Application_DocumentBeforeSave programu obsługi zdarzeń ze zdarzeniem DocumentBeforeSave .

    this.Application.DocumentBeforeSave += 
    new Word.ApplicationEvents4_DocumentBeforeSaveEventHandler(Application_DocumentBeforeSave);

    Aby zmodyfikować dokument po zapisaniu, poprzednie przykłady kodu używają następujących obiektów:

  • Pole ApplicationThisAddIn klasy . Pole Application zwraca Application obiekt, który reprezentuje bieżące wystąpienie programu Word.

  • Doc Parametr programu obsługi zdarzeń dla DocumentBeforeSave zdarzenia. Parametr Doc jest obiektem reprezentującym Document zapisany dokument. Aby uzyskać więcej informacji, zobacz Omówienie modelu obiektów programu Word.

Testowanie projektu

Aby przetestować projekt

  1. Naciśnij klawisz F5 , aby skompilować i uruchomić projekt.

    Podczas kompilowania projektu kod jest kompilowany w zestawie, który znajduje się w folderze danych wyjściowych kompilacji dla projektu. Program Visual Studio tworzy również zestaw wpisów rejestru, które umożliwiają programowi Word odnajdywanie i ładowanie dodatku VSTO oraz konfigurowanie ustawień zabezpieczeń na komputerze dewelopera w celu włączenia uruchamiania dodatku VSTO. Aby uzyskać więcej informacji, zobacz Tworzenie rozwiązań pakietu Office.

  2. W programie Word zapisz aktywny dokument.

  3. Sprawdź, czy do dokumentu został dodany następujący tekst.

    Ten tekst został dodany przy użyciu kodu.

  4. Zamknij program Word.

Czyszczenie projektu

Po zakończeniu tworzenia projektu usuń zestaw dodatku VSTO, wpisy rejestru i ustawienia zabezpieczeń z komputera dewelopera. W przeciwnym razie dodatek VSTO będzie nadal działać za każdym razem, gdy otworzysz program Word na komputerze dewelopera.

Aby wyczyścić ukończony projekt na komputerze dewelopera

  1. W programie Visual Studio w menu Kompilacja kliknij pozycję Wyczyść rozwiązanie.

Następne kroki

Po utworzeniu podstawowego dodatku VSTO dla programu Word możesz dowiedzieć się więcej o sposobie tworzenia dodatków VSTO z następujących tematów:

  • Ogólne zadania programistyczne, które można wykonywać w dodatku VSTO: Program VSTO Dodatki.

  • Zadania programistyczne specyficzne dla dodatków programu Word VSTO: rozwiązania programu Word.

  • Korzystanie z modelu obiektów programu Word: Omówienie modelu obiektów programu Word.

  • Dostosowywanie interfejsu użytkownika programu Word, na przykład przez dodanie karty niestandardowej do wstążki lub utworzenie własnego niestandardowego okienka zadań: dostosowywanie interfejsu użytkownika pakietu Office.

  • Kompilowanie i debugowanie dodatków VSTO dla programu Word: Tworzenie rozwiązań pakietu Office.

  • Wdrażanie dodatków VSTO dla programu Word: wdrażanie rozwiązania pakietu Office.

Powiązana zawartość