Zdarzenia w projektach pakietu Office

  • Artykuł

Każdy szablon projektu pakietu Office automatycznie generuje kilka procedur obsługi zdarzeń. Procedury obsługi zdarzeń dla dostosowań na poziomie dokumentu różnią się nieco od procedur obsługi zdarzeń dla dodatków VSTO.

Dotyczy: informacje w tym temacie dotyczą projektów na poziomie dokumentu i projektów dodatków VSTO. Zobacz Funkcje dostępne według aplikacja pakietu Office lication i typu projektu.

Projekty na poziomie dokumentu

Program Visual Studio udostępnia wygenerowany kod za nowymi lub istniejącymi dokumentami lub arkuszami w dostosowaniach na poziomie dokumentu. Ten kod wywołuje dwa różne zdarzenia: Uruchamianie i zamykanie.

Startup — Zdarzenie

Zdarzenie uruchamiania jest wywoływane dla każdego elementu hosta (dokumentu, skoroszytu lub arkusza) po uruchomieniu dokumentu i uruchomieniu całego kodu inicjowania w zestawie. Ostatnią rzeczą jest uruchomienie w konstruktorze klasy, w której działa kod. Aby uzyskać więcej informacji na temat elementów hosta, zobacz Omówienie elementów hosta i kontrolek hosta.

Podczas tworzenia projektu na poziomie dokumentu program Visual Studio tworzy programy obsługi zdarzeń dla zdarzenia uruchamiania w wygenerowanych plikach kodu:

  • W przypadku projektów programu Microsoft Office Word program obsługi zdarzeń ma nazwę ThisDocument_Startup.

  • W przypadku projektów programu Microsoft Office Excel programy obsługi zdarzeń mają następujące nazwy:

    • Sheet1_Startup

    • Sheet2_Startup

    • Sheet3_Startup

    • ThisWorkbook_Startup

Shutdown — Zdarzenie

Zdarzenie Zamykanie jest zgłaszane dla każdego elementu hosta (dokumentu lub arkusza), gdy domena aplikacji, w ramach którego załadowano kod, ma się rozładować. Jest to ostatnia rzecz, którą należy wywołać w klasie podczas zwalniania.

Podczas tworzenia projektu na poziomie dokumentu program Visual Studio tworzy programy obsługi zdarzeń dla zdarzenia Shutdown w wygenerowanych plikach kodu:

  • W przypadku projektów programu Microsoft Office Word program obsługi zdarzeń ma nazwę ThisDocument_Shutdown.

  • W przypadku projektów programu Microsoft Office Excel programy obsługi zdarzeń mają następujące nazwy:

    • Sheet1_Shutdown

    • Sheet2_Shutdown

    • Sheet3_Shutdown

    • ThisWorkbook_Shutdown

Uwaga

Nie usuwaj programowo kontrolek podczas obsługi zdarzeń zamykania dokumentu. Elementy interfejsu użytkownika dokumentu nie są już dostępne, gdy wystąpi zdarzenie Zamykanie . Jeśli chcesz usunąć kontrolki przed zamknięciem aplikacji, dodaj kod do innego programu obsługi zdarzeń, takiego jak BeforeClose lub BeforeSave.

Deklaracje metod obsługi zdarzeń

Każda deklaracja metody obsługi zdarzeń ma te same argumenty przekazane do niego: nadawca i e. W programie Excel argument nadawcy odnosi się do arkusza, takiego jak Sheet1 lub Sheet2; w programie Word argument nadawcy odwołuje się do dokumentu. Argument e odnosi się do standardowych argumentów zdarzenia, które nie są używane w tym przypadku.

Poniższy przykład kodu przedstawia domyślne programy obsługi zdarzeń w projektach na poziomie dokumentu dla programu Word.

private void ThisDocument_Startup(object sender, System.EventArgs e)
{
}

private void ThisDocument_Shutdown(object sender, System.EventArgs e)
{
}

Poniższy przykład kodu przedstawia domyślne programy obsługi zdarzeń w projektach na poziomie dokumentu dla programu Excel.

Uwaga

Poniższy przykład kodu przedstawia programy obsługi zdarzeń w Sheet1 klasie . Nazwy programów obsługi zdarzeń w innych klasach elementów hosta odpowiadają nazwie klasy. Na przykład w Sheet2 klasie program obsługi zdarzeń uruchamiania ma nazwę Sheet2_Startup. ThisWorkbook W klasie program obsługi zdarzeń uruchamiania ma nazwę ThisWorkbook_Startup.

private void Sheet1_Startup(object sender, System.EventArgs e)
{
}

private void Sheet1_Shutdown(object sender, System.EventArgs e)
{
}

Kolejność zdarzeń w projektach programu Excel na poziomie dokumentu

Programy obsługi zdarzeń uruchamiania w projektach programu Excel są wywoływane w następującej kolejności:

  1. ThisWorkbook_Startup.

  2. Sheet1_Startup.

  3. Sheet2_Startup.

  4. Sheet3_Startup.

  5. Inne arkusze w kolejności.

    Programy obsługi zdarzeń zamykania w rozwiązaniu skoroszytu są wywoływane w następującej kolejności:

  6. ThisWorkbook_Shutdown.

  7. Sheet1_Shutdown.

  8. Sheet2_Shutdown.

  9. Sheet3_Shutdown.

  10. Inne arkusze w kolejności.

    Kolejność jest określana podczas kompilowania projektu. Jeśli użytkownik zmienia kolejność arkuszy w czasie wykonywania, nie zmienia kolejności wywoływanej przy następnym otwarciu lub zamknięciu skoroszytu.

Projekty dodatków VSTO

Program Visual Studio udostępnia wygenerowany kod w dodatku VSTO. Ten kod wywołuje dwa różne zdarzenia: Startup i Shutdown.

Startup — Zdarzenie

Zdarzenie Startup jest wywoływane po załadowaniu dodatku VSTO i uruchomieniu całego kodu inicjowania w zestawie. To zdarzenie jest obsługiwane przez metodę ThisAddIn_Startup w wygenerowany plik kodu.

Kod w procedurze obsługi zdarzeń ThisAddIn_Startup jest pierwszym kodem użytkownika do uruchomienia, chyba że dodatek VSTO zastępuje metodę RequestComAddInAutomationService . W takim przypadku ThisAddIn_Startup program obsługi zdarzeń jest wywoływany po RequestComAddInAutomationService.

Nie dodawaj kodu w procedurze ThisAdd-In_Startup obsługi zdarzeń, jeśli kod wymaga otwarcia dokumentu. Zamiast tego dodaj ten kod do zdarzenia, które aplikacja pakietu Office lication zgłasza, gdy użytkownik tworzy lub otwiera dokument. Aby uzyskać więcej informacji, zobacz Uzyskiwanie dostępu do dokumentu po uruchomieniu aplikacja pakietu Office licacji.

Aby uzyskać więcej informacji na temat sekwencji uruchamiania dodatków VSTO, zobacz Architektura dodatków VSTO.

Shutdown — Zdarzenie

Zdarzenie jest zgłaszane, gdy domena Shutdown aplikacji, w ramach którego załadowano kod, ma zostać zwolniona. To zdarzenie jest obsługiwane przez metodę ThisAddIn_Shutdown w wygenerowany plik kodu. Ta procedura obsługi zdarzeń to ostatni kod użytkownika, który ma zostać uruchomiony po usunięciu dodatku VSTO.

Zdarzenie zamknięcia w dodatku VSTO programu Outlook

Zdarzenie Shutdown jest zgłaszane tylko wtedy, gdy użytkownik wyłączy dodatek VSTO za pomocą okna dialogowego Dodatki COM w programie Outlook. Nie jest wywoływana, gdy program Outlook kończy działanie. Jeśli masz kod, który musi działać po zakończeniu działania programu Outlook, obsłuż jedną z następujących zdarzeń:

Uwaga

Możesz wymusić, aby program Outlook zgłaszał zdarzenie po jego zakończeniu Shutdown , modyfikując rejestr. Jeśli jednak administrator przywróci to ustawienie, każdy kod dodany do metody nie będzie już uruchamiany po zakończeniu ThisAddIn_Shutdown działania programu Outlook. Aby uzyskać więcej informacji, zobacz Zamykanie zmian w programie Outlook 2010.

Powiązana zawartość