Mercurial > silverbladetech

comparison MetroWpf/Libs/Ookii.Dialogs.1.0/readme.html @ 15:060f02cd4591

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial commit, pre airport work
author stevenh7776 stevenhollidge@hotmail.com
date Mon, 12 Mar 2012 23:05:21 +0800
parents
children
comparison
equal deleted inserted replaced
14:741981715d94 15:060f02cd4591
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
3 <head>
4 <title>Ookii.Dialogs</title>
5 <style type="text/css">
6 body
7 {
8 font-family: Calibri, sans-serif;
9 background: white;
10 color: black;
11 }
12 a:link, a:visited, a:active
13 {
14 color: #00008B;
15 }
16 h1
17 {
18 font-weight: bold;
19 font-size: xx-large;
20 }
21 h2
22 {
23 color: #00008B;
24 font-weight: bold;
25 font-style: italic;
26 font-size: large;
27 }
28 h3
29 {
30 font-size: medium;
31 }
32 img
33 {
34 border: none;
35 }
36 .copyright
37 {
38 font-style: italic;
39 }
40 </style>
41 </head>
42 <body>
43 <h1>
44 Ookii.Dialogs
45 </h1>
46 <p class="copyright">
47 Copyright © Sven Groot (Ookii.org) 2009, see license.txt for details
48 </p>
49 <h2>
50 Overview
51 </h2>
52 <p>
53 Ookii.Dialogs is a class library for .Net applications providing several common dialogs. Included are classes for
54 task dialogs, credential dialogs, progress dialogs, input dialogs, and common file dialogs.
55 </p>
56 <p>
57 This package contains two class libraries: Ookii.Dialogs.dll for use with Windows Forms, and Ookii.Dialogs.Wpf.dll
58 for use with Windows Presentation Foundation. The classes inside are pretty much identical; only the input dialog
59 is not available for WPF. Some additional utility classes for Windows Forms are provided that are not available for
60 WPF, see below for details.
61 </p>
62 <p>
63 Ookii.Dialogs requires the <a href="http://www.ookii.org/link.ashx?id=NetFramework35">Microsoft .Net Framework 3.5 SP1</a>.
64 The included source code is intended for use in Visual Studio 2008.
65 </p>
66 <p>
67 The included sample applications Ookii.Dialogs.Sample.exe and Ookii.Dialogs.Sample.Wpf.exe demonstrate the dialogs
68 for Windows Forms and WPF respectively. View the source of these applications to see how to use the dialogs.
69 </p>
70 <p>
71 Full reference documentation for the class library is available in the <a href="Ookii.Dialogs.chm">included help file</a>.
72 </p>
73 <h2>
74 Included dialogs
75 </h2>
76 <h3>
77 Task dialog
78 </h3>
79 <p>
80 <a href="http://msdn.microsoft.com/en-us/library/bb760441(VS.85).aspx">Task dialogs</a> are a new type of dialog
81 first introduced in Windows Vista. They provide a superset of the message box functionality.
82 </p>
83 <p>
84 <img src="images/taskdialog.png" alt="A task dialog" />
85 </p>
86 <p>
87 The Ookii.Dialogs.TaskDialog (for Windows Forms) and the Ookii.Dialogs.Wpf.TaskDialog (for WPF) classes provide access
88 to the task dialog functionality. The TaskDialog class inherits from System.ComponentModel.Component and offers full
89 support for the Windows Forms designer and component designer of Visual Studio 2008.
90 </p>
91 <p>
92 The TaskDialog class requires Windows Vista or a later version of Windows. Windows XP is not supported. Note that it is
93 safe to instantiate the TaskDialog class and set any of its properties; only when the dialog is shown will a NotSupportedException
94 be thrown on unsupported operating systems.
95 </p>
96 <h3>
97 Progress dialog
98 </h3>
99 <p>
100 Progress dialogs are a common dialog to show progress during operations that may take a long time. They are used
101 extensively in the Windows shell, and an API has been available since Windows 2000.
102 </p>
103 <p>
104 <img src="images/progressdialog.png" alt="A progress dialog as it appears on Windows Vista and later" />
105 </p>
106 <p>
107 The Ookii.Dialogs.ProgressDialog (for Windows Forms) and the Ookii.Dialogs.Wpf.ProgressDialog (for WPF) classes provide
108 a wrapper for the Windows progress dialog API. The ProgressDialog class inherits from System.ComponentModel.Component and offers full
109 support for the Windows Forms designer and component designer of Visual Studio 2008. The ProgressDialog class resembles
110 the System.ComponentModel.BackgroundWorker class and can be used in much the same way as that class.
111 </p>
112 <p>
113 The progress dialog's behaviour of the ShowDialog function is slightly different than that of other .Net dialogs; please
114 read the reference documentation for more information. It is recommended to use a non-modal dialog with the Show function.
115 </p>
116 <p>
117 The ProgressDialog class is supported on Windows XP and later versions of Windows. However, the progress dialog has a very different
118 appearance on Windows Vista and later (the image above shows the Vista version), so it is recommended to test on both
119 operating systems to see if it appears to your satisfaction.
120 </p>
121 <p>
122 When using Windows 7, the ProgressDialog class automatically provides progress notification in the application's task bar
123 button.
124 </p>
125 <h3>
126 Credential dialog
127 </h3>
128 <p>
129 The Ookii.Dialogs.CredentialDialog (for Windows Forms) and the Ookii.Dialogs.Wpf.CredentialDialog (for WPF) classes provide
130 wrappers for the CredUI functionality first introduced in Windows XP. This class provides functionality for saving and
131 retrieving generic credentials, as well as displaying the credential UI dialog. This class does not support all functionality
132 of CredUI; only generic credentials are supported, thing such as domain credentials or alternative authentication
133 providers (e.g. smart cards or biometric devices) are not supported.
134 </p>
135 <p>
136 <img src="images/credentialdialog.png" alt="A credential dialog as it appears on Windows Vista and later" />
137 </p>
138 <p>
139 The CredentialDialog class inherits from System.ComponentModel.Component and offers full
140 support for the Windows Forms designer and component designer of Visual Studio 2008.
141 </p>
142 <p>
143 On Windows XP, the CredentialDialog class will use the CredUIPromptForCredentials function to show the dialog;
144 on Windows Vista and later, the CredUIPromptForWindowsCredentials function is used instead to show the new dialog
145 introduced with Windows Vista. Because of the difference in appearance in the two versions (the image above shows
146 the Vista version), it is recommended to test on both operating systems to see if it appears to your satisfaction.
147 </p>
148 <h3>
149 Input dialog
150 </h3>
151 <p>
152 The input dialog is a dialog that can be used to prompt the user for a single piece of text. Its functionality
153 is reminiscent of the Visual Basic InputBox function, only with a cleaner API and UI.
154 </p>
155 <p>
156 <img src="images/inputdialog.png" alt="An input dialog as it appears on Windows Vista and later" />
157 </p>
158 <p>
159 The Ookii.Dialogs.InputDialog class provides the input dialog functionality for Windows Forms. This class is not
160 available for WPF.
161 </p>
162 <p>
163 Unlike the other classes in this package, this class is not a wrapper for any existing API; the dialog uses
164 a custom implementation in Windows Forms. This dialog is supported on Windows XP and later versions of windows;
165 on Windows Vista and later, the visual styles API is used to draw the dialog to mimic the appearance of task dialogs,
166 as shown in the image above.
167 </p>
168 <p>
169 The InputDialog class inherits from System.ComponentModel.Component and offers full
170 support for the Windows Forms designer and component designer of Visual Studio 2008.
171 </p>
172 <h3>
173 Vista-style common file dialogs
174 </h3>
175 <p>
176 Windows Vista introduced a new style of common file dialogs. As of .Net 3.5 SP1, the Windows Forms OpenFileDialog and
177 SaveFileDialog class will automatically use the new style under most circumstances; however, some settings (such
178 as setting ShowReadOnly to true) still cause it to revert to the old dialog. The FolderBrowserDialog still uses the
179 old style. In WPF, the Microsoft.Win32.OpenFileDialog and SaveFileDialog classes still use the old style dialogs,
180 and a folder browser dialog is not provided at all.
181 </p>
182 <p>
183 <img src="images/folderbrowserdialog.png" alt="The Vista-style folder browser dialog on Windows 7" />
184 </p>
185 <p>
186 The Ookii.Dialogs.VistaOpenFileDialog, Ookii.Dialogs.VistaSaveFileDialog and Ookii.Dialogs.VistaFolderBrowserDialog
187 provide these dialogs for Windows Forms (note that in the case of the OpenFileDialog and SaveFileDialog it is
188 recommended to use the built-in .Net classes unless you hit one of the scenarios where those classes use the old
189 dialogs). The Ookii.Dialogs.Wpf.VistaOpenFileDialog, Ookii.Dialogs.Wpf.VistaSaveFileDialog and Ookii.Dialogs.Wpf.VistaFolderBrowserDialog
190 classes provide the same functionality for WPF.
191 </p>
192 <p>
193 The classes have been designed to resemble the original Windows Forms and WPF classes to make it easy to switch.
194 When the classes are used on Windows XP, they will automatically fall back to the old style dialog; this is also
195 true for the VistaFolderBrowserDialog on WPF; that class provides a complete implementation of a folder browser
196 dialog for WPF, old as well as new style.
197 </p>
198 <p>
199 The Vista-style file and folder dialogs classes for Windows Forms inherit from System.ComponentModel.Component and offer full
200 support for the Windows Forms designer and component designer of Visual Studio 2008.
201 </p>
202 <h2>
203 Additional functionality for Windows Forms
204 </h2>
205 <p>
206 Three additional classes are provided for Windows Forms only, in the Ookii.Dialogs library. These classes are used to
207 support the InputDialog (with the exception of the Aero glass functionality, which the InputDialog does not use) but
208 are made public for your convenience.
209 </p>
210 <p>
211 The AdditionalVisualStyleElements class provides some visual style elements used by task dialogs on Windows Vista and later.
212 </p>
213 <p>
214 The Glass class provides functionality for extending Aero glass into the client area of a window on Windows Vista and later,
215 and for drawing text on a glass surface.
216 </p>
217 <p>
218 The ExtendedForm class serves as an alternative base class for forms, and provides functionality to automatically use the
219 system font (e.g. Tahoma on XP and Segoe UI on Vista and later), and easy access to some of the functionality of the Glass
220 class.
221 </p>
222 </body>
223 </html>