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


Справка по XML-элементам WebpageControlOptions

С помощью элемента WebpageControlOptions в форме рабочих элементов может отображаться содержимое, определенное на веб-странице или в CDATA-теге. Можно включить либо дочерний элемент Link, либо дочерний элемент Content для задания либо URL-адреса, либо HTML-кода содержимого, которое должно присутствовать в форме.

Элемент WebpageControlOptions является дочерним для элемента CONTROL.

Иерархия схемы

WITD

   WORKITEMTYPE

       FORM

           Макет

               Группа

               Столбец

               TabGroup

                  Вкладка

                     Control

<xs:element name="WebpageControlOptions" type="WebpageControlOptionsType" minOccurs="0" maxOccurs="1" />
<xs:element name="Link" type="HyperLinkType" minOccurs="0" maxOccurs="1" />
<xs:element name="Param" type="HyperLinkParamType" minOccurs="0" maxOccurs="unbounded"/>

<WebpageControlOptions AllowScript="true | false" ReloadOnParamChange="true | false" >
   <Link UrlRoot="UrlRoot" UrlPath ="UrlPathWithParameters">
      <Param index="IndexValue " value="Param Value " type ="Original | Current"/>
   </Link>
   <Content>
      <![CDATA[Contents of HTML]]>
   </Content>
</WebpageControlOptions>

Атрибуты и элементы

В следующих разделах описаны атрибуты, дочерние и родительские элементы.

Дочерние элементы и атрибуты

Элемент

Атрибут

Описание

WebpageControlOptions

 

Необязательный элемент Control при type="WebpageControl".

Элемент контейнера для определения URL-адреса, контент которого будет отображаться в форме рабочего элемента.

Необязательный элемент LINK. Требуется, если указан UrlPath.

Задает значение, которое используется для определения URL-адреса гиперссылки, если для элемента задано значение UrlPath.

Тип элемента – это сложный тип: WebpageControlOptionsType.

 

AllowScript

Необязательный атрибут элемента WebpageControlOptions.

Указывает, разрешено выполнение JavaScript в веб-странице (true) или нет (false). Типом атрибута является xs:boolean.

Все другие параметры, такие как ActiveX, основаны на параметрах Internet Explorer, заданных для клиента.

 

ReloadOnParamChange

Необязательный атрибут элемента WebpageControlOptions.

Указывает, следует ли перезагружать (true) содержимое веб-страницы при изменении параметра в форме рабочего элемента (true) или нет (false). Типом атрибута является xs:boolean.

Значение по умолчанию — true.

Link

 

Необязательный элемент WebpageControlOptions. Этот элемент является взаимоисключающим с элементом Content.

Задает URL-адрес для веб-страницы, отображаемой в форме рабочего элемента.

Дополнительные сведения см. в разделе Справка по XML-элементам Link и Param.

Content

 

Необязательный элемент WebpageControlOptions.

Этот элемент является взаимоисключающим с элементом Link.

Задает HTML-содержимое, которое отображается элементом управления веб-страницы. Содержимое указано внутри тега CDATA. Примеры.

<![CDATA[Click here for detailed <b><a href="http://www.microsoft.com">Process Guidance</a></b>]]>

Тип элемента — xs:string.

ПримечаниеПримечание
HTML-содержимое не проверяется до отображения его в форме рабочего элемента.

Родительские элементы

Элемент

Описание

Control

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

Text

Необязательный элемент LabelText.

Элемент контейнера для информации или метки, отображаемых в форме рабочего элемента.

Дополнительные сведения см. в разделе Справка по XML-элементам LabelText и Text.

Заметки

Элементы Link и Content являются взаимоисключающими.

Атрибуты AllowScript и ReloadOnParamChange не разрешены при использовании элемента Content.

При настройке элемента управления веб-страницы для отображения необработанного HTML все сценарии отключаются. Все нажимаемые гиперссылки в содержимом открываются в веб-браузере Visual Studio, если форма рабочего элемента отображается в Visual Studio или в Internet Explorer.

В форму рабочего элемента для вкладки, содержащей WebpageControl, добавлены несколько кнопок панели инструментов. В число этих параметров входят следующие функции:

  • Навигация назад и вперед

  • Остановить загрузку содержимого и обновить содержимое

  • Возврат на домашнюю страницу содержимого

  • Открыть содержимое в новом окне или во внешнем браузере

Кроме того, если загружаемая веб-страница содержит ненадежный контент, то значок блокируется и появляется заблокированный значок.

Элемент WebpageControlOptions распознается только клиентами, на которых работает последняя версия Сред. Командный обозреватель. В предыдущих версиях отображается красная область, и появляется сообщение, указывающее, что не удается найти этот элемент управления. Дополнительные сведения см. в разделе Предоставление текста справки, руководства по процессам, веб-содержимого и ссылок на веб-страницы на форме рабочего элемента.

Пример

В следующем примере показывается, как загрузить форму рабочего элемента с HTML, заданным в теге CDATA.

<Control Type="WebpageControl">
   <WebpageControlOptions>
      <Content>
         <![CDATA[Click here for detailed <b><a href="https://www.microsoft.com">Process Guidance</a></b>]]>
      </Content>
   </WebpageControlOptions>
</Control>

Определения схем

WebpageControlOptionsType

<xs:complexType name="WebpageControlOptionsType">
   <xs:choice minOccurs="1" maxOccurs="1">
      <xs:element name="Link" type="HyperLinkType"/>
      <xs:element name="Content" type="xs:string"/>
   </xs:choice>
      <xs:attribute name="AllowScript" type="xs:boolean" use="optional" />
      <xs:attribute name="ReloadOnParamChange" type="xs:boolean" use="optional" />
</xs:complexType>

NonBlankString

<xs:simpleType name="NonBlankString">
   <xs:restriction  base="xs:string">
   <xs:pattern value=".*\S+.*"/>
   </xs:restriction>
</xs:simpleType>

Сведения об элементе

Пространство имен

https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef

Имя схемы

Определение типа рабочего элемента

Файл проверки

WorkItemTypeDefinition.xsd

Тип элемента

WebpageControlOptionsType

Может быть пустым

Неприменимо

См. также

Основные понятия

Указание элементов управления на форме рабочего элемента

Проектирование и настройка формы рабочего элемента

Другие ресурсы

Предоставление текста справки, руководства по процессам, веб-содержимого и ссылок на веб-страницы на форме рабочего элемента

Журнал изменений

Дата

Журнал

Причина

Май 2011

Исправлен случай с несколькими элементами и атрибутами в XML-синтаксисе. Определение схемы для отслеживания рабочих элементов определяет все дочерние элементы элемента FORM в формате Camel, а имена всех остальных элементов пишутся всеми заглавными буквами.

Исправление ошибки содержимого.

Январь 2011

Удалены ссылки на удаленные разделы.

Улучшение информации.