linux-packaging-mono/mcs/class/Managed.Windows.Forms/Documentation/en/System.Windows.Forms/Help.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="Help" FullName="System.Windows.Forms.Help">
  <TypeSignature Language="C#" Value="public class Help" />
  <AssemblyInfo>
    <AssemblyName>System.Windows.Forms</AssemblyName>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>You cannot create a new instance of the <see cref="T:System.Windows.Forms.Help" /> class. To provide Help for an application, call the static <see cref="M:System.Windows.Forms.Help.ShowHelp(System.Windows.Forms.Control,System.String)" /> and <see cref="M:System.Windows.Forms.Help.ShowHelpIndex(System.Windows.Forms.Control,System.String)" /> methods.</para>
      <para>You can use <see cref="T:System.Windows.Forms.Help" /> to show compiled Help files (.chm) or HTML files in the HTML Help format. Compiled Help files provide a table of contents, an index, search capability, and keyword links in pages. Shortcuts work only in compiled Help files.</para>
      <para>You can generate HTML Help 1.x files by using HTML Help Workshop. For more information about HTML Help, see "HTML Help Workshop" and other HTML Help topics at <see cref="http://go.microsoft.com/fwlink/?LinkId=178661">Microsoft HTML Help</see>.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Encapsulates the HTML Help 1.0 engine.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName="ShowHelp">
      <MemberSignature Language="C#" Value="public static void ShowHelp (System.Windows.Forms.Control parent, string url);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="parent" Type="System.Windows.Forms.Control" />
        <Parameter Name="url" Type="System.String" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <paramref name="url" /> parameter can be of the form C:\path\sample.chm or /folder/file.htm.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Displays the contents of the Help file at the specified URL.</para>
        </summary>
        <param name="parent">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Control" /> that identifies the parent of the Help dialog box. </param>
        <param name="url">
          <attribution license="cc4" from="Microsoft" modified="false" />The path and name of the Help file. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="ShowHelp">
      <MemberSignature Language="C#" Value="public static void ShowHelp (System.Windows.Forms.Control parent, string url, string keyword);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="parent" Type="System.Windows.Forms.Control" />
        <Parameter Name="url" Type="System.String" />
        <Parameter Name="keyword" Type="System.String" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <paramref name="url" /> parameter can be of the form C:\path\sample.chm or /folder/file.htm.</para>
          <para>If you provide the keyword null, the table of contents for the Help file will be displayed.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Displays the contents of the Help file found at the specified URL for a specific keyword.</para>
        </summary>
        <param name="parent">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Control" /> that identifies the parent of the Help dialog box. </param>
        <param name="url">
          <attribution license="cc4" from="Microsoft" modified="false" />The path and name of the Help file. </param>
        <param name="keyword">
          <attribution license="cc4" from="Microsoft" modified="false" />The keyword to display Help for. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="ShowHelp">
      <MemberSignature Language="C#" Value="public static void ShowHelp (System.Windows.Forms.Control parent, string url, System.Windows.Forms.HelpNavigator navigator);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="parent" Type="System.Windows.Forms.Control" />
        <Parameter Name="url" Type="System.String" />
        <Parameter Name="navigator" Type="System.Windows.Forms.HelpNavigator" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <paramref name="url" /> parameter can be of the form C:\path\sample.chm or /folder/file.htm.</para>
          <para>Compiled Help files provide table of contents, index, search, and keyword links in pages. You can use the following values for the <paramref name="navigator" /> parameter: <see cref="F:System.Windows.Forms.HelpNavigator.TableOfContents" />, <see cref="F:System.Windows.Forms.HelpNavigator.Find" />, <see cref="F:System.Windows.Forms.HelpNavigator.Index" />, or <see cref="F:System.Windows.Forms.HelpNavigator.Topic" />.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Displays the contents of the Help file found at the specified URL for a specific topic.</para>
        </summary>
        <param name="parent">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Control" /> that identifies the parent of the Help dialog box. </param>
        <param name="url">
          <attribution license="cc4" from="Microsoft" modified="false" />The path and name of the Help file. </param>
        <param name="navigator">
          <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.HelpNavigator" /> values. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="ShowHelp">
      <MemberSignature Language="C#" Value="public static void ShowHelp (System.Windows.Forms.Control parent, string url, System.Windows.Forms.HelpNavigator command, object parameter);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="parent" Type="System.Windows.Forms.Control" />
        <Parameter Name="url" Type="System.String" />
        <Parameter Name="command" Type="System.Windows.Forms.HelpNavigator" />
        <Parameter Name="parameter" Type="System.Object" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Compiled Help files provide table-of-contents, index, search, and keyword links in pages. You can use the <paramref name="param" /> parameter to provide additional refinement of the <see cref="F:System.Windows.Forms.HelpNavigator.Topic" />, <see cref="F:System.Windows.Forms.HelpNavigator.TopicId" />, <see cref="F:System.Windows.Forms.HelpNavigator.KeywordIndex" />, or <see cref="F:System.Windows.Forms.HelpNavigator.AssociateIndex" /> command. If the value specified in the <paramref name="command" /> parameter is <see cref="F:System.Windows.Forms.HelpNavigator.TableOfContents" />, <see cref="F:System.Windows.Forms.HelpNavigator.Index" />, or <see cref="F:System.Windows.Forms.HelpNavigator.Find" />, this value should be an empty string. If the <paramref name="command" /> parameter references <see cref="F:System.Windows.Forms.HelpNavigator.Topic" />, <see cref="F:System.Windows.Forms.HelpNavigator.TopicId" />, <see cref="F:System.Windows.Forms.HelpNavigator.KeywordIndex" />, or <see cref="F:System.Windows.Forms.HelpNavigator.AssociateIndex" />, this value should be a string that contains the topic name, or the keyword or numeric identifier of the topic to display.</para>
          <para>The <paramref name="url" /> parameter can be of the form C:\path\sample.chm or /folder/file.htm.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Displays the contents of the Help file located at the URL supplied by the user.</para>
        </summary>
        <param name="parent">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Control" /> that identifies the parent of the Help dialog box. </param>
        <param name="url">
          <attribution license="cc4" from="Microsoft" modified="false" />The path and name of the Help file. </param>
        <param name="command">
          <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.HelpNavigator" /> values. </param>
        <param name="parameter">
          <attribution license="cc4" from="Microsoft" modified="false" />A string that contains the topic identifier.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="ShowHelpIndex">
      <MemberSignature Language="C#" Value="public static void ShowHelpIndex (System.Windows.Forms.Control parent, string url);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="parent" Type="System.Windows.Forms.Control" />
        <Parameter Name="url" Type="System.String" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <paramref name="url" /> parameter can be of the form C:\path\sample.chm or /folder/file.htm.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Displays the index of the specified Help file.</para>
        </summary>
        <param name="parent">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Control" /> that identifies the parent of the Help dialog box. </param>
        <param name="url">
          <attribution license="cc4" from="Microsoft" modified="false" />The path and name of the Help file. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="ShowPopup">
      <MemberSignature Language="C#" Value="public static void ShowPopup (System.Windows.Forms.Control parent, string caption, System.Drawing.Point location);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="parent" Type="System.Windows.Forms.Control" />
        <Parameter Name="caption" Type="System.String" />
        <Parameter Name="location" Type="System.Drawing.Point" />
      </Parameters>
      <Docs>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Displays a Help pop-up window.</para>
        </summary>
        <param name="parent">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.Control" /> that identifies the parent of the Help dialog box. </param>
        <param name="caption">
          <attribution license="cc4" from="Microsoft" modified="false" />The message to display in the pop-up window. </param>
        <param name="location">
          <attribution license="cc4" from="Microsoft" modified="false" />A value that specifies the horizontal and vertical coordinates at which to display the pop-up window, relative to the upper-left corner of the screen. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>