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

Clase HelpProvider

 

Publicado: octubre de 2016

Proporciona ayuda emergente o en pantalla para los controles.

Espacio de nombres:   System.Windows.Forms
Ensamblado:  System.Windows.Forms (en System.Windows.Forms.dll)

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Windows.Forms.HelpProvider

public class HelpProvider : Component, IExtenderProvider

NombreDescripción
System_CAPS_pubmethodHelpProvider()

Inicializa una nueva instancia de la clase HelpProvider.

NombreDescripción
System_CAPS_protpropertyCanRaiseEvents

Obtiene un valor que indica si el componente puede provocar un evento.(Heredado de Component).

System_CAPS_pubpropertyContainer

Obtiene IContainer que contiene Component.(Heredado de Component).

System_CAPS_protpropertyDesignMode

Obtiene un valor que indica si la Component está actualmente en modo de diseño.(Heredado de Component).

System_CAPS_protpropertyEvents

Obtiene la lista de controladores de eventos que se adjuntará a este Component.(Heredado de Component).

System_CAPS_pubpropertyHelpNamespace

Obtiene o establece un valor que especifica el nombre del archivo de ayuda asociado a este HelpProvider objeto.

System_CAPS_pubpropertySite

Obtiene o establece la ISite de la Component.(Heredado de Component).

System_CAPS_pubpropertyTag

Obtiene o establece el objeto que contiene datos complementarios sobre la HelpProvider.

NombreDescripción
System_CAPS_pubmethodCanExtend(Object)

Especifica si este objeto puede proporcionar sus propiedades extensoras al objeto especificado.

System_CAPS_pubmethodCreateObjRef(Type)

Crea un objeto que contiene toda la información relevante necesaria para generar a un proxy que se utiliza para comunicarse con un objeto remoto.(Heredado de MarshalByRefObject).

System_CAPS_pubmethodDispose()

Libera todos los recursos que usa Component.(Heredado de Component).

System_CAPS_protmethodDispose(Boolean)

Libera los recursos no administrados que usa Component y libera los recursos administrados de forma opcional.(Heredado de Component).

System_CAPS_pubmethodEquals(Object)

Determina si el objeto especificado es igual al objeto actual.(Heredado de Object).

System_CAPS_protmethodFinalize()

Libera recursos no administrados y realiza otras operaciones de limpieza antes de que se reclame el elemento Component durante la recolección de elementos no usados.(Heredado de Component).

System_CAPS_pubmethodGetHashCode()

Sirve como la función hash predeterminada.(Heredado de Object).

System_CAPS_pubmethodGetHelpKeyword(Control)

Devuelve la palabra clave de ayuda para el control especificado.

System_CAPS_pubmethodGetHelpNavigator(Control)

Devuelve el valor actual HelpNavigator establecer para el control especificado.

System_CAPS_pubmethodGetHelpString(Control)

Devuelve el contenido de la ventana de ayuda emergente del control especificado.

System_CAPS_pubmethodGetLifetimeService()

Recupera el objeto de servicio de duración actual que controla la directiva de duración de esta instancia.(Heredado de MarshalByRefObject).

System_CAPS_protmethodGetService(Type)

Devuelve un objeto que representa el servicio suministrado por Component o por Container.(Heredado de Component).

System_CAPS_pubmethodGetShowHelp(Control)

Devuelve un valor que indica si la Ayuda del control especificado debería mostrarse.

System_CAPS_pubmethodGetType()

Obtiene el Type de la instancia actual.(Heredado de Object).

System_CAPS_pubmethodInitializeLifetimeService()

Obtiene un objeto de servicio de duración para controlar la directiva de duración de esta instancia.(Heredado de MarshalByRefObject).

System_CAPS_protmethodMemberwiseClone()

Crea una copia superficial del Object actual.(Heredado de Object).

System_CAPS_protmethodMemberwiseClone(Boolean)

Crea una copia superficial del elemento actual MarshalByRefObject objeto.(Heredado de MarshalByRefObject).

System_CAPS_pubmethodResetShowHelp(Control)

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Quita la Ayuda asociada al control especificado.

System_CAPS_pubmethodSetHelpKeyword(Control, String)

Especifica la palabra clave utilizada para recuperar la Ayuda cuando el usuario solicita ayuda para el control especificado.

System_CAPS_pubmethodSetHelpNavigator(Control, HelpNavigator)

Especifica el comando ayuda a utilizar al recuperar la Ayuda desde el archivo de ayuda para el control especificado.

System_CAPS_pubmethodSetHelpString(Control, String)

Especifica la cadena de ayuda asociada al control especificado.

System_CAPS_pubmethodSetShowHelp(Control, Boolean)

Especifica si se muestra ayuda para el control especificado.

System_CAPS_pubmethodToString()

Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Devuelve una cadena que representa el objeto HelpProvider actual.(Invalida Component.ToString()).

NombreDescripción
System_CAPS_pubeventDisposed

Se produce cuando el componente se elimina mediante una llamada a la Dispose (método).(Heredado de Component).

Cada instancia de HelpProvider mantiene una colección de referencias a los controles asociados con él. Para asociar un archivo de ayuda con la HelpProvider, establezca el HelpNamespace propiedad. Especificar el tipo de ayuda proporcionada por una llamada a la SetHelpNavigator método y proporcionar una HelpNavigator valor para el control especificado. Para proporcionar la palabra clave o el tema de la Ayuda, llame el SetHelpKeyword método. Para abrir la ayuda sobre un tema concreto, la palabra clave se debe pasar en el formulario topicNamehtm.

Para asociar una cadena de ayuda específica a un control, utilice la SetHelpString método. La cadena que se asocia a un control con este método se muestra en una ventana emergente cuando el usuario presiona la tecla F1 mientras el control tiene el foco.

Si el HelpNamespace no se estableció la propiedad, debe utilizar el SetHelpString método para proporcionar el texto de ayuda. Si ha establecido tanto HelpNamespace y la cadena de ayuda, Ayuda basada en la HelpNamespace tendrá prioridad.

HelpProvider llama a métodos en la Help clase para proporcionar la funcionalidad de ayuda.

En el ejemplo de código siguiente se muestra cómo utilizar el HelpProvider clase para mostrar Ayuda contextual en un formulario que contiene cuatro campos de dirección. El ejemplo utiliza el SetHelpString para establecer el texto de Ayuda de información sobre herramientas. Cuando utilice el botón de ayuda contextual y haga clic en el cursor de ayuda sobre un campo de dirección, aparece la información sobre herramientas de ayuda con el texto especificado. Cuando se presiona la tecla F1 con el foco en un campo de dirección, se muestra el archivo de ayuda mspaint.chm porque la HelpNamespace propiedad se ha establecido en mspaint.chm. El SetShowHelp se llama al método para que cada control de dirección para indicar que tiene contenido de ayuda disponible.

using System;
using System.Drawing;
using System.Windows.Forms;

public class Form1 : System.Windows.Forms.Form
{
	private System.Windows.Forms.TextBox addressTextBox;
	private System.Windows.Forms.Label label2;
	private System.Windows.Forms.TextBox cityTextBox;
	private System.Windows.Forms.Label label3;
	private System.Windows.Forms.TextBox stateTextBox;
	private System.Windows.Forms.TextBox zipTextBox;
	private System.Windows.Forms.HelpProvider helpProvider1;
	private System.Windows.Forms.Label helpLabel;

    [STAThread]
    static void Main() 
    {
        Application.Run(new Form1());
    }

	public Form1()
	{
        this.addressTextBox = new System.Windows.Forms.TextBox();
        this.helpLabel = new System.Windows.Forms.Label();
        this.label2 = new System.Windows.Forms.Label();
        this.cityTextBox = new System.Windows.Forms.TextBox();
        this.label3 = new System.Windows.Forms.Label();
        this.stateTextBox = new System.Windows.Forms.TextBox();
        this.zipTextBox = new System.Windows.Forms.TextBox();

        // Help Label
        this.helpLabel.BorderStyle = System.Windows.Forms.BorderStyle.Fixed3D;
        this.helpLabel.Location = new System.Drawing.Point(8, 80);
        this.helpLabel.Size = new System.Drawing.Size(272, 72);
        this.helpLabel.Text = "Click the Help button in the title bar, then click a control " + 
            "to see a Help tooltip for the control.  Click on a control and press F1 to invoke " +
            "the Help system with a sample Help file.";

        // Address Label
        this.label2.Location = new System.Drawing.Point(16, 8);
        this.label2.Size = new System.Drawing.Size(100, 16);
        this.label2.Text = "Address:";

        // Comma Label
        this.label3.Location = new System.Drawing.Point(136, 56);
        this.label3.Size = new System.Drawing.Size(16, 16);
        this.label3.Text = ",";

        // Create the HelpProvider.
        this.helpProvider1 = new System.Windows.Forms.HelpProvider();

        // Tell the HelpProvider what controls to provide help for, and
        // what the help string is.
        this.helpProvider1.SetShowHelp(this.addressTextBox, true);
        this.helpProvider1.SetHelpString(this.addressTextBox, "Enter the street address in this text box.");

        this.helpProvider1.SetShowHelp(this.cityTextBox, true);
        this.helpProvider1.SetHelpString(this.cityTextBox, "Enter the city here.");

        this.helpProvider1.SetShowHelp(this.stateTextBox, true);
        this.helpProvider1.SetHelpString(this.stateTextBox, "Enter the state in this text box.");

        this.helpProvider1.SetShowHelp(this.zipTextBox, true);
        this.helpProvider1.SetHelpString(this.zipTextBox, "Enter the zip code here.");

        // Set what the Help file will be for the HelpProvider.
        this.helpProvider1.HelpNamespace = "mspaint.chm";

        // Sets properties for the different address fields.

        // Address TextBox
        this.addressTextBox.Location = new System.Drawing.Point(16, 24);
        this.addressTextBox.Size = new System.Drawing.Size(264, 20);
        this.addressTextBox.TabIndex = 0;
        this.addressTextBox.Text = "";

        // City TextBox
        this.cityTextBox.Location = new System.Drawing.Point(16, 48);
        this.cityTextBox.Size = new System.Drawing.Size(120, 20);
        this.cityTextBox.TabIndex = 3;
        this.cityTextBox.Text = "";

        // State TextBox
        this.stateTextBox.Location = new System.Drawing.Point(152, 48);
        this.stateTextBox.MaxLength = 2;
        this.stateTextBox.Size = new System.Drawing.Size(32, 20);
        this.stateTextBox.TabIndex = 5;
        this.stateTextBox.Text = "";

        // Zip TextBox
        this.zipTextBox.Location = new System.Drawing.Point(192, 48);
        this.zipTextBox.Size = new System.Drawing.Size(88, 20);
        this.zipTextBox.TabIndex = 6;
        this.zipTextBox.Text = "";

        // Add the controls to the form.
        this.Controls.AddRange(new System.Windows.Forms.Control[] {
                                    this.zipTextBox, this.stateTextBox,
                                    this.label3, this.cityTextBox,
                                    this.label2, this.helpLabel,
                                    this.addressTextBox});

        // Set the form to look like a dialog, and show the HelpButton.    
        this.FormBorderStyle = System.Windows.Forms.FormBorderStyle.FixedDialog;
        this.HelpButton = true;
        this.MaximizeBox = false;
        this.MinimizeBox = false;
        this.ClientSize = new System.Drawing.Size(292, 160);
        this.Text = "Help Provider Demonstration";

    }
}

.NET Framework
Disponible desde 1.1

Cualquier miembro ( Compartido en Visual Basic) estático público de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Volver al principio
Mostrar: