Поделиться через

Файлы описания элементов управления веб-частями

  • Статья

Обновлен: Ноябрь 2007

Файлы описания элементов управления веб-частями содержат значения свойств, данные состояния и сведения о сборке или исходном файле, экспортированные из элемента управления WebPart (или серверного или пользовательского элемента управления ASP.NET, используемого в приложении веб-частей) в XML-файл с расширением WEBPART. Файл описания используется функцией импорта веб-частей для импорта элемента управления, описание которого данный файл предоставляет на странице веб-частей, а также для настройки импортированного элемента управления с использованием сохраненных данных. В этом разделе описана базовая структура и XML-элементы, включенные в файл описания.

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

Заметки

В следующей таблице перечислены все элементы, которые могут быть включены в файл описания веб-частей (под элементом расположены его непосредственные дочерние элементы); атрибуты, существующие в данном элементе, а также сводная информация об области применения элемента. Обратите внимание, что если элемент управления реализует интерфейс IPersonalizable, отображается соответствующий дочерний элемент <ipersonalizable>, содержащий реализованные свойства как элементы <property>; в противном случае элемент <ipersonalizable> не отображается в файле.

Элемент

Атрибуты

Сводная информация

webParts

  webPart

Отсутствует.

Родительский элемент в файле; может использоваться в файле один раз. Логика XML заключается в том, что данный элемент может содержать несколько элементов <webPart> в файле, но в настоящий момент в файле описания реализуется только один элемент <webPart>.

webPart

  метаданные (metaData)

  данные

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

ms227561.alert_note(ru-ru,VS.90).gifПримечание.
Представляет собой атрибут пространства имен с фиксированным значением.

Представляет элемент управления, состояние и свойства данных которого содержатся в файле. В настоящий момент в одном файле может существовать только один элемент <webPart>.

metaData

  тип

  importErrorMessage

Отсутствует.

Содержит сведения о типе элемента <webPart> и сообщение для пользователей, которое выводится в случае возникновения ошибок во время процесса импорта. Один экземпляр на элемент <webPart>.

type

Для элемента type должен быть задан один из атрибутов: name или src, либо могут быть заданы оба эти атрибута. Если заданы оба атрибута, приоритет имеет атрибут name.

Значение атрибута name состоит из строки с типом и (необязательно) сведений о сборке, относящихся к элементу <webPart>.

Атрибут src предоставляет путь к исходному файлу пользовательского элемента управления.

Перечисляет данные о типе для сборки, содержащей элемент <webPart>, либо путь исходного файла, если элемент <webPart> представляет пользовательский элемент управления. Один экземпляр на элемент <webPart>.

importErrorMessage

Отсутствует.

Содержит текст сообщения, отображаемого для пользователей в случае возникновения ошибки во время импорта. Один экземпляр на элемент <webPart>.

data

  свойства

  genericWebPartProperties

Отсутствует.

Содержит данные о значениях свойства и состояния для элемента <webPart>. Один экземпляр на элемент <webPart>.

properties

  ipersonalizable

  свойство

Отсутствует.

Содержит элементы <property>, один элемент <ipersonalizable> (который содержит дочерние элементы <property>), или оба. Элемент <properties> присутствует всегда, но он может содержать дочерние элементы <property> только в том случае, если элемент <webPart> имеет настраиваемые свойства. Один экземпляр на элемент <webPart>.

genericWebPartProperties

  ipersonalizable

  свойство

Отсутствует.

Содержит элементы <property>, один элемент <ipersonalizable> (который содержит дочерние элементы <property>), или оба. Данный элемент присутствует только в том случае, если элемент управления, который соответствует элементу <webPart>, не наследует от класса WebPart. Один экземпляр на элемент <webPart>.

ipersonalizable

  свойство

Отсутствует.

Дочерний элемент для элементов <properties> и <genericWebPartProperties>. Данный элемент присутствует только в том случае, если элемент управления, соответствующий элементу <webPart>, реализует интерфейс IPersonalizable. Содержит один или несколько элементов <property>. Один экземпляр на элемент <webPart>.

property

Элемент свойства, имеющий три атрибута: name, type и null. Требуются атрибуты name и type; атрибут null используется только в случае, если свойство имеет значение null.

Атрибут name является именем конкретного свойства элемента управления, соответствующего элементу <webPart>.

Атрибут null может принимать значение true или false; он используется только в том случае, когда свойство фактически имеет значение null, чтобы отличать данное значение от значения пустой строки ("").

Атрибут type определяет тип Type свойства, на которое ссылается атрибут name. Фактическое значение атрибута type может быть строкой с полным именем типа, либо строкой, использующей одно из сокращенных имен типа, перечисленных ниже.

* string

* int

* bool

* double

* single

* datetime

* color

* unit

* fontsize

* object

* direction (представляет ContentDirection)

* helpmode (представляет WebPartHelpMode)

* chromestate (представляет PartChromeState)

* chrometype (представляет PartChromeType)

* exportmode (представляет WebPartExportMode)

Дочерний элемент элементов <properties>, <genericWebPartProperties> и <ipersonalizable>. Данный элемент содержит пары имя-значение для каждого значения свойства или элемента данных состояния в элементе <webPart>. Фактические данные свойства содержатся между тегами элемента <property>, при этом имя и тип элемента свойства задаются атрибутами. В трех типах родительских элементов могут содержаться от нуля и более элементов <property>.

Пример

В следующих примерах кода демонстрируются два файла описания WEBPART, которые были экспортированы из экземпляров элементов управления в приложении веб-частей. В первом примере показан файл для элемента управления, который наследует от базового класса WebPart. Обратите внимание, что данные свойства этого элемента содержатся в разделе <properties>. Во втором примере показан файл для серверного элемента управления ASP.NET, который не наследует от класса WebPart. Обратите внимание, что данные свойства этого элемента содержатся в разделе <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>

См. также

Ссылки

ExportWebPart

ImportWebPart

ExportMode

ImportCatalogPart