-
Notifications
You must be signed in to change notification settings - Fork 0
/
ObjectListView.XML
15703 lines (15576 loc) · 739 KB
/
ObjectListView.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>ObjectListView</name>
</assembly>
<members>
<member name="T:BrightIdeasSoftware.TreeListView">
<summary>
A TreeListView combines an expandable tree structure with list view columns.
</summary>
<remarks>
<para>To support tree operations, two delegates must be provided:</para>
<list type="table">
<item>
<term>
CanExpandGetter
</term>
<description>
This delegate must accept a model object and return a boolean indicating
if that model should be expandable.
</description>
</item>
<item>
<term>
ChildrenGetter
</term>
<description>
This delegate must accept a model object and return an IEnumerable of model
objects that will be displayed as children of the parent model. This delegate will only be called
for a model object if the CanExpandGetter has already returned true for that model.
</description>
</item>
</list>
<para>
The top level branches of the tree are set via the Roots property. SetObjects(), AddObjects()
and RemoveObjects() are interpreted as operations on this collection of roots.
</para>
<para>
To add new children to an existing branch, make changes to your model objects and then
call RefreshObject() on the parent.
</para>
<para>The tree must be a directed acyclic graph -- no cycles are allowed. Put more mundanely,
each model object must appear only once in the tree. If the same model object appears in two
places in the tree, the control will become confused.</para>
</remarks>
</member>
<member name="T:BrightIdeasSoftware.VirtualObjectListView">
<summary>
A virtual object list view operates in virtual mode, that is, it only gets model objects for
a row when it is needed. This gives it the ability to handle very large numbers of rows with
minimal resources.
</summary>
<remarks><para>A listview is not a great user interface for a large number of items. But if you've
ever wanted to have a list with 10 million items, go ahead, knock yourself out.</para>
<para>Virtual lists can never iterate their contents. That would defeat the whole purpose.</para>
<para>Animated GIFs should not be used in virtual lists. Animated GIFs require some state
information to be stored for each animation, but virtual lists specifically do not keep any state information.
In any case, you really do not want to keep state information for 10 million animations!</para>
<para>
Although it isn't documented, .NET virtual lists cannot have checkboxes. This class codes around this limitation,
but you must use the functions provided by ObjectListView: CheckedObjects, CheckObject(), UncheckObject() and their friends.
If you use the normal check box properties (CheckedItems or CheckedIndicies), they will throw an exception, since the
list is in virtual mode, and .NET "knows" it can't handle checkboxes in virtual mode.
</para>
<para>Due to the limits of the underlying Windows control, virtual lists do not trigger ItemCheck/ItemChecked events.
Use a CheckStatePutter instead.</para>
<para>To enable grouping, you must provide an implmentation of IVirtualGroups interface, via the GroupingStrategy property.</para>
<para>Similarly, to enable filtering on the list, your VirtualListDataSource must also implement the IFilterableDataSource interface.</para>
</remarks>
</member>
<member name="T:BrightIdeasSoftware.ObjectListView">
<summary>
An ObjectListView is a much easier to use, and much more powerful, version of the ListView.
</summary>
<remarks>
<para>
An ObjectListView automatically populates a ListView control with information taken
from a given collection of objects. It can do this because each column is configured
to know which bit of the model object (the "aspect") it should be displaying. Columns similarly
understand how to sort the list based on their aspect, and how to construct groups
using their aspect.
</para>
<para>
Aspects are extracted by giving the name of a method to be called or a
property to be fetched. These names can be simple names or they can be dotted
to chain property access e.g. "Owner.Address.Postcode".
Aspects can also be extracted by installing a delegate.
</para>
<para>
An ObjectListView can show a "this list is empty" message when there is nothing to show in the list,
so that the user knows the control is supposed to be empty.
</para>
<para>
Right clicking on a column header should present a menu which can contain:
commands (sort, group, ungroup); filtering; and column selection. Whether these
parts of the menu appear is controlled by ShowCommandMenuOnRightClick,
ShowFilterMenuOnRightClick and SelectColumnsOnRightClick respectively.
</para>
<para>
The groups created by an ObjectListView can be configured to include other formatting
information, including a group icon, subtitle and task button. Using some undocumented
interfaces, these groups can even on virtual lists.
</para>
<para>
ObjectListView supports dragging rows to other places, including other application.
Special support is provide for drops from other ObjectListViews in the same application.
In many cases, an ObjectListView becomes a full drag source by setting <see cref="P:BrightIdeasSoftware.ObjectListView.IsSimpleDragSource"/> to
true. Similarly, to accept drops, it is usually enough to set <see cref="P:BrightIdeasSoftware.ObjectListView.IsSimpleDropSink"/> to true,
and then handle the <see cref="E:BrightIdeasSoftware.ObjectListView.CanDrop"/> and <see cref="E:BrightIdeasSoftware.ObjectListView.Dropped"/> events (or the <see cref="E:BrightIdeasSoftware.ObjectListView.ModelCanDrop"/> and
<see cref="E:BrightIdeasSoftware.ObjectListView.ModelDropped"/> events, if you only want to handle drops from other ObjectListViews in your application).
</para>
<para>
For these classes to build correctly, the project must have references to these assemblies:
</para>
<list type="bullet">
<item><description>System</description></item>
<item><description>System.Data</description></item>
<item><description>System.Design</description></item>
<item><description>System.Drawing</description></item>
<item><description>System.Windows.Forms (obviously)</description></item>
</list>
</remarks>
</member>
<member name="F:BrightIdeasSoftware.ObjectListView.SORT_INDICATOR_UP_KEY">
<summary>
The name of the image used when a column is sorted ascending
</summary>
<remarks>This image is only used on pre-XP systems. System images are used for XP and later</remarks>
</member>
<member name="F:BrightIdeasSoftware.ObjectListView.SORT_INDICATOR_DOWN_KEY">
<summary>
The name of the image used when a column is sorted descending
</summary>
<remarks>This image is only used on pre-XP systems. System images are used for XP and later</remarks>
</member>
<member name="F:BrightIdeasSoftware.ObjectListView.CHECKED_KEY">
<summary>
The name of the image used when a check box is checked
</summary>
</member>
<member name="F:BrightIdeasSoftware.ObjectListView.UNCHECKED_KEY">
<summary>
The name of the image used when a check box is unchecked
</summary>
</member>
<member name="F:BrightIdeasSoftware.ObjectListView.INDETERMINATE_KEY">
<summary>
The name of the image used when a check box is Indeterminate
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.#ctor">
<summary>
Create an ObjectListView
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.Dispose(System.Boolean)">
<summary>
Dispose of any resources this instance has been using
</summary>
<param name="disposing"></param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.EnumerableToArray(System.Collections.IEnumerable,System.Boolean)">
<summary>
Convert the given enumerable into an ArrayList as efficiently as possible
</summary>
<param name="collection">The source collection</param>
<param name="alwaysCreate">If true, this method will always create a new
collection.</param>
<returns>An ArrayList with the same contents as the given collection.</returns>
<remarks>
<para>When we move to .NET 3.5, we can use LINQ and not need this method.</para>
</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.IsEnumerableEmpty(System.Collections.IEnumerable)">
<summary>
Return whether or not the given enumerable is empty. A string is regarded as
an empty collection.
</summary>
<param name="collection"></param>
<returns>True if the given collection is null or empty</returns>
<remarks>
<para>When we move to .NET 3.5, we can use LINQ and not need this method.</para>
</remarks>
</member>
<member name="F:BrightIdeasSoftware.ObjectListView.EditorRegistry">
<summary>
This registry decides what control should be used to edit what cells, based
on the type of the value in the cell.
</summary>
<see cref="F:BrightIdeasSoftware.ObjectListView.EditorRegistry"/>
<remarks>All instances of ObjectListView share the same editor registry.</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.AddObject(System.Object)">
<summary>
Add the given model object to this control.
</summary>
<param name="modelObject">The model object to be displayed</param>
<remarks>See AddObjects() for more details</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.AddObjects(System.Collections.ICollection)">
<summary>
Add the given collection of model objects to this control.
</summary>
<param name="modelObjects">A collection of model objects</param>
<remarks>
<para>The added objects will appear in their correct sort position, if sorting
is active (i.e. if LastSortColumn is not null). Otherwise, they will appear at the end of the list.</para>
<para>No check is performed to see if any of the objects are already in the ListView.</para>
<para>Null objects are silently ignored.</para>
</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.AutoResizeColumns">
<summary>
Resize the columns to the maximum of the header width and the data.
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.AutoSizeColumns">
<summary>
Set up any automatically initialized column widths (columns that
have a width of 0 or -1 will be resized to the width of their
contents or header respectively).
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.BuildGroups">
<summary>
Organise the view items into groups, based on the last sort column or the first column
if there is no last sort column
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.BuildGroups(BrightIdeasSoftware.OLVColumn,System.Windows.Forms.SortOrder)">
<summary>
Organise the view items into groups, based on the given column
</summary>
<remarks>
<para>
If the AlwaysGroupByColumn property is not null,
the list view items will be organisd by that column,
and the 'column' parameter will be ignored.
</para>
<para>This method triggers sorting events: BeforeSorting and AfterSorting.</para>
</remarks>
<param name="column">The column whose values should be used for sorting.</param>
<param name="order"></param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.BuildGroups(BrightIdeasSoftware.OLVColumn,System.Windows.Forms.SortOrder,BrightIdeasSoftware.OLVColumn,System.Windows.Forms.SortOrder,BrightIdeasSoftware.OLVColumn,System.Windows.Forms.SortOrder)">
<summary>
Organise the view items into groups, based on the given columns
</summary>
<param name="groupByColumn">What column will be used for grouping</param>
<param name="groupByOrder">What ordering will be used for groups</param>
<param name="column">The column whose values should be used for sorting. Cannot be null</param>
<param name="order">The order in which the values from column will be sorted</param>
<param name="secondaryColumn">When the values from 'column' are equal, use the values provided by this column</param>
<param name="secondaryOrder">How will the secondary values be sorted</param>
<remarks>This method does not trigger sorting events. Use BuildGroups() to do that</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.CollectGroupingParameters(BrightIdeasSoftware.OLVColumn,System.Windows.Forms.SortOrder,BrightIdeasSoftware.OLVColumn,System.Windows.Forms.SortOrder,BrightIdeasSoftware.OLVColumn,System.Windows.Forms.SortOrder)">
<summary>
Collect and return all the variables that influence the creation of groups
</summary>
<returns></returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.MakeGroups(BrightIdeasSoftware.GroupingParameters)">
<summary>
Make a list of groups that should be shown according to the given parameters
</summary>
<param name="parms"></param>
<returns>The list of groups to be created</returns>
<remarks>This should not change the state of the control. It is possible that the
groups created will not be used. They may simply be discarded.</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.BuildList">
<summary>
Build/rebuild all the list view items in the list, preserving as much state as is possible
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.BuildList(System.Boolean)">
<summary>
Build/rebuild all the list view items in the list
</summary>
<param name="shouldPreserveState">If this is true, the control will try to preserve the selection,
focused item, and the scroll position (see Remarks)
</param>
<remarks>
<para>
Use this method in situations were the contents of the list is basically the same
as previously.
</para>
</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.ApplyExtendedStyles">
<summary>
Apply all required extended styles to our control.
</summary>
<remarks>
<para>
Whenever .NET code sets an extended style, it erases all other extended styles
that it doesn't use. So, we have to explicit reapply the styles that we have
added.
</para>
<para>
Normally, we would override CreateParms property and update
the ExStyle member, but ListView seems to ignore all ExStyles that
it doesn't already know about. Worse, when we set the LVS_EX_HEADERINALLVIEWS
value, bad things happen (the control crashes!).
</para>
</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.CalculateReasonableTileSize">
<summary>
Give the listview a reasonable size of its tiles, based on the number of lines of
information that each tile is going to display.
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.ChangeToFilteredColumns(System.Windows.Forms.View)">
<summary>
Rebuild this list for the given view
</summary>
<param name="view"></param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.ClearObjects">
<summary>
Remove all items from this list
</summary>
<remark>This method can safely be called from background threads.</remark>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.ClearUrlVisited">
<summary>
Reset the memory of which URLs have been visited
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.CopySelectionToClipboard">
<summary>
Copy a text and html representation of the selected rows onto the clipboard.
</summary>
<remarks>Be careful when using this with virtual lists. If the user has selected
10,000,000 rows, this method will faithfully try to copy all of them to the clipboard.
From the user's point of view, your program will appear to have hung.</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.CopyObjectsToClipboard(System.Collections.IList)">
<summary>
Copy a text and html representation of the given objects onto the clipboard.
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.ObjectsToHtml(System.Collections.IList)">
<summary>
Return a html representation of the given objects
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.DeselectAll">
<summary>
Deselect all rows in the listview
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.EnableCustomSelectionColors">
<summary>
Setup the list so it will draw selected rows using custom colours.
</summary>
<remarks>
This method makes the list owner drawn, and ensures that all columns have at
least a BaseRender installed.
</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.GetNextItem(BrightIdeasSoftware.OLVListItem)">
<summary>
Return the ListViewItem that appears immediately after the given item.
If the given item is null, the first item in the list will be returned.
Return null if the given item is the last item.
</summary>
<param name="itemToFind">The item that is before the item that is returned, or null</param>
<returns>A ListViewItem</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.GetLastItemInDisplayOrder">
<summary>
Return the last item in the order they are shown to the user.
If the control is not grouped, the display order is the same as the
sorted list order. But if the list is grouped, the display order is different.
</summary>
<returns></returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.GetNthItemInDisplayOrder(System.Int32)">
<summary>
Return the n'th item (0-based) in the order they are shown to the user.
If the control is not grouped, the display order is the same as the
sorted list order. But if the list is grouped, the display order is different.
</summary>
<param name="n"></param>
<returns></returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.GetDisplayOrderOfItemIndex(System.Int32)">
<summary>
Return the display index of the given listviewitem index.
If the control is not grouped, the display order is the same as the
sorted list order. But if the list is grouped, the display order is different.
</summary>
<param name="itemIndex"></param>
<returns></returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.GetPreviousItem(BrightIdeasSoftware.OLVListItem)">
<summary>
Return the ListViewItem that appears immediately before the given item.
If the given item is null, the last item in the list will be returned.
Return null if the given item is the first item.
</summary>
<param name="itemToFind">The item that is before the item that is returned</param>
<returns>A ListViewItem</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.InsertObjects(System.Int32,System.Collections.ICollection)">
<summary>
Insert the given collection of objects before the given position
</summary>
<param name="index">Where to insert the objects</param>
<param name="modelObjects">The objects to be inserted</param>
<remarks>
<para>
This operation only makes sense of non-sorted, non-grouped
lists, since any subsequent sort/group operation will rearrange
the list.
</para>
<para>This method only works on ObjectListViews and FastObjectListViews.</para>
</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.IsSelected(System.Object)">
<summary>
Return true if the row representing the given model is selected
</summary>
<param name="model">The model object to look for</param>
<returns>Is the row selected</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.IsUrlVisited(System.String)">
<summary>
Has the given URL been visited?
</summary>
<param name="url">The string to be consider</param>
<returns>Has it been visited</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.LowLevelScroll(System.Int32,System.Int32)">
<summary>
Scroll the ListView by the given deltas.
</summary>
<param name="dx">Horizontal delta</param>
<param name="dy">Vertical delta</param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.MarkUrlVisited(System.String)">
<summary>
Remember that the given URL has been visited
</summary>
<param name="url">The url to be remembered</param>
<remarks>This does not cause the control be redrawn</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.MoveObjects(System.Int32,System.Collections.ICollection)">
<summary>
Move the given collection of objects to the given index.
</summary>
<remarks>This operation only makes sense on non-grouped ObjectListViews.</remarks>
<param name="index"></param>
<param name="modelObjects"></param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HitTest(System.Int32,System.Int32)">
<summary>
Calculate what item is under the given point?
</summary>
<param name="x"></param>
<param name="y"></param>
<returns></returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.LowLevelHitTest(System.Int32,System.Int32)">
<summary>
Perform a hit test using the Windows control's SUBITEMHITTEST message.
This provides information about group hits that the standard ListView.HitTest() does not.
</summary>
<param name="x"></param>
<param name="y"></param>
<returns></returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.OlvHitTest(System.Int32,System.Int32)">
<summary>
What is under the given point? This takes the various parts of a cell into accout, including
any custom parts that a custom renderer might use
</summary>
<param name="x"></param>
<param name="y"></param>
<returns>An information block about what is under the point</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.CalculateStandardHitTest(BrightIdeasSoftware.OlvListViewHitTestInfo,System.Int32,System.Int32)">
<summary>
Perform a hit test when the control is not owner drawn
</summary>
<param name="hti"></param>
<param name="x"></param>
<param name="y"></param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.CalculateOwnerDrawnHitTest(BrightIdeasSoftware.OlvListViewHitTestInfo,System.Int32,System.Int32)">
<summary>
Perform a hit test when the control is owner drawn. This hands off responsibility
to the renderer.
</summary>
<param name="hti"></param>
<param name="x"></param>
<param name="y"></param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.PauseAnimations(System.Boolean)">
<summary>
Pause (or unpause) all animations in the list
</summary>
<param name="isPause">true to pause, false to unpause</param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.RebuildColumns">
<summary>
Rebuild the columns based upon its current view and column visibility settings
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.RemoveObject(System.Object)">
<summary>
Remove the given model object from the ListView
</summary>
<param name="modelObject">The model to be removed</param>
<remarks>See RemoveObjects() for more details
<para>This method is thread-safe.</para>
</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.RemoveObjects(System.Collections.ICollection)">
<summary>
Remove all of the given objects from the control.
</summary>
<param name="modelObjects">Collection of objects to be removed</param>
<remarks>
<para>Nulls and model objects that are not in the ListView are silently ignored.</para>
<para>This method is thread-safe.</para>
</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.SelectAll">
<summary>
Select all rows in the listview
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.SetNativeBackgroundWatermark(System.Drawing.Image)">
<summary>
Set the given image to be fixed in the bottom right of the list view.
This image will not scroll when the list view scrolls.
</summary>
<remarks>
<para>
This method uses ListView's native ability to display a background image.
It has a few limitations:
</para>
<list type="bullet">
<item><description>It doesn't work well with owner drawn mode. In owner drawn mode, each cell draws itself,
including its background, which covers the background image.</description></item>
<item><description>It doesn't look very good when grid lines are enabled, since the grid lines are drawn over the image.</description></item>
<item><description>It does not work at all on XP.</description></item>
<item><description>Obviously, it doesn't look good when alternate row background colors are enabled.</description></item>
</list>
<para>
If you can live with these limitations, native watermarks are quite neat. They are true backgrounds, not
translucent overlays like the OverlayImage uses. They also have the decided advantage over overlays in that
they work correctly even in MDI applications.
</para>
<para>Setting this clears any background image.</para>
</remarks>
<param name="image">The image to be drawn. If null, any existing image will be removed.</param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.SetNativeBackgroundImage(System.Drawing.Image,System.Int32,System.Int32)">
<summary>
Set the given image to be background of the ListView so that it appears at the given
percentage offsets within the list.
</summary>
<remarks>
<para>This has the same limitations as described in <see cref="M:BrightIdeasSoftware.ObjectListView.SetNativeBackgroundWatermark(System.Drawing.Image)"/>. Make sure those limitations
are understood before using the method.</para>
<para>This is very similar to setting the <see cref="P:System.Windows.Forms.Control.BackgroundImage"/> property of the standard .NET ListView, except that the standard
BackgroundImage does not handle images with transparent areas properly -- it renders transparent areas as black. This
method does not have that problem.</para>
<para>Setting this clears any background watermark.</para>
</remarks>
<param name="image">The image to be drawn. If null, any existing image will be removed.</param>
<param name="xOffset">The horizontal percentage where the image will be placed. 0 is absolute left, 100 is absolute right.</param>
<param name="yOffset">The vertical percentage where the image will be placed.</param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.SetNativeBackgroundTiledImage(System.Drawing.Image)">
<summary>
Set the given image to be the tiled background of the ListView.
</summary>
<remarks>
<para>This has the same limitations as described in <see cref="M:BrightIdeasSoftware.ObjectListView.SetNativeBackgroundWatermark(System.Drawing.Image)"/> and <see cref="M:BrightIdeasSoftware.ObjectListView.SetNativeBackgroundImage(System.Drawing.Image,System.Int32,System.Int32)"/>.
Make sure those limitations
are understood before using the method.</para>
</remarks>
<param name="image">The image to be drawn. If null, any existing image will be removed.</param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.SetObjects(System.Collections.IEnumerable)">
<summary>
Set the collection of objects that will be shown in this list view.
</summary>
<remark>This method can safely be called from background threads.</remark>
<remarks>The list is updated immediately</remarks>
<param name="collection">The objects to be displayed</param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.SetObjects(System.Collections.IEnumerable,System.Boolean)">
<summary>
Set the collection of objects that will be shown in this list view.
</summary>
<remark>This method can safely be called from background threads.</remark>
<remarks>The list is updated immediately</remarks>
<param name="collection">The objects to be displayed</param>
<param name="preserveState">Should the state of the list be preserved as far as is possible.</param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.UpdateNotificationSubscriptions(System.Collections.IEnumerable)">
<summary>
Change any subscriptions to INotifyPropertyChanged events on our current
model objects so that we no longer listen for events on the old models
and do listen for events on the given collection.
</summary>
<remarks>This does nothing if UseNotifyPropertyChanged is false.</remarks>
<param name="collection"></param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.SaveState">
<summary>
Return a byte array that represents the current state of the ObjectListView, such
that the state can be restored by RestoreState()
</summary>
<remarks>
<para>The state of an ObjectListView includes the attributes that the user can modify:
<list type="bullet">
<item><description>current view (i.e. Details, Tile, Large Icon...)</description></item>
<item><description>sort column and direction</description></item>
<item><description>column order</description></item>
<item><description>column widths</description></item>
<item><description>column visibility</description></item>
</list>
</para>
<para>
It does not include selection or the scroll position.
</para>
</remarks>
<returns>A byte array representing the state of the ObjectListView</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.RestoreState(System.Byte[])">
<summary>
Restore the state of the control from the given string, which must have been
produced by SaveState()
</summary>
<param name="state">A byte array returned from SaveState()</param>
<returns>Returns true if the state was restored</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleApplicationIdle(System.Object,System.EventArgs)">
<summary>
The application is idle. Trigger a SelectionChanged event.
</summary>
<param name="sender"></param>
<param name="e"></param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleApplicationIdleResizeColumns(System.Object,System.EventArgs)">
<summary>
The application is idle. Trigger a SelectionChanged event.
</summary>
<param name="sender"></param>
<param name="e"></param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleBeginScroll(System.Windows.Forms.Message@)">
<summary>
Handle the BeginScroll listview notification
</summary>
<param name="m"></param>
<returns>True if the event was completely handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleEndScroll(System.Windows.Forms.Message@)">
<summary>
Handle the EndScroll listview notification
</summary>
<param name="m"></param>
<returns>True if the event was completely handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleLinkClick(System.Windows.Forms.Message@)">
<summary>
Handle the LinkClick listview notification
</summary>
<param name="m"></param>
<returns>True if the event was completely handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleCellToolTipShowing(System.Object,BrightIdeasSoftware.ToolTipShowingEventArgs)">
<summary>
The cell tooltip control wants information about the tool tip that it should show.
</summary>
<param name="sender"></param>
<param name="e"></param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HeaderToolTipShowingCallback(System.Object,BrightIdeasSoftware.ToolTipShowingEventArgs)">
<summary>
Allow the HeaderControl to call back into HandleHeaderToolTipShowing without making that method public
</summary>
<param name="sender"></param>
<param name="e"></param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleHeaderToolTipShowing(System.Object,BrightIdeasSoftware.ToolTipShowingEventArgs)">
<summary>
The header tooltip control wants information about the tool tip that it should show.
</summary>
<param name="sender"></param>
<param name="e"></param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleColumnClick(System.Object,System.Windows.Forms.ColumnClickEventArgs)">
<summary>
Event handler for the column click event
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.WndProc(System.Windows.Forms.Message@)">
<summary>
Override the basic message pump for this control
</summary>
<param name="m"></param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleChar(System.Windows.Forms.Message@)">
<summary>
Handle the search for item m if possible.
</summary>
<param name="m">The m to be processed</param>
<returns>bool to indicate if the msg has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleContextMenu(System.Windows.Forms.Message@)">
<summary>
The user wants to see the context menu.
</summary>
<param name="m">The windows m</param>
<returns>A bool indicating if this m has been handled</returns>
<remarks>
We want to ignore context menu requests that are triggered by right clicks on the header
</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleCustomDraw(System.Windows.Forms.Message@)">
<summary>
Handle the Custom draw series of notifications
</summary>
<param name="m">The message</param>
<returns>True if the message has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleDestroy(System.Windows.Forms.Message@)">
<summary>
Handle the underlying control being destroyed
</summary>
<param name="m"></param>
<returns></returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleFindItem(System.Windows.Forms.Message@)">
<summary>
Handle the search for item m if possible.
</summary>
<param name="m">The m to be processed</param>
<returns>bool to indicate if the msg has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.FindMatchingRow(System.String,System.Int32,System.Windows.Forms.SearchDirectionHint)">
<summary>
Find the first row after the given start in which the text value in the
comparison column begins with the given text. The comparison column is column 0,
unless IsSearchOnSortColumn is true, in which case the current sort column is used.
</summary>
<param name="text">The text to be prefix matched</param>
<param name="start">The index of the first row to consider</param>
<param name="direction">Which direction should be searched?</param>
<returns>The index of the first row that matched, or -1</returns>
<remarks>The text comparison is a case-insensitive, prefix match. The search will
search the every row until a match is found, wrapping at the end if needed.</remarks>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.FindMatchInRange(System.String,System.Int32,System.Int32,BrightIdeasSoftware.OLVColumn)">
<summary>
Find the first row in the given range of rows that prefix matches the string value of the given column.
</summary>
<param name="text"></param>
<param name="first"></param>
<param name="last"></param>
<param name="column"></param>
<returns>The index of the matched row, or -1</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleGroupInfo(System.Windows.Forms.Message@)">
<summary>
Handle the Group Info series of notifications
</summary>
<param name="m">The message</param>
<returns>True if the message has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleKeyDown(System.Windows.Forms.Message@)">
<summary>
Handle a key down message
</summary>
<param name="m"></param>
<returns>True if the msg has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleLButtonDown(System.Windows.Forms.Message@)">
<summary>
Catch the Left Button down event.
</summary>
<param name="m">The m to be processed</param>
<returns>bool to indicate if the msg has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.ProcessLButtonDown(BrightIdeasSoftware.OlvListViewHitTestInfo)">
<summary>
Handle a left mouse down at the given hit test location
</summary>
<remarks>Subclasses can override this to do something unique</remarks>
<param name="hti"></param>
<returns>True if the message has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleLButtonUp(System.Windows.Forms.Message@)">
<summary>
Catch the Left Button up event.
</summary>
<param name="m">The m to be processed</param>
<returns>bool to indicate if the msg has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.TriggerGroupExpandCollapse(BrightIdeasSoftware.OLVGroup)">
<summary>
Trigger a GroupExpandCollapse event and return true if the action was cancelled
</summary>
<param name="group"></param>
<returns></returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleRButtonDown(System.Windows.Forms.Message@)">
<summary>
Catch the Right Button down event.
</summary>
<param name="m">The m to be processed</param>
<returns>bool to indicate if the msg has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.ProcessRButtonDown(BrightIdeasSoftware.OlvListViewHitTestInfo)">
<summary>
Handle a left mouse down at the given hit test location
</summary>
<remarks>Subclasses can override this to do something unique</remarks>
<param name="hti"></param>
<returns>True if the message has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleLButtonDoubleClick(System.Windows.Forms.Message@)">
<summary>
Catch the Left Button double click event.
</summary>
<param name="m">The m to be processed</param>
<returns>bool to indicate if the msg has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.ProcessLButtonDoubleClick(BrightIdeasSoftware.OlvListViewHitTestInfo)">
<summary>
Handle a mouse double click at the given hit test location
</summary>
<remarks>Subclasses can override this to do something unique</remarks>
<param name="hti"></param>
<returns>True if the message has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleRButtonDoubleClick(System.Windows.Forms.Message@)">
<summary>
Catch the right Button double click event.
</summary>
<param name="m">The m to be processed</param>
<returns>bool to indicate if the msg has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.ProcessRButtonDoubleClick(BrightIdeasSoftware.OlvListViewHitTestInfo)">
<summary>
Handle a right mouse double click at the given hit test location
</summary>
<remarks>Subclasses can override this to do something unique</remarks>
<param name="hti"></param>
<returns>True if the message has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleMouseMove(System.Windows.Forms.Message@)">
<summary>
Catch the MouseMove event.
</summary>
<param name="m">The m to be processed</param>
<returns>bool to indicate if the msg has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleReflectNotify(System.Windows.Forms.Message@)">
<summary>
Handle notifications that have been reflected back from the parent window
</summary>
<param name="m">The m to be processed</param>
<returns>bool to indicate if the msg has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleNotify(System.Windows.Forms.Message@)">
<summary>
In the notification messages, we handle attempts to change the width of our columns
</summary>
<param name="m">The m to be processed</param>
<returns>bool to indicate if the msg has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.CreateCellToolTip">
<summary>
Create a ToolTipControl to manage the tooltip control used by the listview control
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.UpdateCellToolTipHandle">
<summary>
Update the handle used by our cell tooltip to be the tooltip used by
the underlying Windows listview control.
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandlePaint(System.Windows.Forms.Message@)">
<summary>
Handle the WM_PAINT event
</summary>
<param name="m"></param>
<returns>Return true if the msg has been handled and nothing further should be done</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandlePrePaint">
<summary>
Perform any steps needed before painting the control
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandlePostPaint">
<summary>
Perform any steps needed after painting the control
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleWindowPosChanging(System.Windows.Forms.Message@)">
<summary>
Handle the window position changing.
</summary>
<param name="m">The m to be processed</param>
<returns>bool to indicate if the msg has been handled</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleHeaderRightClick(System.Int32)">
<summary>
The user has right clicked on the column headers. Do whatever is required
</summary>
<returns>Return true if this event has been handle</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.ShowHeaderRightClickMenu(System.Int32,System.Drawing.Point)">
<summary>
Show a menu that is appropriate when the given column header is clicked.
</summary>
<param name="columnIndex">The index of the header that was clicked. This
can be -1, indicating that the header was clicked outside of a column</param>
<param name="pt">Where should the menu be shown</param>
<returns>True if a menu was displayed</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.MakeHeaderRightClickMenu(System.Int32)">
<summary>
Create the menu that should be displayed when the user right clicks
on the given column header.
</summary>
<param name="columnIndex">Index of the column that was right clicked.
This can be negative, which indicates a click outside of any header.</param>
<returns>The toolstrip that should be displayed</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.HandleHeaderRightClick">
<summary>
The user has right clicked on the column headers. Do whatever is required
</summary>
<returns>Return true if this event has been handle</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.ShowColumnSelectMenu(System.Drawing.Point)">
<summary>
Show a popup menu at the given point which will allow the user to choose which columns
are visible on this listview
</summary>
<param name="pt">Where should the menu be placed</param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.ShowColumnCommandMenu(System.Int32,System.Drawing.Point)">
<summary>
Show a popup menu at the given point which will allow the user to choose which columns
are visible on this listview
</summary>
<param name="columnIndex"></param>
<param name="pt">Where should the menu be placed</param>
</member>
<member name="F:BrightIdeasSoftware.ObjectListView.SortAscendingImage">
<summary>
Gets or sets the image that will be place next to the Sort Ascending command
</summary>
</member>
<member name="F:BrightIdeasSoftware.ObjectListView.SortDescendingImage">
<summary>
Gets or sets the image that will be placed next to the Sort Descending command
</summary>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.MakeColumnCommandMenu(System.Windows.Forms.ToolStripDropDown,System.Int32)">
<summary>
Append the column selection menu items to the given menu strip.
</summary>
<param name="strip">The menu to which the items will be added.</param>
<param name="columnIndex"></param>
<returns>Return the menu to which the items were added</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.MakeColumnSelectMenu(System.Windows.Forms.ToolStripDropDown)">
<summary>
Append the column selection menu items to the given menu strip.
</summary>
<param name="strip">The menu to which the items will be added.</param>
<returns>Return the menu to which the items were added</returns>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.AddItemsToColumnSelectMenu(System.Windows.Forms.ToolStripItemCollection)">
<summary>
Create the menu items that will allow columns to be choosen and add them to the
given collection
</summary>
<param name="items"></param>
</member>
<member name="M:BrightIdeasSoftware.ObjectListView.MakeFilteringMenu(System.Windows.Forms.ToolStripDropDown,System.Int32)">
<summary>
Create a Filtering menu
</summary>
<param name="strip"></param>
<param name="columnIndex"></param>