File di descrizione del controllo Web part

  • Articolo

Aggiornamento: novembre 2007

I file di descrizione del controllo Web part contengono valori di proprietà, dati di stato e dettagli del file di origine o dell'assembly esportati da un controllo WebPart, o da altro controllo server o utente ASP.NET utilizzato in un'applicazione Web part, in un file XML con estensione WEBPART. Il file di descrizione viene utilizzato dalla funzionalità di importazione Web part per importare il controllo descritto in una pagina Web part e configurarlo con i dati salvati. In questo argomento viene descritta la struttura di base e gli elementi XML inclusi in un file di descrizione.

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

Note

Nella seguente tabella sono elencati gli elementi che è possibile includere in un file di descrizione insieme ai relativi elementi figlio, agli attributi disponibili per ogni elemento e a una breve descrizione dello scopo per cui ciascun elemento viene utilizzato. Se un controllo implementa l'interfaccia IPersonalizable, è presente l'elemento figlio <ipersonalizable> appropriato contenente le proprietà implementate come elementi <property>. altrimenti l'elemento <ipersonalizable> non è presente nel file.

Elemento

Attributi

Riepilogo

webParts

  webPart

Nessuno.

Elemento padre nel file, che può essere presente una sola volta. Sebbene la logica di XML consenta la presenza di più elementi <webPart> per file, in base all'implementazione attuale è possibile specificare un solo elemento <webPart> per file di descrizione.

webPart

  metaData

  data

xmlns="https://schemas.microsoft.com/WebPart/v3"

Nota:
Attributo dello spazio dei nomi con un valore fisso.

Rappresenta il controllo i cui dati di proprietà e stato sono contenuti nel file. Al momento, può essere presente un solo elemento <webPart> per file.

metaData

  type

  importErrorMessage

Nessuno.

Contiene informazioni sul tipo dell'elemento <webPart> e un messaggio da visualizzare se si verificano errori durante il processo di importazione. Può essere presente un'istanza per elemento <webPart>.

type

Per l'elemento type deve essere specificato un attributo name o src oppure entrambi. Se sono specificati entrambi, name avrà la precedenza.

Il valore dell'attributo name è costituito da una stringa contenente le informazioni sul tipo e, facoltativamente, sull'assembly in relazione all'elemento <webPart>.

L'attributo src fornisce il percorso del file di origine di un controllo utente.

Elenca le informazioni sul tipo per un assembly contenente un elemento <webPart> o il percorso del file di origine se <webPart> rappresenta un controllo utente. Può essere presente un'istanza per elemento <webPart>.

importErrorMessage

Nessuno.

Contiene il testo di un messaggio che viene visualizzato se si verifica un errore durante il processo di importazione. Può essere presente un'istanza per elemento <webPart>.

data

  properties

  genericWebPartProperties

Nessuno.

Contiene i dati dei valori di proprietà e stato per l'elemento <webPart>. Può essere presente un'istanza per elemento <webPart>.

properties

  ipersonalizable

  property

Nessuno.

Contiene gli elementi <property>, un singolo elemento <ipersonalizable> contenente gli elementi figlio <property> o entrambi. L'elemento <properties> è sempre presente, ma contiene elementi figlio <property> solo se <webPart> dispone di proprietà personalizzabili. Può essere presente un'istanza per elemento <webPart>.

genericWebPartProperties

  ipersonalizable

  property

Nessuno.

Contiene gli elementi <property>, un singolo elemento <ipersonalizable> contenente gli elementi figlio <property> o entrambi. L'elemento è presente solo se il controllo corrispondente a <webPart> non eredita dalla classe WebPart. Può essere presente un'istanza per elemento <webPart>.

ipersonalizable

  property

Nessuno.

L'elemento figlio di entrambi gli elementi <properties> e <genericWebPartProperties>. L'elemento viene indicato solo se il controllo corrispondente all'elemento <webPart> implementa l'interfaccia IPersonalizable. Contiene uno o più elementi <property>. Può essere presente un'istanza per elemento <webPart>.

property

L'elemento property contiene tre attributi: name, type e null. Gli attributi name e type sono obbligatori, mentre null viene utilizzato solo se la proprietà ha un valore null.

L'attributo name è il nome di una particolare proprietà del controllo corrispondente all'elemento <webPart>.

Il valore dell'attributo null può essere true o false. Questo attributo viene utilizzato solo se una proprietà contiene effettivamente un valore null in modo da distinguere il valore da quello di stringa vuota ("").

L'attributo type identifica l'elemento Type della proprietà indicata nell'attributo name. Il valore di type può essere una stringa con un nome di tipo completo o una stringa che utilizza uno dei nomi di tipo abbreviati indicati di seguito.

* string

* int

* bool

* double

* single

* datetime

* color

* unit

* fontsize

* object

* direction (rappresenta ContentDirection)

* helpmode (rappresenta WebPartHelpMode)

* chromestate (rappresenta PartChromeState)

* chrometype (rappresenta PartChromeType)

* exportmode (rappresenta WebPartExportMode)

Figlio degli elementi <properties>, <genericWebPartProperties> e <ipersonalizable>. Contiene le coppie nome/valore per ogni elemento dati di stato o valore di proprietà contenuto nell'elemento <webPart>. I dati effettivi per una proprietà sono contenuti tra i tag dell'elemento <property>, mentre il nome e il tipo dell'elemento proprietà sono specificati dagli attributi. Possono essere presenti nessuno o più elementi <property> nei tre tipi di elementi padre che li contengono.

Esempio

Negli esempi di codice riportati di seguito vengono illustrati due file di descrizione WEBPART esportati da istanze di controlli in un'applicazione Web part. Il primo esempio mostra un file per un controllo che eredita dalla classe base WebPart, dove i dati delle proprietà sono tutti contenuti nella sezione <properties>. Il secondo esempio mostra un file per un controllo server ASP.NET che non eredita dalla classe WebPart, dove i dati delle proprietà sono tutti contenuti nella sezione <genericWebPartProperties>.

<!-- 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>

Vedere anche

Riferimenti

ExportWebPart

ImportWebPart

ExportMode

ImportCatalogPart