Создание своих библиотек в WPF: функциональная, стили и пользовательские контролы — pack URI и dll

Некоторые блоки кода если они довольно обширные и могут использоваться и в других проектах, выносятся в отдельные библиотеки. Явный пример — Newtonsoft.Json — отдельная библиотека с функционалом для сериализации и десериализации. Мы можем создавать такие же библиотеки в трех направлениях: функциональная библиотека, библиотека стилей и библиотека пользовательских элементов управления.

Для примера, я создам маленькое приложение, над которым буду издеваться.

Функциональная библиотека #

Для создания функциональной библиотеки и в принципе любых библиотек нам необходимо добавить новый проект внутрь нашего решения. Решение может хранить несколько проектов и библиотек, чтобы мы сразу видели, что несколько библиотек/приложения относятся к одному и тому же.

ПКМ нажмем по решению и выберем «Добавить», «Создать проект».

В появившемся окне, как при старте программы, нам нужно найти самую простую библиотеку классов, которая будет поддерживаться на C#.

Назовем как-нибудь наш проект и продолжим.

Теперь внутри нашего решения у нас появился ещё один проект — библиотека с одним классом. По умолчанию, сразу после создания, у нас откроется этот класс.

Теперь, прямо внутри этого класса мы можем начать писать какой-то функционал, также как мы это делали и в других приложениях — отдельный класс — отдельный функционал.

Я создам функционал по имитации какого-то долгого действия (примерно, как была генерация точек в лекции про Task). Изменю имя класса на ImmitationWork и внутрь впишу следующий код.

Следующий код представлен только для примера и не понадобится вам ни в какой практической, ничего. Вы сюда хоть месседжбокс можете пихнуть.

1
using System.Net;
2

3
namespace FunctionalLib
4
{
5
    public class ImmitationWork
6
    {
7
        public static void ImmitateLongFileBlock(string file, int milisecond)
8
        {
9
            using (FileStream fs = new FileStream(file, FileMode.Open))
10
            {
11
                Thread.Sleep(milisecond);
12
            }
13
        }
14

15
        public static HttpStatusCode ImmitateServerResponce(int milisecond = 0)
16
        {
17
            Thread.Sleep(milisecond);
18
            var statuses = Enum.GetValues(typeof(HttpStatusCode)).Cast<HttpStatusCode>().ToArray();
19
            Random rand = new Random();
20
            return statuses[rand.Next(0, statuses.Length)];
21
        }
22
    }
23
}

Подключение библиотеки к проекту #

Окей, код мы написали, теперь давайте им воспользуемся внутри приложения. Чтобы это сделать, нам сначала необходимо подключить эту библиотеку. И если мы раньше делали это через NuGet, то для самосозданных библиотек мы делаем иначе.

Подключим библиотеку, нажав ПКМ по «Зависимости» и выберем «Добавить ссылку на проект».

Поставим галочку на нашей библиотеке и нажмем ОК.

И теперь мы можем использовать классы, которые были внутри этой библиотеки. Например, обработаю нажатие на кнопку и результат метода ImmitateServerResponce выведу в текстовое поле. Само текстовое поле названо Txt.

Запущу, и по нажатию на кнопку у меня меняется текст.

Библиотека стилей #

Для создания библиотеки стилей нам нужно сделать тоже самое — ПКМ по решению → Создать проект → Библиотека настраиваемых элементов управления (либо Microsoft, либо .NET Framework). Назову этот проект CustomLib.

Проект будет выглядеть следующим образом.

В базовом открываемом файле вы увидите CustomControl — это файл, при помощи которого вы можете переписывать стиль для всего приложения через код. Внутри него также есть инструкция как надо подключать этот проект.

Но честно, нам этот файл не интересен, так что я его удалю.

Внутри папки Themes разместим стили для кнопок/текстовых полей и других элементов интерфейса, которые мы хотим менять. Старый файл из Themes я удалю.

Добавлю внутрь папки Theme два заготовленных стиля — кнопку и текстовое поле.

Чтобы я смогла их всецелостно импортировать в свой проект, мне необходимо создать файл, подобный App.xaml внутри приложения, где я буду просто хранить все объединенные библиотеки. Назову её FullDictionary и помещу его в корень проекта.

Содержимое будет следующим — просто сразу скажем что этот словарь состоит из нескольких словарей.

1
<ResourceDictionary xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
2
                    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
3
    <ResourceDictionary.MergedDictionaries>
4
        <ResourceDictionary Source="Themes/ControlButton.xaml"/>
5
        <ResourceDictionary Source="Themes/DefaultTextBox.xaml"/>
6
    </ResourceDictionary.MergedDictionaries>
7
</ResourceDictionary>

Чтобы подключить такую библиотеку, опять же в основном проекте нажмем на зависимости → Добавить существующий проект и галочку по новой библиотеке → ОК.

Внутрь App.xaml основного приложения нужно прописать ссылку на файл со всеми словарями. Этот ресурс пропишется как:

1
<ResourceDictionary Source="pack://application:,,,/библиотека;component/папка/названиесловаря.xaml"/>

Не забываем собрать проект заново, как только мы подключили новую библиотеку!

И теперь мы можем использовать стили из этой библиотеки.

Библиотека пользовательских элементов управления #

Создадим внутри решения ещё одну библиотеку — Библиотека пользовательских элементов WPF. Назову её ControlsLib.

Выглядеть она будет следующим образом. Здесь я смогу располагать все пользовательские элементы интерфейса, которые хочу вынести из проекта.

Возьму, например, карточку из календаря и перенесу её сюда. Она подразумевала картинку, так что добавлю ещё и картинку.

Чтобы картинка работала, поставлю ей в свойствах Ресурс и Копировать всегда. Однако у меня появится проблема — картинка не будет видна в карточке.

Для того, чтобы это исправить, внутрь Image, в свойство Source, необходимо вставить такой же источник, каким мы делали ResourceDictionary для App.xaml. Алгоритм следующий:

1
pack://application:,,,/библиотека;component/папка/названиекартинки.расширение

Я ссылаюсь сама на себя, так что ссылка будет следующая.

Подключение и использование #

И теперь библиотеку со своими элементами управления мы можем добавить в наш проект. Также нажмем ПКМ по зависимостям → Добавить проект и галочку по проекту → ОК.

Не забудем собрать проект при помощи Ctrl + B.

Чтобы вызывать эти элементы интерфейса из другой библиотеки, нам надо добавить новый xmlns внутрь MainWindow. Добавим и назовем например cards. Внутрь впишем название библиотеки. Как только мы начнем его вписывать, он автоматом нам предложит подключить эту ссылку.

Полностью выглядеть она будет так.

1
<Window x:Class="libExample.MainWindow"
2
        xmlns:cards="clr-namespace:ControlWpfLib;assembly=ControlsLib">

Чтобы обратиться к этим элементам, воспользуемся библиотекой cards при помощи cards:названиеэлемента.

И в целом, с тремя подключенными библиотеками, наша программа будет выглядеть вот так.

Подключение сторонних библиотек через .dll #

Также, если мы вдруг нашли dll файл, мы можем подключить его как библиотеку. Каждая собранная нами библиотека также имеет формат dll файла, а не exe или прочего. Например так выглядит папка debug у библиотеки с классом.

А так выглядит папка debug у приложения.

Если вдруг где-то на просторах интернета или просто на рабочем столе вы нашли dll файлик (что дико маловероятно), то вы можете добавить его внутрь проекта следующим образом.

Выгружу библиотеку FunctionalLib чтобы решение не видело его (ПКМ → Выгрузить проект).

В проводнике у меня всё ещё остался этот проект и его dll файл (картинки выше). Чтобы подключить отдельный файл, мне нужно ПКМ нажать по зависимостям, тыкнуть на любую из первых трех пунктов и в появившемся окне перейти в «Обзор».

Нажмем на кнопку «Обзор» внизу и найду папку, где у меня хранилась dll.

Поставлю галочку напротив него, нажму ОК и я опять же могу её использовать.

Полный код примера #

FunctionalLib/ImmitationWork.cs — функциональная библиотека:

1
using System;
2
using System.IO;
3
using System.Linq;
4
using System.Net;
5
using System.Threading;
6

7
namespace FunctionalLib
8
{
9
    public class ImmitationWork
10
    {
11
        public static void ImmitateLongFileBlock(string file, int milisecond)
12
        {
13
            using (FileStream fs = new FileStream(file, FileMode.Open))
14
            {
15
                Thread.Sleep(milisecond);
16
            }
17
        }
18

19
        public static HttpStatusCode ImmitateServerResponce(int milisecond = 0)
20
        {
21
            Thread.Sleep(milisecond);
22
            var statuses = Enum.GetValues(typeof(HttpStatusCode)).Cast<HttpStatusCode>().ToArray();
23
            Random rand = new Random();
24
            return statuses[rand.Next(0, statuses.Length)];
25
        }
26
    }
27
}

CustomLib/FullDictionary.xaml — объединённый словарь стилей:

1
<ResourceDictionary xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
2
                    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
3
    <ResourceDictionary.MergedDictionaries>
4
        <ResourceDictionary Source="Themes/ControlButton.xaml"/>
5
        <ResourceDictionary Source="Themes/DefaultTextBox.xaml"/>
6
    </ResourceDictionary.MergedDictionaries>
7
</ResourceDictionary>

libExample/App.xaml — pack URI до словаря из CustomLib:

1
<Application x:Class="libExample.App"
2
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
3
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
4
             StartupUri="MainWindow.xaml">
5
    <Application.Resources>
6
        <ResourceDictionary>
7
            <ResourceDictionary.MergedDictionaries>
8
                <ResourceDictionary Source="pack://application:,,,/CustomLib;component/FullDictionary.xaml"/>
9
            </ResourceDictionary.MergedDictionaries>
10
        </ResourceDictionary>
11
    </Application.Resources>
12
</Application>

libExample/MainWindow.xaml — xmlns на свою сборку и использование <cards:CalendarCard/>:

1
<Window x:Class="libExample.MainWindow"
2
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
3
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
4
        xmlns:cards="clr-namespace:ControlWpfLib;assembly=ControlsLib"
5
        Title="MainWindow" Height="345" Width="450">
6
    <Grid>
7
        <cards:CalendarCard HorizontalAlignment="Center" VerticalAlignment="Top" Height="50" Width="50"/>
8
        <TextBox x:Name="Txt" Style="{DynamicResource DefaultTextBox}"
9
                 HorizontalAlignment="Center" VerticalAlignment="Center"/>
10
        <Button Style="{DynamicResource ControlButton}"
11
                HorizontalAlignment="Center" VerticalAlignment="Bottom" Margin="10"
12
                Content="Запустить задачку" Click="Button_Click"/>
13
    </Grid>
14
</Window>

libExample/MainWindow.xaml.cs — использование статического метода из библиотеки:

1
using System.Windows;
2
using FunctionalLib;
3

4
namespace libExample
5
{
6
    public partial class MainWindow : Window
7
    {
8
        public MainWindow()
9
        {
10
            InitializeComponent();
11
        }
12

13
        private void Button_Click(object sender, RoutedEventArgs e)
14
        {
15
            Txt.Text = ImmitationWork.ImmitateServerResponce().ToString();
16
        }
17
    }
18
}