WebPart.HelpMode Свойство

  • Ссылка

Определение

Пространство имен:
System.Web.UI.WebControls.WebParts
Сборка:
System.Web.dll

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

public:
 virtual property System::Web::UI::WebControls::WebParts::WebPartHelpMode HelpMode { System::Web::UI::WebControls::WebParts::WebPartHelpMode get(); void set(System::Web::UI::WebControls::WebParts::WebPartHelpMode value); };
[System.Web.UI.Themeable(false)]
[System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)]
public virtual System.Web.UI.WebControls.WebParts.WebPartHelpMode HelpMode { get; set; }
[<System.Web.UI.Themeable(false)>]
[<System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)>]
member this.HelpMode : System.Web.UI.WebControls.WebParts.WebPartHelpMode with get, set
Public Overridable Property HelpMode As WebPartHelpMode

Значение свойства

WebPartHelpMode

Одно из значений перечисления WebPartHelpMode. Значение по умолчанию — Modal.

Атрибуты
ThemeableAttribute PersonalizableAttribute

Исключения

ArgumentOutOfRangeException

Указанное значение не равно ни одному из значений WebPartHelpMode.

Примеры

В следующем примере кода показано использование свойства для отображения справки HelpMode для элемента управления в том же окне браузера. В первой части этого примера предполагается использование пользовательского элемента управления, TextDisplayWebPartкоторый находится в разделе WebPart "Пример" обзора класса.

Пример кода также содержит HTML-страницу, содержащую вымышленное содержимое справки TextDisplayWebPart для элемента управления. Чтобы этот пример работал, необходимо сохранить следующий код в файле с именем Textwebparthelp.htm и поместить его в тот же каталог сайта, что и ASPX-страница.

<html>  
<head runat="server">  
    <title>Text Content WebPart Help</title>  
</head>  
<body>  
  <div>  
  <h1>Text Content WebPart Help</h1>  
  To make the WebPart control work...  
  </div>  
</body>  
</html>

Последняя часть примера — это веб-страница, на которую показано, как ссылаться на TextDisplayWebPart элемент управления. Обратите внимание, что в декларативной разметке HelpMode значение свойства задается Navigate, а код также задает значение HelpUrl свойства на имя HTML-файла, содержащего содержимое справки. Загрузите страницу в браузер и щелкните команду справки в меню WebPart команд элемента управления.

<%@ page language="C#" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.CS.Controls" 
             Assembly="TextDisplayWebPartCS" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" 
            width="350px" 
            HelpMode="navigate"
            HelpUrl="TextWebPartHelp.htm" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

<%@ page language="VB" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.VB.Controls" 
             Assembly="TextDisplayWebPartVB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" 
            width="350px" 
            HelpMode="navigate"
            HelpUrl="TextWebPartHelp.htm" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

Комментарии

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

Режим справки Поведение браузера
Modal Открывает отдельное окно браузера, если браузер поддерживает эту возможность. Пользователь должен закрыть это окно перед возвращением на страницу веб-частей.
Modeless Открывает отдельное окно браузера, если браузер поддерживает эту возможность. Пользователь может и не закрывать это окно перед возвращением на веб-страницу.
Navigate Заменяет страницу веб-частей в окне браузера.

Значение для данного свойства нельзя задать с помощью тем или тем таблиц стилей. Дополнительные сведения см. в статье ThemeableAttribute и ASP.NET темы и обложки.

Область персонализации этого свойства задана Shared и может быть изменена только авторизованными пользователями. Дополнительные сведения см. в обзоре PersonalizableAttribute персонализации и веб-части.

Применяется к

См. также раздел