Beschreibungsdateien für Webparts-Steuerelemente

Artikel
10/22/2014

Aktualisiert: November 2007

Beschreibungsdateien für Webparts-Steuerelemente enthalten Eigenschaftenwerte, Zustandsdaten sowie Assembly- und Quelldateidetails, die aus einem WebPart-Steuerelement (oder einem anderen in einer Webparts-Anwendung verwendeten ASP.NET-Serversteuerelement oder ASP.NET-Benutzersteuerelement) in eine XML-Datei mit der Erweiterung .WebPart exportiert wurden. Die Beschreibungsdatei wird von der Webparts-Importfeature zum Importieren des beschriebenen Steuerelements in eine Webparts-Seite und zum Konfigurieren des importierten Steuerelements mit den gespeicherten Daten verwendet. In diesem Thema werden die grundlegende Struktur einer Beschreibungsdatei und die darin enthaltenen XML-Elemente beschrieben.

<webParts>
  <webPart>
    <metaData>
      <type …/>
      <importErrorMessage …/>
    </metadata>
    <data>
      <properties>
        <ipersonalizable>
          <property …/>
        </ipersonalizable>
        <property …/>
      </properties>
      <genericWebPartProperties>
        <ipersonalizable>
          <property …/>
        </ipersonalizable>
        <property …/>
      </genericWebPartProperties>
    </data>
  </webPart>
</webParts>

Hinweise

Die folgende Tabelle enthält alle Elemente, die in eine Webparts-Beschreibungsdatei aufgenommen werden können (darunter eingerückt die unmittelbar untergeordneten Elemente des Elements), alle für das betreffende Element vorhandenen Attribute und eine Zusammenfassung des Verwendungszwecks. Beachten Sie, dass für ein Steuerelement, das die IPersonalizable-Schnittstelle implementiert, das untergeordnete <ipersonalizable>-Element vorhanden ist und die implementierten Eigenschaften als <property>-Elemente enthält. Andernfalls ist das <ipersonalizable>-Element in der Datei nicht vorhanden.

Element	Attribute	Zusammenfassung
webParts webPart	Keins.	Das übergeordnete Element in der Datei. Es kann nur einmal pro Datei vorhanden sein. Dahinter steht die Logik, dass dieses Element mehrere <webPart>-Elemente pro Datei enthalten könnte. In der aktuellen Implementierung ist in einer Beschreibungsdatei ein <webPart> vorhanden.
webPart metaData data	xmlns="https://schemas.microsoft.com/WebPart/v3" Hinweis: Dies ist ein Namespaceattribut mit einem festen Wert.	Stellt das Steuerelement dar, dessen der Zustand und Eigenschaftendaten in der Datei enthalten sind. Derzeit kann nur ein <webPart>-Element pro Datei vorhanden sein.
metaData type importErrorMessage	Keins.	Enthält Informationen zum Typ des <webPart>-Elements und eine Meldung für Benutzer, die bei Fehlern während des Importvorgangs angezeigt wird. Eine Instanz pro <webPart>-Element.
type	Für das type-Element muss ein name-Attribut oder ein src-Attribut oder beides angegeben werden. Wenn beide Attribute angegeben sind, hat name Vorrang. Der Wert des name-Attributs ist eine Zeichenfolge mit Typ- und (optional) Assemblyinformationen zum <webPart>-Element. Das src-Attribut stellt einen Pfad zur Quelldatei eines Benutzersteuerelements dar.	Enthält eine Liste von Typinformationen für eine Assembly, die ein <webPart>-Element enthält, bzw. den Pfad einer Quelldatei, falls <webPart> ein Benutzersteuerelement darstellt. Eine Instanz pro <webPart>-Element.
importErrorMessage	Keins.	Enthält den Text einer Meldung für Benutzer im Falle eines Fehlers während des Importvorgangs. Eine Instanz pro <webPart>-Element.
data properties genericWebPartProperties	Keins.	Enthält die Werte für Zustand und Eigenschaften des <webPart>-Elements. Eine Instanz pro <webPart>-Element.
properties ipersonalizable property	Keins.	Enthält <property>-Elemente, ein einzelnes <ipersonalizable>-Element (das untergeordnete <property>-Elemente enthält) oder beides. Das <properties>-Element ist immer vorhanden. Es verfügt nur dann über untergeordnete <property>-Elemente, wenn <webPart> personalisierbare Eigenschaften besitzt. Eine Instanz pro <webPart>-Element.
genericWebPartProperties ipersonalizable property	Keins.	Enthält <property>-Elemente, ein einzelnes <ipersonalizable>-Element (das untergeordnete <property>-Elemente enthält) oder beides. Dieses Element ist nur dann vorhanden, wenn das <webPart> entsprechende Steuerelement nicht von der WebPart-Klasse erbt. Eine Instanz pro <webPart>-Element.
ipersonalizable property	Keins.	Ein untergeordnetes Element des <properties>-Elements und des <genericWebPartProperties>-Elements. Dieses Element ist nur dann vorhanden, wenn das dem <webPart>-Element entsprechende Steuerelement die IPersonalizable-Schnittstelle implementiert. Es enthält ein oder mehrere <property>-Elemente. Eine Instanz pro <webPart>-Element.
property	Das Eigenschaftenelement verfügt über drei Attribute: name, type und null. Das name-Attribut und das type-Attribut müssen vorhanden sein. null wird nur dann verwendet, wenn die Eigenschaft über einen null-Wert verfügt. Das name-Attribut ist der Name derjenigen Eigenschaft des Steuerelements, die dem <webPart>-Element entspricht. Das null-Attribut kann einen der Werte true oder false annehmen. Es wird zur Unterscheidung des Werts von einer leeren Zeichenfolge ("") verwendet, wenn eine Eigenschaft über einen echten null-Wert verfügt. Das type-Attribut bezeichnet den Type der Eigenschaft, auf die im name-Attribut verwiesen wird. Der eigentliche Wert von type kann eine Zeichenfolge mit einem vollqualifizierten Typnamen oder mit einem der unten aufgeführten abgekürzten Typnamen sein. * string * int * bool * double * single * datetime * color * unit * fontsize * object * direction (stellt ContentDirection dar) * helpmode (stellt WebPartHelpMode dar) * chromestate (stellt PartChromeState dar) * chrometype (stellt PartChromeType dar) * exportmode (stellt WebPartExportMode dar)	Ein untergeordnetes Element der Elemente <properties>, <genericWebPartProperties> und <ipersonalizable>. Dieses Element enthält Name-Wert-Paare für jeden Eigenschaftenwert oder jedes Zustandsdatenelement innerhalb des <webPart>-Elements. Die eigentlichen Daten für eine Eigenschaft befinden sich zwischen den Tags des <property>-Elements, und Name und Typ des Eigenschaftselements werden durch die Attribute angegeben. Die drei Typen, die <property>-Elemente enthalten können, können keines oder beliebig viele davon enthalten.

Beispiel

Das folgende Codebeispiel zeigt zwei Webparts-Beschreibungsdateien, die aus Instanzen von Steuerelementen einer Webparts-Anwendung exportiert wurden. Das erste Beispiel zeigt eine Datei für ein Steuerelement, das von der WebPart-Basisklasse erbt. Beachten Sie, dass seine Eigenschaftendaten alle im Abschnitt <properties> enthalten sind. Das zweite Beispiel zeigt eine Datei für ein ASP.NET-Serversteuerelement, das nicht von der WebPart-Klasse erbt. Beachten Sie, dass seine Eigenschaftendaten alle im Abschnitt <genericWebPartProperties> enthalten sind.

<!-- File exported from a System.Web.UI.WebControls.WebParts.WebPart 
     control. -->
<?xml version="1.0" encoding="utf-8"?>
<webParts>
  <webPart xmlns="https://schemas.microsoft.com/WebPart/v3">
    <metaData>
      <type name="Samples.AspNet.CS.Controls.TextDisplayWebPart, 
        App_Code.zq0cecf5, Version=0.0.0.0, Culture=neutral, 
        PublicKeyToken=null" />
      <importErrorMessage>
        Cannot import this Web Parts control.
      </importErrorMessage>
    </metaData>
    <data>
      <properties>
        <property name="AllowClose" type="bool">True</property>
        <property name="Width" type="unit" />
        <property name="AllowMinimize" type="bool">True</property>
        <property name="ContentText" type="string" null="true" />
        <property name="AllowConnect" type="bool">True</property>
        <property name="ChromeType" type="chrometype">
          Default
        </property>
        <property name="TitleIconImageUrl" type="string" />
        <property name="Description" type="string" />
        <property name="Hidden" type="bool">False</property>
        <property name="TitleUrl" type="string" />
        <property name="AllowEdit" type="bool">True</property>
        <property name="Height" type="unit" />
        <property name="HelpUrl" type="string" />
        <property name="Title" type="string" />
        <property name="CatalogIconImageUrl" type="string" />
        <property name="Direction" type="direction">
          NotSet
        </property>
        <property name="ChromeState" type="chromestate">
          Normal
        </property>
        <property name="AllowZoneChange" type="bool">True</property>
        <property name="AllowHide" type="bool">True</property>
        <property name="HelpMode" type="helpmode">Navigate</property>
        <property name="ExportMode" type="exportmode">All</property>
      </properties>
    </data>
  </webPart>
</webParts>

<!-- File exported from a System.Web.UI.WebControls.BulletedList 
     control placed in a Web Parts zone. -->
<?xml version="1.0" encoding="utf-8"?>
<webParts>
  <webPart xmlns="https://schemas.microsoft.com/WebPart/v3">
    <metaData>
      <type name="System.Web.UI.WebControls.BulletedList, 
        System.Web, Version=2.0.0.0, Culture=neutral, 
        PublicKeyToken=b03f5f7f11d50a3a" />
      <importErrorMessage>
        Cannot import this Web Parts control.
      </importErrorMessage>
    </metaData>
    <data>
      <properties />
      <genericWebPartProperties>
        <property name="AllowClose" type="bool">True</property>
        <property name="Width" type="unit" />
        <property name="AllowMinimize" type="bool">True</property>
        <property name="AllowConnect" type="bool">True</property>
        <property name="ChromeType" type="chrometype">
          Default
        </property>
        <property name="TitleIconImageUrl" type="string" />
        <property name="Description" type="string" />
        <property name="Hidden" type="bool">False</property>
        <property name="TitleUrl" type="string" />
        <property name="AllowEdit" type="bool">True</property>
        <property name="Height" type="unit" />
        <property name="HelpUrl" type="string" />
        <property name="Title" type="string">
          Favorite Links
        </property>
        <property name="CatalogIconImageUrl" type="string" />
        <property name="Direction" type="direction">
          NotSet
        </property>
        <property name="ChromeState" type="chromestate">
          Normal
        </property>
        <property name="AllowZoneChange" type="bool">
          True
        </property>
        <property name="AllowHide" type="bool">True</property>
        <property name="HelpMode" type="helpmode">
          Navigate
        </property>
        <property name="ExportMode" type="exportmode">
          All
        </property>
      </genericWebPartProperties>
    </data>
  </webPart>
</webParts>

Siehe auch

Referenz

Beschreibungsdateien für Webparts-Steuerelemente

Hinweise

Beispiel

Siehe auch

Referenz

Zusätzliche Ressourcen