Parametri dichiarativi (C#)

di Scott Mitchell

Scarica PDF

In questa esercitazione verrà illustrato come usare un set di parametri su un valore hardcoded per selezionare i dati da visualizzare in un controllo DetailsView.

Introduzione

Nell'ultima esercitazione è stata esaminata la visualizzazione dei dati con i controlli GridView, DetailsView e FormView associati a un controllo ObjectDataSource che ha richiamato il GetProducts() metodo dalla ProductsBLL classe . Il GetProducts() metodo restituisce un oggetto DataTable fortemente tipizzato popolato con tutti i record della tabella del Products database Northwind. La ProductsBLL classe contiene metodi aggiuntivi per restituire solo subset dei prodotti - GetProductByProductID(productID), GetProductsByCategoryID(categoryID)e GetProductsBySupplierID(supplierID). Questi tre metodi prevedono un parametro di input che indica come filtrare le informazioni sul prodotto restituite.

ObjectDataSource può essere usato per richiamare metodi che prevedono parametri di input, ma per farlo è necessario specificare da dove provengono i valori per questi parametri. I valori dei parametri possono essere hardcoded o possono provenire da un'ampia gamma di origini dinamiche, tra cui valori di querystring, variabili di sessione, valore della proprietà di un controllo Web nella pagina o altri.

Per questa esercitazione si inizierà illustrando come usare un parametro impostato su un valore hardcoded. In particolare, esamineremo l'aggiunta di un controllo DetailsView alla pagina che visualizza informazioni su un prodotto specifico, vale a dire Chef Anton's Gumbo Mix, che ha un ProductID valore pari a 5. Si vedrà quindi come impostare il valore del parametro in base a un controllo Web. In particolare, si userà un controllo TextBox per consentire all'utente di digitare un paese o un'area geografica, dopo di che è possibile fare clic su un pulsante per visualizzare l'elenco dei fornitori che risiedono in tale paese o area geografica.

Uso di un valore di parametro hardcoded

Per il primo esempio, iniziare aggiungendo un controllo DetailsView alla DeclarativeParams.aspx pagina nella BasicReporting cartella . Dallo smart tag DetailsView selezionare <Nuova origine> dati dall'elenco a discesa e scegliere di aggiungere un OggettoDataSource.

Figura 1: Aggiungere objectDataSource alla pagina (fare clic per visualizzare l'immagine a dimensione intera)

Verrà avviata automaticamente la procedura guidata Scegli origine dati del controllo ObjectDataSource. Selezionare la ProductsBLL classe nella prima schermata della procedura guidata.

Figura 2: Selezionare la classe (fare clic per visualizzare l'immagine ProductsBLLa dimensione intera)

Poiché si vogliono visualizzare informazioni su un particolare prodotto che si vuole usare il GetProductByProductID(productID) metodo .

Figura 3: Scegliere il GetProductByProductID(productID) metodo (fare clic per visualizzare l'immagine a dimensione intera)

Poiché il metodo selezionato include un parametro, è disponibile un'altra schermata per la procedura guidata, in cui viene chiesto di definire il valore da usare per il parametro. L'elenco a sinistra mostra tutti i parametri per il metodo selezionato. Per GetProductByProductID(productID) c'è un productIDsolo . A destra è possibile specificare il valore per il parametro selezionato. L'elenco a discesa origine parametri enumera le varie origini possibili per il valore del parametro. Poiché si vuole specificare un valore hardcoded pari a 5 per il productID parametro, lasciare l'origine Parametro come Nessuno e immettere 5 nella casella di testo DefaultValue.

Figura 4: Verrà usato un valore di parametro hardcoded pari a 5 per il parametro (fare clic per visualizzare l'immagine productIDa dimensione intera)

Dopo aver completato la procedura guidata Configura origine dati, il markup dichiarativo del controllo ObjectDataSource include un Parameter oggetto nella SelectParameters raccolta per ognuno dei parametri di input previsti dal metodo definito nella SelectMethod proprietà . Poiché il metodo usato in questo esempio prevede solo un singolo parametro di input, parameterID, è presente una sola voce qui. La SelectParameters raccolta può contenere qualsiasi classe che deriva dalla Parameter classe nello spazio dei System.Web.UI.WebControls nomi . Per i valori dei parametri hardcoded viene usata la classe base Parameter , ma per le altre opzioni di origine dei parametri viene usata una classe derivata Parameter . Se necessario, è anche possibile creare tipi di parametri personalizzati.

<asp:ObjectDataSource ID="ObjectDataSource1" runat="server"
    SelectMethod="GetProductByProductID" TypeName="ProductsBLL">
    <SelectParameters>
        <asp:Parameter DefaultValue="5" Name="productID"
         Type="Int32" />
    </SelectParameters>
</asp:ObjectDataSource>

Quando si visita questa pagina, il controllo Web dati richiamerà il metodo objectDataSource Select , che chiamerà il ProductsBLL metodo della GetProductByProductID(productID) classe usando il valore hardcoded pari a 5 per il productID parametro di input. Il metodo restituirà un oggetto fortemente tipizzato ProductDataTable che contiene una singola riga con informazioni su Chef Anton's Gumbo Mix (il prodotto con ProductID 5).

Figura 5: Vengono visualizzate informazioni sulla combinazione Gumbo di Chef Anton (fare clic per visualizzare l'immagine a dimensione intera)

Impostazione del valore del parametro sul valore della proprietà di un controllo Web

I valori dei parametri di ObjectDataSource possono essere impostati anche in base al valore di un controllo Web nella pagina. Per illustrare questo problema, si avrà un controllo GridView che elenca tutti i fornitori che si trovano in un paese o in un'area geografica specificata dall'utente. A tale scopo, aggiungere un controllo TextBox alla pagina in cui l'utente può immettere un nome paese/paese. Impostare la proprietà del ID controllo TextBox su CountryName. Aggiungere anche un controllo Web Button.

Figura 6: Aggiungere un controllo TextBox alla pagina con ID CountryName (fare clic per visualizzare l'immagine a dimensione intera)

Aggiungere quindi un controllo GridView alla pagina e, dallo smart tag, scegliere di aggiungere un nuovo OggettoDataSource. Poiché si vogliono visualizzare le informazioni sul fornitore, selezionare la SuppliersBLL classe dalla prima schermata della procedura guidata. Nella seconda schermata selezionare il GetSuppliersByCountry(country) metodo .

Figura 7: Scegliere il GetSuppliersByCountry(country) metodo (fare clic per visualizzare l'immagine a dimensione intera)

Poiché il GetSuppliersByCountry(country) metodo ha un parametro di input, la procedura guidata include nuovamente una schermata finale per la scelta del valore del parametro. Questa volta impostare Origine parametro su Controllo. Verrà popolato l'elenco a discesa ControlID con i nomi dei controlli nella pagina; selezionare il CountryName controllo dall'elenco. Quando la pagina viene visitata per la prima volta, TextBox CountryName sarà vuota, quindi non vengono restituiti risultati e non viene visualizzato alcun risultato. Per visualizzare alcuni risultati per impostazione predefinita, impostare di conseguenza la casella di testo DefaultValue.

Figura 8: Impostare il valore del parametro sul valore del controllo (fare clic per visualizzare l'immagine CountryNamea dimensione intera)

Il markup dichiarativo di ObjectDataSource è leggermente diverso dal primo esempio, usando controlParameter anziché l'oggetto standardParameter. Un ControlParameter oggetto dispone di proprietà aggiuntive per specificare l'oggetto ID del controllo Web e il valore della proprietà da utilizzare per il parametro (PropertyName). La procedura guidata Configura origine dati è stata abbastanza intelligente per determinare che, per un controllo TextBox, è probabile che si voglia usare la Text proprietà per il valore del parametro. Se, tuttavia, si desidera utilizzare un valore di proprietà diverso dal controllo Web, è possibile modificare il PropertyName valore qui o facendo clic sul collegamento "Mostra proprietà avanzate" nella procedura guidata.

<asp:ObjectDataSource ID="ObjectDataSource2" runat="server"
    SelectMethod="GetSuppliersByCountry" TypeName="SuppliersBLL">
    <SelectParameters>
        <asp:ControlParameter ControlID="CountryName"
          Name="country" PropertyName="Text"
            Type="String" />
    </SelectParameters>
</asp:ObjectDataSource>

Quando si visita la pagina per la prima volta che TextBox CountryName è vuoto. Il metodo ObjectDataSource Select viene ancora richiamato da GridView, ma viene passato un valore di null nel GetSuppliersByCountry(country) metodo . TableAdapter converte in null un valore di database NULL (DBNull.Value), ma la query usata dal GetSuppliersByCountry(country) metodo viene scritta in modo che non restituisca valori quando viene specificato un NULL valore per il @CategoryID parametro . In breve, non vengono restituiti fornitori.

Una volta che il visitatore entra in un paese, tuttavia, e fa clic sul pulsante Show Suppliers per generare un postback, il metodo objectDataSource Select viene rieseguito la query, passando il valore del Text controllo TextBox come country parametro.

Figura 9: Vengono visualizzati i fornitori del Canada (fare clic per visualizzare l'immagine a dimensione intera)

Visualizzazione di tutti i fornitori per impostazione predefinita

Invece di mostrare nessuno dei fornitori quando si visualizza per la prima volta la pagina, è possibile visualizzare tutti i fornitori in un primo momento, consentendo all'utente di abbassare l'elenco immettendo un nome paese/area geografica nel controllo TextBox. Quando TextBox è vuoto, il SuppliersBLL metodo della GetSuppliersByCountry(country) classe viene passato in un null valore per il country parametro di input. Questo null valore viene quindi passato al metodo dal GetSupplierByCountry(country) , in cui viene convertito in un valore di database NULL per il @Country parametro nella query seguente:

SELECT     SupplierID, CompanyName, Address, City, Country, Phone
FROM         Suppliers
WHERE Country = @Country

L'espressione Country = NULL restituisce sempre False, anche per i record la cui Country colonna ha un NULL valore, pertanto non vengono restituiti record.

Per restituire tutti i fornitori quando il paese TextBox è vuoto, è possibile aumentare il GetSuppliersByCountry(country) metodo nel BLL per richiamare il metodo quando il GetSuppliers() parametro country è null e per chiamare il metodo DAL GetSuppliersByCountry(country) in caso contrario. Questo avrà l'effetto di restituire tutti i fornitori quando non viene specificato alcun paese e il subset appropriato di fornitori quando il parametro paese è incluso.

Modificare il GetSuppliersByCountry(country) metodo nella SuppliersBLL classe come segue:

public Northwind.SuppliersDataTable GetSuppliersByCountry(string country)
{
    if (string.IsNullOrEmpty(country))
        return GetSuppliers();
    else
        return Adapter.GetSuppliersByCountry(country);
}

Con questa modifica la DeclarativeParams.aspx pagina mostra tutti i fornitori quando vengono visitati per la prima volta (o ogni volta che textBox CountryName è vuoto).

Figura 10: Tutti i fornitori sono ora visualizzati per impostazione predefinita (fare clic per visualizzare l'immagine a dimensione intera)

Riepilogo

Per usare metodi con parametri di input, è necessario specificare i valori per i parametri nell'insieme SelectParameters ObjectDataSource. Diversi tipi di parametri consentono di ottenere il valore del parametro da origini diverse. Il tipo di parametro predefinito usa un valore hardcoded, ma altrettanto facilmente (e senza una riga di codice) i valori dei parametri possono essere ottenuti dalla stringa di query, dalle variabili di sessione, dai cookie e persino dai valori immessi dall'utente dai controlli Web nella pagina.

Negli esempi esaminati in questa esercitazione è stato illustrato come usare i valori dei parametri dichiarativi. Tuttavia, potrebbero verificarsi momenti in cui è necessario usare un'origine di parametri non disponibile, ad esempio la data e l'ora correnti oppure, se il sito usa l'appartenenza, l'ID utente del visitatore. Per questi scenari è possibile impostare i valori dei parametri a livello di codice prima di richiamare il metodo dell'oggetto sottostante a ObjectDataSource. Si vedrà come eseguire questa operazione nell'esercitazione successiva.

Buon programmatori!

Informazioni sull'autore

Scott Mitchell, autore di sette libri ASP/ASP.NET e fondatore di 4GuysFromRolla.com, ha lavorato con le tecnologie Web Microsoft dal 1998. Scott lavora come consulente indipendente, formatore e scrittore. Il suo ultimo libro è Sams Teach Yourself ASP.NET 2.0 in 24 ore. Può essere raggiunto all'indirizzo mitchell@4GuysFromRolla.com. o tramite il suo blog, che può essere trovato all'indirizzo http://ScottOnWriting.NET.

Grazie speciale a

Questa serie di esercitazioni è stata esaminata da molti revisori utili. Il revisore principale per questa esercitazione era Hilton Giesenow. Si è interessati a esaminare i prossimi articoli MSDN? In tal caso, rilasciarmi una riga in mitchell@4GuysFromRolla.com.