WebPart.HelpUrl Свойство

  • Ссылка

Определение

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

Получает или задает URL-адрес файла справки для элемента управления WebPart.

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

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

String

Строка, представляющая URL-адрес файла справки. Значение по умолчанию — пустая строка.

Атрибуты
ThemeableAttribute PersonalizableAttribute

Исключения

ArgumentException

Внутренняя система проверки определила, что URL-адрес может содержать скриптовые атаки.

Примеры

В следующем примере кода демонстрируется использование HelpUrl свойство. В этом примере предполагается использование пользовательского элемента управления , 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>

Комментарии

Чтобы включить меню команд с командой справки в меню WebPart команд элемента управления , необходимо указать значение для HelpUrl свойства . Способ отображения содержимого справки в браузере определяется значением HelpMode свойства .

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

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

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

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