The Labs \ Source Viewer \ SSCLI \ System.ComponentModel.Design \ IHelpService

  1. //------------------------------------------------------------------------------
  2. // <copyright file="IHelpService.cs" company="Microsoft">
  3. //
  4. // Copyright (c) 2006 Microsoft Corporation. All rights reserved.
  5. //
  6. // The use and distribution terms for this software are contained in the file
  7. // named license.txt, which can be found in the root of this distribution.
  8. // By using this software in any fashion, you are agreeing to be bound by the
  9. // terms of this license.
  10. //
  11. // You must not remove this notice, or any other, from this software.
  12. //
  13. // </copyright>
  14. //------------------------------------------------------------------------------
  15. /*
  16. */
  17. namespace System.ComponentModel.Design
  18. {
  19.     using System.Runtime.Remoting;
  20.     using System.ComponentModel;
  21.    
  22.     using System.Diagnostics;
  23.    
  24.     using System;
  25.    
  26.     /// <devdoc>
  27.     /// <para>
  28.     /// Provides the Integrated Development Environment (IDE) help
  29.     /// system with contextual information for the current task.</para>
  30.     /// </devdoc>
  31.     public interface IHelpService
  32.     {
  33.         /// <devdoc>
  34.         /// <para>Adds a context attribute to the document.</para>
  35.         /// </devdoc>
  36.         void AddContextAttribute(string name, string value, HelpKeywordType keywordType);
  37.        
  38.         /// <devdoc>
  39.         /// Clears all existing context attributes from the document.
  40.         /// </devdoc>
  41.         void ClearContextAttributes();
  42.        
  43.         /// <devdoc>
  44.         /// Creates a Local IHelpService to manage subcontexts.
  45.         /// </devdoc>
  46.         IHelpService CreateLocalContext(HelpContextType contextType);
  47.        
  48.         /// <devdoc>
  49.         /// <para>
  50.         /// Removes a previously added context attribute.
  51.         /// </para>
  52.         /// </devdoc>
  53.         void RemoveContextAttribute(string name, string value);
  54.        
  55.         /// <devdoc>
  56.         /// Removes a context that was created with CreateLocalContext
  57.         /// </devdoc>
  58.         void RemoveLocalContext(IHelpService localContext);
  59.        
  60.         /// <devdoc>
  61.         /// <para>Shows the help topic that corresponds to the specified keyword.</para>
  62.         /// </devdoc>
  63.         void ShowHelpFromKeyword(string helpKeyword);
  64.        
  65.         /// <devdoc>
  66.         /// <para>
  67.         /// Shows the help topic that corresponds with the specified Url and topic navigation ID.
  68.         /// </para>
  69.         /// </devdoc>
  70.         void ShowHelpFromUrl(string helpUrl);
  71.     }
  72. }

Developer Fusion