1 | <?xml version="1.0"?>
|
---|
2 | <doc>
|
---|
3 | <assembly>
|
---|
4 | <name>BMXWIN40</name>
|
---|
5 | </assembly>
|
---|
6 | <members>
|
---|
7 | <member name="F:IndianHealthService.BMXNet.WinForm.Forms.ExceptionMessageDialog.components">
|
---|
8 | <summary>
|
---|
9 | Required designer variable.
|
---|
10 | </summary>
|
---|
11 | </member>
|
---|
12 | <member name="M:IndianHealthService.BMXNet.WinForm.Forms.ExceptionMessageDialog.Dispose(System.Boolean)">
|
---|
13 | <summary>
|
---|
14 | Clean up any resources being used.
|
---|
15 | </summary>
|
---|
16 | <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
|
---|
17 | </member>
|
---|
18 | <member name="M:IndianHealthService.BMXNet.WinForm.Forms.ExceptionMessageDialog.InitializeComponent">
|
---|
19 | <summary>
|
---|
20 | Required method for Designer support - do not modify
|
---|
21 | the contents of this method with the code editor.
|
---|
22 | </summary>
|
---|
23 | </member>
|
---|
24 | <member name="T:IndianHealthService.BMXNet.WinForm.AttemptingLoginEventArgs">
|
---|
25 | <summary>
|
---|
26 | The LoginProcess provides the AttemptingLoginEvent to allow changes in workflow with
|
---|
27 | this Cancelable event args class
|
---|
28 | </summary>
|
---|
29 | </member>
|
---|
30 | <member name="P:IndianHealthService.BMXNet.WinForm.AttemptingLoginEventArgs.Process">
|
---|
31 | <summary>
|
---|
32 | The LoginProcess can be modified (e.g. ConnectionSpec) after the user has OK'd the dialog
|
---|
33 | but before the login attempt is made.
|
---|
34 | </summary>
|
---|
35 | </member>
|
---|
36 | <member name="P:IndianHealthService.BMXNet.WinForm.AttemptingLoginEventArgs.Handled">
|
---|
37 | <summary>
|
---|
38 | The receiver of the event can perform the login differently or not allow
|
---|
39 | the login. If Handled is set the True the LoginProcess assumes the login was attempted.
|
---|
40 | </summary>
|
---|
41 | </member>
|
---|
42 | <member name="P:IndianHealthService.BMXNet.WinForm.AttemptingLoginEventArgs.HandledSucccessfully">
|
---|
43 | <summary>
|
---|
44 | Set HandledSucccessfully is the Handled logging was successful.
|
---|
45 | </summary>
|
---|
46 | </member>
|
---|
47 | <member name="T:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSettings">
|
---|
48 | <summary>
|
---|
49 | Container for all persistent and available connection spec
|
---|
50 | </summary>
|
---|
51 | </member>
|
---|
52 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSettings.AddConnectionSpec(IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec)">
|
---|
53 | <summary>
|
---|
54 | Add aSpec to the receiver. Not persisted
|
---|
55 | </summary>
|
---|
56 | <param name="aSpec"></param>
|
---|
57 | </member>
|
---|
58 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSettings.RemoveConnectionSpec(IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec)">
|
---|
59 | <summary>
|
---|
60 | Remove aSpec from the receiver. Not persisted.
|
---|
61 | </summary>
|
---|
62 | <param name="aSpec"></param>
|
---|
63 | </member>
|
---|
64 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSettings.MoveConnectionSpecUp(IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec)">
|
---|
65 | <summary>
|
---|
66 |
|
---|
67 | </summary>
|
---|
68 | <param name="aSpec"></param>
|
---|
69 | <returns>True if there was any movement</returns>
|
---|
70 | </member>
|
---|
71 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSettings.MoveConnectionSpecDown(IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec)">
|
---|
72 | <summary>
|
---|
73 |
|
---|
74 | </summary>
|
---|
75 | <param name="aSpec"></param>
|
---|
76 | <returns>True if there was any movement</returns>
|
---|
77 | </member>
|
---|
78 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSettings.Revert">
|
---|
79 | <summary>
|
---|
80 | Refresh the receiver from the current state of the persistent store
|
---|
81 | </summary>
|
---|
82 | </member>
|
---|
83 | <member name="P:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSettings.ManagedConnectionSpecs">
|
---|
84 | <summary>
|
---|
85 | Answer all connection specs in user defined order
|
---|
86 | </summary>
|
---|
87 | </member>
|
---|
88 | <member name="P:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSettings.ConnectionSpecs">
|
---|
89 | <summary>
|
---|
90 | Answer all available connection specs, including command-line spec
|
---|
91 | </summary>
|
---|
92 | </member>
|
---|
93 | <member name="P:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSettings.DefaultConnectionSpec">
|
---|
94 | <summary>
|
---|
95 | Answer the default connection spec. If there is not
|
---|
96 | user defined default, answer the first connection spec
|
---|
97 | </summary>
|
---|
98 | </member>
|
---|
99 | <member name="F:IndianHealthService.BMXNet.WinForm.Forms.RpmsServerConnectionPropertiesDialog.components">
|
---|
100 | <summary>
|
---|
101 | Required designer variable.
|
---|
102 | </summary>
|
---|
103 | </member>
|
---|
104 | <member name="M:IndianHealthService.BMXNet.WinForm.Forms.RpmsServerConnectionPropertiesDialog.Dispose(System.Boolean)">
|
---|
105 | <summary>
|
---|
106 | Clean up any resources being used.
|
---|
107 | </summary>
|
---|
108 | <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
|
---|
109 | </member>
|
---|
110 | <member name="M:IndianHealthService.BMXNet.WinForm.Forms.RpmsServerConnectionPropertiesDialog.InitializeComponent">
|
---|
111 | <summary>
|
---|
112 | Required method for Designer support - do not modify
|
---|
113 | the contents of this method with the code editor.
|
---|
114 | </summary>
|
---|
115 | </member>
|
---|
116 | <member name="F:IndianHealthService.BMXNet.WinForm.Forms.RpmsServerConfigurationManagementDialog.components">
|
---|
117 | <summary>
|
---|
118 | Required designer variable.
|
---|
119 | </summary>
|
---|
120 | </member>
|
---|
121 | <member name="M:IndianHealthService.BMXNet.WinForm.Forms.RpmsServerConfigurationManagementDialog.Dispose(System.Boolean)">
|
---|
122 | <summary>
|
---|
123 | Clean up any resources being used.
|
---|
124 | </summary>
|
---|
125 | <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
|
---|
126 | </member>
|
---|
127 | <member name="M:IndianHealthService.BMXNet.WinForm.Forms.RpmsServerConfigurationManagementDialog.InitializeComponent">
|
---|
128 | <summary>
|
---|
129 | Required method for Designer support - do not modify
|
---|
130 | the contents of this method with the code editor.
|
---|
131 | </summary>
|
---|
132 | </member>
|
---|
133 | <member name="F:IndianHealthService.BMXNet.Forms.ChangeDivisionDialog.components">
|
---|
134 | <summary>
|
---|
135 | Required designer variable.
|
---|
136 | </summary>
|
---|
137 | </member>
|
---|
138 | <member name="M:IndianHealthService.BMXNet.Forms.ChangeDivisionDialog.Dispose(System.Boolean)">
|
---|
139 | <summary>
|
---|
140 | Clean up any resources being used.
|
---|
141 | </summary>
|
---|
142 | <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
|
---|
143 | </member>
|
---|
144 | <member name="M:IndianHealthService.BMXNet.Forms.ChangeDivisionDialog.InitializeComponent">
|
---|
145 | <summary>
|
---|
146 | Required method for Designer support - do not modify
|
---|
147 | the contents of this method with the code editor.
|
---|
148 | </summary>
|
---|
149 | </member>
|
---|
150 | <member name="T:IndianHealthService.BMXNet.WinForm.Configuration.PersistentStore">
|
---|
151 | <summary>
|
---|
152 | The persistent store interface is to save local setting configuration data. The
|
---|
153 | settings are written and read based on a string a keys, like a path.
|
---|
154 |
|
---|
155 | The keys are application specific. Some example could be: "Product","Version"
|
---|
156 |
|
---|
157 | The location of the PersistentStore is based on the implementation. The LocalPersistentStore
|
---|
158 | provides the settings to be stored in special OS forlders like Environment.SpecialFolder.LocalApplicationData
|
---|
159 | so that the settings would be based both on the logged in user and keys.
|
---|
160 | </summary>
|
---|
161 | </member>
|
---|
162 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.PersistentStore.Write``1(``0,System.String[])">
|
---|
163 | <summary>
|
---|
164 | The implementor must serialize the object anObject given the keys.
|
---|
165 | </summary>
|
---|
166 | <typeparam name="T">The type of the object to be serialized to the store</typeparam>
|
---|
167 | <param name="anObject">The objects to be stored</param>
|
---|
168 | <param name="keys">The key used to locate the settings</param>
|
---|
169 | </member>
|
---|
170 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.PersistentStore.Read``1(System.String[])">
|
---|
171 | <summary>
|
---|
172 | The implementor must deserialize an object of type T from the given location based
|
---|
173 | on the keys
|
---|
174 | </summary>
|
---|
175 | <typeparam name="T">The type of the object to be deserialized from the store</typeparam>
|
---|
176 | <param name="keys">The keys used to locate the object</param>
|
---|
177 | <returns>An deserialized object, or null if no valid objects exists at the keys</returns>
|
---|
178 | </member>
|
---|
179 | <member name="T:IndianHealthService.BMXNet.WinForm.LoginAttemptedEventArgs">
|
---|
180 | <summary>
|
---|
181 | The LoginProcess provides feedback after every LoginAttempt, even if the login
|
---|
182 | attempt was performer using the AttemptingLoginEvent. If a custom dialog box or action can
|
---|
183 | take place and Handled set to True, the LoginProcess will not display the standard dialog.
|
---|
184 | The LoginProcess is available so examine or modify.
|
---|
185 | </summary>
|
---|
186 | </member>
|
---|
187 | <member name="T:IndianHealthService.BMXNet.WinForm.AboutDialog">
|
---|
188 | <summary>
|
---|
189 | Stardardized "About" dialog that displays information from the executable's (RootAssembly) AssemblyInfo:
|
---|
190 | <list>
|
---|
191 | AssemblyTitle
|
---|
192 | AssemblyProduct
|
---|
193 | AssemblyVersion
|
---|
194 | AssemblyCopyright
|
---|
195 | AssemblyCompany
|
---|
196 | AssemblyDescription
|
---|
197 | </list>
|
---|
198 | <para>
|
---|
199 | Additionally, a list box showing all non-system .NET assemblies is displayed. Set IncludeRoot=True
|
---|
200 | if the RootAssembly should be included in the list.
|
---|
201 | </para>
|
---|
202 | <example>
|
---|
203 | Usage of dialog:
|
---|
204 | <code>
|
---|
205 | AboutDialog dialog=new AboutDialog();
|
---|
206 | dialog.RootAssembly = Assembly.GetExecutingAssembly();
|
---|
207 | dialog.IncludeRoot = true;
|
---|
208 | dialog.Show(this.Parent);
|
---|
209 | </code>
|
---|
210 | By default, the RootAssebmly is the Assembly.GetExecutingAssembly();
|
---|
211 | </example>
|
---|
212 | </summary>
|
---|
213 | </member>
|
---|
214 | <member name="F:IndianHealthService.BMXNet.WinForm.AboutDialog.components">
|
---|
215 | <summary>
|
---|
216 | Required designer variable.
|
---|
217 | </summary>
|
---|
218 | </member>
|
---|
219 | <member name="M:IndianHealthService.BMXNet.WinForm.AboutDialog.Dispose(System.Boolean)">
|
---|
220 | <summary>
|
---|
221 | Clean up any resources being used.
|
---|
222 | </summary>
|
---|
223 | </member>
|
---|
224 | <member name="M:IndianHealthService.BMXNet.WinForm.AboutDialog.InitializeComponent">
|
---|
225 | <summary>
|
---|
226 | Required method for Designer support - do not modify
|
---|
227 | the contents of this method with the code editor.
|
---|
228 | </summary>
|
---|
229 | </member>
|
---|
230 | <member name="P:IndianHealthService.BMXNet.WinForm.AboutDialog.IncludeRoot">
|
---|
231 | <summary>
|
---|
232 | Set to True if the RootAssembly should be included in the list of displayed assemblies. False by default.
|
---|
233 | </summary>
|
---|
234 | </member>
|
---|
235 | <member name="P:IndianHealthService.BMXNet.WinForm.AboutDialog.RootAssembly">
|
---|
236 | <summary>
|
---|
237 | The assembly that all references are followed from. The EntryAssembly by default.
|
---|
238 | </summary>
|
---|
239 | </member>
|
---|
240 | <member name="F:IndianHealthService.BMXNet.Forms.RpmsLoginDialog.components">
|
---|
241 | <summary>
|
---|
242 | Required designer variable.
|
---|
243 | </summary>
|
---|
244 | </member>
|
---|
245 | <member name="M:IndianHealthService.BMXNet.Forms.RpmsLoginDialog.Dispose(System.Boolean)">
|
---|
246 | <summary>
|
---|
247 | Clean up any resources being used.
|
---|
248 | </summary>
|
---|
249 | <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
|
---|
250 | </member>
|
---|
251 | <member name="M:IndianHealthService.BMXNet.Forms.RpmsLoginDialog.InitializeComponent">
|
---|
252 | <summary>
|
---|
253 | Required method for Designer support - do not modify
|
---|
254 | the contents of this method with the code editor.
|
---|
255 | </summary>
|
---|
256 | </member>
|
---|
257 | <member name="T:IndianHealthService.BMXNet.WinForm.Model.WinPatient">
|
---|
258 | <summary>
|
---|
259 | Implementation of Patient. Attempt to stay within CSS_Patient capabilties
|
---|
260 |
|
---|
261 | this.CssPatient.Age
|
---|
262 | this.CssPatient.DOB
|
---|
263 | this.CssPatient.Detail
|
---|
264 | this.CssPatient.DOD
|
---|
265 | this.CssPatient.HRN
|
---|
266 | this.CssPatient.ICN
|
---|
267 | this.CssPatient.Location
|
---|
268 | this.CssPatient.LocationName
|
---|
269 | this.CssPatient.PrimaryProvider
|
---|
270 | this.CssPatient.PrimaryTeam
|
---|
271 | this.CssPatient.RoomBed
|
---|
272 | this.CssPatient.Sex
|
---|
273 | this.CssPatient.SSN*/
|
---|
274 | </summary>
|
---|
275 | </member>
|
---|
276 | <member name="T:IndianHealthService.BMXNet.WinForm.Configuration.Settings">
|
---|
277 | <summary>
|
---|
278 | Provides settings interface and implementation for settings from command-line,
|
---|
279 | stored in PersistentStore, or hardcoded in application.
|
---|
280 | </summary>
|
---|
281 | </member>
|
---|
282 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.Settings.Set(System.String,System.Boolean)">
|
---|
283 | <summary>
|
---|
284 | Update the Setting value aName to aBool
|
---|
285 | </summary>
|
---|
286 | <param name="aName">Name of the Setting</param>
|
---|
287 | <param name="aBool">Boolean value to set</param>
|
---|
288 | <returns>True if the setting was changed, False if the setting was the same value</returns>
|
---|
289 | </member>
|
---|
290 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.Settings.Set(System.String,System.Int32)">
|
---|
291 | <summary>
|
---|
292 | Update the Setting value aName to anInt
|
---|
293 | </summary>
|
---|
294 | <param name="aName">Name of the Setting</param>
|
---|
295 | <param name="aBool">Integer value to set</param>
|
---|
296 | <returns>True if the setting was changed, False if the setting was the same value</returns>
|
---|
297 | </member>
|
---|
298 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.Settings.Set(System.String,System.String)">
|
---|
299 | <summary>
|
---|
300 | Update the Setting value aName to a string
|
---|
301 | </summary>
|
---|
302 | <param name="aName">Name of the Setting</param>
|
---|
303 | <param name="aBool">String value to set</param>
|
---|
304 | <returns>True if the setting was changed, False if the setting was the same value</returns>
|
---|
305 | </member>
|
---|
306 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.Settings.Get(System.String,System.String)">
|
---|
307 | <summary>
|
---|
308 | Get the string Setting named aString. Answer the defaultValue if the Setting named
|
---|
309 | aString does not exist in the receiver or it's Backup chain.
|
---|
310 | </summary>
|
---|
311 | <param name="aString">Name of the setting</param>
|
---|
312 | <param name="defaultValue">Default value</param>
|
---|
313 | <returns></returns>
|
---|
314 | </member>
|
---|
315 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.Settings.Get(System.String,System.Boolean)">
|
---|
316 | <summary>
|
---|
317 | Get the boolean Setting named aString. Answer the defaultValue if the Setting named
|
---|
318 | aString does not exist in the receiver or it's Backup chain.
|
---|
319 | </summary>
|
---|
320 | <param name="aString">Name of the setting</param>
|
---|
321 | <param name="defaultValue">Default value</param>
|
---|
322 | <returns></returns>
|
---|
323 | </member>
|
---|
324 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.Settings.Get(System.String,System.Int32)">
|
---|
325 | <summary>
|
---|
326 | Get the Integer Setting named aString. Answer the defaultValue if the Setting named
|
---|
327 | aString does not exist in the receiver or it's Backup chain.
|
---|
328 | </summary>
|
---|
329 | <param name="aString">Name of the setting</param>
|
---|
330 | <param name="defaultValue">Default value</param>
|
---|
331 | <returns></returns>
|
---|
332 | </member>
|
---|
333 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.Settings.MergeSettings(IndianHealthService.BMXNet.WinForm.Configuration.Settings)">
|
---|
334 | <summary>
|
---|
335 | Merge the settings from someSettings into the receiver
|
---|
336 | </summary>
|
---|
337 | <param name="someSettings">Settings to copy</param>
|
---|
338 | </member>
|
---|
339 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.Settings.Load">
|
---|
340 | <summary>
|
---|
341 | Load the receiver's settings from the PersistentStore
|
---|
342 | </summary>
|
---|
343 | </member>
|
---|
344 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.Settings.Save">
|
---|
345 | <summary>
|
---|
346 | Save the receiver's settings to the PersistentStore
|
---|
347 | </summary>
|
---|
348 | </member>
|
---|
349 | <member name="P:IndianHealthService.BMXNet.WinForm.Configuration.Settings.WillPersistFutureSets">
|
---|
350 | <summary>
|
---|
351 | After set to true, every setting update will be flushed the PersistentStore if
|
---|
352 | the Settings is configured with one
|
---|
353 | </summary>
|
---|
354 | </member>
|
---|
355 | <member name="P:IndianHealthService.BMXNet.WinForm.Configuration.Settings.IsPersistent">
|
---|
356 | <summary>
|
---|
357 | Answer true if the current Settings IsPersistent. It is possible that the Backup
|
---|
358 | Settings IsPersistennt
|
---|
359 | </summary>
|
---|
360 | </member>
|
---|
361 | <member name="T:IndianHealthService.BMXNet.WinForm.Configuration.LocalPersistentStore">
|
---|
362 | <summary>
|
---|
363 | LocalPersistentStore is the core BMX implementation for the most common
|
---|
364 | local setting store patterns:
|
---|
365 |
|
---|
366 | 1) In a special folder
|
---|
367 | 2) In any specified path
|
---|
368 | 3) In IsolatedStorage
|
---|
369 |
|
---|
370 | Use the object factory static class methods to create the different storage
|
---|
371 | mechanisms.
|
---|
372 | </summary>
|
---|
373 | </member>
|
---|
374 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.LocalPersistentStore.TranslateToValidFileName(System.String[])">
|
---|
375 | <summary>
|
---|
376 | Remove on non-letters, digits, to _ and add Bmx_ to the front.
|
---|
377 | </summary>
|
---|
378 | <param name="aKey"></param>
|
---|
379 | <returns></returns>
|
---|
380 | </member>
|
---|
381 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.LocalPersistentStore.ReadFromIsolatedStorage``1(System.String[])">
|
---|
382 | <summary>
|
---|
383 | Isolated storage is scoped on user/application isolated storage
|
---|
384 | </summary>
|
---|
385 | <param name="aKey"></param>
|
---|
386 | <returns></returns>
|
---|
387 | </member>
|
---|
388 | <member name="M:IndianHealthService.BMXNet.WinForm.Configuration.LocalPersistentStore.WriteToIsolatedStorage``1(``0,System.String[])">
|
---|
389 | <summary>
|
---|
390 | Isolated storage is scoped on user/application isolated storage
|
---|
391 | </summary>
|
---|
392 | <param name="aKey"></param>
|
---|
393 | <param name="someContent"></param>
|
---|
394 | </member>
|
---|
395 | <member name="T:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec">
|
---|
396 | <summary>
|
---|
397 | Specification for BMX RPMS Connection. Instances of this class are serialized as XML
|
---|
398 | to a PersisentStore and are used is picklists for users to select from.
|
---|
399 | </summary>
|
---|
400 | </member>
|
---|
401 | <member name="P:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec.Name">
|
---|
402 | <summary>
|
---|
403 | The required display name of a connection used in pick lists
|
---|
404 | </summary>
|
---|
405 | </member>
|
---|
406 | <member name="P:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec.Server">
|
---|
407 | <summary>
|
---|
408 | The required Name/IP Address of the RPMS Host
|
---|
409 | </summary>
|
---|
410 | </member>
|
---|
411 | <member name="P:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec.ReceiveTimeout">
|
---|
412 | <summary>
|
---|
413 | The optional time in millseconds to wait for a response from RPMS
|
---|
414 | </summary>
|
---|
415 | </member>
|
---|
416 | <member name="P:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec.SendTimeout">
|
---|
417 | <summary>
|
---|
418 | The optional time in millseconds to wait when sending a request to RPMS
|
---|
419 | </summary>
|
---|
420 | </member>
|
---|
421 | <member name="P:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec.Port">
|
---|
422 | <summary>
|
---|
423 | The required TCP/IP port number of the RPMS BMX Broker
|
---|
424 | </summary>
|
---|
425 | </member>
|
---|
426 | <member name="P:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec.NameSpace">
|
---|
427 | <summary>
|
---|
428 | The optional Namespace to use in RPMS. Will default to BMX Brokers namespace.
|
---|
429 | </summary>
|
---|
430 | </member>
|
---|
431 | <member name="P:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec.IsDefault">
|
---|
432 | <summary>
|
---|
433 | The optional flag to specify this connection as the users default.
|
---|
434 | </summary>
|
---|
435 | </member>
|
---|
436 | <member name="P:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec.UseWindowsAuthentication">
|
---|
437 | <summary>
|
---|
438 | The optional flag to specify that WindowsAuthenication should be attempted.
|
---|
439 | </summary>
|
---|
440 | </member>
|
---|
441 | <member name="P:IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec.UseDefaultNamespace">
|
---|
442 | <summary>
|
---|
443 | The optional flag to specify that the BMX Broker default namespace should be used.
|
---|
444 | </summary>
|
---|
445 | </member>
|
---|
446 | <member name="T:IndianHealthService.BMXNet.WinForm.LoginProcess">
|
---|
447 | <summary>
|
---|
448 | This class models the workflow of the LoginProcess. It correographs UI and non-UI
|
---|
449 | login methods, login cancelling, management dialogs, and provides hooks (events) to
|
---|
450 | customize the login workflow.
|
---|
451 | </summary>
|
---|
452 | <example>
|
---|
453 | See the SDK for other examples.
|
---|
454 | <code>
|
---|
455 | this.Framework = WinFramework.CreateWithNetworkBroker(true);
|
---|
456 | this.Framework.LoadSettings(LocalPersistentStore.CreateIn(Environment.SpecialFolder.LocalApplicationData, EntryAssemblyInfo.AssemblyCompany + "/" + EntryAssemblyInfo.AssemblyProduct, false), "settings");
|
---|
457 | this.Framework.LoadConnectionSpecs(LocalPersistentStore.CreateIn(Environment.SpecialFolder.LocalApplicationData, EntryAssemblyInfo.AssemblyCompany + "/" + EntryAssemblyInfo.AssemblyProduct, false), "connectiosn");
|
---|
458 | LoginProcess login = this.Framework.CreateLoginProcess();
|
---|
459 |
|
---|
460 | //Attempt a non-UI WindowsAuth if and only if there is a default connection with WindowsAuth
|
---|
461 | //Of course, an application can set its own policy of when to AttemptWindowsAuthLogin()
|
---|
462 |
|
---|
463 | if (login.HasDefaultConnectionWithUseWindowsAuth)
|
---|
464 | {
|
---|
465 | login.AttemptWindowsAuthLogin();
|
---|
466 | }
|
---|
467 |
|
---|
468 | //If not attempted yet, i.e. skipped the AttemptWindowsAuthLogin(), or was unsuccessul, try and UI login
|
---|
469 | if (!login.WasLoginAttempted || !login.WasSuccessful)
|
---|
470 | {
|
---|
471 | login.AttemptUserInputLogin(IndianHealthService.BMXNet.Util.EntryAssemblyInfo.AssemblyTitle+" Login", 3,!this.Framework.BootStrapSettings.Get("lockedit",false), this);
|
---|
472 | }
|
---|
473 |
|
---|
474 | //If the login process was unable to login after the max tries (or fow other configuration reasons), exit the application
|
---|
475 | if (!login.WasSuccessful)
|
---|
476 | {
|
---|
477 | this.Close();
|
---|
478 | return;
|
---|
479 | }
|
---|
480 |
|
---|
481 | // Making sure that the user's division is set. Can use AttemptUserInputSetDivision() or the application can devise another solution
|
---|
482 | if ((this.Framework.User.Division == null) && !this.Framework.AttemptUserInputSetDivision("Set Initial Division", this))
|
---|
483 | {
|
---|
484 | this.Close();
|
---|
485 | return;
|
---|
486 | }
|
---|
487 |
|
---|
488 | // Logged in with valid user and division
|
---|
489 | this.RemoteSession = this.Framework.PrimaryRemoteSession;
|
---|
490 | </code></example>
|
---|
491 | </member>
|
---|
492 | <member name="M:IndianHealthService.BMXNet.WinForm.LoginProcess.AttemptWindowsAuthLogin(IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec)">
|
---|
493 | <summary>
|
---|
494 | Attempt a WindowsAuthentication Login and answer true if it was successful.
|
---|
495 | </summary>
|
---|
496 | <returns>True if login was successful</returns>
|
---|
497 | </member>
|
---|
498 | <member name="M:IndianHealthService.BMXNet.WinForm.LoginProcess.AttemptWindowsAuthLogin">
|
---|
499 | <summary>
|
---|
500 | Using the current default connection spec, attempt a WindowsAuthentication Login and answer true if it was successful.
|
---|
501 | </summary>
|
---|
502 | <remarks>
|
---|
503 | Most common approach when using the DefaultConnection feature the RpmsConnection spec class.
|
---|
504 | </remarks>
|
---|
505 | <returns>True if login was successful</returns>
|
---|
506 | </member>
|
---|
507 | <member name="M:IndianHealthService.BMXNet.WinForm.LoginProcess.AttemptUserInputLogin(System.String,System.Int32,System.Boolean,System.Windows.Forms.IWin32Window)">
|
---|
508 | <summary>
|
---|
509 | Attempt an interactive UI login. There are several useful arguments to control the process and appearance of the this process.
|
---|
510 | </summary>
|
---|
511 | <param name="aDialogTitle">The title of the login. Customize to be something like "MyApplication Login"</param>
|
---|
512 | <param name="maxAttempts">The number of attempts before cancelling</param>
|
---|
513 | <param name="enableConnectionManagement">If false, the user will not be able to change the connections. This is useful for lockdown situations</param>
|
---|
514 | <param name="aUiOwnerForPositioningDialog">Provide your main application as the window owner so the LoginDialog box is correctly managed.</param>
|
---|
515 | <returns>True if login was successful</returns>
|
---|
516 | </member>
|
---|
517 | <member name="M:IndianHealthService.BMXNet.WinForm.LoginProcess.Succeeded">
|
---|
518 | <summary>
|
---|
519 | If the application is managing the actual login, send Succeeded() to indicate success.
|
---|
520 | </summary>
|
---|
521 | <remarks>
|
---|
522 | Do not set WasSuccessful to true.
|
---|
523 | </remarks>
|
---|
524 | <returns>True if successful</returns>
|
---|
525 | </member>
|
---|
526 | <member name="M:IndianHealthService.BMXNet.WinForm.LoginProcess.AttemptAccessVerifyLogin(IndianHealthService.BMXNet.WinForm.Configuration.RpmsConnectionSpec,System.String,System.String)">
|
---|
527 | <summary>
|
---|
528 | Attempt a headless non-interactive UI login. This would be useful for an ASP.NET or NT-service type application
|
---|
529 | </summary>
|
---|
530 | <param name="aSpec">The RpmsConnectionSpec to use during the login process</param>
|
---|
531 | <param name="anAccessCode">The clear text access code</param>
|
---|
532 | <param name="aVerifyCode">The clear text verify code</param>
|
---|
533 | <returns>True if the login was successful</returns>
|
---|
534 | </member>
|
---|
535 | <member name="M:IndianHealthService.BMXNet.WinForm.LoginProcess.HandleLoginAttemptedFailed">
|
---|
536 | <summary>
|
---|
537 | Will trigger the LoginAttempted event
|
---|
538 | </summary>
|
---|
539 | <returns>Answer true if the LoginProcess has been Canceled or handled</returns>
|
---|
540 | </member>
|
---|
541 | <member name="E:IndianHealthService.BMXNet.WinForm.LoginProcess.AttemptingLogin">
|
---|
542 | <summary>
|
---|
543 | Triggered before every login attempt. See <see cref="T:IndianHealthService.BMXNet.WinForm.AttemptingLoginEventArgs" /> for details .
|
---|
544 | </summary>
|
---|
545 | </member>
|
---|
546 | <member name="E:IndianHealthService.BMXNet.WinForm.LoginProcess.LoginAttempted">
|
---|
547 | <summary>
|
---|
548 | Triggered after every login attempt. See <see cref="T:IndianHealthService.BMXNet.WinForm.LoginAttemptedEventArgs" /> for details .
|
---|
549 | </summary>
|
---|
550 | </member>
|
---|
551 | <member name="P:IndianHealthService.BMXNet.WinForm.LoginProcess.Cancel">
|
---|
552 | <summary>
|
---|
553 | During a LoginAttempted the LoginProcess can be Cancelled by setting Cancel to True.
|
---|
554 | </summary>
|
---|
555 | </member>
|
---|
556 | <member name="P:IndianHealthService.BMXNet.WinForm.LoginProcess.IsSwitchServerModeEnabled">
|
---|
557 | <summary>
|
---|
558 | If set to True, the Connection combo box on the Login screen with be dropped down when the
|
---|
559 | dialog is displayed. This is useful for applications that have an option to change Connections.
|
---|
560 | The default is False.
|
---|
561 | </summary>
|
---|
562 | </member>
|
---|
563 | <member name="P:IndianHealthService.BMXNet.WinForm.LoginProcess.AutoSetDivisionToLastLookup">
|
---|
564 | <summary>
|
---|
565 | If set to True, RPMS is checked and if there was a previously set division for the user it will be used, otherwise
|
---|
566 | MustResolveDivision will be set to True and the division will need to be set for the user.
|
---|
567 | The default is True
|
---|
568 | </summary>
|
---|
569 | </member>
|
---|
570 | <member name="P:IndianHealthService.BMXNet.WinForm.LoginProcess.MustResolveDivision">
|
---|
571 | <summary>
|
---|
572 | If the division for the user has not been determine after the LoginProcess, MustResolveDivision will be set to True.
|
---|
573 | The default if False.
|
---|
574 | </summary>
|
---|
575 | </member>
|
---|
576 | <member name="P:IndianHealthService.BMXNet.WinForm.LoginProcess.LoginAttempts">
|
---|
577 | <summary>
|
---|
578 | The number of login attempts so far. This value can be modified during the AttemptingLogin and LoginAttempted events.
|
---|
579 | </summary>
|
---|
580 | </member>
|
---|
581 | <member name="P:IndianHealthService.BMXNet.WinForm.LoginProcess.MaxAttempts">
|
---|
582 | <summary>
|
---|
583 | The number of login attempts before cancelling the LoginProcess. The default value is 3. This value can be modified during the AttemptingLogin and LoginAttempted events.
|
---|
584 | </summary>
|
---|
585 | </member>
|
---|
586 | <member name="P:IndianHealthService.BMXNet.WinForm.LoginProcess.WasLoginAttempted">
|
---|
587 | <summary>
|
---|
588 | True if a login was attempted. False if the user is presented with a LoginDialog and "Cancel" is selected.
|
---|
589 | The value is changed during every login attempt cycle.
|
---|
590 | </summary>
|
---|
591 | </member>
|
---|
592 | <member name="P:IndianHealthService.BMXNet.WinForm.LoginProcess.WasSuccessful">
|
---|
593 | <summary>
|
---|
594 | True if the most recent login attempt was successful.
|
---|
595 | </summary>
|
---|
596 | </member>
|
---|
597 | <member name="P:IndianHealthService.BMXNet.WinForm.LoginProcess.FailureMessage">
|
---|
598 | <summary>
|
---|
599 | A reasonable message to display to the user if the last login attempt failed.
|
---|
600 | </summary>
|
---|
601 | </member>
|
---|
602 | <member name="P:IndianHealthService.BMXNet.WinForm.LoginProcess.FailureException">
|
---|
603 | <summary>
|
---|
604 | If an exception occured during the last login attempt, FailureException will be set to it.
|
---|
605 | </summary>
|
---|
606 | </member>
|
---|
607 | <member name="P:IndianHealthService.BMXNet.WinForm.LoginProcess.ConnectionSpec">
|
---|
608 | <summary>
|
---|
609 | The active ConnectionSpec being used to login. With care, the property can be changed or the instance can be modified during the AttemptingLogin and LoginAttempted events
|
---|
610 | with care.
|
---|
611 | </summary>
|
---|
612 | </member>
|
---|
613 | <member name="P:IndianHealthService.BMXNet.WinForm.LoginProcess.HasDefaultConnectionWithUseWindowsAuth">
|
---|
614 | <summary>
|
---|
615 | Answer True if there is a default managed connection that uses WindowsAuthenication
|
---|
616 | </summary>
|
---|
617 | </member>
|
---|
618 | <member name="T:IndianHealthService.BMXNet.WinForm.WinFramework">
|
---|
619 | <summary>
|
---|
620 | Instance manages the context/access to RPMS
|
---|
621 | - Configuration information
|
---|
622 | - Login entry points
|
---|
623 | - External changes to patient context
|
---|
624 | </summary>
|
---|
625 |
|
---|
626 | </member>
|
---|
627 | <member name="M:IndianHealthService.BMXNet.WinForm.WinFramework.ImHereServer">
|
---|
628 | <summary>
|
---|
629 | Ping the server, will reset read-timeout
|
---|
630 | </summary>
|
---|
631 | <returns></returns>
|
---|
632 | </member>
|
---|
633 | <member name="M:IndianHealthService.BMXNet.WinForm.WinFramework.AttemptUserInputSetDivision(System.String,System.Windows.Forms.IWin32Window)">
|
---|
634 | <summary>
|
---|
635 | Answer true if changed, false if the same
|
---|
636 | </summary>
|
---|
637 | <param name="aDialogTitle"></param>
|
---|
638 | <param name="aUiOwnerForPositioningDialog"></param>
|
---|
639 | <returns></returns>
|
---|
640 | </member>
|
---|
641 | <member name="P:IndianHealthService.BMXNet.WinForm.WinFramework.Log">
|
---|
642 | <summary>
|
---|
643 | Logger to be used by all BMX objects.
|
---|
644 | </summary>
|
---|
645 | </member>
|
---|
646 | </members>
|
---|
647 | </doc>
|
---|