Xamarin.Forms Formattazione delle stringhe

Download Sample Scaricare l'esempio

In alcuni casi è utile usare i data binding per visualizzare la rappresentazione di un oggetto o di un valore sotto forma di stringa. Ad esempio, si può usare Label per visualizzare il valore corrente di un elemento Slider. In questo data binding, Slider rappresenta l'origine, mentre la destinazione è la proprietà Text di Label.

Lo strumento più efficace per visualizzare le stringhe nel codice è il metodo statico String.Format. La stringa di formattazione include codici di formattazione specifici per i vari tipi di oggetti e ai valori da formattare è possibile aggiungere altro testo. Per altre informazioni sulla formattazione delle stringhe, vedere Formattazione di tipi in .NET.

La proprietà StringFormat

Questa funzionalità è replicata nei data binding, in cui si imposta la proprietà StringFormat di Binding, o la proprietà StringFormat dell'estensione di markup Binding, su una stringa di formattazione .NET standard con un segnaposto:

<Slider x:Name="slider" />
<Label Text="{Binding Source={x:Reference slider},
                      Path=Value,
                      StringFormat='The slider value is {0:F2}'}" />

Si noti che la stringa di formattazione è delimitata da virgolette singole (apostrofi) per evitare che il parser XAML consideri le parentesi graffe come un'altra estensione di markup XAML. In caso contrario, la stringa senza le virgoletta singole corrisponderebbe alla stringa utilizzata per visualizzare un valore a virgola mobile in una chiamata a String.Format. Una specifica di formattazione F2 fa sì che il valore venga visualizzato con due cifre decimali.

La proprietà StringFormat risulta utile solo quando la proprietà di destinazione è di tipo string, e la modalità di binding è OneWay o TwoWay. Per i data binding bidirezionali, StringFormat è applicabile solo per i valori che passano dall'origine alla destinazione.

Come si vedrà nel prossimo articolo sul Percorso di binding, i data binding possono diventare piuttosto complessi e intricati. Durante il debug di questi data binding, è possibile aggiungere nel file XAML un elemento Label con StringFormat per visualizzare alcuni risultati intermedi. Anche se utilizzato solo per visualizzare il tipo di un oggetto, può essere utile.

La pagina di formattazione delle stringhe illustra diversi utilizzi della proprietà :

<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:sys="clr-namespace:System;assembly=netstandard"
             x:Class="DataBindingDemos.StringFormattingPage"
             Title="String Formatting">

    <ContentPage.Resources>
        <ResourceDictionary>
            <Style TargetType="Label">
                <Setter Property="HorizontalTextAlignment" Value="Center" />
            </Style>

            <Style TargetType="BoxView">
                <Setter Property="Color" Value="Blue" />
                <Setter Property="HeightRequest" Value="2" />
                <Setter Property="Margin" Value="0, 5" />
            </Style>
        </ResourceDictionary>
    </ContentPage.Resources>

    <StackLayout Margin="10">
        <Slider x:Name="slider" />
        <Label Text="{Binding Source={x:Reference slider},
                              Path=Value,
                              StringFormat='The slider value is {0:F2}'}" />

        <BoxView />

        <TimePicker x:Name="timePicker" />
        <Label Text="{Binding Source={x:Reference timePicker},
                              Path=Time,
                              StringFormat='The TimeSpan is {0:c}'}" />

        <BoxView />

        <Entry x:Name="entry" />
        <Label Text="{Binding Source={x:Reference entry},
                              Path=Text,
                              StringFormat='The Entry text is &quot;{0}&quot;'}" />

        <BoxView />

        <StackLayout BindingContext="{x:Static sys:DateTime.Now}">
            <Label Text="{Binding}" />
            <Label Text="{Binding Path=Ticks,
                                  StringFormat='{0:N0} ticks since 1/1/1'}" />
            <Label Text="{Binding StringFormat='The {{0:MMMM}} specifier produces {0:MMMM}'}" />
            <Label Text="{Binding StringFormat='The long date is {0:D}'}" />
        </StackLayout>

        <BoxView />

        <StackLayout BindingContext="{x:Static sys:Math.PI}">
            <Label Text="{Binding}" />
            <Label Text="{Binding StringFormat='PI to 4 decimal points = {0:F4}'}" />
            <Label Text="{Binding StringFormat='PI in scientific notation = {0:E7}'}" />
        </StackLayout>
    </StackLayout>
</ContentPage>

I data binding su Slider e TimePicker mostrano l'uso di specifiche di formato speciali per i tipi di dati double e TimeSpan. L'elemento StringFormat che visualizza il testo dalla vista Entry illustra come specificare virgolette doppie nella stringa di formattazione usando l'entità HTML &quot;.

La sezione successiva del file XAML contiene un elemento StackLayout con un BindingContext impostato su un'estensione di markup x:Static che fa riferimento alla proprietà statica DateTime.Now. Il primo data binding non ha proprietà:

<Label Text="{Binding}" />

Verrà semplicemente visualizzato il valore DateTime di BindingContext con formattazione predefinita. Il secondo data binding visualizza la proprietà Ticks di DateTime, mentre gli altri due visualizzano DateTime con formattazione specifica. Si noti questo StringFormat:

<Label Text="{Binding StringFormat='The {{0:MMMM}} specifier produces {0:MMMM}'}" />

Per visualizzare parentesi graffe di apertura o chiusura nella stringa di formattazione, usarne una coppia.

Quest'ultima sezione imposta BindingContext sul valore di Math.PI e lo visualizza con la formattazione predefinita e due tipi diversi di formattazione numerica.

Ecco il programma in esecuzione:

String Formatting

ViewModel e formattazione delle stringhe

Quando si usa Label e StringFormat per visualizzare il valore di una vista che rappresenta anche la destinazione di un elemento ViewModel, è possibile definire l'associazione dalla vista a Label oppure da ViewModel a Label. In generale, il secondo approccio è migliore perché verifica che le associazioni tra View e ViewModel funzionino.

Questo approccio è illustrato nell'esempio Better Color Selector che usa lo stesso elemento ViewModel del programma Simple Color Selector illustrato nell'articolo Binding Mode (Modalità di binding):

<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:local="clr-namespace:DataBindingDemos"
             x:Class="DataBindingDemos.BetterColorSelectorPage"
             Title="Better Color Selector">

    <ContentPage.Resources>
        <ResourceDictionary>
            <Style TargetType="Slider">
                <Setter Property="VerticalOptions" Value="CenterAndExpand" />
            </Style>

            <Style TargetType="Label">
                <Setter Property="HorizontalTextAlignment" Value="Center" />
            </Style>
        </ResourceDictionary>
    </ContentPage.Resources>

    <StackLayout>
        <StackLayout.BindingContext>
            <local:HslColorViewModel Color="Sienna" />
        </StackLayout.BindingContext>

        <BoxView Color="{Binding Color}"
                 VerticalOptions="FillAndExpand" />

        <StackLayout Margin="10, 0">
            <Label Text="{Binding Name}" />

            <Slider Value="{Binding Hue}" />
            <Label Text="{Binding Hue, StringFormat='Hue = {0:F2}'}" />

            <Slider Value="{Binding Saturation}" />
            <Label Text="{Binding Saturation, StringFormat='Saturation = {0:F2}'}" />

            <Slider Value="{Binding Luminosity}" />
            <Label Text="{Binding Luminosity, StringFormat='Luminosity = {0:F2}'}" />
        </StackLayout>
    </StackLayout>
</ContentPage>    

Sono ora disponibili tre coppie di elementi Slider e Label associate alla stessa proprietà di origine nell'oggetto HslColorViewModel. L'unica differenza è che per Label è presente una proprietà StringFormat per visualizzare ogni valore Slider.

Better Color Selector

È lecito chiedersi come si possono visualizzare valori RGB (rosso, verde, blu) nel tradizionale formato esadecimale a due cifre. Questi valori interi non sono disponibili direttamente nella struttura Color. Una soluzione sarebbe calcolare i valori interi dei componenti dei colori all'interno dell'elemento ViewModel ed esporli come proprietà. A questo punto, si potrebbe formattarli utilizzando la specifica di formattazione X2.

Un'alternativa consiste nell'adottare un approccio più generale: scrivere un convertitore dei valori di associazione come illustrato nell'articolo Binding Value Converters (Convertitori dei valori di associazione).

L'articolo seguente, tuttavia, illustra il Percorso di binding in dettaglio e mostra come usarlo creare riferimenti a sottoproprietà ed elementi nelle raccolte.