UWP (Universal Windows Platform) Wprowadzenie — Szybki start

Categories:

1. Xaml

1.1. Wprowadzenie do XAML

  • Przegląd XAML
  • Służy głównie do tworzenia wizualnych elementów interfejsu użytkownika (UI).
  • Podstawowa składnia XAML opiera się na XML.
  • Deklaracja aliasu przestrzeni nazw:
xmlns:controls="using:Common.Controls"
  • Użycie klasy zadeklarowanej w przestrzeni nazw:
<controls:MyControl />

  • Możliwe do ponownego użycia zasoby (Resource),

    x:Key

<Style x:Key="TextBlock_Style" />
  • Nazwa elementu kontrolki,

x:Name

Xaml:

<MyControl x:Name="myControl" />

C#:

private MyControl myControl;

  • Lokalizacja

    x:Uid

<TextBlock x:Uid="sampleText" />

1.2. Najbardziej podstawowe kontrolki (Control) — TextBlock, Button

<Page x:Class="MyPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
    <StackPanel>
        <TextBlock Text="Wprowadzenie do UWP" />
        <Button Content="Wprowadzenie do UWP" Click="Button_Click" />
    </StackPanel>
</Page>

2. MVVM

Szczegółowe informacje o MVVM

View <=> ViewModel <=> Model

  • View powinien w miarę możliwości zawierać tylko treści wyświetlane w interfejsie użytkownika, View jest w większości tworzony przy użyciu języka Xaml;
  • ViewModel powinien w miarę możliwości nie zawierać logiki obsługi biznesowej, lecz wykonywać czynności poprzez wywoływanie funkcji w Modelu;
  • Model powinien w miarę możliwości zawierać wszystkie dane biznesowe i logikę oraz nie zależeć od View i ViewModel;

3. Interakcja ViewModel i Model

3.1. ViewModel steruje danymi Modelu

ViewModel:

public class ViewModel
{
    private Model model;
    private ChangeA()
    {
        this.model.A = "A";
    }
}

Model:

public class Model
{
    public string A { get; set; }
    public string B { get; set; }
}

3.2. Model powiadamia ViewModel — event

ViewModel:

public class ViewModel
{
private Model model;
    private ChangeA()
    {
        r.BEventArgs += this.Handler;
    }
    private void Handler(object sender, EventArgs e)
    {
        AnyActions();
    }
}

Model:

public delegate void BChangedHandler(object sender, EventArgs e);

public class Model
{
    public string A { get; set; }
    private string _B;
    public string B
    {
        get { return this._B; }
        set
        {
            this._B = value;
            if (BEventArgs != null)
            {
                BEventArgs(this, new EventArgs());
            }
        }
    }
    public event BChangedHandler BEventArgs;
}

4. Interakcja View i ViewModel

4.1. Wiązanie danych

4.1.1. Wiązanie w ViewModel

View:

<TextBlock Text={Binding SampleText} />

ViewModel:

public string SampleText { get; set; }

4.1.2. Wiązanie w innym Control

View:

<TextBlock x:Name="TextBlock1" Text="SampleText" />
<Button Content="{Binding ElementName=TextBlock1, Path= Text}" />

4.1.3. Określanie DataContext

public ViewModelClass ViewModel { get; set; }

...
SpecifiedControl.DataContext = ViewModel;
...

5. (View i ViewModel) Implementacja powiadomień — INotifyPropertyChanged

Gdy SampleText ulegnie zmianie, powiadomienie zostanie wysłane do DependencyProperty powiązanego z tą właściwością

public class MyControlViewModel : INotifyPropertyChanged
    {
        public event PropertyChangedEventHandler PropertyChanged;

        public void Notify(string propName)
        {
            if (this.PropertyChanged != null)
            {
                PropertyChanged(this, new PropertyChangedEventArgs(propName));
            }
        }

        private string _sampleText;
        public string SampleText
        {
            get
            {
                return _sampleText;
            }
            set
            {
                _sampleText = value;
                Notify(nameof(SampleText));
            }
        }
    }

Lub dziedziczenie po ViewModelBase

public class ViewModelBase : INotifyPropertyChanged
    {
        public event PropertyChangedEventHandler PropertyChanged;

        public void Notify(string propName)
        {
            if (this.PropertyChanged != null)
            {
                PropertyChanged(this, new PropertyChangedEventArgs(propName));
            }
        }
    }

6. (View i ViewModel) ListView powiązany ze źródłem implementującym powiadomienia — ObservableCollection

ListView

Implementacja wiązania w ListView do ItemSource z powiadomieniami

View:

<ListView ItemsSource="{Binding Items}">

ViewModel:

public ObservableCollection<Recording> Items { get; set; }
  • ObservableCollection wysyła powiadomienia tylko przy dodaniu/usunięciu elementu (Item) lub odświeżeniu całej listy;
  • Jeśli potrzebne jest powiadomienie interfejsu o zmianie treści elementu Recording, musi on zaimplementować INotifyPropertyChanged.

7. (View) Szablon Item ListView (DataTemplate | UserControl)

7.1. DataTemplate

View:

<ListView ItemsSource="{Binding Items}">
    <ListView.ItemTemplate>
        <DataTemplate DataType="local:Recording">
            <StackPanel Orientation="Horizontal">
                <TextBlock Text="{Binding A}" />
                <TextBlock Text="{Binding B}" />
            </StackPanel>
        </DataTemplate>
    </ListView.ItemTemplate>
</ListView>

ViewModel:

public ObservableCollection<RecordingViewModel> Items { get; set; }

public class RecordingViewModel : INotifyPropertyChanged
{
    ...
    Implement INotifyPropertyChanged
    ...

    private Recording _recording;

    public string A
    {
        get
        {
            return this._recording.A;
        }
        set
        {
            this._recording.A = value;
            Notify(nameof(A));
        }
    }

    public string B { get; set; } = this._recording.B;

    public RecordingViewModel (Recording recording)
    {
        this._recording = recording;
    }
}

Model:

public class Recording
{
    public string A { get; set; }
    public string B { get; set; }
    public string C { get; set; }
    ... ...
}

Porównanie:

Separacja ViewModel/Model

7.2. UserControl

7.2.1. DependencyProperty

View:

<control:MyControl Text="App is on searching" IsSearching="{Binding ViewModel.IsSearching}" />

ViewModel:

public class MyControl
{
...
public static readonly DependencyProperty IsSearchingProperty =
    DependencyProperty.Register
    (
        "IsSearching", typeof(Boolean),
        typeof(MyControl), null
    );

public bool IsSearching
{
    get { return (bool)GetValue(IsSearchingProperty); }
    set { SetValue(IsSearchingProperty, value); }
}
...
}

8. (ViewModel i Model) Konwersja danych — IValueConverter

Można użyć IValueConverter do konwersji danych między ViewModel a Model.

public class ShowAllButtonVisibilityConverter:IValueConverter
    {
        public object Convert(object value, Type targetType, object parameter, string language)
        {
            if (value is IList)
            {
                int count = (value as IList).Count;
                if (count > 3)
                {
                    return Windows.UI.Xaml.Visibility.Visible;
                }
            }
            return Windows.UI.Xaml.Visibility.Collapsed;
        }

        public object ConvertBack(object value, Type targetType, object parameter, string language)
        {
            if (value is IList)
            {
                int count = (value as IList).Count;
                if (count > 3)
                {
                    return Windows.UI.Xaml.Visibility.Visible;
                }
            }
            return Windows.UI.Xaml.Visibility.Collapsed;
        }

9. (View) Modyfikacja stylu Control

9.1. Niestandardowy Style w Control

View:

<TextBlock Foreground="Red" Text="SampleText" />

9.2. Używanie jednolitego Style — ResourceDictionary

View:

<Window.Resources>
    <ResourceDictionary>
        <Style TargetType="TextBlock" x:Key="ImportantText">
            <Setter Property="Foreground" Value="Red" />
        </Style>
    </ResourceDictionary>
</Window.Resources>
...
<TextBlock Text="SampleText" Style={StaticResource ImportantText} />

9.3. Używanie ThemeResource

View:

<Window.Resources>
    <ResourceDictionary>
        <ResourceDictionary.ThemeDictionaries>
            <ResourceDictionary x:Key="Light">
                <Style TargetType="TextBlock" x:Key="ImportantText">
                    <Setter Property="Foreground" Value="Red" />
                </Style>
            </ResourceDictionary>

            <ResourceDictionary x:Key="Dark">
                <Style TargetType="TextBlock" x:Key="ImportantText">
                    <Setter Property="Foreground" Value="Yellow" />
                </Style>
            </ResourceDictionary>

            <ResourceDictionary x:Key="HighContrast">
                <Style TargetType="TextBlock" x:Key="ImportantText">
                    <Setter Property="Foreground" Value="Black" />
                </Style>
            </ResourceDictionary>
        </ResourceDictionary.ThemeDictionaries>
    </ResourceDictionary>
</Window.Resources>
...
<TextBlock Text="SampleText" Style={ThemeResource ImportantText} />

10. Używanie Panelu

10.1. Grid

Cechy:

  • Domyślnie Height/Width równają się elementowi nadrzędnemu;

Zalecenia:

  • Zdefiniuj rozmiar układu elementów podrzędnych w Grid;
  • Wyświetlaj proporcjonalnie;

10.2. StackPanel

Cechy:

  • Może przekroczyć granice elementu nadrzędnego;
  • Height lub Width zmienia się wraz z elementami w Panelu;

Zalecenia:

  • Elastyczne używanie Paddingu i proporcji;
  • W elemencie nadrzędnym nadaj StackPanel wartość Width lub Height, aby zapobiec wyjściu Control poza granice;

11. (View) Adaptacyjny interfejs UI (Adaptive UI)

  • Użyj VisualStateManager.VisualStateGroup
<VisualStateGroup>
    <VisualState x:Name="WideLayout">
        <VisualState.StateTriggers>
            <AdaptiveTrigger x:Name="WideLayoutTrigger" MinWindowWidth="1280" />
        </VisualState.StateTriggers>
        <VisualState.Setters>
            <Setter Target="SystemUpdateSideGrid.Width" Value="800" />
            <Setter Target="SystemUpdateSideGrid.Grid.Row" Value="0" />
        </VisualState.Setters>
    </VisualState>

    <VisualState x:Name="MidLayout">
        <VisualState.StateTriggers>
            <AdaptiveTrigger x:Name="MidLayoutTrigger" MinWindowWidth="700" />
        </VisualState.StateTriggers>
        <VisualState.Setters>
            <Setter Target="SystemUpdateSideGrid.Width" Value="400" />
            <Setter Target="SystemUpdateSideGrid.Grid.Row" Value="1" />
        </VisualState.Setters>
    </VisualState>
    ...
</VisualStateGroup>

12. Zasady układu

  • Nie ustawiaj jawnie rozmiarów elementów;
  • Nie używaj współrzędnych ekranowych do określania pozycji elementów;
  • Elementy podrzędne w kontenerze współdzielą dostępną przestrzeń;
  • Kontenery układu mogą być zagnieżdżane;

13. Lokalizacja

  • Użyj x:Uid, unikalnego identyfikatora elementu
    <TextBlock x:Uid="S_TextBlock1" />
  • Użyj pliku Resources
    <data name="S_TextBlock1.Text" xml:space="preserve">
        <value>Przykładowy tekst</value>
    </data>

14. Konwencje nazewnictwa

Wielka wielbłądzia notacja (big camel-case): firstName

Mała wielbłądzia notacja (little camel-case): FirstName

  • Class: big camel-case
  • Property: big camel-case
  • Field: little camel-case z prefiksem “_”
  • Control w Xaml: little camel-case

15. Uwagi

  • Ostrożnie zmieniaj nazwy Property w ViewModel, ponieważ nazwy wiązań (Binding) w Xaml nie będą podążać za refaktoryzacją;