forked from VFPX/Log4VFP
-
Notifications
You must be signed in to change notification settings - Fork 0
/
wwDotNetBridge.xml
1812 lines (1785 loc) · 88.8 KB
/
wwDotNetBridge.xml
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>wwDotNetBridge</name>
</assembly>
<members>
<member name="T:Westwind.WebConnection.wwDotNetBridge">
<summary>
The wwDotNetBridge class provides a host of COM support functions for Visual FoxPro.
It allows you to host the .NET runtime without relying on COM interop to load types,
rather it acts as a proxy for instantiation and other tasks.
This library can be used itself to load .NET and types, or you can use it as a helper
with COM interop in which case you have to instantiate it as a COM object and call
its methods directly rather than using the FoxPro helper class.
</summary>
</member>
<member name="P:Westwind.WebConnection.wwDotNetBridge.ErrorMessage">
<summary>
Returns error information if the call fails
</summary>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.LoadAssembly(System.String)">
<summary>
Loads an assembly into the AppDomain by its fully qualified assembly name
</summary>
<param name="AssemblyName"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.LoadAssemblyFrom(System.String)">
<summary>
Loads an assembly into the AppDomain by a fully qualified assembly path
</summary>
<param name="AssemblyFileName"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateInstance(System.String)">
<summary>
Creates a type reference from a given type name if the
assembly is already loaded.
</summary>
<param name="TypeName"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateInstance_OneParm(System.String,System.Object)">
<summary>
Creates a type reference from a given type name if the
assembly is already loaded.
</summary>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateInstance_TwoParms(System.String,System.Object,System.Object)">
<summary>
Creates a type reference from a given type name if the
assembly is already loaded.
</summary>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateInstance_ThreeParms(System.String,System.Object,System.Object,System.Object)">
<summary>
Creates a type reference from a given type name if the
assembly is already loaded.
</summary>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateInstance_Internal(System.String,System.Object[])">
<summary>
Creates an instance of a class based on its type name. Assumes that the type's
assembly is already loaded.
Note this will be a little slower than the versions that work with assembly
name specified because this code has to search for the type first rather
than directly activating it.
</summary>
<param name="TypeName"></param>
<param name="args"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateInstance_Internal(System.String,System.String,System.Object[])">
<summary>
Routine that loads an assembly by its 'application assembly name' - unsigned
assemblies must be visible via the .NET path (current path or BIN dir) and
GAC assemblies must be referenced by their full assembly name.
</summary>
<param name="AssemblyName"></param>
<param name="TypeName"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateInstanceOnType(System.Object,System.String,System.String)">
<summary>
Creates an instance of a type on an existing property of another type
</summary>
<param name="instance">Parent Instance that contains the property to set</param>
<param name="property">The property on the parent instance to set</param>
<param name="TypeName">Full name of the type to create</param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateInstanceOnType_OneParm(System.Object,System.String,System.String,System.Object)">
<summary>
Creates an instance of a type on an existing property of another type
</summary>
<param name="instance">Parent Instance that contains the property to set</param>
<param name="property">The property on the parent instance to set</param>
<param name="TypeName">Full name of the type to create</param>
<param name="parm1"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateInstanceOnType_TwoParms(System.Object,System.String,System.String,System.Object,System.Object)">
<summary>
Creates an instance of a type on an existing property of another type
</summary>
<param name="instance">Parent Instance that contains the property to set</param>
<param name="property">The property on the parent instance to set</param>
<param name="TypeName">Full name of the type to create</param>
<param name="parm1"></param>
<param name="parm2"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateInstanceOnType_ThreeParms(System.Object,System.String,System.String,System.Object,System.Object,System.Object)">
<summary>
Creates an instance of a type on an existing property of another type
</summary>
<param name="instance">Parent Instance that contains the property to set</param>
<param name="property">The property on the parent instance to set</param>
<param name="TypeName">Full name of the type to create</param>
<param name="parm1"></param>
<param name="parm2"></param>
<param name="parm3"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateInstanceOnType_FourParms(System.Object,System.String,System.String,System.Object,System.Object,System.Object,System.Object)">
<summary>
Creates an instance of a type on an existing property of another type
</summary>
<param name="instance">Parent Instance that contains the property to set</param>
<param name="property">The property on the parent instance to set</param>
<param name="TypeName">Full name of the type to create</param>
<param name="parm1"></param>
<param name="parm2"></param>
<param name="parm3"></param>
<param name="parm4"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateInstanceOnType_FiveParms(System.Object,System.String,System.String,System.Object,System.Object,System.Object,System.Object,System.Object)">
<summary>
Creates an instance of a type on an existing property of another type
</summary>
<param name="instance">Parent Instance that contains the property to set</param>
<param name="property">The property on the parent instance to set</param>
<param name="TypeName">Full name of the type to create</param>/// <param name="parm1"></param>
<param name="parm2"></param>
<param name="parm3"></param>
<param name="parm4"></param>
<param name="parm5"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateAssemblyInstanceFromFile(System.String,System.String)">
<summary>
Creates an instance from a file reference with a parameterless constructor
</summary>
<param name="AssemblyFileName"></param>
<param name="TypeName"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateAssemblyInstanceFromFile_OneParm(System.String,System.String,System.Object)">
<summary>
Creates an instance from a file reference with a 1 parameter constructor
</summary>
<param name="AssemblyFileName"></param>
<param name="TypeName"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateAssemblyInstanceFromFile_TwoParms(System.String,System.String,System.Object,System.Object)">
<summary>
Creates an instance from a file reference with a two parameter constructor
</summary>
<param name="AssemblyFileName"></param>
<param name="TypeName"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateInstanceFromFile_Internal(System.String,System.String,System.Object[])">
<summary>
Routine that loads a class from an assembly file name specified.
</summary>
<param name="AssemblyFileName"></param>
<param name="TypeName"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateAssemblyInstance(System.String,System.String)">
<summary>
Creates a new instance from a file file based assembly refence. Requires full
filename including extension and path.
</summary>
<param name="AssemblyFileName"></param>
<param name="TypeName"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateAssemblyInstance_OneParm(System.String,System.String,System.Object)">
<summary>
Creates a new instance from a file file based assembly refence. Requires full
filename including extension and path.
</summary>
<param name="AssemblyFileName"></param>
<param name="TypeName"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateAssemblyInstance_TwoParms(System.String,System.String,System.Object,System.Object)">
<summary>
Creates a new instance from a file file based assembly refence. Requires full
filename including extension and path.
</summary>
<param name="AssemblyFileName"></param>
<param name="TypeName"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.GetTypeFromName(System.String)">
<summary>
Helper routine that looks up a type name and tries to retrieve the
full type reference in the actively executing assemblies.
</summary>
<param name="typeName"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.InvokeStaticMethod_Internal(System.String,System.String,System.Object[])">
<summary>
Invokes a static method
</summary>
<param name="TypeName"></param>
<param name="Method"></param>
<param name="args"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.GetStaticProperty(System.String,System.String)">
<summary>
Retrieves a value from a static property by specifying a type full name and property
</summary>
<param name="TypeName">Full type name (namespace.class)</param>
<param name="Property">Property to get value from</param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.InvokeMethod(System.Object,System.String)">
<summary>
Invokes a method with no parameters
</summary>
<param name="Instance"></param>
<param name="Method"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.InvokeMethodWithParameterArray(System.Object,System.String,System.Object[])">
<summary>
Invokes a method with an explicit array of parameters
Allows for any number of parameters to be passed.
</summary>
<param name="instance"></param>
<param name="method"></param>
<param name="parms"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.InvokeMethod_OneParm(System.Object,System.String,System.Object)">
<summary>
Invokes a method with one parameter
</summary>
<param name="Instance"></param>
<param name="Method"></param>
<param name="Parm1"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.InvokeMethod_TwoParms(System.Object,System.String,System.Object,System.Object)">
<summary>
Invokes a method with two parameters
</summary>
<param name="Instance"></param>
<param name="Method"></param>
<param name="Parm1"></param>
<param name="Parm2"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.GetPropertyEx(System.Object,System.String)">
<summary>
Returns a property value by allowing . syntax to drill
into nested objects. Use this method to step over objects
that FoxPro can't directly access (like structs, generics etc.)
</summary>
<param name="Instance"></param>
<param name="Property"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.SetProperty(System.Object,System.String,System.Object)">
<summary>
Sets a property of a .NET object with a value
</summary>
<param name="Instance"></param>
<param name="Property"></param>
<param name="Value"></param>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.SetPropertyEx(System.Object,System.String,System.Object)">
<summary>
Sets a property of a .NET object with a value using extended syntax.
This method supports '.' syntax so you can use "Property.ChildProperty"
to walk the object hierarchy in the string property parameter.
This method also supports accessing of Array/Collection indexers (Item[1])
</summary>
<param name="Instance"></param>
<param name="Property"></param>
<param name="Value"></param>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.GetEnumString(System.String,System.Object)">
<summary>
Returns the name of an enum field given an enum value
passed. Pass in the name of the enum type
</summary>
<param name="EnumTypeName"></param>
<param name="Value"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.InvokeStaticMethodAsync(System.Object,System.String,System.String,System.Object[])">
<summary>
Invokes a method on asynchronously and fires OnCompleted and OnError
events on a passed in callback object.
</summary>
<param name="callBack">
A callback object that has to have two methods:
OnCompleted(lvResult, lcMethod)
OnError(lcErrorMsg,loException, lcMethod)
</param>
<param name="instance"></param>
<param name="method"></param>
<param name="parameters"></param>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.InvokeMethodAsync(System.Object,System.Object,System.String,System.Object[])">
<summary>
Invokes a method on a new thread and fires OnCompleted and OnError
events on a passed in callback object.
</summary>
<param name="callBack">
A callback object that has to have two methods:
OnCompleted(lvResult, lcMethod)
OnError(lcErrorMsg,loException, lcMethod)
</param>
<param name="instance"></param>
<param name="method"></param>
<param name="parameters"></param>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge._InvokeMethodAsync(System.Object)">
<summary>
Internal handler method that actually makes the async call on a thread
</summary>
<param name="parmList"></param>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateArrayInstanceInternal(System.Object,System.String,System.Int32)">
<summary>
Creates an instance of an array on a given base object instance by name.
Array is created with 'empty' elements - ie. objects are null and value
types are set to their default() values.
</summary>
<param name="baseType"></param>
<param name="arrayProperty"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateArrayOnInstance(System.Object,System.String,System.Int32)">
<summary>
Creates an array instance of a given type and size. Note the
elements of this array are null/default and need to be set explicitly
</summary>
<param name="baseType">Object instance on which to create the array</param>
<param name="arrayProperty">String property/field name of the array to create</param>
<param name="size">Size of the array to createArray</param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateArrayOnInstanceWithObject(System.Object,System.String,System.Object)">
<summary>
Creates a new array instance on a type of exactly 1 array item which is
assigned the item parameter passed in.
</summary>
<param name="baseType"></param>
<param name="arrayProperty"></param>
<param name="item"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateArray(System.String)">
<summary>
Creates an instance of an array
</summary>
<param name="arrayTypeString"></param>
<param name="item"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.CreateArrayFromInstance(System.Object)">
<summary>
Creates an array from a specific instance of a COM object
</summary>
<param name="instance"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.AddArrayItem(System.Object,System.String,System.Object)">
<summary>
Used to add an item to an array by indirection to work around VFP's
inability to easily add array elements.
</summary>
<param name="baseObject">The object that has the Array property</param>
<param name="arrayObject">The array property name as a string</param>
<param name="item">The item to set it to. Should not be null.</param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.GetIndexedProperty(System.Object,System.Int32)">
<summary>
Returns an indexed property Value
</summary>
<param name="baseList">List object</param>
<param name="index">Index into the list</param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.GetArrayItem(System.Object,System.String,System.Int32)">
<summary>
Returns an individual Array Item by its index
</summary>
<param name="baseObject"></param>
<param name="arrayName"></param>
<param name="index"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.SetArrayItem(System.Object,System.String,System.Int32,System.Object)">
<summary>
Sets an array element to a given value. Assumes the array is big
enough and the array item exists.
</summary>
<param name="baseObject">base object reference</param>
<param name="arrayName">Name of the array as a string</param>
<param name="index">The index of the item to set</param>
<param name="value">The value to set the array item to</param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.RemoveArrayItem(System.Object,System.String,System.Int32)">
<summary>
Removes an item from a .NET array with indirection to work around VFP's
inability to manipulate .NET array elements.
</summary>
<param name="baseObject">The arrays parent object</param>
<param name="arrayObject">The array's name as a string</param>
<param name="Index">The index to of the item to delete. NOTE: 1 based!</param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.DataSetToXmlString(System.Data.DataSet,System.Boolean)">
<summary>
Returns an XML string from a .NET DataSet
</summary>
<param name="ds"></param>
<param name="includeSchema"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.XmlStringToDataSet(System.String)">
<summary>
Converts an Xml String created from a FoxPro Xml Adapter or CursorToXml
into a DataSet if possible.
</summary>
<param name="xml"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.FixupReturnValue(System.Object)">
<summary>
Fixes up a return value to return to FoxPro
based on its type. Fixes up some values to
be type safe for FoxPro and others are returned
as wrappers (ComArray, ComGuid)
</summary>
<param name="val"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.ConvertObjectToByteArray(System.Object)">
<summary>
Converts an object to a byte array
</summary>
<param name="val"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.FixupAssemblyName(System.String)">
<summary>
Helper routine that automatically assigns default names to certain
'common' system assemblies so that we don't have to provide a full path
NOTE:
All names are for .NET 2.0 Runtime at the moment
</summary>
<param name="AssemblyName"></param>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.GetDotnetVersion(System.Boolean)">
<summary>
Returns the .NET framework version installed on the machine
as a string of 4.x.y version
</summary>
<remarks>Minimum version supported is 4.0</remarks>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.wwDotNetBridge.GetWindowsVersion(Westwind.WebConnection.WindowsVersionModes)">
<summary>
Returns Windows Version as a string
0 - Full: 10.0.17134.0 - Release: 1803
1 - Version only: 10.0.17134.0
2 - Release only: 1803
</summary>
<param name="mode"></param>
<returns></returns>
</member>
<member name="T:Westwind.WebConnection.EventSubscriber">
<summary>
FoxPro interop access to .NET events. Handles all events of a source object for subsequent retrieval by a FoxPro client.
</summary>
<remarks>For a FoxPro program to be notified of events, it should use `wwDotNetBridge.InvokeMethodAsync` to call <see cref="M:Westwind.WebConnection.EventSubscriber.WaitForEvent"/>. When <see cref="M:Westwind.WebConnection.EventSubscriber.WaitForEvent"/> asynchronously completes, the FoxPro program should handle the event it returns and then call <see cref="M:Westwind.WebConnection.EventSubscriber.WaitForEvent"/> again to wait for the next event. The FoxPro class `EventSubscription`, which is returned by `SubscribeToEvents`, encapsulates this async wait loop.</remarks>
</member>
<member name="M:Westwind.WebConnection.EventSubscriber.WaitForEvent">
<summary>
Waits until an event is raised, or returns immediately if a queued event is available.
</summary>
<returns>The next event, or null if this subscriber has been disposed.</returns>
</member>
<member name="M:Westwind.WebConnection.TypePassingTests.PassEnumArray(System.Windows.Forms.MessageBoxButtons[])">
<summary>
</summary>
<example>
LOCAL loArray as Westwind.WebConnection.ComArray
loArray = loBridge.Createarray("System.Windows.Forms.MessageBoxButtons")
loComValue = loBridge.CreateComValue()
loComValue.SetEnum("System.Windows.Forms.MessageBoxButtons.OK")
loArray.AddItem( loComValue)
? loBridge.InvokeMethod(loTest,"PassEnumArray",loArray)
</example>
<param name="buttons"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.TypePassingTests.Pass24Parameters(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Pass in 15 parameters and return the value of the last
</summary>
<returns></returns>
</member>
<member name="T:Westwind.WebConnection.FileUtils">
<summary>
wwUtils class which contains a set of common utility classes for
Formatting strings
Reflection Helpers
Object Serialization
</summary>
</member>
<member name="M:Westwind.WebConnection.FileUtils.CopyStream(System.IO.Stream,System.IO.Stream,System.Int32)">
<summary>
Copies the content of the one stream to another.
Streams must be open and stay open.
</summary>
</member>
<member name="M:Westwind.WebConnection.FileUtils.GetFileEncoding(System.String)">
<summary>
Detects the byte order mark of a file and returns
an appropriate encoding for the file.
</summary>
<param name="srcFile"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.FileUtils.OpenStreamReaderWithEncoding(System.String)">
<summary>
Opens a stream reader with the appropriate text encoding applied.
</summary>
<param name="srcFile"></param>
</member>
<member name="M:Westwind.WebConnection.FileUtils.JustPath(System.String)">
<summary>
Returns the full path of a full physical filename
</summary>
<param name="path"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.FileUtils.GetFullPath(System.String)">
<summary>
Returns a fully qualified path from a partial or relative
path. Also fixes up case of the entire path **if the file exists**
</summary>
<param name="Path"></param>
</member>
<member name="M:Westwind.WebConnection.FileUtils.GetRelativePath(System.String,System.String)">
<summary>
Returns a relative path string from a full path.
</summary>
<param name="FullPath">The path to convert. Can be either a file or a directory</param>
<param name="BasePath">The base path to truncate to and replace</param>
<returns>
Lower case string of the relative path. If path is a directory it's returned without a backslash at the end.
Examples of returned values:
.\test.txt, ..\test.txt, ..\..\..\test.txt, ., ..
</returns>
<summary>
Returns a relative path string from a full path based on a base path
provided.
</summary>
<param name="fullPath">The path to convert. Can be either a file or a directory</param>
<param name="basePath">The base path on which relative processing is based. Should be a directory.</param>
<returns>
String of the relative path.
Examples of returned values:
test.txt, ..\test.txt, ..\..\..\test.txt, ., .., subdir\test.txt
</returns>
</member>
<member name="M:Westwind.WebConnection.FileUtils.SaveFileDialog(System.String,System.String,System.String,System.String,System.Boolean)">
<summary>
Returns a filename for a file to save
</summary>
<param name="folder"></param>
<param name="caption"></param>
<param name="title"></param>
<param name="defaultExtension">a default extension like png, txt, md etc.</param>
<param name="extensionFilter">"|Png Image (.png)|*.png|JPEG Image (.jpeg)|*.jpeg|Gif Image (.gif)|*.gif|Tiff Image (.tiff)|*.tiff|All Files (*.*)|*.*";</param>
<param name="promptOverwrite">If true prompts if file exists</param>
<returns>Filename or null</returns>
</member>
<member name="M:Westwind.WebConnection.FileUtils.OpenFileDialog(System.String,System.String,System.String,System.Boolean)">
<summary>
Returns a filename for a file to open
</summary>
<param name="folder"></param>
<param name="caption"></param>
<param name="title"></param>
<param name="extensionFilter">"|Png Image (.png)|*.png|JPEG Image (.jpeg)|*.jpeg|Gif Image (.gif)|*.gif|Tiff Image (.tiff)|*.tiff|All Files (*.*)|*.*";</param>
<param name="checkIfFileExists">If true requires that the selected file exists. Otherwise you can type a filename.</param>
<returns>Filename or null</returns>
</member>
<member name="M:Westwind.WebConnection.FileUtils.OpenFolderDialog(System.String,System.String)">
<summary>
Displays a folder browser dialog box
</summary>
<param name="startFolder"></param>
<param name="description"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.FileUtils.DeleteFiles(System.String,System.Int32)">
<summary>
Deletes files based on a file spec and a given timeout.
This routine is useful for cleaning up temp files in
Web applications.
</summary>
<param name="filespec">A DOS filespec that includes path and/or wildcards to select files</param>
<param name="seconds">The timeout - if files are older than this timeout they are deleted</param>
</member>
<member name="M:Westwind.WebConnection.FileUtils.ZipFolder(System.String,System.String,System.Boolean)">
<summary>
Zips a folder
</summary>
<param name="outputZipFile"></param>
<param name="folder"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.FileUtils.UnzipFolder(System.String,System.String)">
<summary>
Unzips a zip file to a destination folder.
</summary>
<param name="zipFile"></param>
<param name="folder"></param>
<returns></returns>
</member>
<member name="T:Westwind.WebConnection.ReflectionUtils">
<summary>
Collection of Reflection and type conversion related utility functions
</summary>
</member>
<member name="F:Westwind.WebConnection.ReflectionUtils.MemberAccess">
<summary>
Binding Flags constant to be reused for all Reflection access methods.
</summary>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.GetProperty(System.Object,System.String)">
<summary>
Retrieve a property value from an object dynamically. This is a simple version
that uses Reflection calls directly. It doesn't support indexers.
</summary>
<param name="instance">Object to make the call on</param>
<param name="property">Property to retrieve</param>
<returns>Object - cast to proper type</returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.GetField(System.Object,System.String)">
<summary>
Retrieve a field dynamically from an object. This is a simple implementation that's
straight Reflection and doesn't support indexers.
</summary>
<param name="Object">Object to retreve Field from</param>
<param name="Property">name of the field to retrieve</param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.GetPropertyInternal(System.Object,System.String)">
<summary>
Parses Properties and Fields including Array and Collection references.
Used internally for the 'Ex' Reflection methods.
</summary>
<param name="Parent"></param>
<param name="Property"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.SetPropertyInternal(System.Object,System.String,System.Object)">
<summary>
Parses Properties and Fields including Array and Collection references.
</summary>
<param name="Parent"></param>
<param name="Property"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.GetPropertyEx(System.Object,System.String)">
<summary>
Returns a property or field value using a base object and sub members including . syntax.
For example, you can access: oCustomer.oData.Company with (this,"oCustomer.oData.Company")
This method also supports indexers in the Property value such as:
Customer.DataSet.Tables["Customers"].Rows[0]
</summary>
<param name="Parent">Parent object to 'start' parsing from. Typically this will be the Page.</param>
<param name="Property">The property to retrieve. Example: 'Customer.Entity.Company'</param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.GetPropertyInfoEx(System.Object,System.String)">
<summary>
Returns a PropertyInfo object for a given dynamically accessed property
Property selection can be specified using . syntax ("Address.Street" or "DataTable[0].Rows[1]") hence the 'Ex' name for this function.
</summary>
<param name="Parent"></param>
<param name="Property"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.GetPropertyInfoInternal(System.Object,System.String)">
<summary>
Returns a PropertyInfo structure from an extended Property reference
</summary>
<param name="Parent"></param>
<param name="Property"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.SetProperty(System.Object,System.String,System.Object)">
<summary>
Sets the property on an object. This is a simple method that uses straight Reflection
and doesn't support indexers.
</summary>
<param name="obj">Object to set property on</param>
<param name="property">Name of the property to set</param>
<param name="value">value to set it to</param>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.SetField(System.Object,System.String,System.Object)">
<summary>
Sets the field on an object. This is a simple method that uses straight Reflection
and doesn't support indexers.
</summary>
<param name="obj">Object to set property on</param>
<param name="property">Name of the field to set</param>
<param name="value">value to set it to</param>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.SetPropertyEx(System.Object,System.String,System.Object)">
<summary>
Sets a value on an object. Supports . syntax for named properties
(ie. Customer.Entity.Company) as well as indexers.
</summary>
<param name="Object ParentParent">
Object to set the property on.
</param>
<param name="String PropertyProperty">
Property to set. Can be an object hierarchy with . syntax and can
include indexers. Examples: Customer.Entity.Company,
Customer.DataSet.Tables["Customers"].Rows[0]
</param>
<param name="Object ValueValue">
Value to set the property to
</param>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.CallMethod(System.Object,System.String,System.Type[],System.Object[])">
<summary>
Calls a method on an object dynamically. This version requires explicit
specification of the parameter type signatures.
</summary>
<param name="instance">Instance of object to call method on</param>
<param name="method">The method to call as a stringToTypedValue</param>
<param name="parameterTypes">Specify each of the types for each parameter passed.
You can also pass null, but you may get errors for ambiguous methods signatures
when null parameters are passed</param>
<param name="parms">any variable number of parameters.</param>
<returns>object</returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.CallMethod(System.Object,System.String,System.Object[])">
<summary>
Calls a method on an object dynamically.
This version doesn't require specific parameter signatures to be passed.
Instead parameter types are inferred based on types passed. Note that if
you pass a null parameter, type inferrance cannot occur and if overloads
exist the call may fail. if so use the more detailed overload of this method.
</summary>
<param name="instance">Instance of object to call method on</param>
<param name="method">The method to call as a stringToTypedValue</param>
<param name="parameterTypes">Specify each of the types for each parameter passed.
You can also pass null, but you may get errors for ambiguous methods signatures
when null parameters are passed</param>
<param name="parms">any variable number of parameters.</param>
<returns>object</returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.CallStaticMethod(System.String,System.String,System.Object[])">
<summary>
Invokes a static method
</summary>
<param name="typeName"></param>
<param name="method"></param>
<param name="parms"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.CallMethodEx(System.Object,System.String,System.Object[])">
<summary>
Calls a method on an object with extended . syntax (object: this Method: Entity.CalculateOrderTotal)
</summary>
<param name="parent"></param>
<param name="method"></param>
<param name="params"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.CreateInstanceFromType(System.Type,System.Object[])">
<summary>
Creates an instance from a type by calling the parameterless constructor.
Note this will not work with COM objects - continue to use the Activator.CreateInstance
for COM objects.
<seealso>Class wwUtils</seealso>
</summary>
<param name="typeToCreate">
The type from which to create an instance.
</param>
<returns>object</returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.CreateInstanceFromString(System.String,System.Object[])">
<summary>
Creates an instance of a type based on a string. Assumes that the type's
</summary>
<param name="typeName"></param>
<param name="args"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.GetTypeFromName(System.String)">
<summary>
Helper routine that looks up a type name and tries to retrieve the
full type reference in the actively executing assemblies.
</summary>
<param name="typeName"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.CreateComInstance(System.String)">
<summary>
Creates a COM instance from a ProgID. Loads either
Exe or DLL servers.
</summary>
<param name="progId"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.TypedValueToString(System.Object,System.Globalization.CultureInfo,System.String)">
<summary>
Converts a type to string if possible. This method supports an optional culture generically on any value.
It calls the ToString() method on common types and uses a type converter on all other objects
if available
</summary>
<param name="rawValue">The Value or Object to convert to a string</param>
<param name="culture">Culture for numeric and DateTime values</param>
<param name="unsupportedReturn">Return string for unsupported types</param>
<returns>string</returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.StringToTypedValue(System.String,System.Type,System.Globalization.CultureInfo)">
<summary>
Turns a string into a typed value generically.
Explicitly assigns common types and falls back
on using type converters for unhandled types.
Common uses:
* UI -> to data conversions
* Parsers
<seealso>Class ReflectionUtils</seealso>
</summary>
<param name="sourceString">
The string to convert from
</param>
<param name="targetType">
The type to convert to
</param>
<param name="culture">
Culture used for numeric and datetime values.
</param>
<returns>object. Throws exception if it cannot be converted.</returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.StringToTypedValue``1(System.String,System.Globalization.CultureInfo)">
<summary>
Generic version allow for automatic type conversion without the explicit type
parameter
</summary>
<typeparam name="T">Type to be converted to</typeparam>
<param name="sourceString">input string value to be converted</param>
<param name="culture">Culture applied to conversion</param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.GetEnumList(System.Type,System.Boolean)">
<summary>
Returns a List of KeyValuePair object
</summary>
<param name="enumeration"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.GetStaticProperty(System.String,System.String)">
<summary>
Retrieves a value from a static property by specifying a type full name and property
</summary>
<param name="typeName">Full type name (namespace.class)</param>
<param name="property">Property to get value from</param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.GetStaticProperty(System.Type,System.String)">
<summary>
Returns a static property from a given type
</summary>
<param name="type">Type instance for the static property</param>
<param name="property">Property name as a string</param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.GetPropertyCom(System.Object,System.String)">
<summary>
Retrieve a dynamic 'non-typelib' property
</summary>
<param name="instance">Object to make the call on</param>
<param name="property">Property to retrieve</param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.GetPropertyExCom(System.Object,System.String)">
<summary>
Returns a property or field value using a base object and sub members including . syntax.
For example, you can access: oCustomer.oData.Company with (this,"oCustomer.oData.Company")
</summary>
<param name="parent">Parent object to 'start' parsing from.</param>
<param name="property">The property to retrieve. Example: 'oBus.oData.Company'</param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.SetPropertyCom(System.Object,System.String,System.Object)">
<summary>
Sets the property on an object.
</summary>
<param name="Object">Object to set property on</param>
<param name="Property">Name of the property to set</param>
<param name="Value">value to set it to</param>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.SetPropertyExCom(System.Object,System.String,System.Object)">
<summary>
Sets the value of a field or property via Reflection. This method alws
for using '.' syntax to specify objects multiple levels down.
ReflectionUtils.SetPropertyEx(this,"Invoice.LineItemsCount",10)
which would be equivalent of:
Invoice.LineItemsCount = 10;
</summary>
<param name="Object ParentParent">
Object to set the property on.
</param>
<param name="String PropertyProperty">
Property to set. Can be an object hierarchy with . syntax.
</param>
<param name="Object ValueValue">
Value to set the property to
</param>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.CallMethodCom(System.Object,System.String,System.Object[])">
<summary>
Wrapper method to call a 'dynamic' (non-typelib) method
on a COM object
</summary>
<param name="params"></param>
1st - Method name, 2nd - 1st parameter, 3rd - 2nd parm etc.
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.ReflectionUtils.CallMethodExCom(System.Object,System.String,System.Object[])">
<summary>
Calls a method on a COM object with '.' syntax (Customer instance and Address.DoSomeThing method)
</summary>
<param name="parent">the object instance on which to call method</param>
<param name="method">The method or . syntax path to the method (Address.Parse)</param>
<param name="parms">Any number of parameters</param>
<returns></returns>
</member>
<member name="T:Westwind.WebConnection.StringUtils">
<summary>
String utility class that provides a host of string related operations
</summary>
</member>
<member name="M:Westwind.WebConnection.StringUtils.TrimStart(System.String,System.String,System.Boolean)">
<summary>
Trims a sub string from a string
</summary>
<param name="text"></param>
<param name="textToTrim"></param>
<returns></returns>
</member>
<member name="M:Westwind.WebConnection.StringUtils.Replicate(System.String,System.Int32)">
<summary>
Replicates an input string n number of times
</summary>
<param name="input"></param>
<param name="charCount"></param>