Udostępnij za pośrednictwem

Przewodnik: Dodawanie odbiorników zdarzeń funkcji

  • Artykuł

Odbiorniki zdarzeń funkcji to metody, które są wykonywane po wystąpieniu jednego z następujących zdarzeń związanych z funkcjami w programie SharePoint:

  • Zainstalowano funkcję.

  • Aktywowano funkcję.

  • Funkcja jest dezaktywowana.

  • Funkcja zostanie usunięta.

W tym przewodniku pokazano, jak dodać odbiornik zdarzeń do funkcji w projekcie programu SharePoint. Przedstawia następujące zadania:

  • Tworzenie pustego projektu z odbiornikiem zdarzeń funkcji.

  • Obsługa metody FeatureDeactivating .

  • Użycie modelu obiektów projektu programu SharePoint w celu dodania anonsu do listy Anonsy.

    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:

  • Obsługiwane wersje systemów Microsoft Windows i SharePoint.

  • Visual Studio.

Tworzenie projektu odbiorcy zdarzeń funkcji

Najpierw utwórz projekt zawierający odbiornik zdarzeń funkcji.

Aby utworzyć projekt z odbiornikiem zdarzeń funkcji

  1. Na pasku menu wybierz pozycję Plik>nowy>projekt, aby wyświetlić okno dialogowe Nowy projekt.

  2. Rozwiń węzeł programu SharePoint w obszarze Visual C# lub Visual Basic, a następnie wybierz węzeł 2010.

  3. W okienku Szablony wybierz szablon Projekt programu SharePoint 2010.

    Ten typ projektu jest używany dla odbiorników zdarzeń funkcji, ponieważ nie mają szablonu projektu.

  4. W polu Nazwa wprowadź FeatureEvtTest, a następnie wybierz przycisk OK , aby wyświetlić Kreatora dostosowywania programu SharePoint.

  5. Na stronie Określanie witryny i poziomu zabezpieczeń na potrzeby debugowania wprowadź adres URL witryny serwera programu SharePoint, do której chcesz dodać nowy element pola niestandardowego, lub użyj lokalizacji domyślnej (http://< nazwa> systemu/).

  6. W sekcji Co to jest poziom zaufania dla tego rozwiązania programu SharePoint? wybierz przycisk Wdróż jako rozwiązanie farmy.

    Aby uzyskać więcej informacji na temat rozwiązań w trybie piaskownicy i rozwiązań farmy, zobacz Zagadnienia dotyczące rozwiązania w trybie piaskownicy.

  7. Wybierz przycisk Zakończ, a następnie zwróć uwagę, że w węźle Funkcje pojawi się funkcja o nazwie Feature1.

Dodawanie odbiornika zdarzeń do funkcji

Następnie dodaj odbiornik zdarzeń do funkcji i dodaj kod wykonywany po dezaktywowaniu funkcji.

Aby dodać odbiornik zdarzeń do funkcji

  1. Otwórz menu skrótów dla węzła Funkcje, a następnie wybierz pozycję Dodaj funkcję , aby utworzyć funkcję.

  2. W węźle Funkcje otwórz menu skrótów dla funkcji Feature1, a następnie wybierz pozycję Dodaj odbiornik zdarzeń, aby dodać odbiornik zdarzeń do funkcji.

    Spowoduje to dodanie pliku kodu w obszarze Feature1. W takim przypadku ma nazwę Feature1.EventReceiver.cs lub Feature1.EventReceiver.vb, w zależności od języka programowania projektu.

  3. Jeśli projekt został napisany w języku Visual C#, dodaj następujący kod w górnej części odbiornika zdarzeń, jeśli jeszcze go nie ma:

    using System;

  4. Klasa odbiorcy zdarzeń zawiera kilka skomentowanych metod, które działają jako zdarzenia. Zastąp metodę FeatureDeactivating następującym kodem:

    public override void FeatureDeactivating(SPFeatureReceiverProperties properties)
{
    try
    {
        // Get reference to SharePoint site.
        SPSite site = new SPSite("http://localhost");
        SPWeb web = site.OpenWeb("/");
        // Get reference to Announcements list.
        SPList announcementsList = web.Lists["Announcements"];

        // Add new announcement to Announcements list.
        SPListItem oListItem = announcementsList.Items.Add();
        oListItem["Title"] = "Deactivated Feature: " + properties.Definition.DisplayName;
        oListItem["Body"] = properties.Definition.DisplayName + " was deactivated on: " + DateTime.Now.ToString();
        oListItem.Update();

    }

    catch (Exception e)
    {
        Console.WriteLine("Error: " + e.ToString());
    }
    
}

Testowanie odbiornika zdarzeń funkcji

Następnie zdezaktywuj funkcję, aby sprawdzić, czy metoda FeatureDeactivating generuje anons na liście anonsów programu SharePoint.

Aby przetestować odbiornik zdarzeń funkcji

  1. Ustaw wartość właściwości Active Deployment Configuration projektu na Wartość Brak aktywacji.

    Ustawienie tej właściwości uniemożliwia aktywowanie funkcji w programie SharePoint i umożliwia debugowanie odbiorników zdarzeń funkcji. Aby uzyskać więcej informacji, zobacz Debugowanie rozwiązań programu SharePoint.

  2. Wybierz klucz F5, aby uruchomić projekt i wdrożyć go w programie SharePoint.

  3. W górnej części strony sieci Web programu SharePoint otwórz menu Akcje witryny, a następnie wybierz pozycję Ustawienia witryny.

  4. W sekcji Akcje witryny strony Ustawienia witryny wybierz link Zarządzaj funkcjami witryny.

  5. Na stronie Funkcje wybierz przycisk Aktywuj obok funkcji FeatureEvtTest Feature1 .

  6. Na stronie Funkcje wybierz przycisk Dezaktywuj obok funkcji FeatureEvtTest Feature1 , a następnie wybierz link Potwierdzenia dezaktywacji tej funkcji , aby dezaktywować funkcję.

  7. Wybierz przycisk Narzędzia główne.

    Zwróć uwagę, że po dezaktywowaniu funkcji na liście Anonsy zostanie wyświetlone ogłoszenie.

Powiązana zawartość