Gewusst wie: Anpassen des Webparts für Inhaltsabfragen mithilfe benutzerdefinierter Eigenschaften

Letzte Änderung: Mittwoch, 22. September 2010

Gilt für: SharePoint Server 2010

Mit dem Webpart für Inhaltsabfragen können Sie benutzerdefinierte Ansichten für Daten aus vielen verschiedenen Quellen erstellen und diese Daten zentral anzeigen. Nachdem Sie das Webpart für Inhaltsabfragen einer Website hinzugefügt haben, können Sie das Abfrageverhalten, benutzerdefinierte Listen und Inhaltstypen des Webparts durch Festlegen benutzerdefinierter Eigenschaften anpassen. Für die ContentByQueryWebPart-Klasse sind 60 Eigenschaften und Methoden verfügbar, von denen viele angepasst werden können. In diesem Thema werden einige Eigenschaften vorgestellt. Außerdem gibt es Syntax- und Verwendungsbeispiele im CAML-Format (Collaborative Application Markup Language), die Sie einer WEBPART-Datei hinzufügen können.

Einige Eigenschaften des Webparts für Inhaltsabfragen von Microsoft SharePoint Server 2010 werden von Microsoft SharePoint Foundation geerbt, andere Eigenschaften wiederum gibt es nur in SharePoint Server 2010. Schwerpunkt dieses Themas sind in SharePoint Server 2010 eingeführte Eigenschaften. Bei den Eigenschaften des Webparts für Inhaltsabfragen von SharePoint Server 2010 gibt es die folgenden beiden Basiskategorien:

• Eigenschaften, mit denen ein Aspekt des zugrunde liegenden Webpartverhaltens festgelegt oder überschrieben wird. In einigen Fällen wirken sich diese Eigenschaften auch auf die Benutzeroberfläche aus.

• Eigenschaften, mit denen die Webpart-Benutzeroberfläche geändert wird, ohne dass zugrunde liegendes Verhalten festgelegt oder überschrieben wird.

Eigenschaften mit Änderung der Benutzeroberfläche und des Verhaltens

Die Eigenschaften in der ersten Gruppe, wie z. B. Überschreibungen, sind im Allgemeinen leistungsfähiger, da damit das Verhalten des Webparts geändert werden kann. Wenn ein Benutzer versucht, die Benutzeroberfläche zu ändern oder eine andere Eigenschaft festzulegen, die sich auf das Verhalten dieser Eigenschaft auswirken könnte, hat diese Eigenschaft in der Benutzeroberfläche die Oberhand. Sie überschreibt andere Einstellungen und bestimmt das Verhalten des Webparts für Inhaltsabfragen. Diese Eigenschaften sind für folgende Aufgaben hilfreich:

• Hinzufügen permanenter Felder und Feldoptionen.

• Überschreiben des Standardverhaltens listenübergreifender Abfragen, sodass Änderungen an Feldern und Feldoptionen in der Benutzeroberfläche permanent sind und nicht überschrieben oder durch andere Änderungen außer Kraft gesetzt werden können.

• Umbenennen langer, zusammengesetzter Spaltennamen in gängigere XSL-Transformationsvariablennamen und Vermeiden des Erstellens benutzerdefinierter XSL-Transformationen für jedes Schema.

In Tabelle 1 werden einige Eigenschaften beschrieben, mit denen die Benutzeroberfläche und das Verhalten geändert werden.

Tabelle 1. Eigenschaften mit Änderung der Benutzeroberfläche und des Verhaltens

Eigenschaften mit Änderung der Benutzeroberfläche, aber ohne Überschreibung des Verhaltens

Alternativ benötigen Sie möglicherweise einfachere Optionen zum Anpassen von Feldern, Feldoptionen, Gruppierungs- und Sortieroptionen sowie Filteroptionen in der Benutzeroberfläche. Diese Anpassungen wirken sich nicht auf das zugrunde liegende Verhalten aus und können durch Eigenschaften in der ersten Gruppe überschrieben werden, die das Verhalten tatsächlich überschreiben. Derartige Anpassungen sind für folgende Aufgaben hilfreich:

• Anbieten von mehr Optionen über ein Webpart für Inhaltsabfragen, als ursprünglich festgelegt sind, wenn der Seite eine Webpartinstanz hinzugefügt wird.

• Auswirkungen nur auf ein Webpart, das wahrscheinlich nicht überschrieben wird.

• Verfügbarmachen von mehr Optionen für den Endbenutzer.

In Tabelle 2 sind einige der Eigenschaften aus dieser Gruppe beschrieben.

Tabelle 2. Eigenschaften ohne Überschreiben des Verhaltens

Vorgehensweisen zum Anpassen eines Webparts für Inhaltsabfragen

Es gibt mehrere Möglichkeiten, um benutzerdefinierte Eigenschaften in einem Webpart für Inhaltsabfragen festzulegen oder zu ändern. Die gewählte Methode hängt ab von Ihren Zielsetzungen und wo Sie sich in der Website und im Websiteentwurfsprozess befinden. Wenn Sie z. B. ein vorhandenes Seitenlayout anpassen, können Sie mit Microsoft SharePoint Designer 2010 das Webpart für Inhaltsabfragen anpassen, während Sie das Seitenlayout anpassen. Wenn Sie ein neues, angepasstes Webpart für Inhaltsabfragen für ein vorhandenes Seitenlayout erstellen, können Sie mit SharePoint Designer 2010 benutzerdefinierte Eigenschaften hinzufügen oder ändern.

Wenn Sie die benutzerdefinierten Eigenschaften eines vorhandenen Webparts für Inhaltsabfragen ändern möchten, können Sie die WEBPART-Datei exportieren, eine Kopie davon erstellen und die Originaldatei umbenennen, die benutzerdefinierten Eigenschaften in der Kopie der WEBPART-Datei ändern und diese anschließend in eine Webpartzone Ihrer Seite importieren. Durch das Umbenennen der WEBPART-Originaldatei wird sichergestellt, dass eine Kopie der WEBPART-Originaldatei für künftige Upgradeszenarien vorhanden ist.

So exportieren Sie eine WEBPART-Datei, legen deren benutzerdefinierte Eigenschaften fest und importieren sie anschließend

1. Melden Sie sich bei Ihrer Website an.

2. Klicken Sie im Menü Websiteaktionen auf Seite bearbeiten.

3. Suchen Sie auf der Seite nach dem Webpart für Inhaltsabfragen, und klicken Sie dann im Menü Bearbeiten des Webparts auf Exportieren.

4. Speichern Sie die WEBPART-Datei.

5. Benennen Sie die WEBPART-Datei um, und öffnen Sie dann die umbenannte Datei in einem Text-Editor oder in SharePoint Designer 2010.

   Hinweis
   Durch das Umbenennen der WEBPART-Originaldatei wird sichergestellt, dass eine Kopie der WEBPART-Originaldatei für künftige Upgradeszenarien vorhanden ist.

6. Fügen Sie Eigenschaften und Eigenschaftenwerte hinzu, oder ändern Sie diese, und speichern Sie anschließend die Änderungen.

7. Zeigen Sie im Menü Seite auf Webparts hinzufügen, und klicken Sie dann auf Durchsuchen.

8. Wählen Sie in der Webpartliste das zu importierende Webpart aus, und klicken Sie dann auf OK.

9. Ziehen Sie das Webpart in eine Webpartzone auf der Seite.

Beispiel

Beschreibung

In diesem Abschnitt werden benutzerdefinierte Eigenschaften beschrieben. Außerdem gibt es Formatierungs- und Codebeispiele für benutzerdefinierte Eigenschaftsanweisungen und CAML-Abfragen in einem Webpart für Inhaltsabfragen. Zunächst finden Sie hier Informationen zu Formatierung und Basisfeldern der CommonViewFields-Eigenschaft sowie Tipps zu deren Verwendung. Anschließend folgt eine komplette CAML-Abfrage, und außerdem befassen wir uns mit den Eigenschaften QueryOverride, ListsOverride, WebsOverride und ViewFieldsOverride, die mit dieser Abfrage festgelegt werden. Sie können die verschiedenen Eigenschaftenwerte aus der CAML-Abfrage der entsprechenden <Eigenschaftenwert>-Anweisung in der WEBPART-Datei hinzufügen. Schließlich wird die DataColumnRenames-Eigenschaft und deren Filter-, Gruppierungs- und Sortieroptionen vorgestellt.

CommonViewFields-Eigenschaft

Beim Anpassen der CommonViewFields-Eigenschaft können zwei Formate verwendet werden. Sie können Felder wie folgt anhand ihres internen Werts angeben, oder anhand einer Kombination aus internem Namen und Feldnamen:

• Interner Name des Felds

• Interner Name des Felds, Feldtyp

Bei der Schreibweise für Sonderzeichen wird der interne Name von dem in der Benutzeroberfläche verwendeten Namen unterschieden. Beispielsweise wird ein Leerzeichen zwischen Wörtern durch _x0020_ im internen Namen dargestellt. Den internen Namen können Sie anzeigen, indem Sie den Abfragezeichenfolge-Parameter auf einer Websitespaltenseite anzeigen oder indem Sie den Webpartcode nach dem Erstellen des Felds anzeigen. Den Webpartcode können Sie anzeigen, wenn Sie für das Webpart die Filterung nach einem Feld festlegen, das Webpart exportieren und anschließend die Filtereigenschaften anzeigen.

Hinweis

Eine Liste zusätzlicher field types, die von der CommonViewField-Eigenschaft angefordert werden können, finden Sie in der SPFieldType-Enumeration im SharePoint Foundation 2010 SDK. SharePoint Server 2010 enthält vier zusätzliche Felder – HTML, Image, Link und SummaryLink –, die Sie anfordern können. Mit den in diesem Thema aufgelisteten Konstanten werden die zulässigen Datentypen für eine CommonViewFields-Eigenschaft identifiziert.

Definitionen für CommonViewFields können auch zu Verbundanweisungen zusammengefasst werden. Dies ist hilfreich, um mehrere Felder in einer Eigenschaftsanweisung festzulegen. Verwenden Sie ein Semikolon zum Trennen der Felder, wenn Sie Definitionen in einer Anweisung zusammenfassen. Beispiel:

Interner Name des Felds; Interner Name des Felds, Feldtyp

CommonViewFields ist eine additive Eigenschaft, d. h., Sie können neben den Basisfeldern, die vom Webpart für Inhaltsabfragen immer angefordert werden, ein allgemeines Ansichtsfeld hinzufügen. Von den Basisfeldern werden Standardspalten anhand der GUID angefordert, und in der Benutzeroberfläche werden sie als Websitespaltennamen angezeigt. In Tabelle 3 werden die Basisfeldnamen und -typen aufgelistet.

Tabelle 3. Basisfeldnamen und -typen

Im folgenden Beispiel wird mit der CommonViewFields-Eigenschaft die GUID festgelegt, mit der intern von SharePoint Server 2010 der interne Name des Felds, der Feldtyp, der interne Name von CommonViewField und der Basistyp angegeben werden, gefolgt von der GUID des Basistyps.

<property name="CommonViewFields" type="string">_Level,Number;PublishingRollupImage;</property>

Die Eigenschaften "QueryOverride", "ListsOverride", "WebsOverride" und "ViewFieldsOverride"

Mit jeder Überschreibungseigenschaft – QueryOverride, ListsOverride, WebsOverride und ViewFieldsOverride – wird ein Standardverhalten des Webparts für Inhaltsabfragen überschrieben. Wenn Sie ein Verhalten überschreiben möchten, erstellen Sie eine CAML-Abfrage, mit der die gewünschten Bedingungen definiert werden.

Hinweis
Weitere Informationen zur CAML-Syntax und zu CAML-Befehlen finden Sie in der CAML-Hauptschemas (Collaborative Application Markup Language) im SharePoint Foundation 2010 SDK.

Im folgenden Beispiel wird das Festlegen benutzerdefinierter Eigenschaften für das Webpart für Inhaltsabfragen mithilfe einer CAML-Abfrage veranschaulicht. Mit der CAML-Abfrage werden folgende Aktionen ausgeführt:

1. Das Feld Created wird abgerufen.

2. Die Abfrage wird so konfiguriert, dass Elemente, die in den letzten sieben Tagen aktualisiert wurden, abgerufen und in absteigender Reihenfolge sortiert werden.

3. Der Listentyp, der für die Abfrage verwendet werden soll, wird angegeben.

4. Daten werden rekursiv aus der angegebenen Website und deren Unterwebsites abgerufen.

5. Werte für ein bestimmtes Feld werden abgerufen, um sie für jedes Element anzuzeigen.

In den folgenden Abschnitten wird die komplette Abfrage angezeigt und ausführlich beschrieben.

 1 <ViewFields>
 2   <FieldRef Name="Title" Nullable="True" Type="Text"/>
 3   <FieldRef Name="Comments" Nullable="True" Type="Note"/>
 4 </ViewFields>
 5 <Lists ServerTemplate="850"></Lists>
 6 <Webs Recursive="True" />
 7 <RowLimit>15</RowLimit>
 8 <![CDATA[
 9    <Where>
10     <Gt>
11       <FieldRef Name="Created" Nullable="True" Type="DateTime"/>
12       <Value Type="DateTime"><Today OffsetDays="-7"/></Value>
13     </Gt>
14   </Where>
15   <OrderBy>
16       <FieldRef Name="Created" Nullable="True" Type="DateTime"
17       Ascending="FALSE"/>
18   </OrderBy>]]> 

QueryOverride-Eigenschaft

In den Zeilen 8 bis 19 wird die QueryOverride-Eigenschaft definiert.

 8 <![CDATA[
 9    <Where>
10     <Gt>
11       <FieldRef Name="Created" Nullable="True" Type="DateTime"/>
12       <Value Type="DateTime"><Today OffsetDays="-7"/></Value>
13     </Gt>
14   </Where>
15 <OrderBy>
16    <FieldRef Name="Created" Nullable="True" Type="DateTime"
17    Ascending="FALSE"/>
18 </OrderBy>
19 </Query>]]>

Im vorherigen Beispiel:

• In den Zeilen 8 bis 10 wird die Abfrage definiert und die <where>-Klausel geöffnet.

• In Zeile 11 wird auf das Basistypfeld mit dem Namen "Created" verwiesen, das den Feldtyp DateTime aufweist.

• In Zeile 12 wird der Wert für dieses Feld auf DateTime sowie ein Offset von -7 festgelegt, d. h., der Wert "7" wird von dem Datum subtrahiert, nach dem die Abfrage filtert.

• In den Zeilen 13 und 14 wird die <where>-Klausel geschlossen.

• In Zeile 15 wird die <OrderBy>-Klausel geöffnet, die die Sortierreihenfolge für die darin angegebenen Felder bestimmt.

• In den Zeilen 16 und 17 wird die Sortierreihenfolge für das Feld "Created" festgelegt. Diese Daten werden vom Webpart in absteigender Reihenfolge angezeigt.

ListsOverride-Eigenschaft

Mit einer CAML-Abfrage können Sie auch Elemente aus SharePoint Foundation 2010- und SharePoint Server 2010-Listen abrufen. In Tabelle 4 finden Sie drei Beispiele für CAML-Anweisungen, mit denen Elemente aus unterschiedlichen Listentypen abgerufen werden.

Tabelle 4. Drei Beispiele für CAML-Anweisungen, mit denen Elemente aus unterschiedlichen Listentypen abgerufen werden

<![CDATA[
   <Lists ServerTemplate="850">
   </Lists>
]]>

<![CDATA[
         <Lists BaseType="0">
         </Lists>
]]>

<![CDATA[
   <Lists>
     <List ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}"/>
   </Lists>
]]>

Im Beispiel wird in Zeile 5 die ListsOverride-Eigenschaft definiert.

5 <Lists ServerTemplate="850"></Lists>

In diesem Fall wird in der Abfrage mithilfe von ServerTemplate="850" die aktuell verwendete Liste überschrieben. Eine Aufstellung der in der Lists-Eigenschaft verfügbaren Listentypen finden Sie im SharePoint Foundation 2010 SDK.

WebsOverride-Eigenschaft

Mithilfe von CAML können Sie wie im folgenden Codebeispiel veranschaulicht für die WebsOverride-Eigenschaft festlegen, dass Elemente rekursiv abgerufen werden.

<![CDATA[
   <Webs Recursive="True"/>
]]>

Sie können Elemente aber auch nur von den angegebenen Websites abrufen.

<![CDATA[
   <Webs/>
]]>

In Zeile 6 des Beispiels legen wir für diese Eigenschaft fest, dass Elemente rekursiv abgerufen werden.

6 <Webs Recursive="True"/>

ViewFieldsOverride-Eigenschaft

Wenn Sie Werte für jedes Element im Webpart abrufen möchten, legen Sie wie im folgenden Codebeispiel veranschaulicht für die ViewFieldsOverride-Eigenschaft fest, dass Daten eines angegebenen Typs aus einem angegeben Feld abgerufen werden.

<![CDATA[
   <FieldRef Name="Comments" Nullable="True" Type="Note"/>
   <FieldRef Name="Created" Nullable="False" Type="User"/>
]]>

Durch Festlegen von Nullable="True" werden Elemente zurückgegeben, die diese Spalte nicht aufweisen.

Im Codebeispiel wird in den Zeilen 1 bis 4 die ViewFieldsOverride-Eigenschaft festgelegt:

1 <ViewFields>
2   <FieldRef Name="Title" Nullable="True" Type="Text"/>
3   <FieldRef Name="Comments" Nullable="True" Type="Note"/>
4 </ViewFields>

• In Zeile 1 wird die <ViewFields>-Klausel geöffnet, mit der die ViewFieldsOverride-Eigenschaft festgelegt wird.

• In den Zeilen 2 und 3 wird auf das Feld Title (ein Textfeld) und das Feld Comments (ein Notizfeld) verwiesen.

• In Zeile 4 wird die <ViewFields>-Klausel geschlossen.

DataColumnRename-Eigenschaft

Verwenden Sie die DataColumnRename-Eigenschaft, um Spalten programmgesteuert umzubenennen. Mit dieser Eigenschaft können XSLT- und Schemaanpassungen minimiert werden oder Spaltenumbenennungen als Massenvorgang oder benutzerdefiniert ausgeführt werden. Beispielsweise können Sie einen zusammengesetzten Spaltennamen wie etwa KBArticleTitle in einen gängigen XSL-Transformationsvariablennamen wie etwa Title umbenennen. Dadurch muss nicht für jedes benutzerdefinierte Schema eine benutzerdefinierte XSL-Transformation erstellt werden.

Trennen Sie die Werte für die Spaltenumbenennung durch Semikolons, und verwenden Sie das Format originalName,newName.

<![CDATA[<property name="DataColumnRenames" type="string">KBArticleTitle,Title</property>]]

Hinweis
Ein Fehler wird gemeldet, wenn Sie eine Spalte in einen bereits vorhandenen Namen umbenennen.

Zusätzliche Feld-, Filter-, Gruppierungs- und Sortieroptionen

In dieser Gruppe legen Sie Eigenschaften fest, um Felder, Gruppierungen, Gruppierungs- und Sortieroptionen, Filter und Filteroptionen hinzuzufügen. Sie können Felder anhand ihres internen Werts, anhand der GUID oder anhand einer Kombination aus internem Namen und Anzeigenamen bzw. GUID und Anzeigenamen angeben.

Definieren Sie die Eigenschaften AdditionalFilterFields und AdditionalGroupAndSortFields mithilfe eines der folgenden Formate:

• internalName

• internalName,DisplayName

• GUID

• GUID,DisplayName

Definitionen für AdditionalFilterFields- und AdditionalGroupAndSortFields können auch zu Verbundanweisungen zusammengefasst werden. Dies ist hilfreich, um mehrere Felder in einer Eigenschaftsanweisung festzulegen. Verwenden Sie wie im Folgenden gezeigt Semikolons zum Trennen der Felder, wenn Sie Definitionen in einer Anweisung zusammenfassen:

internalName;GUID; internalName,DisplayName;GUID,DisplayName

Durch Festlegen der AdditionalFilterFields-Eigenschaft können Sie wie im folgenden Codebeispiel dargestellt der Benutzeroberfläche das Filterfeld Created hinzufügen.

<![CDATA[<property name="AdditionalFilterFields" type="string">Created</property>]]

Durch Festlegen der AdditionalGroupAndSortFields-Eigenschaft können Sie den Gruppierungs- und Sortierlisten in der Benutzeroberfläche die Option Created hinzufügen.

<!CDATA[<property name="AdditionalGroupAndSortFields" type="string">Created</property>]]

Filter-Eigenschaften

Mithilfe benutzerdefinierter Eigenschaften können Sie Filterwerte über die von der Benutzeroberfläche unterstützte Funktionalität hinaus erweitern. Durch Festlegen oder Ändern einer der Eigenschaften für Filterfelder, Filtertypen, Filterwerte oder Filterverkettungsoperatoren wird in der Benutzeroberfläche Filterverhalten hinzugefügt oder geändert.

Hinweis
Die Benutzeroberfläche hat Vorrang vor den Filtereigenschaften. In der Benutzeroberfläche werden damit vorab Standardwerte aufgefüllt.

Die Eigenschaften für Filterfeld, Filtertyp und Filterwert sind immer vom Typ string:

• <property name="FilterField1" type="string" />

• <property name="FilterType1" type="string" />

• <property name="FilterValue1" type="string" />

• <property name="FilterOperator1" type="Microsoft.SharePoint.Publishing.WebControls.ContentByQueryWebPart+FilterFieldQueryOperator, Microsoft.SharePoint.Publishing, Version=12.0.0, Culture=neutral" PublicKeyToken=71e9bce111e9429c"/>

Im folgenden Filtercodebeispiel wird der Filter "Created" im DateTime-Format angezeigt, und es werden Elemente angezeigt, die nach dem 25. Oktober 2011 erstellt wurden:

• <property name="FilterField1" type="string">Created</property>

• <property name="FilterType1" type="string">DateTime</property>

• <property name="FilterValue1" type="string">Today-7</property>

• <property name="FilterOperator1" type="Microsoft.SharePoint.Publishing.WebControls.ContentByQueryWebPart+FilterFieldQueryOperator, Microsoft.SharePoint.Publishing, Version=12.0.0, Culture=neutral" PublicKeyToken=71e9bce111e9429c"/>

Verwenden Sie das folgende Format zum Festlegen des type-Parameters in Eigenschaftsanweisungen für Filter- und Filterverkettungsoperatoren: PropertyName, namespace, Version, Culture, PublicKeyToken.

• <property name="FilterOperator1" type="Microsoft.SharePoint.Publishing.WebControls.ContentByQueryWebPart+FilterFieldQueryOperator, Microsoft.SharePoint.Publishing, Version=12.0.0, Culture=neutral" PublicKeyToken=71e9bce111e9429c"/>

• <property name="Filter1ChainingOperator" type="Microsoft.SharePoint.Publishing.WebControls.ContentByQueryWebPart+FilterField, Microsoft.SharePoint.Publishing, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c">Eq</property>

Die gültigen Werte für die Eigenschaften der Filter- und Filterverkettungsoperatoren unterscheiden sich wie folgt:

• Mit den Filteroperatoreigenschaften werden die Schaltflächen Und und Oder in der Benutzeroberfläche angezeigt.

• Mit den Eigenschaften der Filterverkettungsoperatoren wird das zweite Feld in den Listen Elemente anzeigen, wenn: im Abschnitt Zusätzliche Filter der Benutzeroberfläche aufgefüllt.

In Tabelle 5 sind die gültigen Werte für die Eigenschaften der Filteroperatoren aufgelistet.

Tabelle 5. Gültige Werte für Eigenschaften der Filteroperatoren

In Tabelle 6 sind die gültigen Werte für die Eigenschaften der Filterverkettungsoperatoren aufgelistet.

Tabelle 6. Gültige Werte für Eigenschaften der Filterverkettungsoperatoren

Siehe auch

Aufgaben

Gewusst wie: Anpassen der XSL für das Inhalt-nach-Abfrage-Webpart

Gewusst wie: Anzeigen von benutzerdefinierten Feldern in einem Webpart für Inhaltsabfragen

Gewusst wie: Anpassen von RSS für das Webpart für Inhaltsabfragen

Referenz

SPSiteDataQuery

ContentByQueryWebPart