Instruktaż: Tworzenie składnika Web Part dla programu SharePoint

Artykuł
02/27/2013

Składniki Web Part umożliwiają użytkownikom bezpośrednio modyfikować zawartość, wygląd i zachowanie strony witryny programu SharePoint przy użyciu przeglądarki.W tym instruktażu przedstawiono sposób tworzenia składnika Web Part za pomocą Web Part szablon elementu w Visual Studio 2010.

Składnik Web Part Wyświetla siatkę danych pracowników.Użytkownik określa lokalizację pliku zawierającego dane pracowników.Użytkownika można także filtrować siatka danych, dzięki czemu pracowników są kierownikami pojawiają się tylko na liście.

Ten instruktaż ilustruje następujące zadania:

Tworzenie składnika Web Part za pomocą programu Visual Studio Web Part szablonu elementu.
Tworzenie właściwości można ustawić przez użytkownika składnika Web Part.Właściwość ta określa lokalizację pliku danych pracownika.
Renderowanie zawartości w składniku Web Part, dodając formanty do składnika Web Part kontroluje kolekcji.
Tworzenie nowego elementu menu, określone jako zlecenie, który pojawia się w menu zleceń Wytopiony składnika Web part.Czasowniki umożliwić użytkownikowi modyfikować dane wyświetlane w składniku Web Part.
Testowanie składnika Web Part programu SharePoint.

[!UWAGA]

Komputer może pokazać różne nazwy lub lokalizacje dla niektórych użytkowników programu Visual Studio elementów interfejsu w poniższe instrukcje.Program Visual Studio, że masz i ustawień, które można używać określenia tych elementów.Aby uzyskać więcej informacji, zobacz Visual Studio, ustawienia.

Wymagania wstępne

Potrzebne do przeprowadzenia tego instruktażu następujące składniki:

Obsługiwane wersje systemu Microsoft Windows i programu SharePoint.Aby uzyskać więcej informacji, zobacz Wymagania dotyczące rozwiązań programu SharePoint.
Visual Studio Professionallub wydanie programu Visual Studio aplikacji cyklu zarządzania (ALM).

Tworzenie pustego projektu programu SharePoint

Najpierw utwórz projekt pusty programu SharePoint.Później będzie dodać składnik Web Part do projektu za pomocą Web Part szablonu elementu.

Aby utworzyć pusty projekt programu SharePoint

Uruchom Visual Studio za pomocą Uruchom jako Administrator opcji.
Na pasku mężczyzn wybierz pliku, Nowy, projektu.
W Nowy projekt okno dialogowe rozwiń SharePoint języka, którego chcesz użyć, a następnie wybierz węzeł 2010 węzła.
W szablonów okienku wybierz SharePoint 2010 projektu, a następnie wybierz polecenie OK przycisku.

Kreator dostosowania programu SharePoint pojawi się.Ten kreator umożliwia wybranie witryny, która będzie używać do debugowania projektu i poziom zaufania roztworu.
Wybierz Wdroż jako roztwór farmy przycisk opcji, a następnie wybierz Zakończ przycisk, aby zaakceptować domyślne lokalnej witryny programu SharePoint.

Dodawanie składnika Web Part do projektu

Dodaj Web Part element do projektu.Web Part element dodaje plik składnika Web Part kodu.Później będzie dodać kod pliku składnika Web Part kodu do renderowania zawartości składnika Web Part.

Aby dodać składnik Web Part do projektu

Na pasku menu wybierz projektu, Dodaj nowy element.
W Dodaj nowy element dialogowym Zainstalowane szablonów okienku rozwiń SharePoint węzeł, a następnie wybierz polecenie 2010 węzła.
Na liście szablonów programu SharePoint, wybierz Składnika Web Part szablonu, a następnie wybierz polecenie Dodaj przycisku.

Web Part element pojawia się w Solution Explorer.

Renderowanie zawartości w składniku Web Part

Można określić formanty, które mają się pojawiać w składniku Web Part, dodając je do kolekcji controls klasy składnika Web Part.

Renderowanie zawartości w składniku Web Part

W Solution Explorer, otwórz WebPart1.vb (w języku Visual Basic) lub WebPart1.cs (w języku C#).

Plik składnika Web Part kodu zostanie otwarty w edytorze kodu.
Dodaj następujące instrukcje do początku pliku składnika Web Part kodu.
```
Imports System.Data
```
```
using System.Data;
```
Dodaj następujący kod do WebPart1 klasy.Ten kod deklaruje następujące pola:
- Siatka danych do wyświetlania pracowników w składniku Web Part.
- Tekst wyświetlany na formant, który służy do filtrowania danych siatki.
- Etykiety, która wyświetla błąd, jeśli siatka danych nie można wyświetlić dane.
- Ciąg zawierający ścieżkę pliku danych pracownika.
```
Private grid As DataGrid
Private Shared verbText As String = "Show Managers Only"
Private errorMessage As New Label()
Protected xmlFilePath As String
```
```
private DataGrid grid;
private static string verbText = "Show Managers Only";
private Label errorMessage = new Label();
protected string xmlFilePath;
```

Dodaj następujący kod do WebPart1 klasy.Ten kod dodaje właściwość niestandardową o nazwie DataFilePath do składnika Web Part.Właściwość niestandardowa jest właściwość, która może być ustawiona przez użytkownika w programie SharePoint.Właściwość ta pobiera i Ustawia lokalizację pliku danych XML, który jest używany do wypełnienia siatki danych.

<Personalizable(PersonalizationScope.[Shared]), _
    WebBrowsable(True), WebDisplayName("Path to Employee Data File"), _
    WebDescription("Location of the XML file that contains employee data")> _
Public Property DataFilePath() As String
    Get
        Return xmlFilePath
    End Get
    Set(ByVal value As String)
        xmlFilePath = value
    End Set
End Property

[Personalizable(PersonalizationScope.Shared), WebBrowsable(true),
WebDisplayName("Path to Employee Data File"),
WebDescription("Location of the XML file that contains employee data")]
public string DataFilePath
{
    get
    {
        return xmlFilePath;
    }
    set
    {
        xmlFilePath = value;
    }
}

Zamień CreateChildControls metody z następującego kodu.Ten kod wykonuje następujące zadania:

Dodaje siatki dane i etykiety, która została zadeklarowana w poprzednim kroku.
Siatka danych wiąże pliku XML zawierającego dane pracowników.

Protected Overloads Overrides Sub CreateChildControls()

    'Define the grid control that displays employee data in the Web Part.
    grid = New DataGrid()
    With grid
        .Width = Unit.Percentage(100)
        .GridLines = GridLines.Horizontal
        .HeaderStyle.CssClass = "ms-vh2"
        .CellPadding = 2
        .BorderWidth = Unit.Pixel(5)
        .HeaderStyle.Font.Bold = True
        .HeaderStyle.HorizontalAlign = HorizontalAlign.Center
    End With



    'Populate the grid control with data in the employee data file.
    Try
        Dim dataset As New DataSet()
        dataset.ReadXml(xmlFilePath, XmlReadMode.InferSchema)
        grid.DataSource = dataset
        grid.DataBind()
    Catch x As Exception
        errorMessage.Text += x.Message
    End Try

    'Add control to the controls collection of the Web Part.
    Controls.Add(grid)
    Controls.Add(errorMessage)
    MyBase.CreateChildControls()

End Sub

protected override void CreateChildControls()
{
    // Define the grid control that displays employee data in the Web Part.
    grid = new DataGrid();
    grid.Width = Unit.Percentage(100);
    grid.GridLines = GridLines.Horizontal;
    grid.HeaderStyle.CssClass = "ms-vh2";
    grid.CellPadding = 2;
    grid.BorderWidth = Unit.Pixel(5);
    grid.HeaderStyle.Font.Bold = true;
    grid.HeaderStyle.HorizontalAlign = HorizontalAlign.Center;

    // Populate the grid control with data in the employee data file.
    try
    {
        DataSet dataset = new DataSet();
        dataset.ReadXml(xmlFilePath, XmlReadMode.InferSchema);
        grid.DataSource = dataset;
        grid.DataBind();
    }
    catch (Exception x)
    {
        errorMessage.Text += x.Message;
    }

    // Add control to the controls collection of the Web Part.
    Controls.Add(grid);
    Controls.Add(errorMessage);
    base.CreateChildControls();
}

Dodaj następującą metodę do WebPart1 klasy.Ten kod wykonuje następujące zadania:

Tworzy zlecenie, który pojawia się w menu składnika Web Part zleceń Wytopiony składnika Web Part.
Obsługuje zdarzenie jest wywoływane, gdy użytkownik wybierze zlecenie w menu zleceń.Ten kod filtruje listę pracowników w siatce danych.

Public Overrides ReadOnly Property Verbs() As WebPartVerbCollection
    Get
        Dim customVerb As New WebPartVerb("Manager_Filter_Verb", _
            New WebPartEventHandler(AddressOf CustomVerbEventHandler))

        customVerb.Text = verbText
        customVerb.Description = "Shows only employees that are managers"

        Dim newVerbs() As WebPartVerb = {customVerb}

        Return New WebPartVerbCollection(MyBase.Verbs, newVerbs)
    End Get
End Property

Protected Sub CustomVerbEventHandler(ByVal sender As Object, ByVal args As WebPartEventArgs)
    Dim titleColumn As Integer = 2

    Dim item As DataGridItem
    For Each item In grid.Items
        If item.Cells(titleColumn).Text <> "Manager" Then
            If item.Visible = True Then
                item.Visible = False
            Else
                item.Visible = True
            End If
        End If
    Next item
    If verbText = "Show Managers Only" Then
        verbText = "Show All Employees"
    Else
        verbText = "Show Managers Only"
    End If
End Sub

public override WebPartVerbCollection Verbs
{
    get
    {
        WebPartVerb customVerb = new WebPartVerb("Manager_Filter_Verb",
            new WebPartEventHandler(CustomVerbEventHandler));

        customVerb.Text = verbText;
        customVerb.Description = "Shows only employees that are managers";

        WebPartVerb[] newVerbs = new WebPartVerb[] { customVerb };

        return new WebPartVerbCollection(base.Verbs, newVerbs);
    }
}

protected void CustomVerbEventHandler(object sender, WebPartEventArgs args)
{
    int titleColumn = 2;

    foreach (DataGridItem item in grid.Items)
    {
        if (item.Cells[titleColumn].Text != "Manager")
        {
            if (item.Visible == true)
            {
                item.Visible = false;
            }
            else
            {
                item.Visible = true;
            }
        }

    }
    if (verbText == "Show Managers Only")
    {
        verbText = "Show All Employees";
    }
    else
    {
        verbText = "Show Managers Only";
    }
}

Testowanie składnika Web Part

Po uruchomieniu programu otwiera witrynę programu SharePoint.Składnik Web Part jest automatycznie dodawany do galerii składników Web Part programu SharePoint.Składnik Web Part można dodać do dowolnej strony składników Web Part.

Aby przetestować składnika Web Part

Wklej następujący kod XML do pliku Notatnika.Ten plik XML zawiera przykładowe dane, która będzie wyświetlana w składniku Web Part.

<?xml version="1.0" encoding="utf-8" ?>
    <employees xmlns="https://schemas.microsoft.com/vsto/samples">
       <employee>
           <name>David Hamilton</name>
           <hireDate>2001-05-11</hireDate>
           <title>Sales Associate</title>
       </employee>
       <employee>
           <name>Karina Leal</name>
           <hireDate>1999-04-01</hireDate>
           <title>Manager</title>
       </employee>
       <employee>
           <name>Nancy Davolio</name>
           <hireDate>1992-05-01</hireDate>
           <title>Sales Associate</title>
       </employee>
       <employee>
           <name>Steven Buchanan</name>
           <hireDate>1955-03-04</hireDate>
           <title>Manager</title>
       </employee>
       <employee>
           <name>Suyama Michael</name>
           <hireDate>1963-07-02</hireDate>
           <title>Sales Associate</title>
       </employee>
    </employees>

W Notatniku, na pasku menu wybierz pliku, Zapisać jako.
W Zapisać jako dialogowym Zapisz jako typ wybierz Wszystkie pliki.
W nazwę pliku Data.XML który wprowadź.
Wybierz folder za pomocą Przeglądaj foldery przycisk, a następnie wybierz zapisać przycisku.
W programie Visual Studio wybierz F5 klucza.

Otwiera witrynę programu SharePoint.
Na Akcje witryny menu wybierz Więcej opcji.
W Tworzenie wybierz Strony składników Web Part typu, a następnie wybierz Tworzenie przycisku.
W Nowej strony składników Web Part strony, nazwę strony SampleWebPartPage.aspx, a następnie wybierz polecenie Tworzenie przycisku.

Zostanie wyświetlona strona składników Web Part.
Zaznacz wszystkie strefy na stronie składników Web Part.
U góry strony, wybierz polecenie Wstaw tab, a następnie wybierz Web Part przycisku.
W Kategorie okienku wybierz Niestandardowy folder, wybierz WebPart1 składnika Web Part i wybierz polecenie Dodaj przycisku.

Składnik Web Part jest wyświetlany na stronie.

Badania właściwości niestandardowych

Aby zapełnić siatkę danych, która pojawia się w składniku Web Part, określ ścieżkę pliku XML, który zawiera dane dotyczące każdego pracownika.

Aby przetestować właściwości niestandardowych

Wybierz strzałkę wyświetloną po prawej stronie składnika Web Part, a następnie wybierz Edytowanie składnika Web Part z wyświetlonym menu.

Po prawej stronie strony pojawi się okienko zawiera właściwości składnika Web Part.
W okienku rozwiń różne węzła, wprowadź ścieżkę do utworzonego wcześniej pliku XML, wybierz polecenie Zastosuj przycisk, a następnie wybierz OK przycisku.

Sprawdź, czy lista pracowników jest wyświetlana w składniku Web Part.

Testowanie zlecenia części sieci Web

Pokazywanie i ukrywanie pracowników, które nie są kierownikami klikając element, który pojawia się w menu składnika Web Part zleceń.

Aby przetestować zlecenie składnika Web Part

Wybierz strzałkę wyświetloną po prawej stronie składnika Web Part, a następnie wybierz Pokaż tylko menedżerowie z wyświetlonym menu.

W składniku Web Part są wyświetlane tylko tych pracowników, którzy są kierownikami.
Ponownie wybierz strzałkę, a następnie wybierz Pokaż wszystkich pracowników z wyświetlonym menu.

Wszyscy pracownicy są wyświetlane w składniku Web Part.

Zobacz też

Zadania

Jak: tworzenie część sieci Web programu SharePoint

Jak: tworzenie część sieci Web programu SharePoint przy użyciu projektanta

Instruktaż: Tworzenie składnika Web Part dla programu SharePoint przy użyciu projektanta

Inne zasoby

Tworzenie składników Web Part dla programu SharePoint

Udostępnij za pośrednictwem

Instruktaż: Tworzenie składnika Web Part dla programu SharePoint

Wymagania wstępne

Tworzenie pustego projektu programu SharePoint

Aby utworzyć pusty projekt programu SharePoint

Dodawanie składnika Web Part do projektu

Aby dodać składnik Web Part do projektu

Renderowanie zawartości w składniku Web Part

Renderowanie zawartości w składniku Web Part

Testowanie składnika Web Part

Aby przetestować składnika Web Part

Badania właściwości niestandardowych

Aby przetestować właściwości niestandardowych

Testowanie zlecenia części sieci Web

Aby przetestować zlecenie składnika Web Part

Zobacz też

Zadania

Inne zasoby

Dodatkowe zasoby