ErrorProvider Clase

Definición

Espacio de nombres:

System.Windows.Forms

Ensamblado:

System.Windows.Forms.dll

Source:

ErrorProvider.cs

Proporciona una interfaz de usuario para indicar que un control de un formulario tiene un error asociado al mismo.

C#

[System.ComponentModel.ComplexBindingProperties("DataSource", "DataMember")]
public class ErrorProvider : System.ComponentModel.Component, System.ComponentModel.IExtenderProvider, System.ComponentModel.ISupportInitialize

Herencia

Object

MarshalByRefObject

Component

ErrorProvider

Atributos

ComplexBindingPropertiesAttribute

Implementaciones

IExtenderProvider ISupportInitialize

Ejemplos

En el ejemplo de código siguiente se muestra cómo usar la ErrorProvider clase para notificar al usuario un error de entrada de datos. En el ejemplo se crea un Form objeto que contiene un TextBox control, un NumericUpDown control y un ComboBox control, cada uno validando su contenido y un ErrorProvider para cada control. En el ejemplo se establecen las opciones de icono de error mediante las BlinkRate propiedades y BlinkStyle y los SetIconAlignment métodos y SetIconPadding . Se SetError llama al método con o sin texto de error adecuado durante el evento de Validated un control, en función del contenido del control.

C#

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

namespace ErrorProvider
{
    public class Form1 : System.Windows.Forms.Form
    {
        private System.Windows.Forms.Label label1;
        private System.Windows.Forms.Label label2;
        private System.Windows.Forms.Label label4;
        private System.Windows.Forms.Label label5;
        private System.Windows.Forms.Label label6;
        private System.Windows.Forms.Label label3;
        private System.Windows.Forms.TextBox nameTextBox1;
        private System.Windows.Forms.NumericUpDown ageUpDownPicker;
        private System.Windows.Forms.ComboBox favoriteColorComboBox;
        private System.Windows.Forms.ErrorProvider ageErrorProvider;
        private System.Windows.Forms.ErrorProvider nameErrorProvider;
        private System.Windows.Forms.ErrorProvider favoriteColorErrorProvider;

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

        public Form1()
        {
            this.nameTextBox1 = new System.Windows.Forms.TextBox();
            this.label1 = new System.Windows.Forms.Label();
            this.label2 = new System.Windows.Forms.Label();
            this.ageUpDownPicker = new System.Windows.Forms.NumericUpDown();
            this.favoriteColorComboBox = new System.Windows.Forms.ComboBox();
            this.label3 = new System.Windows.Forms.Label();
            this.label4 = new System.Windows.Forms.Label();
            this.label5 = new System.Windows.Forms.Label();
            this.label6 = new System.Windows.Forms.Label();

            // Name Label
            this.label1.Location = new System.Drawing.Point(56, 32);
            this.label1.Size = new System.Drawing.Size(40, 23);
            this.label1.Text = "Name:";

            // Age Label
            this.label2.Location = new System.Drawing.Point(40, 64);
            this.label2.Size = new System.Drawing.Size(56, 23);
            this.label2.Text = "Age (3-5)";           

            // Favorite Color Label
            this.label3.Location = new System.Drawing.Point(24, 96);
            this.label3.Size = new System.Drawing.Size(80, 24);
            this.label3.Text = "Favorite color";

            // ErrorBlinkStyle.AlwaysBlink Label
            this.label4.Location = new System.Drawing.Point(264, 32);
            this.label4.Size = new System.Drawing.Size(160, 23);
            this.label4.Text = "ErrorBlinkStyle.AlwaysBlink";

            // ErrorBlinkStyle.BlinkIfDifferentError Label
            this.label5.Location = new System.Drawing.Point(264, 64);
            this.label5.Size = new System.Drawing.Size(200, 23);
            this.label5.Text = "ErrorBlinkStyle.BlinkIfDifferentError";

            // ErrorBlinkStyle.NeverBlink Label
            this.label6.Location = new System.Drawing.Point(264, 96);
            this.label6.Size = new System.Drawing.Size(200, 23);
            this.label6.Text = "ErrorBlinkStyle.NeverBlink";

            // Name TextBox
            this.nameTextBox1.Location = new System.Drawing.Point(112, 32);
            this.nameTextBox1.Size = new System.Drawing.Size(120, 20);
            this.nameTextBox1.TabIndex = 0;
            this.nameTextBox1.Validated += new System.EventHandler(this.nameTextBox1_Validated);

            // Age NumericUpDown
            this.ageUpDownPicker.Location = new System.Drawing.Point(112, 64);
            this.ageUpDownPicker.Maximum = new System.Decimal(new int[] {150,0,0,0});
            this.ageUpDownPicker.TabIndex = 4;
            this.ageUpDownPicker.Validated += new System.EventHandler(this.ageUpDownPicker_Validated);

            // Favorite Color ComboBox
            this.favoriteColorComboBox.Items.AddRange(new object[] {"None","Red","Yellow",
                                                                    "Green","Blue","Purple"});
            this.favoriteColorComboBox.Location = new System.Drawing.Point(112, 96);
            this.favoriteColorComboBox.Size = new System.Drawing.Size(120, 21);
            this.favoriteColorComboBox.TabIndex = 5;
            this.favoriteColorComboBox.Validated += new System.EventHandler(this.favoriteColorComboBox_Validated);

            // Set up how the form should be displayed and add the controls to the form.
            this.ClientSize = new System.Drawing.Size(464, 150);
            this.Controls.AddRange(new System.Windows.Forms.Control[] {
                                        this.label6,this.label5,this.label4,this.label3,
                                        this.favoriteColorComboBox,this.ageUpDownPicker,
                                        this.label2,this.label1,this.nameTextBox1});
            this.Text = "Error Provider Example";

            // Create and set the ErrorProvider for each data entry control.

            nameErrorProvider = new  System.Windows.Forms.ErrorProvider();
            nameErrorProvider.SetIconAlignment (this.nameTextBox1, ErrorIconAlignment.MiddleRight);
            nameErrorProvider.SetIconPadding (this.nameTextBox1, 2);
            nameErrorProvider.BlinkRate = 1000;
            nameErrorProvider.BlinkStyle = System.Windows.Forms.ErrorBlinkStyle.AlwaysBlink;

            ageErrorProvider = new  System.Windows.Forms.ErrorProvider();
            ageErrorProvider.SetIconAlignment (this.ageUpDownPicker, ErrorIconAlignment.MiddleRight);
            ageErrorProvider.SetIconPadding (this.ageUpDownPicker, 2);
            ageErrorProvider.BlinkStyle = System.Windows.Forms.ErrorBlinkStyle.BlinkIfDifferentError;

            favoriteColorErrorProvider = new  System.Windows.Forms.ErrorProvider();
            favoriteColorErrorProvider.SetIconAlignment (this.favoriteColorComboBox, ErrorIconAlignment.MiddleRight);
            favoriteColorErrorProvider.SetIconPadding (this.favoriteColorComboBox, 2);
            favoriteColorErrorProvider.BlinkRate = 1000;
            favoriteColorErrorProvider.BlinkStyle = System.Windows.Forms.ErrorBlinkStyle.NeverBlink;
        }
    
        private void nameTextBox1_Validated(object sender, System.EventArgs e)
        {
            if(IsNameValid())
            {
                // Clear the error, if any, in the error provider.
                nameErrorProvider.SetError(this.nameTextBox1, String.Empty);
            }
            else
            {
                // Set the error if the name is not valid.
                nameErrorProvider.SetError(this.nameTextBox1, "Name is required.");
            }
        }

        private void ageUpDownPicker_Validated(object sender, System.EventArgs e)
        {
            if (IsAgeTooYoung())
            {
                // Set the error if the age is too young.
                ageErrorProvider.SetError(this.ageUpDownPicker, "Age not old enough");
            }
            else if (IsAgeTooOld())
            {
                // Set the error if the age is too old.
                ageErrorProvider.SetError(this.ageUpDownPicker, "Age is too old");
            }
            else 
            {
                // Clear the error, if any, in the error provider.
                ageErrorProvider.SetError(this.ageUpDownPicker, String.Empty);
            }
        }

        private void favoriteColorComboBox_Validated(object sender, System.EventArgs e) 
        {
            if (!IsColorValid())
            {
                // Set the error if the favorite color is not valid.
                favoriteColorErrorProvider.SetError(this.favoriteColorComboBox, "Must select a color.");
            }
            else
            {
                // Clear the error, if any, in the error provider.
                favoriteColorErrorProvider.SetError(this.favoriteColorComboBox, String.Empty);
            }
        }

        // Functions to verify data.
        private bool IsNameValid() 
        {
            // Determine whether the text box contains a zero-length string.
            return (nameTextBox1.Text.Length > 0);
        }

        private bool IsAgeTooYoung() 
        {
            // Determine whether the age value is less than three.
            return (ageUpDownPicker.Value < 3);
        }

        private bool IsAgeTooOld() 
        {
            // Determine whether the age value is greater than five.
            return (ageUpDownPicker.Value > 5 );
        }

        private bool IsColorValid() 
        {
            // Determine whether the favorite color has a valid value.
            return ((favoriteColorComboBox.SelectedItem != null) &&
                (!favoriteColorComboBox.SelectedItem.ToString().Equals("None")));
        }
    }
}

En el ejemplo de código siguiente se muestra cómo usar con ErrorProviderDataSource y DataMember para indicar un error de datos al usuario.

C#

private void InitializeComponent()
 {
     // Standard control setup.
     //....
     // You set the DataSource to a data set, and the DataMember to a table.
     errorProvider1.DataSource = dataSet1 ;
     errorProvider1.DataMember = dataTable1.TableName ;
     errorProvider1.ContainerControl = this ;
     errorProvider1.BlinkRate = 200 ;
     //...
     // Since the ErrorProvider control does not have a visible component,
     // it does not need to be added to the form. 
 }
 
 private void buttonSave_Click(object sender, System.EventArgs e)
 {
     // Checks for a bad post code.
     DataTable CustomersTable;
     CustomersTable = dataSet1.Tables["Customers"];
     foreach (DataRow row in (CustomersTable.Rows)) 
     {
         if (Convert.ToBoolean(row["PostalCodeIsNull"])) 
         {
             row.RowError="The Customer details contain errors";
             row.SetColumnError("PostalCode", "Postal Code required");
         } 
     } 
 }

Comentarios

ErrorProvider presenta un mecanismo sencillo para indicar al usuario final que un control de un formulario tiene un error asociado. Si se especifica una cadena de descripción de error para el control, aparece un icono junto al control. El icono parpadea de la manera especificada por BlinkStyle, a la velocidad especificada por BlinkRate. Cuando el mouse mantiene el mouse sobre el icono, aparece una información sobre herramientas que muestra la cadena de descripción del error.

Normalmente, se usa ErrorProvider en asociación con controles enlazados a datos. Al usar ErrorProvider con controles enlazados a datos, debe especificar , ContainerControlya sea en el constructor o estableciendo la ContainerControl propiedad .

Nota

El componente ErrorProvider no proporciona compatibilidad integrada con clientes de accesibilidad. Para que la aplicación sea accesible al usar este componente, debe proporcionar un mecanismo de comentarios adicional y accesible.

Constructores

ErrorProvider()	Inicializa una nueva instancia de la clase ErrorProvider e inicializa los valores predeterminados de las propiedades BlinkRate, BlinkStyle y Icon.
ErrorProvider(ContainerControl)	Inicializa una nueva instancia de la clase ErrorProvider asociada a un contenedor.
ErrorProvider(IContainer)	Inicializa una nueva instancia de la clase ErrorProvider asociada a una implementación IContainer.

Propiedades

BlinkRate	Obtiene o establece la frecuencia con la que parpadea el icono de error.
BlinkStyle	Obtiene o establece un valor que indica cuándo parpadea el icono de error.
ContainerControl	Obtiene o establece un valor que indica el control primario de este ErrorProvider.
DataMember	Obtiene o establece la lista dentro de un origen de datos que se va a supervisar.
DataSource	Obtiene o establece el origen de datos supervisado por ErrorProvider.
HasErrors	Obtiene un valor que indica si esto ErrorProvider tiene errores para cualquiera de los controles asociados.
Icon	Devuelve o establece el objeto Icon que se muestra junto a un control cuando se ha establecido para él una cadena de descripción de error.
RightToLeft	Obtiene o establece un valor que indica si el componente se utiliza en una configuración regional que admite fuentes de derecha a izquierda.
Site	Obtiene o establece ISite de Component.
Tag	Obtiene o establece un objeto que contiene datos sobre el componente.

Métodos

BindToDataAndErrors(Object, String)	Proporciona un método para establecer las propiedades DataSource y DataMember en tiempo de ejecución.
CanExtend(Object)	Obtiene un valor que indica si un control se puede extender.
Clear()	Borra todos los valores de configuración asociados a este componente.
Dispose(Boolean)	Libera los recursos no administrados que usa Component y, de forma opcional, libera los recursos administrados.
GetError(Control)	Devuelve la cadena de descripción del error actual para el control especificado.
GetIconAlignment(Control)	Obtiene un valor que indica dónde se debe colocar el icono de error con respecto al control.
GetIconPadding(Control)	Devuelve el espacio adicional que se va a dejar junto al icono de error.
OnRightToLeftChanged(EventArgs)	Genera el evento RightToLeftChanged.
SetError(Control, String)	Establece la cadena de descripción del error para el control especificado.
SetIconAlignment(Control, ErrorIconAlignment)	Establece dónde se debe colocar el icono de error con respecto al control.
SetIconPadding(Control, Int32)	Establece la cantidad de espacio adicional que se va a dejar entre el control especificado y el icono de error.
UpdateBinding()	Proporciona un método para actualizar los enlaces de DataSource, DataMember y el texto del error.

Eventos

RightToLeftChanged

Se produce cuando cambia el valor de la propiedad RightToLeft.

Implementaciones de interfaz explícitas

ISupportInitialize.BeginInit()	Indica al objeto que está comenzando la inicialización.
ISupportInitialize.EndInit()	Indica al objeto que se ha completado la inicialización.

Se aplica a