Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
alexbevi
GitHub Repository: alexbevi/BizHawk
Path: blob/master/References/GongShell.XML
2 views
1
<?xml version="1.0"?>
2
<doc>
3
<assembly>
4
<name>GongShell</name>
5
</assembly>
6
<members>
7
<member name="T:GongSolutions.Shell.PlacesToolbar">
8
<summary>
9
Provides a toolbar showing common places in the computer's
10
filesystem.
11
</summary>
12
13
<remarks>
14
Use the <see cref="T:GongSolutions.Shell.PlacesToolbar"/> control to display a
15
toolbar listing common places in the computer's filesystem,
16
similar to that on the far left-side of the standard file
17
open/save dialogs.
18
</remarks>
19
</member>
20
<member name="F:GongSolutions.Shell.PlacesToolbar.components">
21
<summary>
22
Required designer variable.
23
</summary>
24
</member>
25
<member name="M:GongSolutions.Shell.PlacesToolbar.Dispose(System.Boolean)">
26
<summary>
27
Clean up any resources being used.
28
</summary>
29
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
30
</member>
31
<member name="M:GongSolutions.Shell.PlacesToolbar.InitializeComponent">
32
<summary>
33
Required method for Designer support - do not modify
34
the contents of this method with the code editor.
35
</summary>
36
</member>
37
<member name="M:GongSolutions.Shell.PlacesToolbar.#ctor">
38
<summary>
39
Initializes a new instance of the
40
<see cref="T:GongSolutions.Shell.PlacesToolbar"/> class.
41
</summary>
42
</member>
43
<member name="M:GongSolutions.Shell.PlacesToolbar.Add(GongSolutions.Shell.ShellItem)">
44
<summary>
45
Adds a new folder to the toolbar.
46
</summary>
47
48
<param name="folder">
49
A <see cref="T:GongSolutions.Shell.ShellItem"/> representing the folder to be added.
50
</param>
51
52
<returns>
53
true if the item was sucessfully added, false otherwise.
54
</returns>
55
</member>
56
<member name="M:GongSolutions.Shell.PlacesToolbar.OnVisibleChanged(System.EventArgs)">
57
<summary>
58
Overrides the <see cref="M:System.Windows.Forms.Control.OnVisibleChanged(System.EventArgs)"/> method.
59
</summary>
60
<param name="e"/>
61
</member>
62
<member name="P:GongSolutions.Shell.PlacesToolbar.ShellView">
63
<summary>
64
A <see cref="C:ShellView"/> that should be automatically
65
navigated when the user clicks on an entry in the toolbar.
66
</summary>
67
</member>
68
<member name="E:GongSolutions.Shell.PlacesToolbar.FilterItem">
69
<summary>
70
Occurs when the <see cref="T:GongSolutions.Shell.PlacesToolbar"/> control wants to
71
know if it should include an item.
72
</summary>
73
74
<remarks>
75
This event allows the items displayed in the
76
<see cref="T:GongSolutions.Shell.PlacesToolbar"/> control to be filtered.
77
</remarks>
78
</member>
79
<member name="P:GongSolutions.Shell.PlacesToolbar.AllowDrop">
80
<summary>
81
This property does not apply to the
82
<see cref="T:GongSolutions.Shell.PlacesToolbar"/> class.
83
</summary>
84
</member>
85
<member name="P:GongSolutions.Shell.PlacesToolbar.AutoScroll">
86
<summary>
87
This property is not relevant to the
88
<see cref="T:GongSolutions.Shell.PlacesToolbar"/> class.
89
</summary>
90
</member>
91
<member name="P:GongSolutions.Shell.PlacesToolbar.AutoScrollMargin">
92
<summary>
93
This property is not relevant to the
94
<see cref="T:GongSolutions.Shell.PlacesToolbar"/> class.
95
</summary>
96
</member>
97
<member name="P:GongSolutions.Shell.PlacesToolbar.AutoScrollMinSize">
98
<summary>
99
This property is not relevant to the
100
<see cref="T:GongSolutions.Shell.PlacesToolbar"/> class.
101
</summary>
102
</member>
103
<member name="P:GongSolutions.Shell.PlacesToolbar.AutoSize">
104
<summary>
105
This property is not relevant to the
106
<see cref="T:GongSolutions.Shell.PlacesToolbar"/> class.
107
</summary>
108
</member>
109
<member name="P:GongSolutions.Shell.PlacesToolbar.AutoSizeMode">
110
<summary>
111
This property is not relevant to the
112
<see cref="T:GongSolutions.Shell.PlacesToolbar"/> class.
113
</summary>
114
</member>
115
<member name="P:GongSolutions.Shell.PlacesToolbar.AutoValidate">
116
<summary>
117
This property is not relevant to the
118
<see cref="T:GongSolutions.Shell.PlacesToolbar"/> class.
119
</summary>
120
</member>
121
<member name="P:GongSolutions.Shell.PlacesToolbar.BackgroundImage">
122
<summary>
123
This property is not relevant to the
124
<see cref="T:GongSolutions.Shell.PlacesToolbar"/> class.
125
</summary>
126
</member>
127
<member name="P:GongSolutions.Shell.PlacesToolbar.BackgroundImageLayout">
128
<summary>
129
This property is not relevant to the
130
<see cref="T:GongSolutions.Shell.PlacesToolbar"/> class.
131
</summary>
132
</member>
133
<member name="P:GongSolutions.Shell.PlacesToolbar.BorderStyle">
134
<summary>
135
This property is not relevant to the
136
<see cref="T:GongSolutions.Shell.PlacesToolbar"/> class.
137
</summary>
138
</member>
139
<member name="P:GongSolutions.Shell.PlacesToolbar.CausesValidation">
140
<summary>
141
This property is not relevant to the
142
<see cref="T:GongSolutions.Shell.PlacesToolbar"/> class.
143
</summary>
144
</member>
145
<member name="F:GongSolutions.Shell.ShellItemBrowseForm.components">
146
<summary>
147
Required designer variable.
148
</summary>
149
</member>
150
<member name="M:GongSolutions.Shell.ShellItemBrowseForm.Dispose(System.Boolean)">
151
<summary>
152
Clean up any resources being used.
153
</summary>
154
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
155
</member>
156
<member name="M:GongSolutions.Shell.ShellItemBrowseForm.InitializeComponent">
157
<summary>
158
Required method for Designer support - do not modify
159
the contents of this method with the code editor.
160
</summary>
161
</member>
162
<member name="T:GongSolutions.Shell.FileNameComboBox">
163
<summary>
164
A filename combo box suitable for use in file Open/Save dialogs.
165
</summary>
166
167
<remarks>
168
<para>
169
This control extends the <see cref="T:System.Windows.Forms.ComboBox"/> class to provide
170
auto-completion of filenames based on the folder selected in a
171
<see cref="P:GongSolutions.Shell.FileNameComboBox.ShellView"/>. The control also automatically navigates
172
the ShellView control when the user types a folder path.
173
</para>
174
</remarks>
175
</member>
176
<member name="M:GongSolutions.Shell.FileNameComboBox.IsInputKey(System.Windows.Forms.Keys)">
177
<summary>
178
Determines whether the specified key is a regular input key or a
179
special key that requires preprocessing.
180
</summary>
181
182
<param name="keyData">
183
One of the <see cref="T:System.Windows.Forms.Keys"/> values.
184
</param>
185
186
<returns>
187
true if the specified key is a regular input key; otherwise, false.
188
</returns>
189
</member>
190
<member name="M:GongSolutions.Shell.FileNameComboBox.OnKeyDown(System.Windows.Forms.KeyEventArgs)">
191
<summary>
192
Raises the <see cref="E:System.Windows.Forms.Control.KeyDown"/> event.
193
</summary>
194
195
<param name="e">
196
A <see cref="T:System.Windows.Forms.KeyEventArgs"/> that contains the event data.
197
</param>
198
</member>
199
<member name="M:GongSolutions.Shell.FileNameComboBox.OnKeyPress(System.Windows.Forms.KeyPressEventArgs)">
200
<summary>
201
Raises the <see cref="E:System.Windows.Forms.Control.KeyPress"/> event.
202
</summary>
203
204
<param name="e">
205
A <see cref="T:System.Windows.Forms.KeyPressEventArgs"/> that contains the event data.
206
</param>
207
</member>
208
<member name="M:GongSolutions.Shell.FileNameComboBox.OnTextChanged(System.EventArgs)">
209
<summary>
210
Raises the <see cref="E:System.Windows.Forms.Control.TextChanged"/> event.
211
</summary>
212
213
<param name="e">
214
An <see cref="T:System.EventArgs"/> that contains the event data.
215
</param>
216
</member>
217
<member name="P:GongSolutions.Shell.FileNameComboBox.FilterControl">
218
<summary>
219
Initializes a new instance of the <see cref="T:GongSolutions.Shell.FileNameComboBox"/>
220
class.
221
</summary>
222
</member>
223
<member name="P:GongSolutions.Shell.FileNameComboBox.ShellView">
224
<summary>
225
Gets/sets the <see cref="P:GongSolutions.Shell.FileNameComboBox.ShellView"/> control that the
226
<see cref="T:GongSolutions.Shell.FileNameComboBox"/> should look for auto-completion
227
hints.
228
</summary>
229
</member>
230
<member name="E:GongSolutions.Shell.FileNameComboBox.FileNameEntered">
231
<summary>
232
Occurs when a file name is entered into the
233
<see cref="T:GongSolutions.Shell.FileNameComboBox"/> and the Return key pressed.
234
</summary>
235
</member>
236
<member name="T:GongSolutions.Shell.ShellComboBox">
237
<summary>
238
Provides a drop-down list displaying the Windows Shell namespace.
239
</summary>
240
241
<remarks>
242
The <see cref="T:GongSolutions.Shell.ShellComboBox"/> class displays a view of the Windows
243
Shell namespace in a drop-down list similar to that displayed in
244
a file open/save dialog.
245
</remarks>
246
</member>
247
<member name="M:GongSolutions.Shell.ShellComboBox.#ctor">
248
<summary>
249
Initializes a new instance of the <see cref="T:GongSolutions.Shell.ShellComboBox"/> class.
250
</summary>
251
</member>
252
<member name="P:GongSolutions.Shell.ShellComboBox.Editable">
253
<summary>
254
Gets/sets a value indicating whether the combo box is editable.
255
</summary>
256
</member>
257
<member name="P:GongSolutions.Shell.ShellComboBox.ShowFileSystemPath">
258
<summary>
259
Gets/sets a value indicating whether the full file system path
260
should be displayed in the main portion of the control.
261
</summary>
262
</member>
263
<member name="P:GongSolutions.Shell.ShellComboBox.RootFolder">
264
<summary>
265
Gets/sets the folder that the <see cref="T:GongSolutions.Shell.ShellComboBox"/> should
266
display as the root folder.
267
</summary>
268
</member>
269
<member name="P:GongSolutions.Shell.ShellComboBox.SelectedFolder">
270
<summary>
271
Gets/sets the folder currently selected in the
272
<see cref="T:GongSolutions.Shell.ShellComboBox"/>.
273
</summary>
274
</member>
275
<member name="P:GongSolutions.Shell.ShellComboBox.ShellView">
276
<summary>
277
Gets/sets a <see cref="P:GongSolutions.Shell.ShellComboBox.ShellView"/> whose navigation should be
278
controlled by the combo box.
279
</summary>
280
</member>
281
<member name="E:GongSolutions.Shell.ShellComboBox.Changed">
282
<summary>
283
Occurs when the <see cref="T:GongSolutions.Shell.ShellComboBox"/>'s
284
<see cref="P:GongSolutions.Shell.ShellComboBox.SelectedFolder"/> property changes.
285
</summary>
286
</member>
287
<member name="E:GongSolutions.Shell.ShellComboBox.FilterItem">
288
<summary>
289
Occurs when the <see cref="T:GongSolutions.Shell.ShellComboBox"/> control wants to know
290
if it should include a folder in its view.
291
</summary>
292
293
<remarks>
294
This event allows the folders displayed in the
295
<see cref="T:GongSolutions.Shell.ShellComboBox"/> control to be filtered.
296
</remarks>
297
</member>
298
<member name="T:GongSolutions.Shell.ShellItem">
299
<summary>
300
Represents an item in the Windows Shell namespace.
301
</summary>
302
</member>
303
<member name="M:GongSolutions.Shell.ShellItem.#ctor(System.Uri)">
304
<summary>
305
Initializes a new instance of the <see cref="T:GongSolutions.Shell.ShellItem"/> class.
306
</summary>
307
308
<remarks>
309
Takes a <see cref="T:System.Uri"/> containing the location of the ShellItem.
310
This constructor accepts URIs using two schemes:
311
312
- file: A file or folder in the computer's filesystem, e.g.
313
file:///D:/Folder
314
- shell: A virtual folder, or a file or folder referenced from
315
a virtual folder, e.g. shell:///Personal/file.txt
316
</remarks>
317
318
<param name="uri">
319
A <see cref="T:System.Uri"/> containing the location of the ShellItem.
320
</param>
321
</member>
322
<member name="M:GongSolutions.Shell.ShellItem.#ctor(System.String)">
323
<summary>
324
Initializes a new instance of the <see cref="T:GongSolutions.Shell.ShellItem"/> class.
325
</summary>
326
327
<remarks>
328
Takes a <see cref="T:System.String"/> containing the location of the ShellItem.
329
This constructor accepts URIs using two schemes:
330
331
- file: A file or folder in the computer's filesystem, e.g.
332
file:///D:/Folder
333
- shell: A virtual folder, or a file or folder referenced from
334
a virtual folder, e.g. shell:///Personal/file.txt
335
</remarks>
336
337
<param name="path">
338
A string containing a Uri with the location of the ShellItem.
339
</param>
340
</member>
341
<member name="M:GongSolutions.Shell.ShellItem.#ctor(System.Environment.SpecialFolder)">
342
<summary>
343
Initializes a new instance of the <see cref="T:GongSolutions.Shell.ShellItem"/> class.
344
</summary>
345
346
<remarks>
347
Takes an <see cref="T:System.Environment.SpecialFolder"/> containing the
348
location of the folder.
349
</remarks>
350
351
<param name="folder">
352
An <see cref="T:System.Environment.SpecialFolder"/> containing the
353
location of the folder.
354
</param>
355
</member>
356
<member name="M:GongSolutions.Shell.ShellItem.#ctor(GongSolutions.Shell.ShellItem,System.String)">
357
<summary>
358
Initializes a new instance of the <see cref="T:GongSolutions.Shell.ShellItem"/> class.
359
</summary>
360
361
<remarks>
362
Creates a ShellItem which is a named child of <paramref name="parent"/>.
363
</remarks>
364
365
<param name="parent">
366
The parent folder of the item.
367
</param>
368
369
<param name="name">
370
The name of the child item.
371
</param>
372
</member>
373
<member name="M:GongSolutions.Shell.ShellItem.#ctor(GongSolutions.Shell.Interop.IShellItem)">
374
<summary>
375
Initializes a new instance of the <see cref="T:GongSolutions.Shell.ShellItem"/> class.
376
</summary>
377
378
<param name="comInterface">
379
An <see cref="T:GongSolutions.Shell.Interop.IShellItem"/> representing the folder.
380
</param>
381
</member>
382
<member name="M:GongSolutions.Shell.ShellItem.Compare(GongSolutions.Shell.ShellItem)">
383
<summary>
384
Compares two <see cref="T:GongSolutions.Shell.Interop.IShellItem"/>s. The comparison is carried
385
out by display order.
386
</summary>
387
388
<param name="item">
389
The item to compare.
390
</param>
391
392
<returns>
393
0 if the two items are equal. A negative number if
394
<see langword="this"/> is before <paramref name="item"/> in
395
display order. A positive number if
396
<see langword="this"/> comes after <paramref name="item"/> in
397
display order.
398
</returns>
399
</member>
400
<member name="M:GongSolutions.Shell.ShellItem.Equals(System.Object)">
401
<summary>
402
Determines whether two <see cref="T:GongSolutions.Shell.ShellItem"/>s refer to
403
the same shell folder.
404
</summary>
405
406
<param name="obj">
407
The item to compare.
408
</param>
409
410
<returns>
411
<see langword="true"/> if the two objects refer to the same
412
folder, <see langword="false"/> otherwise.
413
</returns>
414
</member>
415
<member name="M:GongSolutions.Shell.ShellItem.GetDisplayName(GongSolutions.Shell.Interop.SIGDN)">
416
<summary>
417
Returns the name of the item in the specified style.
418
</summary>
419
420
<param name="sigdn">
421
The style of display name to return.
422
</param>
423
424
<returns>
425
A string containing the display name of the item.
426
</returns>
427
</member>
428
<member name="M:GongSolutions.Shell.ShellItem.GetEnumerator">
429
<summary>
430
Returns an enumerator detailing the child items of the
431
<see cref="T:GongSolutions.Shell.ShellItem"/>.
432
</summary>
433
434
<remarks>
435
This method returns all child item including hidden
436
items.
437
</remarks>
438
439
<returns>
440
An enumerator over all child items.
441
</returns>
442
</member>
443
<member name="M:GongSolutions.Shell.ShellItem.GetEnumerator(GongSolutions.Shell.Interop.SHCONTF)">
444
<summary>
445
Returns an enumerator detailing the child items of the
446
<see cref="T:GongSolutions.Shell.ShellItem"/>.
447
</summary>
448
449
<param name="filter">
450
A filter describing the types of child items to be included.
451
</param>
452
453
<returns>
454
An enumerator over all child items.
455
</returns>
456
</member>
457
<member name="M:GongSolutions.Shell.ShellItem.System#Collections#IEnumerable#GetEnumerator">
458
<summary>
459
Returns an enumerator detailing the child items of the
460
<see cref="T:GongSolutions.Shell.ShellItem"/>.
461
</summary>
462
463
<remarks>
464
This method returns all child item including hidden
465
items.
466
</remarks>
467
468
<returns>
469
An enumerator over all child items.
470
</returns>
471
</member>
472
<member name="M:GongSolutions.Shell.ShellItem.GetIDataObject">
473
<summary>
474
Returns an <see cref="T:System.Runtime.InteropServices.ComTypes.IDataObject"/> representing the
475
item. This object is used in drag and drop operations.
476
</summary>
477
</member>
478
<member name="M:GongSolutions.Shell.ShellItem.GetIDropTarget(System.Windows.Forms.Control)">
479
<summary>
480
Returns an <see cref="T:GongSolutions.Shell.Interop.IDropTarget"/> representing the
481
item. This object is used in drag and drop operations.
482
</summary>
483
</member>
484
<member name="M:GongSolutions.Shell.ShellItem.GetIShellFolder">
485
<summary>
486
Returns an <see cref="T:GongSolutions.Shell.Interop.IShellFolder"/> representing the
487
item.
488
</summary>
489
</member>
490
<member name="M:GongSolutions.Shell.ShellItem.GetSystemImageListIndex(GongSolutions.Shell.ShellIconType,GongSolutions.Shell.ShellIconFlags)">
491
<summary>
492
Gets the index in the system image list of the icon representing
493
the item.
494
</summary>
495
496
<param name="type">
497
The type of icon to retrieve.
498
</param>
499
500
<param name="flags">
501
Flags detailing additional information to be conveyed by the icon.
502
</param>
503
504
<returns></returns>
505
</member>
506
<member name="M:GongSolutions.Shell.ShellItem.IsImmediateParentOf(GongSolutions.Shell.ShellItem)">
507
<summary>
508
Tests whether the <see cref="T:GongSolutions.Shell.ShellItem"/> is the immediate parent
509
of another item.
510
</summary>
511
512
<param name="item">
513
The potential child item.
514
</param>
515
</member>
516
<member name="M:GongSolutions.Shell.ShellItem.IsParentOf(GongSolutions.Shell.ShellItem)">
517
<summary>
518
Tests whether the <see cref="T:GongSolutions.Shell.ShellItem"/> is the parent of
519
another item.
520
</summary>
521
522
<param name="item">
523
The potential child item.
524
</param>
525
</member>
526
<member name="M:GongSolutions.Shell.ShellItem.ToString">
527
<summary>
528
Returns a string representation of the <see cref="T:GongSolutions.Shell.ShellItem"/>.
529
</summary>
530
</member>
531
<member name="M:GongSolutions.Shell.ShellItem.ToUri">
532
<summary>
533
Returns a URI representation of the <see cref="T:GongSolutions.Shell.ShellItem"/>.
534
</summary>
535
</member>
536
<member name="M:GongSolutions.Shell.ShellItem.op_Inequality(GongSolutions.Shell.ShellItem,GongSolutions.Shell.ShellItem)">
537
<summary>
538
Tests if two <see cref="T:GongSolutions.Shell.ShellItem"/>s refer to the same folder.
539
</summary>
540
541
<param name="a">
542
The first folder.
543
</param>
544
545
<param name="b">
546
The second folder.
547
</param>
548
</member>
549
<member name="M:GongSolutions.Shell.ShellItem.op_Equality(GongSolutions.Shell.ShellItem,GongSolutions.Shell.ShellItem)">
550
<summary>
551
Tests if two <see cref="T:GongSolutions.Shell.ShellItem"/>s refer to the same folder.
552
</summary>
553
554
<param name="a">
555
The first folder.
556
</param>
557
558
<param name="b">
559
The second folder.
560
</param>
561
</member>
562
<member name="P:GongSolutions.Shell.ShellItem.Item(System.String)">
563
<summary>
564
Gets a child item.
565
</summary>
566
567
<param name="name">
568
The name of the child item.
569
</param>
570
</member>
571
<member name="P:GongSolutions.Shell.ShellItem.ComInterface">
572
<summary>
573
Gets the underlying <see cref="T:GongSolutions.Shell.Interop.IShellItem"/> COM interface.
574
</summary>
575
</member>
576
<member name="P:GongSolutions.Shell.ShellItem.DisplayName">
577
<summary>
578
Gets the normal display name of the item.
579
</summary>
580
</member>
581
<member name="P:GongSolutions.Shell.ShellItem.FileSystemPath">
582
<summary>
583
Gets the file system path of the item.
584
</summary>
585
</member>
586
<member name="P:GongSolutions.Shell.ShellItem.HasSubFolders">
587
<summary>
588
Gets a value indicating whether the item has subfolders.
589
</summary>
590
</member>
591
<member name="P:GongSolutions.Shell.ShellItem.IsFileSystem">
592
<summary>
593
Gets a value indicating whether the item is a file system item.
594
</summary>
595
</member>
596
<member name="P:GongSolutions.Shell.ShellItem.IsFileSystemAncestor">
597
<summary>
598
Gets a value indicating whether the item is a file system item
599
or the child of a file system item.
600
</summary>
601
</member>
602
<member name="P:GongSolutions.Shell.ShellItem.IsFolder">
603
<summary>
604
Gets a value indicating whether the item is a folder.
605
</summary>
606
</member>
607
<member name="P:GongSolutions.Shell.ShellItem.IsReadOnly">
608
<summary>
609
Gets a value indicating whether the item is read-only.
610
</summary>
611
</member>
612
<member name="P:GongSolutions.Shell.ShellItem.Parent">
613
<summary>
614
Gets the item's parent.
615
</summary>
616
</member>
617
<member name="P:GongSolutions.Shell.ShellItem.ParsingName">
618
<summary>
619
Gets the item's parsing name.
620
</summary>
621
</member>
622
<member name="P:GongSolutions.Shell.ShellItem.Pidl">
623
<summary>
624
Gets a PIDL representing the item.
625
</summary>
626
</member>
627
<member name="P:GongSolutions.Shell.ShellItem.ShellIcon">
628
<summary>
629
Gets the item's shell icon.
630
</summary>
631
</member>
632
<member name="P:GongSolutions.Shell.ShellItem.ToolTipText">
633
<summary>
634
Gets the item's tooltip text.
635
</summary>
636
</member>
637
<member name="P:GongSolutions.Shell.ShellItem.Desktop">
638
<summary>
639
Gets the Desktop folder.
640
</summary>
641
</member>
642
<member name="T:GongSolutions.Shell.ShellIconType">
643
<summary>
644
Enumerates the types of shell icons.
645
</summary>
646
</member>
647
<member name="F:GongSolutions.Shell.ShellIconType.LargeIcon">
648
<summary>The system large icon type</summary>
649
</member>
650
<member name="F:GongSolutions.Shell.ShellIconType.ShellIcon">
651
<summary>The system shell icon type</summary>
652
</member>
653
<member name="F:GongSolutions.Shell.ShellIconType.SmallIcon">
654
<summary>The system small icon type</summary>
655
</member>
656
<member name="T:GongSolutions.Shell.ShellIconFlags">
657
<summary>
658
Enumerates the optional styles that can be applied to shell icons.
659
</summary>
660
</member>
661
<member name="F:GongSolutions.Shell.ShellIconFlags.OpenIcon">
662
<summary>The icon is displayed opened.</summary>
663
</member>
664
<member name="F:GongSolutions.Shell.ShellIconFlags.OverlayIndex">
665
<summary>Get the overlay for the icon as well.</summary>
666
</member>
667
<member name="T:GongSolutions.Shell.ShellContextMenu">
668
<summary>
669
Provides support for displaying the context menu of a shell item.
670
</summary>
671
672
<remarks>
673
<para>
674
Use this class to display a context menu for a shell item, either
675
as a popup menu, or as a main menu.
676
</para>
677
678
<para>
679
To display a popup menu, simply call <see cref="M:GongSolutions.Shell.ShellContextMenu.ShowContextMenu(System.Windows.Forms.Control,System.Drawing.Point)"/>
680
with the parent control and the position at which the menu should
681
be shown.
682
</para>
683
684
<para>
685
To display a shell context menu in a Form's main menu, call the
686
<see cref="M:GongSolutions.Shell.ShellContextMenu.Populate(System.Windows.Forms.Menu)"/> method to populate the menu. In addition,
687
you must intercept a number of special messages that will be sent
688
to the menu's parent form. To do this, you must override
689
<see cref="M:System.Windows.Forms.Form.WndProc(System.Windows.Forms.Message@)"/> like so:
690
</para>
691
692
<code>
693
protected override void WndProc(ref Message m) {
694
if ((m_ContextMenu == null) || (!m_ContextMenu.HandleMenuMessage(ref m))) {
695
base.WndProc(ref m);
696
}
697
}
698
</code>
699
700
<para>
701
Where m_ContextMenu is the <see cref="T:GongSolutions.Shell.ShellContextMenu"/> being shown.
702
</para>
703
704
Standard menu commands can also be invoked from this class, for
705
example <see cref="M:GongSolutions.Shell.ShellContextMenu.InvokeDelete"/> and <see cref="M:GongSolutions.Shell.ShellContextMenu.InvokeRename"/>.
706
</remarks>
707
</member>
708
<member name="M:GongSolutions.Shell.ShellContextMenu.#ctor(GongSolutions.Shell.ShellItem)">
709
<summary>
710
Initialises a new instance of the <see cref="T:GongSolutions.Shell.ShellContextMenu"/>
711
class.
712
</summary>
713
714
<param name="item">
715
The item to which the context menu should refer.
716
</param>
717
</member>
718
<member name="M:GongSolutions.Shell.ShellContextMenu.#ctor(GongSolutions.Shell.ShellItem[])">
719
<summary>
720
Initialises a new instance of the <see cref="T:GongSolutions.Shell.ShellContextMenu"/>
721
class.
722
</summary>
723
724
<param name="items">
725
The items to which the context menu should refer.
726
</param>
727
</member>
728
<member name="M:GongSolutions.Shell.ShellContextMenu.HandleMenuMessage(System.Windows.Forms.Message@)">
729
<summary>
730
Handles context menu messages when the <see cref="T:GongSolutions.Shell.ShellContextMenu"/>
731
is displayed on a Form's main menu bar.
732
</summary>
733
734
<remarks>
735
<para>
736
To display a shell context menu in a Form's main menu, call the
737
<see cref="M:GongSolutions.Shell.ShellContextMenu.Populate(System.Windows.Forms.Menu)"/> method to populate the menu with the shell
738
item's menu items. In addition, you must intercept a number of
739
special messages that will be sent to the menu's parent form. To
740
do this, you must override <see cref="M:System.Windows.Forms.Form.WndProc(System.Windows.Forms.Message@)"/> like so:
741
</para>
742
743
<code>
744
protected override void WndProc(ref Message m) {
745
if ((m_ContextMenu == null) || (!m_ContextMenu.HandleMenuMessage(ref m))) {
746
base.WndProc(ref m);
747
}
748
}
749
</code>
750
751
<para>
752
Where m_ContextMenu is the <see cref="T:GongSolutions.Shell.ShellContextMenu"/> being shown.
753
</para>
754
</remarks>
755
756
<param name="m">
757
The message to handle.
758
</param>
759
760
<returns>
761
<see langword="true"/> if the message was a Shell Context Menu
762
message, <see langword="false"/> if not. If the method returns false,
763
then the message should be passed down to the base class's
764
<see cref="M:System.Windows.Forms.Form.WndProc(System.Windows.Forms.Message@)"/> method.
765
</returns>
766
</member>
767
<member name="M:GongSolutions.Shell.ShellContextMenu.InvokeDelete">
768
<summary>
769
Invokes the Delete command on the shell item.
770
</summary>
771
</member>
772
<member name="M:GongSolutions.Shell.ShellContextMenu.InvokeRename">
773
<summary>
774
Invokes the Rename command on the shell item.
775
</summary>
776
</member>
777
<member name="M:GongSolutions.Shell.ShellContextMenu.Populate(System.Windows.Forms.Menu)">
778
<summary>
779
Populates a <see cref="T:System.Windows.Forms.Menu"/> with the context menu items for
780
a shell item.
781
</summary>
782
783
<remarks>
784
If this method is being used to populate a Form's main menu
785
then you need to call <see cref="M:GongSolutions.Shell.ShellContextMenu.HandleMenuMessage(System.Windows.Forms.Message@)"/> in the
786
Form's message handler.
787
</remarks>
788
789
<param name="menu">
790
The menu to populate.
791
</param>
792
</member>
793
<member name="M:GongSolutions.Shell.ShellContextMenu.ShowContextMenu(System.Windows.Forms.Control,System.Drawing.Point)">
794
<summary>
795
Shows a context menu for a shell item.
796
</summary>
797
798
<param name="control">
799
The parent control.
800
</param>
801
802
<param name="pos">
803
The position on <paramref name="control"/> that the menu
804
should be displayed at.
805
</param>
806
</member>
807
<member name="P:GongSolutions.Shell.ShellContextMenu.ComInterface">
808
<summary>
809
Gets the underlying COM <see cref="T:GongSolutions.Shell.Interop.IContextMenu"/> interface.
810
</summary>
811
</member>
812
<member name="T:GongSolutions.Shell.Properties.Resources">
813
<summary>
814
A strongly-typed resource class, for looking up localized strings, etc.
815
</summary>
816
</member>
817
<member name="P:GongSolutions.Shell.Properties.Resources.ResourceManager">
818
<summary>
819
Returns the cached ResourceManager instance used by this class.
820
</summary>
821
</member>
822
<member name="P:GongSolutions.Shell.Properties.Resources.Culture">
823
<summary>
824
Overrides the current thread's CurrentUICulture property for all
825
resource lookups using this strongly typed resource class.
826
</summary>
827
</member>
828
<member name="T:GongSolutions.Shell.FileDialogToolbar">
829
<summary>
830
Provides a toolbar suitable for use in file Open/Save dialogs.
831
</summary>
832
833
<remarks>
834
This control provides a toolbar containing a
835
<see cref="T:GongSolutions.Shell.ShellComboBox"/> and the various navigation buttons as
836
found in a standard file dialog. By setting the
837
<see cref="P:GongSolutions.Shell.FileDialogToolbar.ShellView"/> property, the toolbar will automatically
838
control the navigation of a ShellView&gt; control in response to the
839
user's actions.
840
</remarks>
841
</member>
842
<member name="F:GongSolutions.Shell.FileDialogToolbar.components">
843
<summary>
844
Required designer variable.
845
</summary>
846
</member>
847
<member name="M:GongSolutions.Shell.FileDialogToolbar.Dispose(System.Boolean)">
848
<summary>
849
Clean up any resources being used.
850
</summary>
851
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
852
</member>
853
<member name="M:GongSolutions.Shell.FileDialogToolbar.InitializeComponent">
854
<summary>
855
Required method for Designer support - do not modify
856
the contents of this method with the code editor.
857
</summary>
858
</member>
859
<member name="M:GongSolutions.Shell.FileDialogToolbar.#ctor">
860
<summary>
861
Initializes a new instance of the FileDialogToolbar control.
862
</summary>
863
</member>
864
<member name="P:GongSolutions.Shell.FileDialogToolbar.RootFolder">
865
<summary>
866
Gets/sets the root folder displayed in the toolbar's drop-down
867
folder list.
868
</summary>
869
</member>
870
<member name="P:GongSolutions.Shell.FileDialogToolbar.SelectedFolder">
871
<summary>
872
Gets/sets the folder currently selected in the toolbar's combo box.
873
</summary>
874
</member>
875
<member name="P:GongSolutions.Shell.FileDialogToolbar.ShellView">
876
<summary>
877
Gets/sets a <see cref="P:GongSolutions.Shell.FileDialogToolbar.ShellView"/> whose navigation should be
878
controlled by the toolbar.
879
</summary>
880
</member>
881
<member name="E:GongSolutions.Shell.FileDialogToolbar.FilterItem">
882
<summary>
883
Occurs when the <see cref="T:GongSolutions.Shell.FileDialogToolbar"/> needs to know
884
what items it should display in its drop-down list.
885
</summary>
886
</member>
887
<member name="T:GongSolutions.Shell.FileFilterComboBox">
888
<summary>
889
A file-filter combo box suitable for use in open/save file dialogs.
890
</summary>
891
892
<remarks>
893
<para>
894
This control extends the <see cref="T:System.Windows.Forms.ComboBox"/> class to provide
895
automatic filtering of shell items according to wildcard patterns.
896
By setting the control's <see cref="P:GongSolutions.Shell.FileFilterComboBox.ShellView"/> property, the control
897
will automatically filter items in a ShellView.
898
</para>
899
900
<para>
901
The <see cref="P:GongSolutions.Shell.FileFilterComboBox.FilterItems"/> property accepts a filter string
902
similar to that accepted by the standard <see cref="T:System.Windows.Forms.FileDialog"/>
903
class, for example:
904
<b>"Text files (*.txt)|*.txt|All files (*.*)|*.*"</b>
905
</para>
906
907
<para>
908
The currently selected filter is selected by the <see cref="P:GongSolutions.Shell.FileFilterComboBox.Filter"/>
909
property. This should be set to one of the filter patterns specified
910
in <see cref="P:GongSolutions.Shell.FileFilterComboBox.FilterItems"/>, e.g. <b>"*.txt"</b>.
911
</para>
912
</remarks>
913
</member>
914
<member name="M:GongSolutions.Shell.FileFilterComboBox.#ctor">
915
<summary>
916
Initializes a new instance of the <see cref="T:GongSolutions.Shell.FileFilterComboBox"/>
917
class.
918
</summary>
919
</member>
920
<member name="M:GongSolutions.Shell.FileFilterComboBox.GenerateRegex(System.String)">
921
<summary>
922
Generates a <see cref="T:System.Text.RegularExpressions.Regex"/> object equivalent to the
923
provided wildcard.
924
</summary>
925
926
<param name="wildcard">
927
The wildcard to generate a regex for.
928
</param>
929
930
<returns>
931
A regex equivalent to the wildcard.
932
</returns>
933
</member>
934
<member name="M:GongSolutions.Shell.FileFilterComboBox.OnTextChanged(System.EventArgs)">
935
<summary>
936
Raises the <see cref="E:System.Windows.Forms.Control.TextChanged"/> event.
937
</summary>
938
939
<param name="e">
940
An EventArgs that contains the event data.
941
</param>
942
</member>
943
<member name="P:GongSolutions.Shell.FileFilterComboBox.Filter">
944
<summary>
945
Gets or sets the current filter string, which determines the
946
items that appear in the control's <see cref="P:GongSolutions.Shell.FileFilterComboBox.ShellView"/>.
947
</summary>
948
</member>
949
<member name="P:GongSolutions.Shell.FileFilterComboBox.DropDownStyle">
950
<summary>
951
This property does not apply to <see cref="T:GongSolutions.Shell.FileFilterComboBox"/>.
952
</summary>
953
</member>
954
<member name="P:GongSolutions.Shell.FileFilterComboBox.FilterItems">
955
<summary>
956
Gets/sets the filter string which determines the choices that
957
appear in the control's drop-down list.
958
</summary>
959
960
<remarks>
961
<para>
962
For each filtering option, the filter string contains a
963
description of the filter, followed by the vertical bar (|) and
964
the filter pattern. The strings for different filtering options
965
are separated by the vertical bar.
966
</para>
967
968
<para>
969
If the filter itself does not appear in the description then
970
it will be automatically added when the control is displayed.
971
For example, in the example below the "Video files" entry will
972
be displayed as "Video files (*.avi, *.wmv)". Beacuse the "All
973
files" entry already has the filter string present in its
974
description, it will not be added again.
975
</para>
976
977
<para>
978
<example>
979
"Video files|*.avi, *.wmv|All files (*.*)|*.*"
980
</example>
981
</para>
982
</remarks>
983
</member>
984
<member name="P:GongSolutions.Shell.FileFilterComboBox.Items">
985
<summary>
986
This property does not apply to <see cref="T:GongSolutions.Shell.FileFilterComboBox"/>.
987
</summary>
988
</member>
989
<member name="P:GongSolutions.Shell.FileFilterComboBox.ShellView">
990
<summary>
991
Gets/sets the <see cref="P:GongSolutions.Shell.FileFilterComboBox.ShellView"/> control that the
992
<see cref="T:GongSolutions.Shell.FileFilterComboBox"/> should filter the items of.
993
</summary>
994
</member>
995
<member name="T:GongSolutions.Shell.ShellTreeView">
996
<summary>
997
Provides a tree view of a computer's folders.
998
</summary>
999
1000
<remarks>
1001
<para>
1002
The <see cref="T:GongSolutions.Shell.ShellTreeView"/> control allows you to embed Windows
1003
Explorer functionality in your Windows Forms applications. The
1004
control provides a tree view of the computer's folders, as it would
1005
appear in the left-hand pane in Explorer.
1006
</para>
1007
</remarks>
1008
</member>
1009
<member name="M:GongSolutions.Shell.ShellTreeView.#ctor">
1010
<summary>
1011
Initializes a new instance of the <see cref="T:GongSolutions.Shell.ShellTreeView"/> class.
1012
</summary>
1013
</member>
1014
<member name="M:GongSolutions.Shell.ShellTreeView.RefreshContents">
1015
<summary>
1016
Refreses the contents of the <see cref="T:GongSolutions.Shell.ShellTreeView"/>.
1017
</summary>
1018
</member>
1019
<member name="P:GongSolutions.Shell.ShellTreeView.AllowDrop">
1020
<summary>
1021
Gets/sets a value indicating whether drag/drop operations are
1022
allowed on the control.
1023
</summary>
1024
</member>
1025
<member name="P:GongSolutions.Shell.ShellTreeView.HotTracking">
1026
<summary>
1027
Gets or sets a value indicating whether a tree node label takes on
1028
the appearance of a hyperlink as the mouse pointer passes over it.
1029
</summary>
1030
</member>
1031
<member name="P:GongSolutions.Shell.ShellTreeView.RootFolder">
1032
<summary>
1033
Gets or sets the root folder that is displayed in the
1034
<see cref="T:GongSolutions.Shell.ShellTreeView"/>.
1035
</summary>
1036
</member>
1037
<member name="P:GongSolutions.Shell.ShellTreeView.ShellView">
1038
<summary>
1039
Gets/sets a <see cref="P:GongSolutions.Shell.ShellTreeView.ShellView"/> whose navigation should be
1040
controlled by the treeview.
1041
</summary>
1042
</member>
1043
<member name="P:GongSolutions.Shell.ShellTreeView.SelectedFolder">
1044
<summary>
1045
Gets or sets the selected folder in the
1046
<see cref="T:GongSolutions.Shell.ShellTreeView"/>.
1047
</summary>
1048
</member>
1049
<member name="P:GongSolutions.Shell.ShellTreeView.ShowHidden">
1050
<summary>
1051
Gets or sets a value indicating whether hidden folders should
1052
be displayed in the tree.
1053
</summary>
1054
</member>
1055
<member name="E:GongSolutions.Shell.ShellTreeView.SelectionChanged">
1056
<summary>
1057
Occurs when the <see cref="P:GongSolutions.Shell.ShellTreeView.SelectedFolder"/> property changes.
1058
</summary>
1059
</member>
1060
<member name="P:GongSolutions.Shell.ShellTreeView.Text">
1061
<summary>
1062
This property does not apply to the <see cref="T:GongSolutions.Shell.ShellTreeView"/>
1063
class.
1064
</summary>
1065
</member>
1066
<member name="T:GongSolutions.Shell.ShowHidden">
1067
Describes whether hidden files/folders should be displayed in a
1068
control.
1069
</member>
1070
<member name="F:GongSolutions.Shell.ShowHidden.False">
1071
<summary>
1072
Hidden files/folders should not be displayed.
1073
</summary>
1074
</member>
1075
<member name="F:GongSolutions.Shell.ShowHidden.True">
1076
<summary>
1077
Hidden files/folders should be displayed.
1078
</summary>
1079
</member>
1080
<member name="F:GongSolutions.Shell.ShowHidden.System">
1081
<summary>
1082
The Windows Explorer "Show hidden files" setting should be used
1083
to determine whether to show hidden files/folders.
1084
</summary>
1085
</member>
1086
<member name="T:GongSolutions.Shell.ShellNotificationListener">
1087
<summary>
1088
Listens for notifications of changes in the Windows Shell Namespace.
1089
</summary>
1090
</member>
1091
<member name="M:GongSolutions.Shell.ShellNotificationListener.#ctor">
1092
<summary>
1093
Initializes a new instance of the
1094
<see cref="T:GongSolutions.Shell.ShellNotificationListener"/> class.
1095
</summary>
1096
</member>
1097
<member name="M:GongSolutions.Shell.ShellNotificationListener.#ctor(System.ComponentModel.IContainer)">
1098
<summary>
1099
Initializes a new instance of the
1100
<see cref="T:GongSolutions.Shell.ShellNotificationListener"/> class.
1101
</summary>
1102
</member>
1103
<member name="M:GongSolutions.Shell.ShellNotificationListener.Dispose(System.Boolean)">
1104
<summary>
1105
Overrides the <see cref="M:System.ComponentModel.Component.Dispose(System.Boolean)"/> method.
1106
</summary>
1107
<param name="disposing"/>
1108
</member>
1109
<member name="E:GongSolutions.Shell.ShellNotificationListener.DriveAdded">
1110
<summary>
1111
Occurs when a drive is added.
1112
</summary>
1113
</member>
1114
<member name="E:GongSolutions.Shell.ShellNotificationListener.DriveRemoved">
1115
<summary>
1116
Occurs when a drive is removed.
1117
</summary>
1118
</member>
1119
<member name="E:GongSolutions.Shell.ShellNotificationListener.FolderCreated">
1120
<summary>
1121
Occurs when a folder is created.
1122
</summary>
1123
</member>
1124
<member name="E:GongSolutions.Shell.ShellNotificationListener.FolderDeleted">
1125
<summary>
1126
Occurs when a folder is deleted.
1127
</summary>
1128
</member>
1129
<member name="E:GongSolutions.Shell.ShellNotificationListener.FolderRenamed">
1130
<summary>
1131
Occurs when a folder is renamed.
1132
</summary>
1133
</member>
1134
<member name="E:GongSolutions.Shell.ShellNotificationListener.FolderUpdated">
1135
<summary>
1136
Occurs when a folder's contents are updated.
1137
</summary>
1138
</member>
1139
<member name="E:GongSolutions.Shell.ShellNotificationListener.ItemCreated">
1140
<summary>
1141
Occurs when a non-folder item is created.
1142
</summary>
1143
</member>
1144
<member name="E:GongSolutions.Shell.ShellNotificationListener.ItemDeleted">
1145
<summary>
1146
Occurs when a non-folder item is deleted.
1147
</summary>
1148
</member>
1149
<member name="E:GongSolutions.Shell.ShellNotificationListener.ItemRenamed">
1150
<summary>
1151
Occurs when a non-folder item is renamed.
1152
</summary>
1153
</member>
1154
<member name="E:GongSolutions.Shell.ShellNotificationListener.ItemUpdated">
1155
<summary>
1156
Occurs when a non-folder item is updated.
1157
</summary>
1158
</member>
1159
<member name="E:GongSolutions.Shell.ShellNotificationListener.SharingChanged">
1160
<summary>
1161
Occurs when the shared state for a folder changes.
1162
</summary>
1163
</member>
1164
<member name="T:GongSolutions.Shell.ShellItemEventArgs">
1165
<summary>
1166
Provides information of changes in the Windows Shell Namespace.
1167
</summary>
1168
</member>
1169
<member name="M:GongSolutions.Shell.ShellItemEventArgs.#ctor(GongSolutions.Shell.ShellItem)">
1170
<summary>
1171
Initializes a new instance of the
1172
<see cref="T:GongSolutions.Shell.ShellItemEventArgs"/> class.
1173
</summary>
1174
1175
<param name="item">
1176
The ShellItem that has changed.
1177
</param>
1178
</member>
1179
<member name="P:GongSolutions.Shell.ShellItemEventArgs.Item">
1180
<summary>
1181
The ShellItem that has changed.
1182
</summary>
1183
</member>
1184
<member name="T:GongSolutions.Shell.ShellItemChangeEventArgs">
1185
<summary>
1186
Provides information of changes in the Windows Shell Namespace.
1187
</summary>
1188
</member>
1189
<member name="M:GongSolutions.Shell.ShellItemChangeEventArgs.#ctor(GongSolutions.Shell.ShellItem,GongSolutions.Shell.ShellItem)">
1190
<summary>
1191
Initializes a new instance of the
1192
<see cref="T:GongSolutions.Shell.ShellItemChangeEventArgs"/> class.
1193
</summary>
1194
1195
<param name="oldItem">
1196
The ShellItem before the change
1197
</param>
1198
1199
<param name="newItem">
1200
The ShellItem after the change
1201
</param>
1202
</member>
1203
<member name="P:GongSolutions.Shell.ShellItemChangeEventArgs.OldItem">
1204
<summary>
1205
The ShellItem before the change.
1206
</summary>
1207
</member>
1208
<member name="P:GongSolutions.Shell.ShellItemChangeEventArgs.NewItem">
1209
<summary>
1210
The ShellItem after the change.
1211
</summary>
1212
</member>
1213
<member name="T:GongSolutions.Shell.ShellItemEventHandler">
1214
<summary>
1215
Represents the method that handles change notifications from
1216
<see cref="T:GongSolutions.Shell.ShellNotificationListener"/>
1217
</summary>
1218
1219
<param name="sender">
1220
The source of the event.
1221
</param>
1222
1223
<param name="e">
1224
A <see cref="T:GongSolutions.Shell.ShellItemEventArgs"/> that contains the data
1225
for the event.
1226
</param>
1227
</member>
1228
<member name="T:GongSolutions.Shell.ShellItemChangeEventHandler">
1229
<summary>
1230
Represents the method that handles change notifications from
1231
<see cref="T:GongSolutions.Shell.ShellNotificationListener"/>
1232
</summary>
1233
1234
<param name="sender">
1235
The source of the event.
1236
</param>
1237
1238
<param name="e">
1239
A <see cref="T:GongSolutions.Shell.ShellItemChangeEventArgs"/> that contains the data
1240
for the event.
1241
</param>
1242
</member>
1243
<member name="T:GongSolutions.Shell.ShellViewStyle">
1244
<summary>
1245
Specifies how list items are displayed in a <see cref="T:GongSolutions.Shell.ShellView"/>
1246
control.
1247
</summary>
1248
</member>
1249
<member name="F:GongSolutions.Shell.ShellViewStyle.LargeIcon">
1250
<summary>
1251
Each item appears as a full-sized icon with a label below it.
1252
</summary>
1253
</member>
1254
<member name="F:GongSolutions.Shell.ShellViewStyle.SmallIcon">
1255
<summary>
1256
Each item appears as a small icon with a label to its right.
1257
</summary>
1258
</member>
1259
<member name="F:GongSolutions.Shell.ShellViewStyle.List">
1260
<summary>
1261
Each item appears as a small icon with a label to its right.
1262
Items are arranged in columns with no column headers.
1263
</summary>
1264
</member>
1265
<member name="F:GongSolutions.Shell.ShellViewStyle.Details">
1266
<summary>
1267
Each item appears on a separate line with further information
1268
about each item arranged in columns. The left-most column
1269
contains a small icon and label.
1270
</summary>
1271
</member>
1272
<member name="F:GongSolutions.Shell.ShellViewStyle.Thumbnail">
1273
<summary>
1274
Each item appears with a thumbnail picture of the file's content.
1275
</summary>
1276
</member>
1277
<member name="F:GongSolutions.Shell.ShellViewStyle.Tile">
1278
<summary>
1279
Each item appears as a full-sized icon with the item label and
1280
file information to the right of it.
1281
</summary>
1282
</member>
1283
<member name="F:GongSolutions.Shell.ShellViewStyle.Thumbstrip">
1284
<summary>
1285
Each item appears in a thumbstrip at the bottom of the control,
1286
with a large preview of the seleted item appearing above.
1287
</summary>
1288
</member>
1289
<member name="T:GongSolutions.Shell.ShellView">
1290
<summary>
1291
Provides a view of a computer's files and folders.
1292
</summary>
1293
1294
<remarks>
1295
<para>
1296
The <see cref="T:GongSolutions.Shell.ShellView"/> control allows you to embed Windows
1297
Explorer functionality in your Windows Forms applications. The
1298
control provides a view of a single folder's contents, as it would
1299
appear in the right-hand pane in Explorer.
1300
</para>
1301
1302
<para>
1303
When a new <see cref="T:GongSolutions.Shell.ShellView"/> control is added to a form,
1304
it displays the contents of the Desktop folder. Other folders
1305
can be displayed by calling one of the Navigate methods or setting
1306
the <see cref="P:GongSolutions.Shell.ShellView.CurrentFolder"/> property.
1307
</para>
1308
</remarks>
1309
</member>
1310
<member name="M:GongSolutions.Shell.ShellView.#ctor">
1311
<summary>
1312
Initializes a new instance of the <see cref="T:GongSolutions.Shell.ShellView"/> class.
1313
</summary>
1314
</member>
1315
<member name="M:GongSolutions.Shell.ShellView.CreateNewFolder">
1316
<summary>
1317
Creates a new folder in the folder currently being browsed.
1318
</summary>
1319
</member>
1320
<member name="M:GongSolutions.Shell.ShellView.DeleteSelectedItems">
1321
<summary>
1322
Deletes the item currently selected in the <see cref="T:GongSolutions.Shell.ShellView"/>.
1323
</summary>
1324
</member>
1325
<member name="M:GongSolutions.Shell.ShellView.Navigate(GongSolutions.Shell.ShellItem)">
1326
<summary>
1327
Navigates to the specified <see cref="P:GongSolutions.Shell.ShellView.ShellItem"/>.
1328
</summary>
1329
1330
<param name="folder">
1331
The folder to navigate to.
1332
</param>
1333
</member>
1334
<member name="M:GongSolutions.Shell.ShellView.Navigate(System.String)">
1335
<summary>
1336
Navigates to the specified filesystem directory.
1337
</summary>
1338
1339
<param name="path">
1340
The path of the directory to navigate to.
1341
</param>
1342
1343
<exception cref="T:System.IO.DirectoryNotFoundException">
1344
<paramref name="path"/> is not a valid folder.
1345
</exception>
1346
</member>
1347
<member name="M:GongSolutions.Shell.ShellView.Navigate(System.Environment.SpecialFolder)">
1348
<summary>
1349
Navigates to the specified standard location.
1350
</summary>
1351
1352
<param name="location">
1353
The <see cref="T:System.Environment.SpecialFolder"/> to which to navigate.
1354
</param>
1355
1356
<remarks>
1357
Standard locations are virtual folders which may be located in
1358
different places in different versions of Windows. For example
1359
the "My Documents" folder is normally located at C:\My Documents
1360
on Windows 98, but is located in the user's "Documents and
1361
Settings" folder in Windows XP. Using a standard
1362
<see cref="T:System.Environment.SpecialFolder"/> to refer to such folders
1363
ensures that your application will behave correctly on all
1364
versions of Windows.
1365
</remarks>
1366
</member>
1367
<member name="M:GongSolutions.Shell.ShellView.NavigateBack">
1368
<summary>
1369
Navigates the <see cref="T:GongSolutions.Shell.ShellView"/> control to the previous folder
1370
in the navigation history.
1371
</summary>
1372
1373
<remarks>
1374
<para>
1375
The WebBrowser control maintains a history list of all the folders
1376
visited during a session. You can use the <see cref="M:GongSolutions.Shell.ShellView.NavigateBack"/>
1377
method to implement a <b>Back</b> button similar to the one in
1378
Windows Explorer, which will allow your users to return to a
1379
previous folder in the navigation history.
1380
</para>
1381
1382
<para>
1383
Use the <see cref="P:GongSolutions.Shell.ShellView.CanNavigateBack"/> property to determine whether
1384
the navigation history is available and contains a previous page.
1385
This property is useful, for example, to change the enabled state
1386
of a Back button when the ShellView control navigates to or leaves
1387
the beginning of the navigation history.
1388
</para>
1389
</remarks>
1390
1391
<exception cref="T:System.InvalidOperationException">
1392
There is no history to navigate backwards through.
1393
</exception>
1394
</member>
1395
<member name="M:GongSolutions.Shell.ShellView.NavigateBack(GongSolutions.Shell.ShellItem)">
1396
<summary>
1397
Navigates the <see cref="T:GongSolutions.Shell.ShellView"/> control backwards to the
1398
requested folder in the navigation history.
1399
</summary>
1400
1401
<remarks>
1402
The WebBrowser control maintains a history list of all the folders
1403
visited during a session. You can use the <see cref="M:GongSolutions.Shell.ShellView.NavigateBack"/>
1404
method to implement a drop-down menu on a <b>Back</b> button similar
1405
to the one in Windows Explorer, which will allow your users to return
1406
to a previous folder in the navigation history.
1407
</remarks>
1408
1409
<param name="folder">
1410
The folder to navigate to.
1411
</param>
1412
1413
<exception cref="T:System.Exception">
1414
The requested folder is not present in the
1415
<see cref="T:GongSolutions.Shell.ShellView"/>'s 'back' history.
1416
</exception>
1417
</member>
1418
<member name="M:GongSolutions.Shell.ShellView.NavigateForward">
1419
<summary>
1420
Navigates the <see cref="T:GongSolutions.Shell.ShellView"/> control to the next folder
1421
in the navigation history.
1422
</summary>
1423
1424
<remarks>
1425
<para>
1426
The WebBrowser control maintains a history list of all the folders
1427
visited during a session. You can use the <see cref="M:GongSolutions.Shell.ShellView.NavigateForward"/>
1428
method to implement a <b>Forward</b> button similar to the one
1429
in Windows Explorer, allowing your users to return to the next
1430
folder in the navigation history after navigating backward.
1431
</para>
1432
1433
<para>
1434
Use the <see cref="P:GongSolutions.Shell.ShellView.CanNavigateForward"/> property to determine
1435
whether the navigation history is available and contains a folder
1436
located after the current one. This property is useful, for
1437
example, to change the enabled state of a <b>Forward</b> button
1438
when the ShellView control navigates to or leaves the end of the
1439
navigation history.
1440
</para>
1441
</remarks>
1442
1443
<exception cref="T:System.InvalidOperationException">
1444
There is no history to navigate forwards through.
1445
</exception>
1446
</member>
1447
<member name="M:GongSolutions.Shell.ShellView.NavigateForward(GongSolutions.Shell.ShellItem)">
1448
<summary>
1449
Navigates the <see cref="T:GongSolutions.Shell.ShellView"/> control forwards to the
1450
requested folder in the navigation history.
1451
</summary>
1452
1453
<remarks>
1454
The WebBrowser control maintains a history list of all the folders
1455
visited during a session. You can use the
1456
<see cref="M:GongSolutions.Shell.ShellView.NavigateForward"/> method to implement a drop-down menu
1457
on a <b>Forward</b> button similar to the one in Windows Explorer,
1458
which will allow your users to return to a folder in the 'forward'
1459
navigation history.
1460
</remarks>
1461
1462
<param name="folder">
1463
The folder to navigate to.
1464
</param>
1465
1466
<exception cref="T:System.Exception">
1467
The requested folder is not present in the
1468
<see cref="T:GongSolutions.Shell.ShellView"/>'s 'forward' history.
1469
</exception>
1470
</member>
1471
<member name="M:GongSolutions.Shell.ShellView.NavigateParent">
1472
<summary>
1473
Navigates to the parent of the currently displayed folder.
1474
</summary>
1475
</member>
1476
<member name="M:GongSolutions.Shell.ShellView.NavigateSelectedFolder">
1477
<summary>
1478
Navigates to the folder currently selected in the
1479
<see cref="T:GongSolutions.Shell.ShellView"/>.
1480
</summary>
1481
1482
<remarks>
1483
If the <see cref="T:GongSolutions.Shell.ShellView"/>'s <see cref="P:GongSolutions.Shell.ShellView.MultiSelect"/>
1484
property is set, and more than one item is selected in the
1485
ShellView, the first Folder found will be navigated to.
1486
</remarks>
1487
1488
<returns>
1489
<see langword="true"/> if a selected folder could be
1490
navigated to, <see langword="false"/> otherwise.
1491
</returns>
1492
</member>
1493
<member name="M:GongSolutions.Shell.ShellView.RefreshContents">
1494
<summary>
1495
Refreshes the contents of the <see cref="T:GongSolutions.Shell.ShellView"/>.
1496
</summary>
1497
</member>
1498
<member name="M:GongSolutions.Shell.ShellView.RenameSelectedItem">
1499
<summary>
1500
Begins a rename on the item currently selected in the
1501
<see cref="T:GongSolutions.Shell.ShellView"/>.
1502
</summary>
1503
</member>
1504
<member name="M:GongSolutions.Shell.ShellView.SelectAll">
1505
<summary>
1506
Selects all items in the <see cref="T:GongSolutions.Shell.ShellView"/>.
1507
</summary>
1508
</member>
1509
<member name="M:GongSolutions.Shell.ShellView.Dispose(System.Boolean)">
1510
<summary>
1511
Overrides <see cref="M:System.Windows.Forms.Control.Dispose(System.Boolean)"/>
1512
</summary>
1513
1514
<param name="disposing"/>
1515
</member>
1516
<member name="M:GongSolutions.Shell.ShellView.OnCreateControl">
1517
<summary>
1518
Creates the actual shell view control.
1519
</summary>
1520
</member>
1521
<member name="M:GongSolutions.Shell.ShellView.OnPreviewKeyDown(System.Windows.Forms.PreviewKeyDownEventArgs)">
1522
<summary>
1523
Overrides <see cref="M:System.Windows.Forms.Control.OnPreviewKeyDown(System.Windows.Forms.PreviewKeyDownEventArgs)"/>.
1524
</summary>
1525
1526
<param name="e"/>
1527
<returns/>
1528
</member>
1529
<member name="M:GongSolutions.Shell.ShellView.OnResize(System.EventArgs)">
1530
<summary>
1531
Overrides <see cref="M:System.Windows.Forms.Control.OnResize(System.EventArgs)"/>.
1532
</summary>
1533
1534
<param name="eventargs"/>
1535
</member>
1536
<member name="M:GongSolutions.Shell.ShellView.PreProcessMessage(System.Windows.Forms.Message@)">
1537
<summary>
1538
Overrides <see cref="M:System.Windows.Forms.Control.PreProcessMessage(System.Windows.Forms.Message@)"/>
1539
</summary>
1540
1541
<param name="msg"/>
1542
<returns/>
1543
</member>
1544
<member name="M:GongSolutions.Shell.ShellView.WndProc(System.Windows.Forms.Message@)">
1545
<summary>
1546
Overrides <see cref="M:System.Windows.Forms.Control.WndProc(System.Windows.Forms.Message@)"/>
1547
</summary>
1548
<param name="m"/>
1549
</member>
1550
<member name="P:GongSolutions.Shell.ShellView.CanCreateFolder">
1551
<summary>
1552
Gets a value indicating whether a new folder can be created in
1553
the folder currently being browsed by th <see cref="T:GongSolutions.Shell.ShellView"/>.
1554
</summary>
1555
</member>
1556
<member name="P:GongSolutions.Shell.ShellView.CanNavigateBack">
1557
<summary>
1558
Gets a value indicating whether a previous page in navigation
1559
history is available, which allows the <see cref="M:GongSolutions.Shell.ShellView.NavigateBack"/>
1560
method to succeed.
1561
</summary>
1562
</member>
1563
<member name="P:GongSolutions.Shell.ShellView.CanNavigateForward">
1564
<summary>
1565
Gets a value indicating whether a subsequent page in navigation
1566
history is available, which allows the <see cref="M:GongSolutions.Shell.ShellView.NavigateForward"/>
1567
method to succeed.
1568
</summary>
1569
</member>
1570
<member name="P:GongSolutions.Shell.ShellView.CanNavigateParent">
1571
<summary>
1572
Gets a value indicating whether the folder currently being browsed
1573
by the <see cref="T:GongSolutions.Shell.ShellView"/> has parent folder which can be
1574
navigated to by calling <see cref="M:GongSolutions.Shell.ShellView.NavigateParent"/>.
1575
</summary>
1576
</member>
1577
<member name="P:GongSolutions.Shell.ShellView.ComInterface">
1578
<summary>
1579
Gets the control's underlying COM IShellView interface.
1580
</summary>
1581
</member>
1582
<member name="P:GongSolutions.Shell.ShellView.CurrentFolder">
1583
<summary>
1584
Gets/sets a <see cref="P:GongSolutions.Shell.ShellView.ShellItem"/> describing the folder
1585
currently being browsed by the <see cref="T:GongSolutions.Shell.ShellView"/>.
1586
</summary>
1587
</member>
1588
<member name="P:GongSolutions.Shell.ShellView.History">
1589
<summary>
1590
Gets the <see cref="T:GongSolutions.Shell.ShellView"/>'s navigation history.
1591
</summary>
1592
</member>
1593
<member name="P:GongSolutions.Shell.ShellView.SelectedItems">
1594
<summary>
1595
Gets a list of the items currently selected in the
1596
<see cref="T:GongSolutions.Shell.ShellView"/>
1597
</summary>
1598
1599
<value>
1600
A <see cref="P:GongSolutions.Shell.ShellView.ShellItem"/> array detailing the items currently
1601
selected in the control. If no items are currently selected,
1602
an empty array is returned.
1603
</value>
1604
</member>
1605
<member name="P:GongSolutions.Shell.ShellView.MultiSelect">
1606
<summary>
1607
Gets/sets a value indicating whether multiple items can be selected
1608
by the user.
1609
</summary>
1610
</member>
1611
<member name="P:GongSolutions.Shell.ShellView.ShowWebView">
1612
<summary>
1613
Gets/sets a value indicating whether a "WebView" is displayed on
1614
the left of the <see cref="T:GongSolutions.Shell.ShellView"/> control.
1615
</summary>
1616
1617
<remarks>
1618
The WebView is a strip of HTML that appears to the left of a
1619
Windows Explorer window when the window has no Explorer Bar.
1620
It displays general system tasks and locations, as well as
1621
information about the items selected in the window.
1622
1623
<para>
1624
<b>Important:</b> When <see cref="P:GongSolutions.Shell.ShellView.ShowWebView"/> is set to
1625
<see langref="true"/>, the <see cref="E:GongSolutions.Shell.ShellView.SelectionChanged"/>
1626
event will not occur. This is due to a limitation in the
1627
underlying windows control.
1628
</para>
1629
</remarks>
1630
</member>
1631
<member name="P:GongSolutions.Shell.ShellView.StatusBar">
1632
<summary>
1633
Gets/sets a <see cref="C:StatusBar"/> control that the
1634
<see cref="T:GongSolutions.Shell.ShellView"/> should use to display folder details.
1635
</summary>
1636
</member>
1637
<member name="P:GongSolutions.Shell.ShellView.View">
1638
<summary>
1639
Gets or sets how items are displayed in the control.
1640
</summary>
1641
</member>
1642
<member name="E:GongSolutions.Shell.ShellView.FilterItem">
1643
<summary>
1644
Occurs when the <see cref="T:GongSolutions.Shell.ShellView"/> control wants to know
1645
if it should include an item in its view.
1646
</summary>
1647
1648
<remarks>
1649
This event allows the items displayed in the <see cref="T:GongSolutions.Shell.ShellView"/>
1650
control to be filtered. You may want to to only list files with
1651
a certain extension, for example.
1652
</remarks>
1653
</member>
1654
<member name="E:GongSolutions.Shell.ShellView.Navigated">
1655
<summary>
1656
Occurs when the <see cref="T:GongSolutions.Shell.ShellView"/> control navigates to a
1657
new folder.
1658
</summary>
1659
</member>
1660
<member name="E:GongSolutions.Shell.ShellView.Navigating">
1661
<summary>
1662
Occurs when the <see cref="T:GongSolutions.Shell.ShellView"/> control is about to
1663
navigate to a new folder.
1664
</summary>
1665
</member>
1666
<member name="E:GongSolutions.Shell.ShellView.SelectionChanged">
1667
<summary>
1668
Occurs when the <see cref="T:GongSolutions.Shell.ShellView"/>'s current selection
1669
changes.
1670
</summary>
1671
1672
<remarks>
1673
<b>Important:</b> When <see cref="P:GongSolutions.Shell.ShellView.ShowWebView"/> is set to
1674
<see langref="true"/>, this event will not occur. This is due to
1675
a limitation in the underlying windows control.
1676
</remarks>
1677
</member>
1678
<member name="P:GongSolutions.Shell.ShellView.BackColor">
1679
<summary>
1680
This property does not apply to <see cref="T:GongSolutions.Shell.ShellView"/>.
1681
</summary>
1682
</member>
1683
<member name="P:GongSolutions.Shell.ShellView.BackgroundImage">
1684
<summary>
1685
This property does not apply to <see cref="T:GongSolutions.Shell.ShellView"/>.
1686
</summary>
1687
</member>
1688
<member name="P:GongSolutions.Shell.ShellView.BackgroundImageLayout">
1689
<summary>
1690
This property does not apply to <see cref="T:GongSolutions.Shell.ShellView"/>.
1691
</summary>
1692
</member>
1693
<member name="T:GongSolutions.Shell.FilterItemEventArgs">
1694
<summary>
1695
Provides information for FilterItem events.
1696
</summary>
1697
</member>
1698
<member name="M:GongSolutions.Shell.FilterItemEventArgs.#ctor(GongSolutions.Shell.ShellItem)">
1699
<summary>
1700
Initializes a new instance of the <see cref="T:GongSolutions.Shell.FilterItemEventArgs"/>
1701
class.
1702
</summary>
1703
1704
<param name="item">
1705
The item to be filtered.
1706
</param>
1707
</member>
1708
<member name="P:GongSolutions.Shell.FilterItemEventArgs.Include">
1709
<summary>
1710
Gets/sets a value which will determine whether the item will be
1711
included in the <see cref="T:GongSolutions.Shell.ShellView"/>.
1712
</summary>
1713
</member>
1714
<member name="P:GongSolutions.Shell.FilterItemEventArgs.Item">
1715
<summary>
1716
The item to be filtered.
1717
</summary>
1718
</member>
1719
<member name="T:GongSolutions.Shell.NavigatingEventArgs">
1720
<summary>
1721
Provides information for the <see cref="E:GongSolutions.Shell.ShellView.Navigating"/>
1722
event.
1723
</summary>
1724
</member>
1725
<member name="M:GongSolutions.Shell.NavigatingEventArgs.#ctor(GongSolutions.Shell.ShellItem)">
1726
<summary>
1727
Initializes a new instance of the <see cref="T:GongSolutions.Shell.NavigatingEventArgs"/>
1728
class.
1729
</summary>
1730
1731
<param name="folder">
1732
The folder being navigated to.
1733
</param>
1734
</member>
1735
<member name="P:GongSolutions.Shell.NavigatingEventArgs.Cancel">
1736
<summary>
1737
Gets/sets a value indicating whether the navigation should be
1738
cancelled.
1739
</summary>
1740
</member>
1741
<member name="P:GongSolutions.Shell.NavigatingEventArgs.Folder">
1742
<summary>
1743
The folder being navigated to.
1744
</summary>
1745
</member>
1746
<member name="T:GongSolutions.Shell.UserAbortException">
1747
<summary>
1748
Exception raised when a user aborts a Shell operation.
1749
</summary>
1750
</member>
1751
<member name="M:GongSolutions.Shell.UserAbortException.#ctor(System.Exception)">
1752
<summary>
1753
Initializes a new instance of the
1754
<see cref="T:GongSolutions.Shell.UserAbortException"/> class.
1755
</summary>
1756
1757
<param name="e">
1758
The inner exception.
1759
</param>
1760
</member>
1761
<member name="T:GongSolutions.Shell.FilterItemEventHandler">
1762
<summary>
1763
Represents the method that will handle FilterItem events.
1764
</summary>
1765
</member>
1766
<member name="T:GongSolutions.Shell.NavigatingEventHandler">
1767
<summary>
1768
Represents the method that will handle the
1769
<see cref="E:GongSolutions.Shell.ShellView.Navigating"/> event.
1770
</summary>
1771
</member>
1772
<member name="T:GongSolutions.Shell.ShellHistory">
1773
<summary>
1774
Holds a <see cref="T:GongSolutions.Shell.ShellView"/>'s navigation history.
1775
</summary>
1776
</member>
1777
<member name="M:GongSolutions.Shell.ShellHistory.Clear">
1778
<summary>
1779
Clears the shell history.
1780
</summary>
1781
</member>
1782
<member name="P:GongSolutions.Shell.ShellHistory.HistoryBack">
1783
<summary>
1784
Gets the list of folders in the <see cref="T:GongSolutions.Shell.ShellView"/>'s
1785
<b>Back</b> history.
1786
</summary>
1787
</member>
1788
<member name="P:GongSolutions.Shell.ShellHistory.HistoryForward">
1789
<summary>
1790
Gets the list of folders in the <see cref="T:GongSolutions.Shell.ShellView"/>'s
1791
<b>Forward</b> history.
1792
</summary>
1793
</member>
1794
</members>
1795
</doc>
1796
1797