ErrorProvider Classe

Definizione

Spazio dei nomi:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Origine:

ErrorProvider.cs

Viene fornita un'interfaccia utente per indicare che a un controllo su un form è associato un errore.

C#

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

Ereditarietà

Object

MarshalByRefObject

Component

ErrorProvider

Attributi

ComplexBindingPropertiesAttribute

Implementazioni

IExtenderProvider ISupportInitialize

Esempio

Nell'esempio di codice seguente viene illustrato l'uso della ErrorProvider classe per notificare all'utente un errore di immissione dati. Nell'esempio viene creato un Form oggetto contenente un TextBox controllo, un NumericUpDown controllo e un ComboBox controllo , ognuno dei quali convalida il contenuto e un ErrorProvider oggetto per ogni controllo. Nell'esempio vengono impostate le opzioni dell'icona di errore usando le BlinkRate proprietà e BlinkStyle e i SetIconAlignment metodi e SetIconPadding . Il SetError metodo viene chiamato con o senza testo di errore appropriato durante l'evento di Validated un controllo, a seconda del contenuto nel controllo.

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

Nell'esempio di codice seguente viene illustrato come usare ErrorProvider con e DataMemberDataSource per indicare un errore di dati all'utente.

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

Commenti

ErrorProvider presenta un meccanismo semplice per indicare all'utente finale che a un controllo di una maschera è associato un errore. Se per il controllo viene specificata una stringa di descrizione dell'errore, accanto al controllo viene visualizzata un'icona. L'icona lampeggia nel modo specificato da BlinkStyle, alla velocità specificata da BlinkRate. Quando si passa il puntatore del mouse sull'icona, viene visualizzata una descrizione comando che mostra la stringa di descrizione dell'errore.

In genere, si usa ErrorProvider in associazione ai controlli associati a dati. Quando si usa ErrorProvider con i controlli associati a dati, è necessario specificare ContainerControl, nel costruttore o impostando la ContainerControl proprietà .

Nota

Il ErrorProvider componente non fornisce il supporto predefinito per i client di accessibilità. Per rendere l'applicazione accessibile quando si usa questo componente, è necessario fornire un meccanismo di feedback aggiuntivo e accessibile.

Costruttori

ErrorProvider()	Inizializza una nuova istanza della classe ErrorProvider e le impostazioni predefinite per le proprietà BlinkRate, BlinkStyle e Icon.
ErrorProvider(ContainerControl)	Inizializza una nuova istanza della classe ErrorProvider allegata a un contenitore.
ErrorProvider(IContainer)	Inizializza una nuova istanza della classe ErrorProvider associata a un'implementazione di IContainer.

Proprietà

BlinkRate	Ottiene o imposta la frequenza di lampeggiamento dell'icona di errore.
BlinkStyle	Ottiene o imposta un valore che indica quando l'icona di errore lampeggia.
ContainerControl	Ottiene o imposta un valore che indica il controllo padre per l'oggetto ErrorProvider.
DataMember	Ottiene o imposta l'elenco all'interno di un'origine dati da controllare.
DataSource	Ottiene o imposta l'origine dati controllata dall'oggetto ErrorProvider.
HasErrors	Ottiene un valore che indica se contiene ErrorProvider errori per uno dei controlli associati.
Icon	Ottiene o imposta l'oggetto Icon che viene visualizzato accanto a un controllo quando una stringa di descrizione dell'errore è impostata per il controllo.
RightToLeft	Ottiene o imposta un valore che indica se il componente viene usato in impostazioni locali che supportano la scrittura da destra a sinistra.
Site	Ottiene o imposta l'oggetto ISite di Component.
Tag	Ottiene o imposta un oggetto che contiene i dati relativi al componente.

Metodi

BindToDataAndErrors(Object, String)	Fornisce un metodo per impostare le proprietà DataSource e DataMember in fase di esecuzione.
CanExtend(Object)	Ottiene un valore che indica se è possibile estendere un controllo.
Clear()	Cancella tutte le impostazioni associate a questo componente.
Dispose(Boolean)	Rilascia le risorse non gestite usate da Component e, facoltativamente, le risorse gestite.
GetError(Control)	Restituisce la stringa di descrizione dell'errore corrente per il controllo specificato.
GetIconAlignment(Control)	Ottiene un valore che indica dove deve essere posizionata l'icona di errore in relazione al controllo.
GetIconPadding(Control)	Restituisce la quantità di spazio aggiuntivo accanto all'icona di errore.
OnRightToLeftChanged(EventArgs)	Genera l'evento RightToLeftChanged.
SetError(Control, String)	Imposta la stringa di descrizione dell'errore per il controllo specificato.
SetIconAlignment(Control, ErrorIconAlignment)	Imposta la posizione dell'icona di errore in relazione al controllo.
SetIconPadding(Control, Int32)	Imposta la quantità di spazio aggiuntivo da lasciare tra il controllo specificato e l'icona di errore.
UpdateBinding()	Fornisce un metodo per aggiornare le associazioni della proprietà DataSource, della proprietà DataMember e del testo dell'errore.

Eventi

RightToLeftChanged

Viene generato quando si modifica il valore della proprietà RightToLeft.

Implementazioni dell'interfaccia esplicita

ISupportInitialize.BeginInit()	Segnala all'oggetto l'avvio dell'inizializzazione.
ISupportInitialize.EndInit()	Segnala all'oggetto che l'inizializzazione è completa.

Si applica a