Procedura dettagliata: modifica di un controllo composito con Visual C#

Articolo
08/11/2011

I controlli compositi consentono di creare e riutilizzare interfacce grafiche personalizzate. Un controllo composito è sostanzialmente un componente con rappresentazione visiva. Può essere composto da uno o più controlli per Windows Form, componenti o blocchi di codice in grado di estenderne le funzionalità convalidando l'input dell'utente, modificando le proprietà della visualizzazione o effettuando altre attività richieste dall'autore. I controlli compositi possono essere inseriti in Windows Form al pari degli altri controlli. Nella prima parte di questa procedura verrà creato un controllo composito semplice denominato ctlClock. Nella seconda parte, le funzionalità di ctlClock verranno estese mediante ereditarietà.

Nota

È possibile che le finestre di dialogo e i comandi di menu visualizzati siano diversi da quelli descritti nella Guida a seconda delle impostazioni attive o dell'edizione del programma. Per modificare le impostazioni, scegliere Importa/Esporta impostazioni dal menu Strumenti. Per ulteriori informazioni, vedere Gestione delle impostazioni.

Creazione del progetto

Quando si crea un nuovo progetto è necessario specificarne il nome per impostare lo spazio dei nomi di primo livello, il nome dell'assembly e il nome del progetto e assicurarsi che il componente predefinito venga inserito nello spazio dei nomi corretto.

Per creare la libreria di controlli ctlClockLib e il controllo ctlClock

Scegliere Nuovo dal menu File, quindi fare clic su Progetto. Verrà visualizzata la finestra di dialogo Nuovo progetto.
Selezionare il modello di progetto Libreria di controlli Windows Form dall'elenco dei progetti di Visual C#, quindi digitare ctlClockLib nella casella Nome e scegliere OK.

Per impostazione predefinita il nome del progetto,ctlClockLib, verrà assegnato anche allo spazio dei nomi di primo livello. Lo spazio dei nomi di primo livello viene utilizzato per qualificare i nomi dei componenti dell'assembly. Se ad esempio due assembly forniscono componenti denominati ctlClock, sarà possibile specificare il componente ctlClock utilizzando il nome completo ctlClockLib.ctlClock. .
In Esplora soluzioni, fare clic con il pulsante destro del mouse su UserControl1.cs, quindi scegliere Rinomina. Modificare il nome file in ctlClock.cs. Scegliere il pulsante Sì quando richiesto per rinominare tutti i riferimenti all'elemento di codice "UserControl1".

Nota

Per impostazione predefinita, un controllo composito eredita dalla classe UserControl fornita dal sistema. La classe UserControl fornisce le funzionalità necessarie per tutti i controlli compositi e consente di implementare metodi e proprietà standard.
Scegliere Salva tutto dal menu File per salvare il progetto.

Aggiunta di componenti e controlli Windows al controllo composito

L'interfaccia visiva è parte integrante del controllo composito e viene implementata mediante l'aggiunta di uno o più controlli Windows nell'area di progettazione. Nella procedura riportata di seguito i controlli Windows verranno incorporati nel controllo composito e verrà scritto il codice per l'implementazione delle funzionalità.

Per aggiungere al controllo utente un oggetto Label e un oggetto Timer

In Esplora soluzioni, fare clic con il pulsante destro del mouse su ctlClock.cs, quindi scegliere Visualizza finestra di progettazione.
Nella Casella degli strumenti, espandere il nodo Controlli comuni, quindi fare doppio clic su Etichetta.

Un controllo Label denominato label1 viene aggiunto al controllo nell'area di progettazione.
Nella finestra di progettazione fare clic su label1. Nella finestra Proprietà impostare le proprietà seguenti.

Proprietà

Modificare in

Name

lblDisplay

Text

(vuoto)

TextAlign

MiddleCenter

Font.Size

14
Nella Casella degli strumenti, espandere il nodo Componenti, quindi fare doppio clic su Timer.

Poiché un Timer è un componente ed è pertanto privo di rappresentazione visiva in fase di esecuzione, non verrà visualizzato insieme ai controlli nell'area di progettazione bensì in Progettazione componenti, una barra delle applicazioni disposta nella parte inferiore dell'area di progettazione.
In Progettazione componenti, fare clic su Timer1, quindi impostare la proprietà Interval su 1000 e la proprietà Enabled su true.

La proprietà Interval controlla la frequenza con cui scatta il componente Timer. Ogni volta che timer1 scatta, viene eseguito il codice nell'evento timer1_Tick. L'intervallo rappresenta i millesimi di secondo che intercorrono tra uno scatto e l'altro.
In Progettazione componenti, fare doppio clic su timer1 per passare all'evento timer1_Tick di ctlClock.
Modificare il codice in modo che risulti simile al seguente. Assicurarsi di cambiare il modificatore di accesso da private a protected.

[C#]
```
protected void timer1_Tick(object sender, System.EventArgs e)
{
    // Causes the label to display the current time.
    lblDisplay.Text = DateTime.Now.ToLongTimeString(); 
}
```
Questo codice determinerà la visualizzazione dell'ora corrente in lblDisplay. Poiché l'intervallo di timer1 è stato impostato su 1000, l'evento si verificherà ogni mille millesimi di secondo, aggiornando quindi l'ora corrente ogni secondo.
Modificare il metodo in modo che sia sottoponibile a override mediante la parola chiave virtual. Per ulteriori informazioni, vedere la sezione "Eredità da un controllo utente" riportata di seguito.
```
protected virtual void timer1_Tick(object sender, System.EventArgs e)
```
Scegliere Salva tutto dal menu File per salvare il progetto.

Proprietà	Modificare in
Name	lblDisplay
Text	(vuoto)
TextAlign	MiddleCenter
Font.Size	14

Aggiunta di proprietà al controllo composito

A questo punto nel controllo sono stati incorporati un controllo Label e un componente Timer, ciascuno dotato di un insieme di proprietà intrinseche. Benché le singole proprietà di questi controlli non siano accessibili ai futuri utenti del controllo, è possibile creare ed esporre proprietà personalizzate scrivendo i blocchi di codice appropriati. Nella procedura riportata di seguito verrà illustrato come aggiungere al controllo proprietà che consentono all'utente di modificare il colore dello sfondo e del testo.

Per aggiungere una proprietà al controllo composito

In Esplora soluzioni, fare clic con il pulsante destro del mouse su ctlClock.cs, quindi scegliere Visualizza codice.

Viene visualizzato l'editor di codice per il controllo.
Individuare l'istruzione public partial class ctlClock. Sotto la parentesi graffa di apertura ({), digitare il seguente codice.

[C#]
```
private Color colFColor;
private Color colBColor;
```
Queste istruzioni consentono di creare le variabili private da utilizzare per la memorizzazione dei valori delle proprietà che verranno create.

Sotto le dichiarazioni delle variabili del passaggio 2 digitare il seguente codice.

[C#]

// Declares the name and type of the property.
public Color ClockBackColor
{
    // Retrieves the value of the private variable colBColor.
    get
    {
        return colBColor;
    }
    // Stores the selected value in the private variable colBColor, and 
    // updates the background color of the label control lblDisplay.
    set
    {
        colBColor = value;
        lblDisplay.BackColor = colBColor;   
    }
}
// Provides a similar set of instructions for the foreground color.
public Color ClockForeColor
{
    get
    {
        return colFColor;
    }
    set
    {
        colFColor = value;
        lblDisplay.ForeColor = colFColor;
    }
}

Il codice iniziale rende disponibili le due proprietà personalizzate ClockForeColor e ClockBackColor agli utenti del controllo. Le istruzioni get e set consentono di archiviare e recuperare il valore della proprietà e di inserire il codice per implementare le funzionalità appropriate per la proprietà.

Scegliere Salva tutto dal menu File per salvare il progetto.

Test del controllo

I controlli non sono applicazioni autonome e devono pertanto essere inseriti in un contenitore. Eseguire il test del comportamento del controllo in fase di esecuzione e sperimentare le proprietà con UserControl Test Container. Per ulteriori informazioni, vedere Procedura: eseguire il test del comportamento in fase di esecuzione di UserControl.

Per eseguire il test del controllo

Per compilare il progetto ed eseguire il controllo in UserControl Test Container, premere F5.
Nella griglia della proprietà di Test Container, individuare la proprietà ClockBackColor e quindi selezionarla per visualizzare la tavolozza dei colori.
Per scegliere un colore, fare clic su di esso.

Il colore di sfondo del controllo cambierà in base al colore selezionato.
Utilizzare una sequenza di eventi simile per verificare il corretto funzionamento della proprietà ClockForeColor.

In questa sezione e in quelle precedenti, è stato illustrato come combinare componenti e controlli Windows con codici e package per aggiungere funzionalità personalizzate al form di un controllo composito. Si è inoltre appreso come esporre le proprietà del controllo composito e come eseguire il test del controllo dopo averlo completato. Nella sezione successiva verranno fornite informazioni sulla modalità di creazione di un controllo composito ereditato utilizzando ctlClock come base.

Eredità da un controllo composito

Nelle sezioni precedenti si è appreso come combinare controlli, componenti e codice Windows in controlli compositi riutilizzabili. Il controllo composito può ora essere utilizzato come base per la compilazione di altri controlli. Il processo di derivazione di una classe da una classe di base è detto ereditarietà. In questa sezione verrà creato un controllo composito denominato ctlAlarmClock. Il controllo verrà derivato dal relativo controllo padre, in questo caso ctlClock. Verrà spiegato come estendere le funzionalità di ctlClock mediante l'override dei metodi padre e l'aggiunta di nuovi metodi e proprietà.

Per creare un controllo ereditato, è innanzitutto necessario derivare il controllo dal relativo elemento padre. Questa operazione consente di creare un nuovo controllo, con le stesse proprietà, metodi e caratteristiche grafiche del controllo padre, che può essere anche utilizzato come base per l'aggiunta di una funzionalità nuova o modificata.

Per creare il controllo ereditato

In Esplora soluzioni, fare clic con il pulsante destro del mouse su ctlClockLib, scegliere Aggiungi, quindi Controllo utente.

Viene aperta la finestra di dialogo Aggiungi nuovo elemento.
Selezionare il modello Controllo utente ereditato.
Nella casella Nome digitare ctlAlarmClock.cs, quindi scegliere Aggiungi.

Viene visualizzata la finestra di dialogo Selezione ereditarietà.
In Nome componente fare doppio clic su ctlClock.
In Esplora soluzioni scorrere i progetti correnti.

Nota

Nel progetto corrente è stato aggiunto il file denominato ctlAlarmClock.cs.

Aggiunta delle proprietà per l'allarme

Le modalità di aggiunta delle proprietà a un controllo ereditato sono analoghe a quelle utilizzate per i controlli compositi. Mediante la sintassi di dichiarazione delle proprietà si aggiungeranno ora al controllo due proprietà: AlarmTime, in cui viene memorizzato il valore della data e dell'ora in cui l'allarme deve essere disattivato, e AlarmSet, che indica se l'allarme è impostato o meno.

Per aggiungere proprietà al controllo composito

In Esplora soluzioni, fare clic con il pulsante destro del mouse su ctlAlarmClock, quindi scegliere Visualizza codice.

Individuare l'istruzione public class. Il controllo eredita da ctlClockLib.ctlClock. Sotto l'istruzione della parentesi graffa di apertura ({), digitare il seguente codice.

[C#]

private DateTime dteAlarmTime;
private bool blnAlarmSet;
// These properties will be declared as public to allow future 
// developers to access them.
public DateTime AlarmTime
{
    get
    {
        return dteAlarmTime;
    }
    set
    {
        dteAlarmTime = value;
    }
}
public bool AlarmSet
{
    get
    {
        return blnAlarmSet;
    }
    set
    {
        blnAlarmSet = value;
    }
}

Aggiunta di elementi all'interfaccia grafica del controllo

Il controllo ereditato presenta un'interfaccia grafica identica a quella del controllo dal quale eredita e possiede gli stessi controlli costitutivi del controllo padre, ma le proprietà dei controlli costitutivi non sono disponibili, a meno che non siano state specificamente esposte. Analogamente a qualsiasi altro controllo composito, è possibile aggiungere elementi all'interfaccia grafica di un controllo composito ereditato, utilizzando la medesima procedura. In questo esempio verrà utilizzato un controllo label che consentirà di aggiungere un effetto intermittente alla grafica del controllo ctlAlarmClock quando l'allarme suona.

Per aggiungere il controllo label

In Esplora soluzioni, fare clic con il pulsante destro del mouse su ctlAlarmClock, quindi scegliere Visualizza finestra di progettazione.

Nella finestra principale verrà aperta la finestra di progettazione per ctlAlarmClock.
Fare clic sulla parte visualizzata del controllo e osservare la finestra Proprietà.

Nota

Tutte le proprietà sono presenti ma inattive, ossia visualizzate in grigio. Ciò indica che le proprietà sono native di lblDisplay e non è possibile accedervi né modificarle nella finestra Proprietà. Per impostazione predefinita i controlli contenuti in un controllo composito sono private e le relative proprietà non sono accessibili.

Nota

Se si desidera che gli utenti successivi del controllo composito abbiano accesso ai relativi controlli interni, dichiararli come public o protected. Sarà così possibile impostare e modificare le proprietà dei controlli contenuti nel controllo composito mediante il codice appropriato.
Aggiungere un controllo Label al controllo composito.
Trascinare con il mouse il controllo Label ponendolo immediatamente sotto la casella di visualizzazione. Nella finestra Proprietà impostare le proprietà seguenti.

Proprietà

Impostazione

Name

lblAlarm

Text

Alarm!

TextAlign

MiddleCenter

Visible

false

Proprietà	Impostazione
Name	lblAlarm
Text	Alarm!
TextAlign	MiddleCenter
Visible	false

Aggiunta della funzionalità di allarme

Nelle procedure precedenti sono state aggiunte proprietà e un controllo in grado di abilitare la funzionalità di allarme nel controllo composito. In questa procedura, verrà aggiunto un codice per confrontare l'ora corrente con l'ora impostata per l'attivazione dell'allarme e, se corrispondono, attivare un segnale di allarme intermittente. Eseguendo l'override del metodo timer1_Tick di ctlClock e aggiungendovi ulteriore codice sarà possibile estendere le capacità di ctlAlarmClock e conservare allo stesso le funzionalità intrinseche di ctlClock.

Per eseguire l'override del metodo timer1_Tick di ctlClock

Nell'editor di codice individuare l'istruzione private bool blnAlarmSet;. e aggiungere subito dopo la seguente istruzione.

[C#]
```
private bool blnColorTicker;
```

Nell'editor di codice individuare la parentesi graffa di chiusura (}) alla fine della classe. Aggiungere il seguente codice prima della parentesi graffa.

[C#]

protected override void timer1_Tick(object sender, System.EventArgs e)
{
    // Calls the Timer1_Tick method of ctlClock.
    base.timer1_Tick(sender, e);
    // Checks to see if the alarm is set.
    if (AlarmSet == false)
        return;
    else
        // If the date, hour, and minute of the alarm time are the same as
        // the current time, flash an alarm. 
    {
        if (AlarmTime.Date == DateTime.Now.Date && AlarmTime.Hour == 
            DateTime.Now.Hour && AlarmTime.Minute == DateTime.Now.Minute)
        {
            // Sets lblAlarmVisible to true, and changes the background color based on
            // the value of blnColorTicker. The background color of the label 
            // will flash once per tick of the clock.
            lblAlarm.Visible = true;
            if (blnColorTicker == false) 
            {
                lblAlarm.BackColor = Color.Red;
                blnColorTicker = true;
            }
            else
            {
                lblAlarm.BackColor = Color.Blue;
                blnColorTicker = false;
            }
        }
        else
        {
            // Once the alarm has sounded for a minute, the label is made 
            // invisible again.
            lblAlarm.Visible = false;
        }
    }
}

Il codice appena aggiunto ha diverse funzioni. Se si utilizza l'istruzione override, il controllo utilizzerà questo metodo anziché il metodo ereditato dal controllo di base. Una volta chiamato, questo metodo chiamerà il metodo di cui esegue l'override utilizzando l'istruzione base.timer1_Tick e assicurando che tutte le funzionalità incorporate nel controllo originale vengano riprodotte in questo controllo. Verrà quindi eseguito il codice aggiuntivo per incorporare la funzionalità di allarme. Quando l'allarme viene attivato, verrà visualizzato un controllo label intermittente.

Il controllo ctlAlarmClock è quasi completo. L'unica operazione rimasta è l'implementazione di un sistema di disattivazione. A tal fine, è necessario aggiungere codice al metodo lblAlarm_Click:

Per implementare il metodo di disattivazione dell'allarme

In Esplora soluzioni, fare clic con il pulsante destro del mouse su ctlAlarmClock.cs e scegliere Visualizza finestra di progettazione.

Verrà aperta la finestra di progettazione.
Aggiungere un pulsante al controllo. Impostare le proprietà del pulsante come illustrato di seguito.

Proprietà

Valore

Name

btnAlarmOff

Text

Disabilita allarme
Nella finestra di progettazione fare doppio clic su btnAlarmOff.

Nell'editor di codice verrà visualizzata la riga private void btnAlarmOff_Click.

Proprietà	Valore
Name	btnAlarmOff
Text	Disabilita allarme

Modificare il metodo in modo che risulti simile al seguente codice.

[C#]

private void btnAlarmOff_Click(object sender, System.EventArgs e)
{
    // Turns off the alarm.
    AlarmSet = false;
    // Hides the flashing label.
    lblAlarm.Visible = false;
}

Scegliere Salva tutto dal menu File per salvare il progetto.

Utilizzo del controllo ereditato in un form

È possibile eseguire il test del controllo ereditato esattamente come si esegue quello del controllo classe base, ctlClock: premere F5 per compilare il progetto ed eseguire il controllo in UserControl Test Container. Per ulteriori informazioni, vedere Procedura: eseguire il test del comportamento in fase di esecuzione di UserControl.

Per utilizzare il controllo è necessario inserirlo in un form. Come i controlli compositi standard, i controlli compositi ereditati non possono essere autonomi e devono essere inclusi in un form o in un altro contenitore. Poiché ctlAlarmClock include un maggior numero di funzionalità, per eseguire il test è necessario aggiungere del codice. In questa procedura verrà scritto un semplice programma per la verifica delle funzionalità di ctlAlarmClock. Verrà inoltre scritto il codice per impostare e visualizzare la proprietà AlarmTime di ctlAlarmClock e verrà eseguito il test delle funzionalità intrinseche del controllo.

Per compilare e aggiungere il controllo a un form di test

In Esplora soluzioni, fare clic con il pulsante destro del mouse su ctlClockLib, quindi scegliere Compila.
Aggiungere un nuovo progetto Applicazione Windows alla soluzione e denominarlo Test.
In Esplora soluzioni fare clic con il pulsante destro del mouse sul nodo Riferimenti del progetto di test. Fare clic su Aggiungi riferimento per visualizzare la finestra di dialogo Aggiungi riferimento. Scegliere la scheda Progetti. Il progetto ctlClockLib verrà elencato in Nome progetto. Fare doppio clic sul progetto per cui si desidera aggiungere il riferimento al progetto di test.
In Esplora soluzioni, fare clic con il pulsante destro del mouse su Test e scegliere Compila.
Nella Casella degli strumenti espandere il nodo Componenti ctlClockLib.
Fare doppio clic su ctlAlarmClock per aggiungere una copia di ctlAlarmClock nel form.
Nella Casella degli strumenti individuare e fare doppio clic su DateTimePicker per aggiungere un controllo DateTimePicker al form, quindi fare doppio clic su Etichetta per aggiungere un controllo Label.
Posizionare mediante il mouse i controlli in un punto del form di facile accesso.
Impostare le proprietà dei controlli come indicato di seguito.

Controllo

Proprietà

Valore

label1

Text

(vuoto)

Name

lblTest

dateTimePicker1

Name

dtpTest

Format

Time
Nella finestra di progettazione fare doppio clic su dtpTest.

Nell'Editor di codice viene visualizzato private void dtpTest_ValueChanged.

Controllo	Proprietà	Valore
label1	Text	(vuoto)
	Name	lblTest
dateTimePicker1	Name	dtpTest
	Format	Time

Modificare il codice in modo che risulti simile al seguente.

[C#]

private void dtpTest_ValueChanged(object sender, System.EventArgs e)
{
    ctlAlarmClock1.AlarmTime = dtpTest.Value;
    ctlAlarmClock1.AlarmSet = true;
    lblTest.Text = "Alarm Time is " +
        ctlAlarmClock1.AlarmTime.ToShortTimeString();
}

In Esplora soluzioni, fare clic con il pulsante destro del mouse su Test e scegliere Imposta come progetto di avvio.
Scegliere Avvia debug dal menu Debug.

Verrà avviato il programma di test. Si noti che l'ora corrente viene aggiornata nel controllo ctlAlarmClock e che l'ora di inizio viene visualizzata nel controllo DateTimePicker.
Fare clic su DateTimePicker nel punto in cui vengono visualizzati i minuti.
Utilizzando la tastiera, impostare un valore per i minuti maggiore di un minuto rispetto all'ora corrente visualizzata da ctlAlarmClock.

L'ora per l'impostazione dell'allarme è visualizzata in lblTest. Attendere che l'ora visualizzata raggiunga l'ora di impostazione dell'allarme. Quando l'ora visualizzata raggiunge l'ora su cui è impostato l'allarme lblAlarm lampeggerà.
Disattivare l'allarme facendo clic su btnAlarmOff. A questo punto è possibile reimpostare l'allarme.

In questa procedura dettagliata sono stati trattati diversi concetti chiave. Si è appreso come creare un controllo composito combinando controlli e componenti in un contenitore controllo composito e come aggiungere proprietà al controllo e scrivere il codice per l'implementazione di funzionalità personalizzate. Nell'ultima sezione sono state illustrate l'estensione delle funzionalità di uno specifico controllo composito mediante ereditarietà e la modifica delle funzionalità dei metodi host mediante override.

Vedere anche

Procedura dettagliata: modifica di un controllo composito con Visual C#

Creazione del progetto

Per creare la libreria di controlli ctlClockLib e il controllo ctlClock

Aggiunta di componenti e controlli Windows al controllo composito

Per aggiungere al controllo utente un oggetto Label e un oggetto Timer

Aggiunta di proprietà al controllo composito

Per aggiungere una proprietà al controllo composito

Test del controllo

Per eseguire il test del controllo

Eredità da un controllo composito

Per creare il controllo ereditato

Aggiunta delle proprietà per l'allarme

Per aggiungere proprietà al controllo composito

Aggiunta di elementi all'interfaccia grafica del controllo

Per aggiungere il controllo label

Aggiunta della funzionalità di allarme

Per eseguire l'override del metodo timer1_Tick di ctlClock

Per implementare il metodo di disattivazione dell'allarme

Utilizzo del controllo ereditato in un form

Per compilare e aggiungere il controllo a un form di test

Vedere anche

Attività

Concetti

Altre risorse

Risorse aggiuntive