forked from fiftin/WinFormsPopupAlerts
-
Notifications
You must be signed in to change notification settings - Fork 0
/
winformspopupalerts.txt
113 lines (83 loc) · 6.01 KB
/
winformspopupalerts.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
Если ваше приложение (например мессенджер) должно работать в фоновом режиме и информировать пользователя о происхождении каких-либо событий, то WinFormsPopupAlerts будет вам очень полезен. Windows.Forms для таких целей предоставляет компонент NotifyIcon. Но он имеет очень ограниченные возможности - позволяет только выводить всплывающие подсказки. В отличие от него, WinFormsPopupAlerts позволяет:
выстроить выводимые сообщения в очередь;
настраивать цвета, формы, размеры, шрифты сообщений;
задавать эффекты появления и скрытия сообщений.
Также, на основе WinFormsPopupAlerts, путем наследования и переопределения методов, вы можете добавить нужное вам поведение, которое не реализовано в текущей версии компонента.
-------------------------------------------
popupAlertManager1.Alert(new TooltipAlertArg("Title", "Text text text", ToolTipIcon.Info));
If your application (e.g. messenger) should run in the background and inform users about of any events, in this case WinFormsPopupAlerts will be very useful for you. Windows.Forms for such purposes provides NotifyIcon component. But he has very limited possibilities - only allows display tooltips. In contrast, WinFormsPopupAlerts allows:
- form messages in queue;
- customize the colors, shapes, sizes, fonts of messages;
- customize effects of appearance and hide of messages.
Also, on the basis WinFormsPopupAlerts, through inheritance and overriding methods, you can add the desired behaviour that is not implemented in the current version of the component.
*************************************************************************
Documentation
*************************************************************************
WinFormsPopupAlerts includes 3 main components:
- PopupAlertManager
- TooltipAlertFactory
- CustomTooltimAlertRenderer.
PopupAlertManager
The component that provide control of alert windows queue.
Main properties:
- AlertAlignment - screen position where alert windows appear.
- AlertsMaxCount - maximum number of simultaneously displayed alert windows.
- AlertFactory - object of PopupAlertFactory class and its descendant used for creating new alert windows.
- VGap - distance between nearest alert windows.
- HGap - distance between alert windows and right or left edge of screen.
Main methods:
- Alert - Create and display new alert window.
WinFormsPopupAlerts включает 3 компонета которые отображаются на панеле Toolbox:
PopupAlertManager
TooltipAlertFactory
CustomTooltimAlertRenderer.
---------- PopupAlertManager ----------
Обеспечивает управление очередью alert-окон:
задает расстояние между соседними alert-окнами,
расстояние от alert-окона до края экрана,
угол экрана в котором будут появляться новые alert-окна,
максимальное число отображаемых alert-окон,
ссылка на объект класса PopupAlertFactory, который будет использоваться для создания новых alert-окон.
---------- TooltipAlertFactory ----------
Наследуется от класса PopupAlertFactory. Отвечает за alert-окон. Омеет следующие свойства:
AlertStyle - стиль отображаемых alert-окон. Может принимать значение System - в этом случае создаваемые alert-окна, выгледят как системные всплывающие подсказки.
Custom - для отрисовки alert-окон будет использоваться указанный пользователем в свойстве CustomRenderer объект класса CustomTooltipAlertRenderer, который будет описан ниже.
HidingDelay - время, в миллисекундах, через которое после создания alert-окно будет скрыто.
HidingStyle - стиль скрытия alert-окон. Может быть Simple - без эффекта, Slide - эффект уезжания окна за пределы экрана, Fade - эффект затухания.
HidingDuration - продолжительность эффкта скрытия, в миллисекундах.
---------- CustomTooltipAlertRenderer ----------
Используется для задания стиля alert-окон компонентом TooltipAlertFactory, если вы указали его в качестве значения свойства CustomRenderer и установили значение свойтва AlertStyle равным Custom. Позваляет задать следующие свойва:
-------------------------------------------
Помимо этих трех компонентов сущетсвутю следующие вспомогательные компоненты и классы, которые вы можете использовать для расширения возможностей компонента:
TooltipAlertRenderer
CustomTooltipAlertRendererBase
SystemTooltipAlertRenderer
PopupAlertFactory
TooltipAlert
PopupAlert
TopFormBase
CornerRadius
CornerRadiusConverter, CornerRadiusEditor, CornerRadiusEditorControl
Add basic documentation needed to understand the general flows through the code, including class, method and parameters documentation.
You can use existing documentation from the source files, if relevant.
*************************************************************************
Setup / installation
*************************************************************************
Солюшин включает 2 проекта:
WindowsFormsApplication1 - приложение, на примере которого вы можете научиться настраивать компоненты WinFormsPopupAlerts.
WinFormsPopupAlerts - библиотека .NET содержащая классы и компоненты.
Для начала вам необходимо собрать проект.
1) Откройте WinFormsPopupAlerts.sln в Visual Studio 2010 и выше. Если вы используете Visual Studio 2012 и выже, то она предложит выполнить конвертацию прокетов.
2) F6 для выполнения сборки проекта.
Интегрировать WinFormsPopupAlerts в существующее приложение или библиотеку можно двумя способами.
Добавить в solution приложения проект WinFormsPopupAlerts.csproj.
Добавить компоненты на Toolbox. Для этого:
1) на Toolbox нажать правой клавишей мыши и в выпадающем меню выбрать пункт Choose Items...
2) В появившемся окне на вкладке .NET Framework Components нажать кнопку Browse...
3) Найти место расположения WinFormsPopupAlerts\bin\Debug\WinFormsPopupAlerts.dll и нажать OK.
4) После этого компонеты PopupAlertManager, TooltipAlertFactory, CustomTooltimAlertRenderer появятся в спике .NET Framework Components помечеными галочками.
5) Нажать OK.
После этого вы увидите компонеты WinFormsPopupAlerts на панеле Toolbox.
Describe how to setup / integrate your project into an existing one. What configuration options can / should be set? how can the project be customized and where?
Walk through the initial process of setting up and using the project.
Example usage