IHelpService Interfaccia

Definizione

Fornisce metodi per visualizzare la Guida e aggiungere e rimuovere parole chiave della Guida in fase di progettazione.Provides methods for showing Help topics and adding and removing Help keywords at design time.

public interface class IHelpService
public interface IHelpService
type IHelpService = interface
Public Interface IHelpService

Esempi

Nell'esempio seguente viene illustrata una finestra IHelpService di progettazione che utilizza per aggiungere e rimuovere gli attributi del contesto della Guida per il controllo incluso.The following example demonstrates a designer that uses the IHelpService to add and remove Help context attributes for the included control. Per utilizzare questo esempio, compilarlo in una libreria di classi e aggiungere un'istanza del controllo a Formun oggetto.To use this sample, compile it to a class library and add an instance of the control to a Form. Nella visualizzazione della struttura selezionare il componente e premere F1 per cercare gli argomenti della guida pertinenti in base alla parola chiave o alle parole chiave del contesto della Guida corrente.In design view, selecting the component and pressing F1 attempts to look up relevant Help topics based on the current Help context keyword or keywords. Fare clic con il pulsante destro del mouse sul componente e il menu di scelta DesignerVerb rapida Visualizza Add IHelpService Help Keyword i Remove IHelpService Help Keywordcomandi, inclusi due comandi personalizzati denominati eRight-click the component and the shortcut menu displays commands, including two custom DesignerVerb commands named Add IHelpService Help Keyword and Remove IHelpService Help Keyword. Questi comandi possono essere usati per aggiungere o rimuovere una parola chiave del contesto della guida del valore "IHelpService", che tenta di IHelpService generare l'argomento quando si preme F1.These commands can be used to add or remove a Help context keyword of the value "IHelpService", which attempts to raise the IHelpService topic when F1 is pressed.

#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

Commenti

L'ambiente in fase di progettazione fornisce un sistema di guida che tenta di individuare gli argomenti della guida pertinenti da visualizzare quando un utente preme F1.The design-time environment provides a Help system that attempts to locate relevant Help topics to display when a user presses F1. Il sistema della Guida gestisce un set di parole chiave del contesto corrente che vengono usate per identificare gli argomenti rilevanti se è richiesta la guida.The Help system maintains a set of current context keywords that are used to identify relevant topics if Help is requested. Per impostazione predefinita, le parole chiave sono associate agli oggetti della classe selezionati e alle proprietà degli oggetti nell'ambiente della fase di progettazione.By default, keywords are associated with selected class objects and properties of objects in the design time environment. La parola chiave default per un componente o una proprietà è il nome completo della classe o della proprietà.The default keyword for a component or property is its fully qualified class or property name. Le parole chiave specifiche sono inoltre associate a determinate modalità, ad esempio quando sono selezionati più oggetti.Specific keywords are also associated with certain modes, such as when multiple objects are selected. Se una raccolta di file della Guida personalizzata è integrata con l'ambiente della fase di progettazione tramite la configurazione per un provider della Guida esterno, un provider di documentazione può associare un argomento per una classe o una proprietà componente specifica con una parola chiave costituita completamente da nome qualificato o nome del membro.If a custom Help collection is integrated with the design-time environment by configuring it for an external help provider, a documentation provider can associate a topic for a specific component class or property with a keyword consisting of the item's fully qualified type or member name.

Può essere utilizzato per richiamare il servizio della guida con una parola chiave specificata utilizzando ShowHelpFromKeyword il metodo oppure per richiamare un argomento della guida da un URL specificato utilizzando ShowHelpFromUrl il metodo. IHelpServiceThe IHelpService can be used to invoke the help service with a specified keyword using the ShowHelpFromKeyword method, or to invoke a help topic from a specified URL using the ShowHelpFromUrl method.

È IHelpService inoltre possibile utilizzare per aggiungere o rimuovere parole chiave della Guida in fase di progettazione.The IHelpService can also be used to add or remove Help keywords at design time. La selezione di un componente o di una proprietà in fase di progettazione consente di impostare una parola chiave del contesto predefinito costituita dal nome completo del tipo o del membro della selezione e di rimuovere le parole chiave per eventuali componenti o proprietà selezionati in precedenza e non più selezionati.Selecting a component or property at design time sets a default context keyword consisting of the fully qualified type or member name of the selection, and removes the keywords for any previously selected and no longer selected components or properties.

Poiché il sistema della guida non rimuove automaticamente le parole chiave della Guida personalizzate, è necessario rimuovere in modo esplicito una parola chiave personalizzata quando non è più applicabile.Because the Help system does not automatically remove custom Help keywords, you must explicitly remove a custom keyword when it no longer applies. È possibile monitorare gli eventi definiti dall' ISelectionService interfaccia per determinare quando cambia la selezione di un componente.You can monitor the events defined by the ISelectionService interface to determine when a component selection changes. In base a tali eventi, è possibile aggiungere un attributo di contesto della Guida per un componente quando è selezionato, quindi rimuovere l'attributo di contesto della guida quando la selezione non include più il componente.Based on those events, you can add a Help context attribute for a component when it is selected and then remove the Help context attribute when the selection no longer includes the component.

Metodi

AddContextAttribute(String, String, HelpKeywordType)

Aggiunge un attributo di contesto al documento.Adds a context attribute to the document.

ClearContextAttributes()

Rimuove dal documento tutti gli attributi di contesto esistenti.Removes all existing context attributes from the document.

CreateLocalContext(HelpContextType)

Crea un oggetto IHelpService locale per gestire i sottocontesti.Creates a local IHelpService to manage subcontexts.

RemoveContextAttribute(String, String)

Rimuove un attributo di contesto aggiunto precedentemente.Removes a previously added context attribute.

RemoveLocalContext(IHelpService)

Rimuove un contesto creato con CreateLocalContext(HelpContextType).Removes a context created with CreateLocalContext(HelpContextType).

ShowHelpFromKeyword(String)

Mostra l'argomento della Guida corrispondente alla parola chiave specificata.Shows the Help topic that corresponds to the specified keyword.

ShowHelpFromUrl(String)

Mostra l'argomento della Guida corrispondente all'URL specificato.Shows the Help topic that corresponds to the specified URL.

Si applica a

Vedi anche