Udostępnij za pośrednictwem

Porady: tworzenie polecenia SharePoint

  • Artykuł

Jeśli chcesz użyć modelu obiektu serwera w rozszerzeniach narzędzia programu SharePoint, należy utworzyć niestandardowy polecenia programu SharePoint do wywołania z interfejsu API.Polecenia programu SharePoint należy zdefiniować w zespole można wywołać bezpośrednio do modelu obiektu serwera.

Aby uzyskać więcej informacji o przeznaczeniu poleceń programu SharePoint, zobacz Wywoływanie modeli obiektów SharePoint.

Aby utworzyć polecenia programu SharePoint

  1. Tworzenie klasy library project ma następującą konfigurację:

    [!UWAGA]

    Polecenia programu SharePoint nie może implementować w samym projektem, który definiuje rozszerzeniem narzędzia programu SharePoint, ponieważ polecenia programu SharePoint, docelowych.NET Framework 3.5 i SharePoint docelowych rozszerzeń narzędzia Program .NET Framework 4.Należy zdefiniować wszystkie polecenia programu SharePoint, które są używane przez użytkownika w osobnym projekcie rozszerzenie.Aby uzyskać więcej informacji, zobacz Wdrażanie rozszerzeń dla narzędzi SharePoint w Visual Studio.

  2. Dodaj odwołania do następujących zestawów:

    • Microsoft.VisualStudio.SharePoint.Commands

    • Microsoft.SharePoint

  3. W klasie w projekcie Utwórz metodę, która definiuje polecenia programu SharePoint.Metody muszą być zgodne z następującymi wytycznymi:

    • Może mieć jeden lub dwa parametry.

      Pierwszy parametr musi być ISharePointCommandContext obiektu.Ten obiekt zawiera Microsoft.SharePoint.SPSite lub Microsoft.SharePoint.SPWeb , w którym polecenie jest wykonywane.Udostępnia również ISharePointCommandLogger obiektu używanego do pisania wiadomości do danych wyjściowych okno lub Listy błędów okno w programie Visual Studio.

      Drugi parametr może być typu wybór, ale ten parametr jest opcjonalny.Jeżeli trzeba przekazać dane z rozszerzenia narzędzi programu SharePoint do polecenia, można dodać ten parametr polecenia programu SharePoint.

    • Może mieć wartości zwracanej, ale jest to opcjonalne.

    • Druga wartość parametru i zwrot musi być typu, który może być serializowany przez Windows Communication Foundation (WCF).Aby uzyskać więcej informacji, zobacz Typy obsługiwane przez serializator kontraktu danych i Używanie klasy XmlSerializer.

    • Metoda może mieć żadnych widoczności (public, internal, lub private), i może być statyczne lub -statycznej.

  4. Stosuje się SharePointCommandAttribute do metody.Ten atrybut określa identyfikator unikatowy polecenia; Identyfikator ten nie pasuje do nazwy metody.

    Po wywołaniu polecenia z rozszerzenia narzędzi programu SharePoint, należy określić ten sam identyfikator unikatowy.Aby uzyskać więcej informacji, zobacz Porady: wykonywanie polecenia SharePoint.

Przykład

Poniższy przykład kodu pokazuje polecenia programu SharePoint, która ma identyfikator Contoso.Commands.UpgradeSolution.To polecenie używa interfejsów API w modelu obiektu serwera do uaktualnienia do wdrożonego roztworu.

<SharePointCommand("Contoso.Commands.UpgradeSolution")> _
Private Sub UpgradeSolution(ByVal context As ISharePointCommandContext, ByVal fullWspPath As String)
    Dim solution As SPSolution = SPFarm.Local.Solutions(Path.GetFileName(fullWspPath))
    If solution Is Nothing Then 
        Throw New InvalidOperationException("The solution has not been deployed.")
    End If
    solution.Upgrade(fullWspPath)
End Sub

[SharePointCommand("Contoso.Commands.UpgradeSolution")]
private void UpgradeSolution(ISharePointCommandContext context, string fullWspPath)
{
    SPSolution solution = SPFarm.Local.Solutions[Path.GetFileName(fullWspPath)];

    if (solution == null)
    {
        throw new InvalidOperationException("The solution has not been deployed.");
    }

    solution.Upgrade(fullWspPath);
}

Oprócz pierwszej niejawny ISharePointCommandContext parametr, to polecenie ma także parametr niestandardowy ciąg, który zawiera pełną ścieżkę pliku .wsp, który jest uaktualniany do witryny programu SharePoint.Aby wyświetlić ten kod w kontekście przykład większych, zobacz Wskazówki: Tworzenie niestandardowego kroku wdrożenia dla projektów SharePoint.

Kompilowanie kodu

W tym przykładzie wymaga odwołania do następujących zestawów:

  • Microsoft.VisualStudio.SharePoint.Commands

  • Microsoft.SharePoint

Wdrażanie, polecenie

Aby wdrożyć polecenia, obejmują zestawu poleceń w tym samym Visual Studio pakietu rozszerzenia (VSIX), ze zgromadzeniem rozszerzenia, która używa polecenia.Należy również dodać wpis dla zestawu poleceń w pliku extension.vsixmanifest.Aby uzyskać więcej informacji, zobacz Wdrażanie rozszerzeń dla narzędzi SharePoint w Visual Studio.

Zobacz też

Zadania

Porady: wykonywanie polecenia SharePoint

Wskazówki: rozszerzanie Eksploratora serwera do potrzeb wyświetlania elementów sieci web

Koncepcje

Wywoływanie modeli obiektów SharePoint