IHelpService Интерфейс

Ссылка

Определение

Пространство имен:: System.ComponentModel.Design

Сборка:: System.ComponentModel.TypeConverter.dll

Сборка:: System.dll

Сборка:: netstandard.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Предоставляет методы для отображения разделов справки, а также для добавления и удаления зарезервированных слов справки во время разработки.

public interface class IHelpService

public interface IHelpService

type IHelpService = interface

Public Interface IHelpService

Примеры

В следующем примере демонстрируется конструктор, использующий IHelpService для добавления и удаления атрибутов контекста справки для включенного элемента управления. Чтобы использовать этот пример, скомпилируйте его в библиотеку классов и добавьте экземпляр элемента управления в Form. В режиме конструктора при выборе компонента и нажатии клавиши F1 выполняется попытка найти соответствующие разделы справки на основе текущего контекста справки ключевое слово или ключевых слов. Щелкните компонент правой кнопкой мыши, и в контекстном меню отображаются команды, включая две пользовательские DesignerVerb команды с именами Add IHelpService Help Keyword и Remove IHelpService Help Keyword. Эти команды можно использовать для добавления или удаления контекста справки ключевое слово значения "IHelpService", который пытается вызвать IHelpService тему при нажатии клавиши F1.

#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
#using <System.Design.dll>
#using <System.dll>

using namespace System;
using namespace System::ComponentModel;
using namespace System::ComponentModel::Design;
using namespace System::Drawing;
using namespace System::IO;
using namespace System::Windows::Forms;
using namespace System::Windows::Forms::Design;

public ref class HelpDesigner: public System::Windows::Forms::Design::ControlDesigner
{
public:
   HelpDesigner(){}

   property System::ComponentModel::Design::DesignerVerbCollection^ Verbs 
   {
      virtual System::ComponentModel::Design::DesignerVerbCollection^ get() override
      {
         array<DesignerVerb^>^temp0 = {gcnew DesignerVerb( "Add IHelpService Help Keyword",gcnew EventHandler( this, &HelpDesigner::addKeyword ) ),gcnew DesignerVerb( "Remove IHelpService Help Keyword",gcnew EventHandler( this, &HelpDesigner::removeKeyword ) )};
         return gcnew DesignerVerbCollection( temp0 );
      }
   }

private:
   void addKeyword( Object^ /*sender*/, EventArgs^ /*e*/ )
   {
      IHelpService^ hs = dynamic_cast<IHelpService^>(this->Control->Site->GetService( IHelpService::typeid ));
      hs->AddContextAttribute( "keyword", "IHelpService", HelpKeywordType::F1Keyword );
   }

   void removeKeyword( Object^ /*sender*/, EventArgs^ /*e*/ )
   {
      IHelpService^ hs = dynamic_cast<IHelpService^>(this->Control->Site->GetService( IHelpService::typeid ));
      hs->RemoveContextAttribute( "keyword", "IHelpService" );
   }
};


[Designer(HelpDesigner::typeid)]
public ref class HelpTestControl: public System::Windows::Forms::UserControl
{
public:
   HelpTestControl()
   {
      this->Size = System::Drawing::Size( 320, 100 );
      this->BackColor = Color::White;
   }

protected:
   virtual void OnPaint( System::Windows::Forms::PaintEventArgs^ e ) override
   {
      Brush^ brush = gcnew SolidBrush( Color::Blue );
      e->Graphics->DrawString( "IHelpService Example Designer Control", gcnew System::Drawing::Font( FontFamily::GenericMonospace,10 ), brush, 5, 5 );
      e->Graphics->DrawString( "Right-click this component for", gcnew System::Drawing::Font( FontFamily::GenericMonospace,8 ), brush, 5, 25 );
      e->Graphics->DrawString( "add/remove Help context keyword commands.", gcnew System::Drawing::Font( FontFamily::GenericMonospace,8 ), brush, 5, 35 );
      e->Graphics->DrawString( "Press F1 while this component is", gcnew System::Drawing::Font( FontFamily::GenericMonospace,8 ), brush, 5, 55 );
      e->Graphics->DrawString( "selected to raise Help topics for", gcnew System::Drawing::Font( FontFamily::GenericMonospace,8 ), brush, 5, 65 );
      e->Graphics->DrawString( "the current keyword or keywords", gcnew System::Drawing::Font( FontFamily::GenericMonospace,8 ), brush, 5, 75 );
   }
};

using System;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.Drawing;
using System.IO;
using System.Windows.Forms;
using System.Windows.Forms.Design;

namespace IHelpServiceSample
{
    public class HelpDesigner : System.Windows.Forms.Design.ControlDesigner
    {
        public HelpDesigner()
        {			
        }

        public override System.ComponentModel.Design.DesignerVerbCollection Verbs
        {
            get
            {
                return new DesignerVerbCollection( new DesignerVerb[] { 
                        new DesignerVerb("Add IHelpService Help Keyword", new EventHandler(this.addKeyword)),
                        new DesignerVerb("Remove IHelpService Help Keyword", new EventHandler(this.removeKeyword))
                } );
            }
        }
        
        private void addKeyword(object sender, EventArgs e)
        {
            IHelpService hs = (IHelpService) this.Control.Site.GetService(typeof(IHelpService));			
            hs.AddContextAttribute("keyword", "IHelpService", HelpKeywordType.F1Keyword);	
        }
        
        private void removeKeyword(object sender, EventArgs e)
        {
            IHelpService hs = (IHelpService) this.Control.Site.GetService(typeof(IHelpService));			
            hs.RemoveContextAttribute("keyword", "IHelpService");
        }
    }

    [Designer(typeof(HelpDesigner))]
    public class HelpTestControl : System.Windows.Forms.UserControl
    {
        public HelpTestControl()
        {
            this.Size = new Size(320, 100);
            this.BackColor = Color.White;
        }

        protected override void OnPaint(System.Windows.Forms.PaintEventArgs e)
        {			
            Brush brush = new SolidBrush(Color.Blue);
            e.Graphics.DrawString("IHelpService Example Designer Control", new Font( FontFamily.GenericMonospace, 10 ), brush, 5, 5);
            e.Graphics.DrawString("Right-click this component for", new Font( FontFamily.GenericMonospace, 8 ), brush, 5, 25);
            e.Graphics.DrawString("add/remove Help context keyword commands.", new Font( FontFamily.GenericMonospace, 8 ), brush, 5, 35);			
            e.Graphics.DrawString("Press F1 while this component is", new Font( FontFamily.GenericMonospace, 8 ), brush, 5, 55);
            e.Graphics.DrawString("selected to raise Help topics for", new Font( FontFamily.GenericMonospace, 8 ), brush, 5, 65);			
            e.Graphics.DrawString("the current keyword or keywords", new Font( FontFamily.GenericMonospace, 8 ), brush, 5, 75);			
        }		
    }
}

Imports System.ComponentModel
Imports System.ComponentModel.Design
Imports System.Drawing
Imports System.IO
Imports System.Windows.Forms
Imports System.Windows.Forms.Design

Namespace IHelpServiceSample

    Public Class HelpDesigner
        Inherits System.Windows.Forms.Design.ControlDesigner

        Public Sub New()
        End Sub

        Public Overrides ReadOnly Property Verbs() As System.ComponentModel.Design.DesignerVerbCollection
            Get
                Return New DesignerVerbCollection(New DesignerVerb() {New DesignerVerb("Add IHelpService Help Keyword", AddressOf Me.addKeyword), New DesignerVerb("Remove IHelpService Help Keyword", AddressOf Me.removeKeyword)})
            End Get
        End Property

        Private Sub addKeyword(ByVal sender As Object, ByVal e As EventArgs)
            Dim hs As IHelpService = CType(Me.Control.Site.GetService(GetType(IHelpService)), IHelpService)
            hs.AddContextAttribute("keyword", "IHelpService", HelpKeywordType.F1Keyword)
        End Sub

        Private Sub removeKeyword(ByVal sender As Object, ByVal e As EventArgs)
            Dim hs As IHelpService = CType(Me.Control.Site.GetService(GetType(IHelpService)), IHelpService)
            hs.RemoveContextAttribute("keyword", "IHelpService")
        End Sub
    End Class

    <Designer(GetType(HelpDesigner))> _
    Public Class HelpTestControl
        Inherits System.Windows.Forms.UserControl

        Public Sub New()
            Me.Size = New Size(320, 100)
            Me.BackColor = Color.White
        End Sub

        Protected Overrides Sub OnPaint(ByVal e As System.Windows.Forms.PaintEventArgs)
            Dim brush As New SolidBrush(Color.Blue)
            e.Graphics.DrawString("IHelpService Example Designer Control", New Font(FontFamily.GenericMonospace, 10), brush, 5, 5)
            e.Graphics.DrawString("Right-click this component for", New Font(FontFamily.GenericMonospace, 8), brush, 5, 25)
            e.Graphics.DrawString("add/remove Help context keyword commands.", New Font(FontFamily.GenericMonospace, 8), brush, 5, 35)
            e.Graphics.DrawString("Press F1 while this component is", New Font(FontFamily.GenericMonospace, 8), brush, 5, 55)
            e.Graphics.DrawString("selected to raise Help topics for", New Font(FontFamily.GenericMonospace, 8), brush, 5, 65)
            e.Graphics.DrawString("the current keyword or keywords", New Font(FontFamily.GenericMonospace, 8), brush, 5, 75)
        End Sub
    End Class
End Namespace 'IHelpServiceSample

Среда времени разработки предоставляет систему справки, которая пытается найти соответствующие разделы справки для отображения при нажатии пользователем клавиши F1. Система справки поддерживает набор ключевых слов текущего контекста, которые используются для определения соответствующих тем при запросе справки. По умолчанию ключевые слова связаны с выбранными объектами класса и свойствами объектов в среде времени разработки. По умолчанию ключевое слово для компонента или свойства является полное имя класса или свойства. Определенные ключевые слова также связаны с определенными режимами, например при выборе нескольких объектов. Если пользовательская коллекция справки интегрирована со средой времени разработки путем ее настройки для внешнего поставщика справки, поставщик документации может связать раздел для определенного класса компонента или свойства с ключевое слово, состоящим из полного типа или имени элемента.

Можно IHelpService использовать для вызова службы справки с указанным ключевое слово с помощью ShowHelpFromKeyword метода или для вызова раздела справки из указанного URL-адреса с помощью ShowHelpFromUrl метода .

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

Так как система справки не удаляет пользовательские ключевые слова справки автоматически, необходимо явно удалить настраиваемую ключевое слово, когда она больше не применяется. Вы можете отслеживать события, определенные интерфейсом, ISelectionService чтобы определить, когда меняется выбор компонента. На основе этих событий можно добавить атрибут контекста справки для компонента при его выборе, а затем удалить атрибут контекста справки, если выбранный элемент больше не включает компонент.

Методы

AddContextAttribute(String, String, HelpKeywordType)	Добавляет в документ атрибут контекста.
ClearContextAttributes()	Удаляет из документа все существующие атрибуты контекста.
CreateLocalContext(HelpContextType)	Создает локальный класс IHelpService для управления вложенными контекстами.
RemoveContextAttribute(String, String)	Удаляет ранее добавленный атрибут контекста.
RemoveLocalContext(IHelpService)	Удаляет контекст, созданный с помощью метода CreateLocalContext(HelpContextType).
ShowHelpFromKeyword(String)	Отображает раздел справки, соответствующий заданному зарезервированному слову.
ShowHelpFromUrl(String)	Отображает раздел справки, соответствующий заданному URL-адресу.

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

IHelpService Интерфейс

Определение

Примеры

Комментарии

Методы

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

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

Обратная связь

Дополнительные ресурсы