Compartilhar via

Arquivos de Descrição de um Controle Web Parts

  • Artigo

Controle de Web Parts Descrição arquivos contêm valores de propriedade, dados, estado e detalhes exportados de um WebPart controle (ou outros servidor ASP.NET ou usado em um aplicativo Web Parts controle de usuário) para um arquivo XML com uma extensão .WebPart conjunto de módulos (assembly) ou arquivo de origem.Um arquivo de descrição é usado pela ferramenta de importação de Web Parts para importar o controle que descreve uma página de Web Parts e para configurar o controle importado com os dados salvos.Este tópico descreve a estrutura básica e elementos XML incluídos em um arquivo de descrição.

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

Comentários

A tabela a seguir lista cada elemento que pode ser incluído em um arquivo de descrição de Web Parts (com os elementos do filho imediato do elemento recuados abaixo dele), lista quaisquer atributos que existam naquele elemento, e resume para que é usado o elemento.Observe que, se um controle implementa a interface IPersonalizable, o elemento filho <ipersonalizable> apropriado aparece e contém as propriedades implementadas como elementos <property>; caso contrário, o elemento <ipersonalizable> não aparece no arquivo.

Elemento

Atributos

Resumo

webParts

  webPart

Nenhum.

O elemento pai no arquivo; ele pode ocorrer uma vez por arquivo.A lógica do XML é que esse elemento pode conter vários elementos <webPart> por arquivo, mas como implementado atualmente há um <webPart> em um arquivo de descrição.

webPart

  metaData

  data

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

Observação:
É um atributo de namespace com um valor fixo.

Representa o controle cujos dados e propriedade de estado estão contidos no arquivo.No momento, só pode haver um elemento <webPart> por arquivo.

metaData

  type

  importErrorMessage

Nenhum.

Contém informações sobre o tipo do elemento <webPart> e uma mensagem para ser exibida aos usuários se houver erros durante o processo de importação.Uma instância por elemento <webPart>.

type

O elemento type deve ter um atributo name ou um atributo src especificado, mas pode ter ambos.Se ambos são especificados, name terá prioridade.

O valor do atributo name consiste em uma sequência de caracteres com tipo e (opcional) informações de assembly sobre o elemento <webPart>.

O atributo src fornece um caminho para o arquivo fonte de um controle de usuário.

Lista informações de tipo para um assembly que contém um elemento <webPart>, ou o caminho de um arquivo de origem se <webPart> representa um controle de usuário.Uma instância por elemento <webPart>.

importErrorMessage

Nenhum.

Contém o texto de uma mensagem exibida para os usuários se ocorrer um erro durante o processo de importação.Uma instância por elemento <webPart>.

data

propriedades

  genericWebPartProperties

Nenhum.

Contém os dados de valores de estado e de propriedade para o elemento <webPart>.Uma instância por elemento <webPart>.

properties

  ipersonalizable

  property

Nenhum.

Contém elementos <property>, um único elemento <ipersonalizable> (que contém elementos filhos <property>), ou ambos.O elemento <properties> está sempre presente, mas só terá elementos filhos <property> se <webPart> tem propriedades personalizáveis.Uma instância por elemento <webPart>.

genericWebPartProperties

  ipersonalizable

  property

Nenhum.

Contém elementos <property>, um único elemento <ipersonalizable> (que contém elementos filhos <property>), ou ambos.Esse elemento só estará presente se o controle que corresponde a <webPart> não herda da classe WebPart.Uma instância por elemento <webPart>.

ipersonalizable

  property

Nenhum.

Um filho do elemento <properties> e do elemento <genericWebPartProperties>.Esse elemento aparece apenas se o controle que corresponde ao elemento <webPart> implementa a interface IPersonalizable.Ele contém um ou mais elementos <property>.Uma instância por elemento <webPart>.

property

O elemento propriedade tem três atributos: name, type, e null. Os atributos name e type são necessários; null é usada somente se a propriedade tem um valor null.

O atributo name é o nome de uma propriedade específica no controle que corresponde ao elemento <webPart>.

O atributo null pode assumir um valor true ou false; é utilizado somente quando uma propriedade realmente tem um valor null, para distinguir esse valor de uma sequência de caracteres vazia (&quot;&quot;).

O atributo type identifica o Type da propriedade referenciada no atributo name.O valor real de type pode ser uma sequência de caracteres com um nome de tipo totalmente qualificado, ou pode ser uma sequência de caracteres que usa um dos nomes de tipo abreviados listados abaixo.

* string

* int

* bool

* double

* single

* datetime

* color

* unit

* fontsize

* object

* direction (representa ContentDirection)

* helpmode (representa WebPartHelpMode)

* chromestate (representa PartChromeState)

* chrometype (representa PartChromeType)

* exportmode (representa WebPartExportMode)

Um filho dos elementos <properties>, <genericWebPartProperties> e <ipersonalizable>.Esse elemento contém pares nome/valor para cada valor de propriedade ou item de dados de estado dentro do elemento <webPart>.Os dados reais de uma propriedade estão contidos entre as marcas de elemento <property> e o nome e o tipo do item propriedade são especificados por atributos.Pode haver zero para muitos elementos <property> dentre os três tipos de elementos pai que os contêm.

Exemplo

Os exemplos de código a seguir demonstram dois arquivos de descrição de .WebPart que foram exportados de instâncias de controles em um aplicativo de Web Parts.O primeiro exemplo mostra um arquivo para um controle que herda da classe base WebPart.Observe que seus dados de propriedade estão todos contidos na seção <properties>.O segundo exemplo mostra um arquivo para um controle de servidor ASP.NET que não herda da classe WebPart.Observe que seus dados de propriedade estão todos contidos na seção <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>

Consulte também

Referência

ExportWebPart

ImportWebPart

ExportMode

ImportCatalogPart