Este artículo se tradujo automáticamente. Para ver el artículo en inglés, active la casilla Inglés. Además, puede mostrar el texto en inglés en una ventana emergente si mueve el puntero del mouse sobre el texto.
Traducción
Inglés

Interfaz IHelpService

 

Publicado: octubre de 2016

Proporciona métodos para mostrar temas de ayuda y agregar y quitar palabras clave de ayuda en tiempo de diseño.

Espacio de nombres:   System.ComponentModel.Design
Ensamblado:  System (en System.dll)

public interface IHelpService

NombreDescripción
System_CAPS_pubmethodAddContextAttribute(String, String, HelpKeywordType)

Agrega un atributo de contexto al documento.

System_CAPS_pubmethodClearContextAttributes()

Quita todos los atributos de contexto existentes del documento.

System_CAPS_pubmethodCreateLocalContext(HelpContextType)

Crea una variable local IHelpService para administrar subcontextos.

System_CAPS_pubmethodRemoveContextAttribute(String, String)

Quita un atributo de contexto agregado previamente.

System_CAPS_pubmethodRemoveLocalContext(IHelpService)

Quita un contexto creado con CreateLocalContext.

System_CAPS_pubmethodShowHelpFromKeyword(String)

Muestra el tema de Ayuda que corresponde a la palabra clave especificada.

System_CAPS_pubmethodShowHelpFromUrl(String)

Muestra el tema de Ayuda que corresponde a la dirección URL especificada.

El entorno de tiempo de diseño proporciona un sistema de ayuda que intenta encontrar los temas de Ayuda relevantes para mostrar cuando el usuario presiona F1. El sistema de ayuda mantiene un conjunto de palabras clave contextuales actuales que se utilizan para identificar los temas relevantes si se solicita ayuda. De forma predeterminada, las palabras clave están asociadas con propiedades de objetos en el entorno de tiempo de diseño y objetos de la clase seleccionada. La palabra clave default para un componente o propiedad es su nombre completo de la clase o propiedad. Palabras clave específicas también está asociados con determinados modos, como cuando se seleccionan varios objetos. Si una colección de ayuda personalizada se integra con el entorno de tiempo de diseño mediante la configuración de un proveedor de ayuda externo, un proveedor de documentación puede asociar un tema de una clase de componente específico o propiedad con una palabra clave formada por el nombre del elemento completo tipo o miembro.

La IHelpService puede utilizarse para invocar el servicio de ayuda con una palabra clave especificada mediante el ShowHelpFromKeyword (método), o para invocar un tema de Ayuda desde una dirección URL especificada utilizando el ShowHelpFromUrl método.

El IHelpService también puede utilizarse para agregar o quitar palabras clave de ayuda en tiempo de diseño. Seleccionar un componente o propiedad en el diseño tiempo establece una palabra clave de contexto de forma predeterminada que consta del nombre de tipo completo o el nombre de miembro de la selección y quita las palabras clave para cualquier seleccionado anteriormente y componentes seleccionados ya no o propiedades.

Dado que el sistema de ayuda no quita automáticamente palabras clave de ayuda personalizado, debe quitar explícitamente una palabra clave personalizada cuando ya no se aplica. Puede supervisar los eventos definidos por el ISelectionService interfaz para determinar cuándo cambia la selección de componentes. En función de esos eventos, puede agregar un atributo de contexto de ayuda para un componente cuando está seleccionado y, a continuación, quite el atributo de contexto de ayuda cuando la selección no incluya el componente.

En el ejemplo siguiente se muestra un diseñador que utiliza el IHelpService para agregar y quitar atributos de contexto de ayuda para el control incluido. Para utilizar este ejemplo, compílelo en una biblioteca de clases y agregue una instancia del control a un Form. En la vista Diseño, al seleccionar el componente y presionar F1 intenta buscar temas de Ayuda relevantes basándose en las palabras clave o la palabra clave de contexto de Ayuda actual. Haga clic en el componente y el menú contextual muestra comandos, incluidos dos DesignerVerb comandos denominados Add IHelpService Help Keyword y Remove IHelpService Help Keyword. Estos comandos pueden usarse para agregar o quitar una palabra clave de contexto de Ayuda del valor "IHelpService", que intenta iniciar el IHelpService tema cuando se presiona 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
Disponible desde 1.1
Volver al principio
Mostrar: