Questo articolo è stato tradotto automaticamente. Per visualizzare l'articolo in inglese, selezionare la casella di controllo Inglese. È possibile anche visualizzare il testo inglese in una finestra popup posizionando il puntatore del mouse sopra il testo.
Traduzione
Inglese

Interfaccia IHelpService

 

Data di pubblicazione: ottobre 2016

Fornisce metodi per visualizzare la Guida e aggiunta e rimozione di parole chiave della Guida in fase di progettazione.

Spazio dei nomi:   System.ComponentModel.Design
Assembly:  System (in System.dll)

public interface IHelpService

NomeDescrizione
System_CAPS_pubmethodAddContextAttribute(String, String, HelpKeywordType)

Aggiunge un attributo di contesto al documento.

System_CAPS_pubmethodClearContextAttributes()

Rimuove tutti gli attributi di contesto esistenti dal documento.

System_CAPS_pubmethodCreateLocalContext(HelpContextType)

Crea un oggetto locale IHelpService per gestire i sottocontesti.

System_CAPS_pubmethodRemoveContextAttribute(String, String)

Rimuove un attributo di contesto aggiunto in precedenza.

System_CAPS_pubmethodRemoveLocalContext(IHelpService)

Rimuove un contesto creato con CreateLocalContext.

System_CAPS_pubmethodShowHelpFromKeyword(String)

Mostra l'argomento della Guida corrispondente alla parola chiave specificata.

System_CAPS_pubmethodShowHelpFromUrl(String)

Mostra l'argomento della Guida corrispondente all'URL specificato.

L'ambiente in fase di progettazione fornisce una Guida in linea che tenta di individuare argomenti della Guida rilevanti da visualizzare quando si preme F1. La Guida in linea gestisce un set di parole chiave del contesto corrente che vengono utilizzati per identificare argomenti rilevanti, se è richiesta la Guida. Per impostazione predefinita, le parole chiave sono associate agli oggetti classe selezionata e le proprietà degli oggetti in fase di progettazione. La parola chiave default per un componente o una proprietà è il nome completo di classe o una proprietà. Parole chiave specifiche sono inoltre associate a determinate modalità, ad esempio quando sono selezionati più oggetti. Se un insieme personalizzato è integrato con l'ambiente in fase di progettazione configurandolo per un provider di Guida esterni, un provider di documentazione è possibile associare un argomento per una classe di componente specifico o una proprietà con una parola chiave composta da nome di membro o un tipo completo dell'elemento.

Il IHelpService può essere utilizzato per richiamare il servizio di help con una parola chiave specificata utilizzando il ShowHelpFromKeyword (metodo), o per richiamare un argomento della Guida da un URL specificato tramite il ShowHelpFromUrl metodo.

Il IHelpService può essere utilizzato anche per aggiungere o rimuovere parole chiave della Guida in fase di progettazione. Selezione di un componente o progettazione imposta una parola chiave contesto predefinito costituito il nome completo del tipo o il nome di membro della selezione e rimuove le parole chiave per qualsiasi selezionata in precedenza e componenti selezionati non sono più o più proprietà.

Poiché la Guida in linea non rimuove automaticamente le parole chiave della Guida personalizzate, è necessario rimuovere in modo esplicito una parola chiave personalizzata quando non è più applicabile. È possibile monitorare gli eventi definiti dal ISelectionService interfaccia per determinare quando cambia la selezione di componenti. In base a tali eventi, è possibile aggiungere un attributo di contesto della Guida per un componente quando viene selezionato e quindi rimuovere l'attributo di contesto della Guida in linea quando la selezione non include più il componente.

Nell'esempio seguente viene illustrata una finestra di progettazione che utilizza il IHelpService per aggiungere e rimuovere gli attributi di contesto della Guida per il controllo incluso. Per usare questo esempio, compilarlo in una libreria di classi e aggiungere un'istanza del controllo da un Form. Nella visualizzazione progettazione, selezionare il componente e premendo F1 tenta di cercare argomenti della Guida rilevanti in base alla parola chiave di contesto della Guida o parole chiave corrente. Il pulsante destro del componente e menu di scelta rapida visualizza comandi, inclusi due personalizzato DesignerVerb comandi denominati Add IHelpService Help Keyword e Remove IHelpService Help Keyword. Questi comandi possono essere utilizzati per aggiungere o rimuovere una parola chiave contesto del valore "IHelpService", che tenta di generare il IHelpService argomento quando si preme F1.

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);			
        }		
    }
}

.NET Framework
Disponibile da 1.1
Torna all'inizio
Mostra: