Erstellen von SharePoint 2010-Listendefinitionen in Visual Studio 2010

Artikel
09/24/2014

SharePoint-Videotutorial

Zusammenfassung: Informationen zum Erstellen von Listendefinitionen und Listeninstanzen für Microsoft SharePoint 2010 mithilfe von Microsoft Visual Studio 2010.

Letzte Änderung: Mittwoch, 12. September 2012

Bereitgestellt von: Ben Hedges, Point8020

Listendefinitionen und Listeninstanzen, die auf diesen Definitionen basieren, sind ein fundamentaler Bestandteil von Microsoft SharePoint 2010. In Microsoft Visual Studio 2010 gibt es einen Projekttyp, der das Erstellen von Listendefinitionen in XML und das Erstellen von Listeninstanzen, die auf diesen Definitionen basieren, erleichtert. Darüber hinaus können Sie durch die enge Integration in SharePoint 2010 Listendefinitionen und Listeninstanzen direkt in Visual Studio 2010 in einer SharePoint-Website bereitstellen.

In diesem SharePoint-Videotutorial werden die folgenden Schritte zum Erstellen und Bereitstellen einer Listendefinition in Visual Studio 2010 beschrieben:

Erstellen einer SharePoint 2010-Listendefinitionsanwendung in Visual Studio 2010.
Bearbeiten der Listeninstanzdatei Elements.xml, um Details für eine Instanz der Liste anzugeben.
Bearbeiten der Listendefinitionsdatei Elements.xml, um den Inhaltstyp und Felder, die auf der Erstellungsseite für in einer Instanz dieser Liste erstellte Elemente angezeigt werden, zu definieren.
Bearbeiten der Listendefinitionsdatei Schema.xml, um die Inhalte und Spalten, die in den Ansichten für diese Liste angezeigt werden, zu definieren.

In diesem Beispiel erstellen Sie eine Listendefinition für Equipment Availability, mit der Benutzer ein Geräteverzeichnis erstellen und angeben können, ob das Gerät aktuell verfügbar ist.

So erstellen Sie eine SharePoint 2010-Listendefinitionsanwendung in Visual Studio 2010

Starten Sie Visual Studio 2010. Klicken Sie im Menü Datei auf Neu, und klicken Sie dann auf Projekt.
Erweitern Sie im Dialogfeld Neues Projekt im Abschnitt Installierte Vorlagen den Eintrag Visual Basic oder Visual C#, erweitern Sie SharePoint, und klicken Sie dann auf 2010.
Klicken Sie in der Vorlagenliste auf Listendefinition.
Geben Sie unten im Feld Name den Namen EquipmentAvailability ein.
Belassen Sie die Standardwerte in den anderen Feldern, und klicken Sie auf OK.
Wählen Sie unter Welche lokale Site soll für das Debugging verwendet werden? Ihre Website aus.
Klicken Sie auf Als Farmlösung bereitstellen, und klicken Sie anschließend auf Weiter.
Geben Sie auf der Seite Listendefinitionseinstellungen auswählen im Feld für den Anzeigenamen der Listendefinition Equipment Availability ein.
Wählen Sie in der Liste Welchen Typ weist die Listendefinition auf? die Option Benutzerdefinierte Liste aus.
Stellen Sie sicher, dass das Kontrollkästchen Fügt eine Listeninstanz für diese Listendefinition hinzu aktiviert ist, und klicken Sie anschließend auf Fertig stellen.

So ändern Sie die Listeninstanzdatei "Elements.xml"

Öffnen Sie im Projektmappen-Explorerim Knoten Listinstance1 die Datei Elements.xml. Ersetzen Sie den Inhalt der Datei Listinstance1\Elements.xml durch das folgende Markup.

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="https://schemas.microsoft.com/sharepoint/">
  <ListInstance Title="Equipment Availability"
                OnQuickLaunch="TRUE"
                TemplateType="10001"
                Url="Lists/EquipmentAvailability-ListInstance1"
                Description="My List Instance">
    <Data>
      <Rows>
        <Row>
          <Field Name ="Title">Projector</Field>
          <Field Name ="EquipmentDescription">
            High Definition Projector with built-in speaker.
          </Field>
          <Field Name ="EquipmentAvailable">TRUE</Field>
        </Row>
        <Row>
          <Field Name ="Title">Wired Microphone</Field>
          <Field Name ="EquipmentDescription">Dynamic Voice Microphone.
          </Field>
          <Field Name ="EquipmentAvailable">FALSE</Field>
        </Row>
        <Row>
          <Field Name ="Title">Wireless Microphone System</Field>
          <Field Name ="EquipmentDescription">
            Two hand held microphones and VHF receiver system.
          </Field>
          <Field Name ="EquipmentAvailable">TRUE</Field>
        </Row>
      </Rows>
    </Data>
  </ListInstance>
</Elements>

So ändern Sie die Listendefinitionsdatei "Elements.xml"

Öffnen Sie im Projektmappen-Explorerim Knoten ListDefinition1 die Datei Elements.xml. Ersetzen Sie den Inhalt der Datei ListDefinition1\Elements.xml durch das folgende Markup.

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="https://schemas.microsoft.com/sharepoint/">
  <Field ID="{d3a92d97-2b77-4a25-9698-3ab54874bc10}" 
         Name="EquipmentDescription" 
         Type="Note" DisplayName="Equipment Description"  
         Required="FALSE" NumLines="6"></Field>
  <Field ID="{d3a92d97-2b77-4a25-9698-3ab54874bc12}" 
         Name="EquipmentAvailable" Type="Boolean" 
         DisplayName="Equipment Available"  Required="FALSE"> 
    
  </Field>
  <ContentType
      ID="0x01004d360004c8074de6a25f4d8cdd3be8dd"
      Name="Equipment Availability"
      Group="Custom Content Type"
      Description="Equipment Availability"
      Version="0">
    <FieldRefs>
      <FieldRef ID="{d3a92d97-2b77-4a25-9698-3ab54874bc10}" />
      <FieldRef ID="{d3a92d97-2b77-4a25-9698-3ab54874bc12}" />
    </FieldRefs>
  </ContentType>

  <!-- Do not change the value of the Name attribute below. 
  If it does not match the folder name of the List Definition 
  project item, an error will occur when the project is run. -->
  <ListTemplate
        Name="ListDefinition1"
        Type="10001"
        AllowDeletion="FALSE"
        DisallowContentTypes="FALSE"
        BaseType="0"
        OnQuickLaunch="FALSE"
        SecurityBits="11"
        Sequence="410"
        DisplayName="Equipment Booking"
        Description="My List Definition"
Image="/_layouts/images/itgen.gif"/>
</Elements>

So ändern Sie die Datei "Schema.xml"

Öffnen Sie im Projektmappen-Explorerim Knoten ListDefinition1 die Datei Schema.xml. Ersetzen Sie den Inhalt der Datei ListDefinition1\Schema.xml durch das folgende Markup.

<?xml version="1.0" encoding="utf-8"?>
<List xmlns:ows="Microsoft SharePoint" 
      EnableContentTypes="TRUE" 
      Title="Equipment Availability" 
      FolderCreation="FALSE" 
      Direction="$Resources:Direction;" 
      Url="Lists/EquipmentAvailability-ListDefinition1" 
      BaseType="0" 
      xmlns="https://schemas.microsoft.com/sharepoint/">
  <MetaData>
    <ContentTypes>
      <ContentTypeRef ID="0x01004d360004c8074de6a25f4d8cdd3be8dd" />
      <ContentTypeRef ID="0x01">
        <Folder TargetName="Item" />
      </ContentTypeRef>
      <ContentTypeRef ID="0x0120" />
    </ContentTypes>
    <Fields>
      <Field ID="{d3a92d97-2b77-4a25-9698-3ab54874bc10}" 
             Name="EquipmentDescription" 
             Type="Note" 
             DisplayName="Equipment Description"  
             Required="FALSE" 
             NumLines="6"></Field>
      <Field ID="{d3a92d97-2b77-4a25-9698-3ab54874bc12}"
             Name="EquipmentAvailable" 
             Type="Boolean" 
             DisplayName="Equipment Available?"  
             Required="FALSE"> </Field>
    </Fields>
    <Views>
      <View BaseViewID="0" Type="HTML" MobileView="TRUE" 
            TabularView="FALSE" 
            MobileDefaultView="TRUE" >
        <Toolbar />
        <XslLink>main.xsl</XslLink>
        <ViewBody>
          <HTML><![CDATA[<tr class="]]></HTML>
          <GetVar Name="AlternateStyle" />
          <HTML><![CDATA["]]></HTML>
          <Switch>
            <Expr>
              <GetVar Name="TabularView" />
            </Expr>
            <Case Value="1">
              <HTML><![CDATA[ iid="]]></HTML>
              <Counter Type="View" />
              <HTML>,</HTML>
              <Column Name="ID" HTMLEncode="TRUE" />
              <HTML><![CDATA[,]]></HTML>
              <LookupColumn Name="FSObjType" HTMLEncode="TRUE" />
              <HTML><![CDATA["><td class="ms-vb-itmcbx">
              <input type="checkbox" class="s4-itm-cbx"/></td>]]></HTML>
            </Case>
            <Default>
              <HTML><![CDATA[>]]></HTML>
            </Default>
          </Switch>
          <IfEqual>
            <Expr1>
              <GetVar Name="AlternateStyle" />
            </Expr1>
            <Expr2>ms-alternating</Expr2>
            <Then>
              <SetVar Scope="Request" Name="AlternateStyle"></SetVar>
            </Then>
            <Else>
              <SetVar Scope="Request" 
                      Name="AlternateStyle">ms-alternating</SetVar>
            </Else>
          </IfEqual>
          <Fields>
            <HTML><![CDATA[<td class="]]></HTML>
            <FieldSwitch>
              <Expr>
                <Property Select="ClassInfo" />
              </Expr>
              <Case Value="Menu">
                <HTML>
                  <![CDATA[ms-vb-title" 
                  onmouseover="OnChildItem(this)" 
                  height="100%]]>
                </HTML>
              </Case>
              <Case Value="Icon">ms-vb-icon</Case>
              <Default>
                <FieldSwitch>
                  <Expr>
                    <Property Select="Type" />
                    <PresenceEnabled />
                  </Expr>
                  <Case Value="UserTRUE">ms-vb-user</Case>
                  <Case Value="UserMultiTRUE">ms-vb-user</Case>
                  <Default>ms-vb2</Default>
                </FieldSwitch>
              </Default>
            </FieldSwitch>
            <HTML><![CDATA[">]]></HTML>
            <Field />
            <HTML><![CDATA[</td>]]></HTML>
          </Fields>
          <HTML><![CDATA[</tr>]]></HTML>
        </ViewBody>
        <RowLimit>20</RowLimit>
        <ViewFields>
          <FieldRef Name="LinkTitleNoMenu"></FieldRef>
          <FieldRef Name="EquipmentAvailable"></FieldRef>
        </ViewFields>
        <Query>
          <OrderBy>
            <FieldRef Name="Modified" Ascending="FALSE"></FieldRef>
          </OrderBy>
        </Query>
        <ParameterBindings>
          <ParameterBinding Name="AddNewAnnouncement" 
                            Location="Resource(wss,addnewitem)" />
          <ParameterBinding Name="NoAnnouncements" 
                            Location="Resource(wss,noXinviewofY_LIST)" />
          <ParameterBinding Name="NoAnnouncementsHowTo" 
                            Location="Resource(wss,noXinviewofY_ONET_HOME)" />
        </ParameterBindings>
      </View>
      <View BaseViewID="1" Type="HTML" 
            WebPartZoneID="Main" 
            DisplayName="$Resources:core,objectiv_schema_mwsidcamlidC24;" 
            DefaultView="TRUE" MobileView="TRUE" 
            MobileDefaultView="TRUE" 
            SetupPath="pages\viewpage.aspx" 
            ImageUrl="/_layouts/images/generic.png" 
            Url="AllItems.aspx">
        <Toolbar />
        <XslLink>main.xsl</XslLink>
        <ViewBody>
          <HTML><![CDATA[<tr class="]]></HTML>
          <GetVar Name="AlternateStyle" />
          <HTML><![CDATA["]]></HTML>
          <Switch>
            <Expr>
              <GetVar Name="TabularView" />
            </Expr>
            <Case Value="1">
              <HTML><![CDATA[ iid="]]></HTML>
              <Counter Type="View" />
              <HTML>,</HTML>
              <Column Name="ID" HTMLEncode="TRUE" />
              <HTML><![CDATA[,]]></HTML>
              <LookupColumn Name="FSObjType" HTMLEncode="TRUE" />
              <HTML><![CDATA["><td class="ms-vb-itmcbx">
              <input type="checkbox" class="s4-itm-cbx"/></td>]]></HTML>
            </Case>
            <Default>
              <HTML><![CDATA[>]]></HTML>
            </Default>
          </Switch>
          <IfEqual>
            <Expr1>
              <GetVar Name="AlternateStyle" />
            </Expr1>
            <Expr2>ms-alternating</Expr2>
            <Then>
              <SetVar Scope="Request" Name="AlternateStyle"></SetVar>
            </Then>
            <Else>
              <SetVar Scope="Request" 
                      Name="AlternateStyle">ms-alternating</SetVar>
            </Else>
          </IfEqual>
          <Fields>
            <HTML><![CDATA[<td class="]]></HTML>
            <FieldSwitch>
              <Expr>
                <Property Select="ClassInfo" />
              </Expr>
              <Case Value="Menu">
                <HTML><![CDATA[ms-vb-title" 
                onmouseover="OnChildItem(this)" 
                height="100%]]></HTML>
              </Case>
              <Case Value="Icon">ms-vb-icon</Case>
              <Default>
                <FieldSwitch>
                  <Expr>
                    <Property Select="Type" />
                    <PresenceEnabled />
                  </Expr>
                  <Case Value="UserTRUE">ms-vb-user</Case>
                  <Case Value="UserMultiTRUE">ms-vb-user</Case>
                  <Default>ms-vb2</Default>
                </FieldSwitch>
              </Default>
            </FieldSwitch>
            <HTML><![CDATA[">]]></HTML>
            <Field />
            <HTML><![CDATA[</td>]]></HTML>
          </Fields>
          <HTML><![CDATA[</tr>]]></HTML>
        </ViewBody>
        <RowLimit Paged="TRUE">30</RowLimit>
        <ViewFields>
          <FieldRef Name="Attachments"></FieldRef>
          <FieldRef Name="LinkTitle"></FieldRef>
          <FieldRef Name="EquipmentDescription"></FieldRef>
          <FieldRef Name="EquipmentAvailable"></FieldRef>
        </ViewFields>
        <Query>
          <OrderBy>
            <FieldRef Name="ID"></FieldRef>
          </OrderBy>
        </Query>
        <ParameterBindings>
          <ParameterBinding Name="NoAnnouncements" 
                            Location="Resource(wss,noXinviewofY_LIST)" />
          <ParameterBinding Name="NoAnnouncementsHowTo" 
                            Location="Resource(wss,noXinviewofY_DEFAULT)" />
        </ParameterBindings>
      </View>
    </Views>
    <Forms>
      <Form Type="DisplayForm" Url="DispForm.aspx" 
            SetupPath="pages\form.aspx" WebPartZoneID="Main" />
      <Form Type="EditForm" Url="EditForm.aspx" 
            SetupPath="pages\form.aspx" WebPartZoneID="Main" />
      <Form Type="NewForm" Url="NewForm.aspx" 
            SetupPath="pages\form.aspx" WebPartZoneID="Main" />
    </Forms>
  </MetaData>
</List>

So stellen Sie das Projekt bereit und testen es

Klicken Sie im Projektmappen-Explorermit der rechten Maustaste auf das Projekt, und wählen Sie dann Bereitstellen aus.
Öffnen Sie die SharePoint-Homepage.
Klicken Sie im Menü Schnellstart auf Equipment Availability. Die in der Listeninstanz definierten Elemente werden angezeigt.

In Visual Studio 2010 gibt es einen Projekttyp, mit dem Sie Listendefinitionen und Listeninstanzen in Visual Studio erstellen können.
Mithilfe einer Listendefinition können Websitebenutzer neue Listeninstanzen basierend auf der Definition erstellen, indem sie die Definition im Dialogfeld Erstellen auf der SharePoint-Website auswählen.
Optional können Sie zusammen mit der Listendefinition eine Listeninstanz in Visual Studio erstellen, damit beim Bereitstellen des Projekts die Instanz basierend auf der Listendefinition erstellt wird.

Listendefinitionsdatei "Elements.xml"

In diesem Beispiel wird die Listendefinitionsdatei Elements.xml bearbeitet, damit sie einen eindeutigen Wert für Type aufweist. Der Wert für Type sollte höher als 10.000 und für dieses Feature eindeutig sein.

Type="10001"

Sie müssen dem XML-Tag List Elements die folgenden Attribute hinzufügen, um Inhaltstypen zu aktivieren und das Löschen von Listen, die basierend auf dieser Definition erstellt werden, zu deaktivieren.

AllowDeletion="FALSE"
DisallowContentTypes="FALSE"

Der Inhaltstyp Equipment Availability wird der Definition hinzugefügt. Er gibt den Inhaltstyp des übergeordneten Elements an und weist eine eindeutige Inhalts-ID auf, die durch Verketten der übergeordneten ID und einer GUID erstellt wird.

<ContentType
      ID="0x01004d360004c8074de6a25f4d8cdd3be8dd"
      Name="Equipment Availability"
      Group="Custom Content Type"
      Description="Equipment Availability"
      Version="0">
    <FieldRefs>
      <FieldRef ID="{d3a92d97-2b77-4a25-9698-3ab54874bc10}" />
      <FieldRef ID="{d3a92d97-2b77-4a25-9698-3ab54874bc12}" />
    </FieldRefs>
  </ContentType>

Weitere Informationen zum Erstellen von IDs für Inhaltstypen finden Sie unter Inhaltstyp-IDs.

Innerhalb dieses Inhaltstyps fügen Sie FieldRef-Tags mit GUIDs zum Identifizieren von Spalten hinzu, die den bereits vorhandenen Spalten des übergeordneten Inhaltstyps hinzugefügt werden. Die GUIDs für jedes Feld werden vom Entwickler generiert. Die Details für diese Spalten werden in derselben Datei hinzugefügt.

<Field ID="{d3a92d97-2b77-4a25-9698-3ab54874bc10}" 
       Name="EquipmentDescription" 
       Type="Note" 
       DisplayName="Equipment Description" 
       Required="FALSE" 
       NumLines="6">
</Field>

<Field ID="{d3a92d97-2b77-4a25-9698-3ab54874bc12}" 
       Name="EquipmentAvailable" 
       Type="Boolean" 
       DisplayName="Equipment Available" 
       Required="FALSE"> 
  </Field>

Die GUIDs müssen unbedingt mit den GUIDs für ContentType aus dem vorherigen Schritt übereinstimmen. Mit den zusätzlichen Attributen werden der Feldtyp und das Verhalten auf dem Bildschirm angegeben.

Listendefinitionsdatei "Schema.xml"

Dem Listendefinitionsschema wird das folgende Attribut hinzugefügt.

EnableContentTypes="TRUE"

Zwischen den Tags <Fields> </Fields> am Anfang der Datei Schema.xml sind die folgenden Field-Tags erforderlich.

<Field ID="{d3a92d97-2b77-4a25-9698-3ab54874bc10}" 
       Name="EquipmentDescription" Type="Note" 
       DisplayName="Equipment Description" 
       Required="FALSE" NumLines="6">
</Field>
<Field ID="{d3a92d97-2b77-4a25-9698-3ab54874bc12}" 
       Name="EquipmentAvailable" Type="Boolean" 
       DisplayName="Equipment Available" Required="FALSE"> 
</Field>

Diese Felder stimmen mit den Feldern überein, die der Datei Elements.xml hinzugefügt wurden.

Die Schemadatei erfordert außerdem einen Verweis auf den Inhaltstyp, der für diese Liste erforderlich ist. Im <ContentTypes>-Element müssen Sie wie folgt auf Content Type ID verweisen.

<ContentTypeRef ID="0x01004d360004c8074de6a25f4d8cdd3be8dd" />

Die Datei Schema.xml enthält auch die Definition für Ansichtsfelder, die beim Anzeigen der Liste auf der Website verwendet werden. Fügen Sie im <ViewFields>-Tag im Abschnitt DefaultView die folgenden Zeilen hinzu.

<FieldRef Name="EquipmentDescription"></FieldRef>
<FieldRef Name="EquipmentAvailable"></FieldRef>

Listeninstanzdatei "Elements.xml"

Sie müssen die Listeninstanzdatei Elements.xml so bearbeiten, dass sie einen eindeutigen TemplateType aufweist und Title der Listeninstanz dieser Website entspricht.

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="https://schemas.microsoft.com/sharepoint/">
  <ListInstance Title="Equipment Availability"
                OnQuickLaunch="TRUE"
                TemplateType="10001"
                Url="Lists/EquipmentAvailability-ListInstance1"
                Description="My List Instance">

Sie konfigurieren die Listeninstanz so, dass sie im Menü Schnellstart angezeigt wird. Dadurch werden die Listendefinitionseinstellungen für diese Listeninstanz überschrieben. Sie können Daten mit der Listeninstanz hinzufügen, indem Sie der Listeninstanz-XML-Datei XML hinzufügen. Mit dem folgenden XML werden der Liste drei Datenzeilen hinzugefügt.

<Data>
  <Rows>
    <Row>
      <Field Name ="Title">Projector</Field>
      <Field Name ="EquipmentDescription">
        High Definition Projector with built-in speaker.
      </Field>
      <Field Name ="EquipmentAvailable">TRUE</Field>
    </Row>
    <Row>
      <Field Name ="Title">Wired Microphone</Field>
      <Field Name ="EquipmentDescription">
        Dynamic Voice Microphone.
      </Field>
      <Field Name ="EquipmentAvailable">FALSE</Field>
    </Row>
    <Row>
      <Field Name ="Title">Wireless Microphone System</Field>
      <Field Name ="EquipmentDescription">
        Two hand held microphones and VHF receiver system.
      </Field>
      <Field Name ="EquipmentAvailable">TRUE</Field>
    </Row>
  </Rows>
</Data>

Video anschauen (00:06:09)

Code abrufen

Informationen zum Autor

Community-Mitwirkender Ben Hedges ist Senior Vice President, Research and Development, bei Point8020. Ben erstellt vor allem Modelle für Lösungen in den Bereichen Talentmanagement, Kompatibilität und Bildung und Entwicklung in SharePoint. Ben besitzt umfangreiche Erfahrungen bei der Erfüllung von Kundenanforderungen mithilfe von Microsoft-Technologien.