/* * ObjectListView - A listview to show various aspects of a collection of objects * * Author: Phillip Piper * Date: 9/10/2006 11:15 AM * * Change log: * 2008-07-23 JPP - Consistently use copy-on-write semantics with Add/RemoveObject methods * 2008-07-10 JPP - Enable validation on cell editors through a CellEditValidating event. * (thanks to Artiom Chilaru for the initial suggestion and implementation). * 2008-07-09 JPP - Added HeaderControl.Handle to allow OLV to be used within UserControls. * (thanks to Michael Coffey for tracking this down). * 2008-06-23 JPP - Split the more generally useful CopyObjectsToClipboard() method * out of CopySelectionToClipboard() * 2008-06-22 JPP - Added AlwaysGroupByColumn and AlwaysGroupBySortOrder, which * force the list view to always be grouped by a particular column. * 2008-05-31 JPP - Allow check boxes on FastObjectListViews * - Added CheckedObject and CheckedObjects properties * 2008-05-11 JPP - Allow selection foreground and background colors to be changed. * Windows doesn't allow this, so we can only make it happen when owner * drawing. Set the HighlightForegroundColor and HighlightBackgroundColor * properties and then call EnableCustomSelectionColors(). * v1.12 * 2008-05-08 JPP - Fixed bug where the column select menu would not appear if the * ObjectListView has a context menu installed. * 2008-05-05 JPP - Non detail views can now be owner drawn. The renderer installed for * primary column is given the chance to render the whole item. * See BusinessCardRenderer in the demo for an example. * - BREAKING CHANGE: RenderDelegate now returns a bool to indicate if default * rendering should be done. Previously returned void. Only important if your * code used RendererDelegate directly. Renderers derived from BaseRenderer * are unchanged. * 2008-05-03 JPP - Changed cell editing to use values directly when the values are Strings. * Previously, values were always handed to the AspectToStringConverter. * - When editing a cell, tabbing no longer tries to edit the next subitem * when not in details view! * 2008-05-02 JPP - MappedImageRenderer can now handle a Aspects that return a collection * of values. Each value will be drawn as its own image. * - Made AddObjects() and RemoveObjects() work for all flavours (or at least not crash) * - Fixed bug with clearing virtual lists that has been scrolled vertically * - Made TopItemIndex work with virtual lists. * 2008-05-01 JPP - Added AddObjects() and RemoveObjects() to allow faster mods to the list * - Reorganised public properties. Now alphabetical. * - Made the class ObjectListViewState internal, as it always should have been. * v1.11 * 2008-04-29 JPP - Preserve scroll position when building the list or changing columns. * - Added TopItemIndex property. Due to problems with the underlying control, this * property is not always reliable. See property docs for info. * 2008-04-27 JPP - Added SelectedIndex property. * - Use a different, more general strategy to handle Invoke(). Removed all delegates * that were only declared to support Invoke(). * - Check all native structures for 64-bit correctness. * 2008-04-25 JPP - Released on SourceForge. * 2008-04-13 JPP - Added ColumnRightClick event. * - Made the assembly CLS-compliant. To do this, our cell editors were made internal, and * the constraint on FlagRenderer template parameter was removed (the type must still * be an IConvertible, but if it isn't, the error will be caught at runtime, not compile time). * 2008-04-12 JPP - Changed HandleHeaderRightClick() to have a columnIndex parameter, which tells * exactly which column was right-clicked. * 2008-03-31 JPP - Added SaveState() and RestoreState() * - When cell editing, scrolling with a mouse wheel now ends the edit operation. * v1.10 * 2008-03-25 JPP - Added space filling columns. See OLVColumn.FreeSpaceProportion property for details. * A space filling columns fills all (or a portion) of the width unoccupied by other columns. * 2008-03-23 JPP - Finished tinkering with support for Mono. Compile with conditional compilation symbol 'MONO' * to enable. On Windows, current problems with Mono: * - grid lines on virtual lists crashes * - when grouped, items sometimes are not drawn when any item is scrolled out of view * - i can't seem to get owner drawing to work * - when editing cell values, the editing controls always appear behind the listview, * where they function fine -- the user just can't see them :-) * 2008-03-16 JPP - Added some methods suggested by Chris Marlowe (thanks for the suggestions Chris) * - ClearObjects() * - GetCheckedObject(), GetCheckedObjects() * - GetItemAt() variation that gets both the item and the column under a point * 2008-02-28 JPP - Fixed bug with subitem colors when using OwnerDrawn lists and a RowFormatter. * v1.9.1 * 2008-01-29 JPP - Fixed bug that caused owner-drawn virtual lists to use 100% CPU * - Added FlagRenderer to help draw bitwise-OR'ed flag values * 2008-01-23 JPP - Fixed bug (introduced in v1.9) that made alternate row colour with groups not quite right * - Ensure that DesignerSerializationVisibility.Hidden is set on all non-browsable properties * - Make sure that sort indicators are shown after changing which columns are visible * 2008-01-21 JPP - Added FastObjectListView * v1.9 * 2008-01-18 JPP - Added IncrementalUpdate() * 2008-01-16 JPP - Right clicking on column header will allow the user to choose which columns are visible. * Set SelectColumnsOnRightClick to false to prevent this behaviour. * - Added ImagesRenderer to draw more than one images in a column * - Changed the positioning of the empty list msg to use all the client area. Thanks to Matze. * 2007-12-13 JPP - Added CopySelectionToClipboard(). Ctrl-C invokes this method. Supports text * and HTML formats. * 2007-12-12 JPP - Added support for checkboxes via CheckStateGetter and CheckStatePutter properties. * - Made ObjectListView and OLVColumn into partial classes so that others can extend them. * 2007-12-09 JPP - Added ability to have hidden columns, i.e. columns that the ObjectListView knows * about but that are not visible to the user. Controlled by OLVColumn.IsVisible. * Added ColumnSelectionForm to the project to show how it could be used in an application. * * v1.8 * 2007-11-26 JPP - Cell editing fully functional * 2007-11-21 JPP - Added SelectionChanged event. This event is triggered once when the * selection changes, no matter how many items are selected or deselected (in * contrast to SelectedIndexChanged which is called once for every row that * is selected or deselected). Thanks to lupokehl42 (Daniel) for his suggestions and * improvements on this idea. * 2007-11-19 JPP - First take at cell editing * 2007-11-17 JPP - Changed so that items within a group are not sorted if lastSortOrder == None * - Only call MakeSortIndicatorImages() if we haven't already made the sort indicators * (Corrected misspelling in the name of the method too) * 2007-11-06 JPP - Added ability to have secondary sort criteria when sorting * (SecondarySortColumn and SecondarySortOrder properties) * - Added SortGroupItemsByPrimaryColumn to allow group items to be sorted by the * primary column. Previous default was to sort by the grouping column. * v1.7 * No big changes to this version but made to work with ListViewPrinter and released with it. * * 2007-11-05 JPP - Changed BaseRenderer to use DrawString() rather than TextRenderer, since TextRenderer * does not work when printing. * v1.6 * 2007-11-03 JPP - Fixed some bugs in the rebuilding of DataListView. * 2007-10-31 JPP - Changed to use builtin sort indicators on XP and later. This also avoids alignment * problems on Vista. (thanks to gravybod for the suggestion and example implementation) * 2007-10-21 JPP - Added MinimumWidth and MaximumWidth properties to OLVColumn. * - Added ability for BuildList() to preserve selection. Calling BuildList() directly * tries to preserve selection; calling SetObjects() does not. * - Added SelectAll() and DeselectAll() methods. Useful for working with large lists. * 2007-10-08 JPP - Added GetNextItem() and GetPreviousItem(), which walk sequentially through the * listview items, even when the view is grouped. * - Added SelectedItem property * 2007-09-28 JPP - Optimized aspect-to-string conversion. BuildList() 15% faster. * - Added empty implementation of RefreshObjects() to VirtualObjectListView since * RefreshObjects() cannot work on virtual lists. * 2007-09-13 JPP - Corrected bug with custom sorter in VirtualObjectListView (thanks for mpgjunky) * 2007-09-07 JPP - Corrected image scaling bug in DrawAlignedImage() (thanks to krita970) * 2007-08-29 JPP - Allow item count labels on groups to be set per column (thanks to cmarlow for idea) * 2007-08-14 JPP - Major rework of DataListView based on Ian Griffiths's great work * 2007-08-11 JPP - When empty, the control can now draw a "List Empty" message * - Added GetColumn() and GetItem() methods * v1.5 * 2007-08-03 JPP - Support animated GIFs in ImageRenderer * - Allow height of rows to be specified - EXPERIMENTAL! * 2007-07-26 JPP - Optimised redrawing of owner-drawn lists by remembering the update rect * - Allow sort indicators to be turned off * 2007-06-30 JPP - Added RowFormatter delegate * - Allow a different label when there is only one item in a group (thanks to cmarlow) * v1.4 * 2007-04-12 JPP - Allow owner drawn on steriods! * - Column headers now display sort indicators * - ImageGetter delegates can now return ints, strings or Images * (Images are only visible if the list is owner drawn) * - Added OLVColumn.MakeGroupies to help with group partitioning * - All normal listview views are now supported * - Allow dotted aspect names, e.g. Owner.Workgroup.Name (thanks to OlafD) * - Added SelectedObject and SelectedObjects properties * v1.3 * 2007-03-01 JPP - Added DataListView * - Added VirtualObjectListView * - Added Freeze/Unfreeze capabilities * - Allowed sort handler to be installed * - Simplified sort comparisons: handles 95% of cases with only 6 lines of code! * - Fixed bug with alternative line colors on unsorted lists (thanks to cmarlow) * 2007-01-13 JPP - Fixed bug with lastSortOrder (thanks to Kwan Fu Sit) * - Non-OLVColumns are no longer allowed * 2007-01-04 JPP - Clear sorter before rebuilding list. 10x faster! (thanks to aaberg) * - Include GetField in GetAspectByName() so field values can be Invoked too. * - Fixed subtle bug in RefreshItem() that erased background colors. * 2006-11-01 JPP - Added alternate line colouring * 2006-10-20 JPP - Refactored all sorting comparisons and made it extendable. See ComparerManager. * - Improved IDE integration * - Made control DoubleBuffered * - Added object selection methods * 2006-10-13 JPP Implemented grouping and column sorting * 2006-10-09 JPP Initial version * * TO DO: * - Extend MappedImageRender to be able to draw more than image if its Aspect returns an ICollection. * * Copyright (C) 2006-2008 Phillip Piper * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * * If you wish to use this code in a closed source application, please contact phillip_piper@bigfoot.com. */ using System; using System.Collections; using System.Collections.Generic; using System.ComponentModel; using System.Data; using System.Diagnostics; using System.Drawing; using System.Drawing.Design; using System.Drawing.Drawing2D; using System.Drawing.Imaging; using System.Globalization; using System.IO; using System.Reflection; using System.Runtime.InteropServices; using System.Text; using System.Threading; using System.Windows.Forms; using System.Runtime.Serialization.Formatters.Binary; namespace BrightIdeasSoftware { /// /// An object list displays 'aspects' of a collection of objects in a listview control. /// /// /// /// The intelligence for this control is in the columns. OLVColumns are /// extended so they understand how to fetch an 'aspect' from each row /// object. They also understand how to sort by their aspect, and /// how to group them. /// /// /// 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. /// /// /// Sorting by column clicking and grouping by column are handled automatically. /// /// /// Right clicking on the column header should present a popup menu that allows the user to /// choose which columns will be visible in the list. This behaviour can be disabled by /// setting SelectColumnsOnRightClick to false. /// /// /// This list puts sort indicators in the column headers to show the column sorting direction. /// On Windows XP and later, the system standard images are used. /// If you wish to replace the standard images with your own images, put entries in the small image list /// with the key values "sort-indicator-up" and "sort-indicator-down". /// /// /// For these classes to build correctly, the project must have references to these assemblies: /// /// System.Data /// System.Design /// System.Drawing /// System.Windows.Forms (obviously) /// /// /// public partial class ObjectListView : ListView, ISupportInitialize { /// /// Create an ObjectListView /// public ObjectListView() : base() { this.ColumnClick += new ColumnClickEventHandler(this.HandleColumnClick); this.ItemCheck += new ItemCheckEventHandler(this.HandleItemCheck); this.Layout += new LayoutEventHandler(this.HandleLayout); this.ColumnWidthChanging += new ColumnWidthChangingEventHandler(this.HandleColumnWidthChanging); this.ColumnWidthChanged += new ColumnWidthChangedEventHandler(this.HandleColumnWidthChanged); base.View = View.Details; this.DoubleBuffered = true; // kill nasty flickers. hiss... me hates 'em this.AlternateRowBackColor = Color.Empty; this.ShowSortIndicators = true; this.isOwnerOfObjects = false; } #region Public properties /// /// Get or set all the columns that this control knows about. /// Only those columns where IsVisible is true will be seen by the user. /// /// If you want to add new columns programmatically, add them to /// AllColumns and then call RebuildColumns(). Normally, you do not have to /// deal with this property directly. Just use the IDE. [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Content)] public List AllColumns { get { // If someone has wiped out the columns, put the list back if (allColumns == null) allColumns = new List(); // If we don't know the columns, use the columns from the control. // This handles legacy cases if (allColumns.Count == 0 && this.Columns.Count > 0) { for (int i = 0; i < this.Columns.Count; i++) { this.allColumns.Add(this.GetColumn(i)); } } return allColumns; } set { allColumns = value; } } private List allColumns = new List(); /// /// If every second row has a background different to the control, what color should it be? /// [Category("Appearance"), Description("If using alternate colors, what color should alterate rows be?"), DefaultValue(typeof(Color), "Empty")] public Color AlternateRowBackColor { get { return alternateRowBackColor; } set { alternateRowBackColor = value; } } private Color alternateRowBackColor = Color.Empty; /// /// Return the alternate row background color that has been set, or the default color /// [Browsable(false)] public Color AlternateRowBackColorOrDefault { get { if (alternateRowBackColor == Color.Empty) return Color.LemonChiffon; else return alternateRowBackColor; } } /// /// This property forces the ObjectListView to always group items by the given column. /// public OLVColumn AlwaysGroupByColumn { get { return alwaysGroupByColumn; } set { alwaysGroupByColumn = value; } } private OLVColumn alwaysGroupByColumn; /// /// If AlwaysGroupByColumn is not null, this property will be used to decide how /// those groups are sorted. If this property has the value SortOrder.None, then /// the sort order will toggle according to the users last header click. /// public SortOrder AlwaysGroupBySortOrder { get { return alwaysGroupBySortOrder; } set { alwaysGroupBySortOrder = value; } } private SortOrder alwaysGroupBySortOrder = SortOrder.None; /// /// Give access to the image list that is actually being used by the control /// [Browsable(false)] public ImageList BaseSmallImageList { get { return base.SmallImageList; } } /// /// How does a user indicate that they want to edit cells? /// public enum CellEditActivateMode { /// /// This list cannot be edited. F2 does nothing. /// None = 0, /// /// A single click on a subitem will edit the value. Single clicking the primary column, /// selects the row just like normal. The user must press F2 to edit the primary column. /// SingleClick = 1, /// /// Double clicking a subitem or the primary column will edit that cell. /// F2 will edit the primary column. /// DoubleClick = 2, /// /// Pressing F2 is the only way to edit the cells. Once the primary column is being edited, /// the other cells in the row can be edited by pressing Tab. /// F2Only = 3 } /// /// How does the user indicate that they want to edit a cell? /// None means that the listview cannot be edited. /// /// Columns can also be marked as editable. [Category("Behavior"), Description("How does the user indicate that they want to edit a cell?"), DefaultValue(CellEditActivateMode.None)] public CellEditActivateMode CellEditActivation { get { return cellEditActivation; } set { cellEditActivation = value; } } private CellEditActivateMode cellEditActivation = CellEditActivateMode.None; /// /// Return the model object of the row that is checked or null if no row is checked /// or more than one row is checked /// public Object CheckedObject { get { ArrayList checkedObjects = this.GetCheckedObjects(); if (checkedObjects.Count == 1) return checkedObjects[0]; else return null; } } /// /// Get or set the collection of model objects that are checked. /// When setting this property, any row whose model object isn't /// in the given collection will be unchecked. Setting to null is /// equivilent to unchecking all. /// /// /// /// This property returns a simple collection. Changes made to the returned /// collection do NOT affect the list. This is different to the behaviour of /// CheckedIndicies collection. /// /// /// The CheckedItems property is not helpful. It is just a short-hand for /// iterating through the list looking for items that are checked. /// /// /// The performance of this method is O(n). Be careful on long lists. /// /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public IList CheckedObjects { get { ArrayList objects = new ArrayList(); if (this.CheckBoxes) { for (int i = 0; i < this.GetItemCount(); i++) { OLVListItem olvi = this.GetItem(i); if (olvi.Checked) objects.Add(olvi.RowObject); } } return objects; } set { if (this.CheckBoxes) { if (value == null) value = new ArrayList(); for (int i = 0; i < this.GetItemCount(); i++) { OLVListItem olvi = this.GetItem(i); bool newValue = value.Contains(olvi.RowObject); if (olvi.Checked != newValue) this.ChangeCheckItem(olvi, olvi.Checked, newValue); } } } } /// /// Get/set the list of columns that should be used when the list switches to tile view. /// /// If no list of columns has been installed, this value will default to the /// first column plus any column where IsTileViewColumn is true. [Browsable(false), Obsolete("Use GetFilteredColumns() and OLVColumn.IsTileViewColumn instead"), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public List ColumnsForTileView { get { return this.GetFilteredColumns(View.Tile); } } /// /// Return the visible columns in the order they are displayed to the user /// [Browsable(false)] public List ColumnsInDisplayOrder { get { List columnsInDisplayOrder = new List(this.Columns.Count); for (int i = 0; i < this.Columns.Count; i++) columnsInDisplayOrder.Add(null); for (int i = 0; i < this.Columns.Count; i++) { OLVColumn col = this.GetColumn(i); columnsInDisplayOrder[col.DisplayIndex] = col; } return columnsInDisplayOrder; } } /// /// If there are no items in this list view, what message should be drawn onto the control? /// [Category("Appearance"), Description("When the list has no items, show this message in the control"), DefaultValue("")] public String EmptyListMsg { get { return emptyListMsg; } set { if (emptyListMsg != value) { emptyListMsg = value; this.Invalidate(); } } } private String emptyListMsg = ""; /// /// What font should the 'list empty' message be drawn in? /// [Category("Appearance"), Description("What font should the 'list empty' message be drawn in?"), DefaultValue(null)] public Font EmptyListMsgFont { get { return emptyListMsgFont; } set { emptyListMsgFont = value; } } private Font emptyListMsgFont; /// /// Return the font for the 'list empty' message or a default /// [Browsable(false)] public Font EmptyListMsgFontOrDefault { get { if (this.EmptyListMsgFont == null) return new Font("Tahoma", 14); else return this.EmptyListMsgFont; } } /// /// Get or set whether or not the listview is frozen. When the listview is /// frozen, it will not update itself. /// /// The Frozen property is similar to the methods Freeze()/Unfreeze() /// except that changes to the Frozen property do not nest. /// objectListView1.Frozen = false; // unfreeze the control regardless of the number of Freeze() calls /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public bool Frozen { get { return freezeCount > 0; } set { if (value) Freeze(); else if (freezeCount > 0) { freezeCount = 1; Unfreeze(); } } } private int freezeCount = 0; /// /// When a group title has an item count, how should the lable be formatted? /// /// /// The given format string can/should have two placeholders: /// /// {0} - the original group title /// {1} - the number of items in the group /// /// /// "{0} [{1} items]" [Category("Behavior"), Description("The format to use when suffixing item counts to group titles"), DefaultValue(null)] public string GroupWithItemCountFormat { get { return groupWithItemCountFormat; } set { groupWithItemCountFormat = value; } } private string groupWithItemCountFormat; /// /// Return this.GroupWithItemCountFormat or a reasonable default /// [Browsable(false)] public string GroupWithItemCountFormatOrDefault { get { if (String.IsNullOrEmpty(this.GroupWithItemCountFormat)) return "{0} [{1} items]"; else return this.GroupWithItemCountFormat; } } /// /// When a group title has an item count, how should the lable be formatted if /// there is only one item in the group? /// /// /// The given format string can/should have two placeholders: /// /// {0} - the original group title /// {1} - the number of items in the group (always 1) /// /// /// "{0} [{1} item]" [Category("Behavior"), Description("The format to use when suffixing item counts to group titles"), DefaultValue(null)] public string GroupWithItemCountSingularFormat { get { return groupWithItemCountSingularFormat; } set { groupWithItemCountSingularFormat = value; } } private string groupWithItemCountSingularFormat; /// /// Return this.GroupWithItemCountSingularFormat or a reasonable default /// [Browsable(false)] public string GroupWithItemCountSingularFormatOrDefault { get { if (String.IsNullOrEmpty(this.GroupWithItemCountSingularFormat)) return "{0} [{1} item]"; else return this.GroupWithItemCountSingularFormat; } } /// /// Does this listview have a message that should be drawn when the list is empty? /// [Browsable(false)] public bool HasEmptyListMsg { get { return !String.IsNullOrEmpty(this.EmptyListMsg); } } /// /// What color should be used for the background of selected rows? /// /// Windows does not give the option of changing the selection background. /// So this color is only used when control is owner drawn and when columns have a /// renderer installed -- a basic new BaseRenderer() will suffice. [Category("Appearance"), Description("The background color of selected rows when the control is owner drawn"), DefaultValue(typeof(Color), "Empty")] public Color HighlightBackgroundColor { get { return highlightBackgroundColor; } set { highlightBackgroundColor = value; } } private Color highlightBackgroundColor = Color.Empty; /// /// Return the color should be used for the background of selected rows or a reasonable default /// [Browsable(false)] public Color HighlightBackgroundColorOrDefault { get { if (this.HighlightBackgroundColor.IsEmpty) return SystemColors.Highlight; else return this.HighlightBackgroundColor; } } /// /// Setup the list so it will draw selected rows using custom colours. /// /// /// This method makes the list owner drawn, and ensures that all columns have at /// least a BaseRender installed. /// public void EnableCustomSelectionColors() { this.OwnerDraw = true; foreach (OLVColumn column in this.AllColumns) { if (column.RendererDelegate == null) column.Renderer = new BaseRenderer(); } } /// /// What color should be used for the foreground of selected rows? /// /// Windows does not give the option of changing the selection foreground (text color). /// So this color is only used when control is owner drawn and when columns have a /// renderer installed -- a basic new BaseRenderer() will suffice. [Category("Appearance"), Description("The foreground color of selected rows when the control is owner drawn"), DefaultValue(typeof(Color), "Empty")] public Color HighlightForegroundColor { get { return highlightForegroundColor; } set { highlightForegroundColor = value; } } private Color highlightForegroundColor = Color.Empty; /// /// Return the color should be used for the foreground of selected rows or a reasonable default /// public Color HighlightForegroundColorOrDefault { get { if (this.HighlightForegroundColor.IsEmpty) return SystemColors.HighlightText; else return this.HighlightForegroundColor; } } /// /// Return true if a cell edit operation is currently happening /// [Browsable(false)] public bool IsCellEditing { get { return this.cellEditor != null; } } /// /// Get/set the collection of objects that this list will show /// /// The contents of the control will be updated immediately after setting this property [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public IEnumerable Objects { get { return this.objects; } set { this.SetObjects(value); } } private IEnumerable objects; /// /// Take ownership of the 'objects' collection. This separats our collection from the source. /// /// /// /// This method /// separates the 'objects' instance variable from its source, so that any AddObject/RemoveObject /// calls will modify our collection and not the original colleciton. /// /// /// This method has the intentional side-effect of converting our list of objects to an ArrayList. /// /// virtual protected void TakeOwnershipOfObjects() { if (this.isOwnerOfObjects) return; this.isOwnerOfObjects = true; if (this.objects == null) this.objects = new ArrayList(); else if (this.objects is ICollection) this.objects = new ArrayList((ICollection)this.objects); else { ArrayList newObjects = new ArrayList(); foreach (object x in this.objects) newObjects.Add(x); this.objects = newObjects; } } /// /// Specify the height of each row in the control in pixels. /// /// The row height in a listview is normally determined by the font size and the small image list size. /// This setting allows that calculation to be overridden (within reason: you still cannot set the line height to be /// less than the line height of the font used in the control). /// Setting it to -1 means use the normal calculation method. /// This feature is experiemental! Strange things may happen to your program, /// your spouse or your pet if you use it. /// [Category("Appearance"), DefaultValue(-1)] public int RowHeight { get { return rowHeight; } set { if (value < 1) rowHeight = -1; else rowHeight = value; this.SetupExternalImageList(); } } private int rowHeight = -1; /// /// Get/set the column that will be used to resolve comparisons that are equal when sorting. /// /// There is no user interface for this setting. It must be set programmatically. /// The default is the first column. [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public OLVColumn SecondarySortColumn { get { if (this.secondarySortColumn == null) { if (this.Columns.Count > 0) return this.GetColumn(0); else return null; } else return this.secondarySortColumn; } set { this.secondarySortColumn = value; } } private OLVColumn secondarySortColumn; /// /// When the SecondarySortColumn is used, in what order will it compare results? /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public SortOrder SecondarySortOrder { get { return this.secondarySortOrder; } set { this.secondarySortOrder = value; } } private SortOrder secondarySortOrder = SortOrder.Ascending; /// /// When the user right clicks on the column headers, should a menu be presented which will allow /// them to choose which columns will be shown in the view? /// [Category("Behavior"), Description("When the user right clicks on the column headers, should a menu be presented which will allow them to choose which columns will be shown in the view?"), DefaultValue(true)] public bool SelectColumnsOnRightClick { get { return selectColumnsOnRightClick; } set { selectColumnsOnRightClick = value; } } private bool selectColumnsOnRightClick = true; /// /// When the column select menu is open, should it stay open after an item is selected? /// Staying open allows the user to turn more than one column on or off at a time. /// [Category("Behavior"), Description("When the column select menu is open, should it stay open after an item is selected?"), DefaultValue(true)] public bool SelectColumnsMenuStaysOpen { get { return selectColumnsMenuStaysOpen; } set { selectColumnsMenuStaysOpen = value; } } private bool selectColumnsMenuStaysOpen = true; /// /// Return the index of the row that is currently selected. If no row is selected, /// or more than one is selected, return -1. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public int SelectedIndex { get { if (this.SelectedIndices.Count == 1) return this.SelectedIndices[0]; else return -1; } set { this.SelectedIndices.Clear(); if (value >= 0 && value < this.Items.Count) this.SelectedIndices.Add(value); } } /// /// Get the ListViewItem that is currently selected . If no row is selected, or more than one is selected, return null. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public ListViewItem SelectedItem { get { if (this.SelectedIndices.Count == 1) return this.GetItem(this.SelectedIndices[0]); else return null; } set { this.SelectedIndices.Clear(); if (value != null) this.SelectedIndices.Add(value.Index); } } /// /// Get the model object from the currently selected row. If no row is selected, or more than one is selected, return null. /// Select the row that is displaying the given model object. All other rows are deselected. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public Object SelectedObject { get { return this.GetSelectedObject(); } set { this.SelectObject(value); } } /// /// Get the model objects from the currently selected rows. If no row is selected, the returned List will be empty. /// When setting this value, select the rows that is displaying the given model objects. All other rows are deselected. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public ArrayList SelectedObjects { get { return this.GetSelectedObjects(); } set { this.SelectObjects(value); } } /// /// Should the list view show a bitmap in the column header to show the sort direction? /// /// /// The only reason for not wanting to have sort indicators is that, on pre-XP versions of /// Windows, having sort indicators required the ListView to have a small image list, and /// as soon as you give a ListView a SmallImageList, the text of column 0 is bumped 16 /// pixels to the right, even if you never used an image. /// [Category("Behavior"), Description("Should the list view show sort indicators in the column headers?"), DefaultValue(true)] public bool ShowSortIndicators { get { return showSortIndicators; } set { showSortIndicators = value; } } private bool showSortIndicators; /// /// Should the list view show images on subitems? /// /// /// Under Windows, this works by sending messages to the underlying /// Windows control. To make this work under Mono, we would have to owner drawing the items :-( [Category("Behavior"), Description("Should the list view show images on subitems?"), DefaultValue(false)] public bool ShowImagesOnSubItems { get { #if MONO return false; #else return showImagesOnSubItems; #endif } set { showImagesOnSubItems = value; } } private bool showImagesOnSubItems; /// /// This property controls whether group labels will be suffixed with a count of items. /// /// /// The format of the suffix is controlled by GroupWithItemCountFormat/GroupWithItemCountSingularFormat properties /// [Category("Behavior"), Description("Will group titles be suffixed with a count of the items in the group?"), DefaultValue(false)] public bool ShowItemCountOnGroups { get { return showItemCountOnGroups; } set { showItemCountOnGroups = value; } } private bool showItemCountOnGroups; /// /// Override the SmallImageList property so we can correctly shadow its operations. /// /// If you use the RowHeight property to specify the row height, the SmallImageList /// must be fully initialised before setting/changing the RowHeight. If you add new images to the image /// list after setting the RowHeight, you must assign the imagelist to the control again. Something as simple /// as this will work: /// listView1.SmallImageList = listView1.SmallImageList; /// new public ImageList SmallImageList { get { return this.shadowedImageList; } set { this.shadowedImageList = value; this.SetupExternalImageList(); } } private ImageList shadowedImageList = null; /// /// When the listview is grouped, should the items be sorted by the primary column? /// If this is false, the items will be sorted by the same column as they are grouped. /// [Category("Behavior"), Description("When the listview is grouped, should the items be sorted by the primary column? If this is false, the items will be sorted by the same column as they are grouped."), DefaultValue(true)] public bool SortGroupItemsByPrimaryColumn { get { return this.sortGroupItemsByPrimaryColumn; } set { this.sortGroupItemsByPrimaryColumn = value; } } private bool sortGroupItemsByPrimaryColumn = true; /// /// When resizing a column by dragging its divider, should any space filling columns be /// resized at each mouse move? If this is false, the filling columns will be /// updated when the mouse is released. /// /// /// I think that this looks very ugly, but it does give more immediate feedback. /// It looks ugly because every /// column to the right of the divider being dragged gets updated twice: once when /// the column be resized changes size (this moves /// all the columns slightly to the right); then again when the filling columns are updated, but they will be shrunk /// so that the combined width is not more than the control, so everything jumps slightly back to the left again. /// [Category("Behavior"), Description("When resizing a column by dragging its divider, should any space filling columns be resized at each mouse move?"), DefaultValue(false)] public bool UpdateSpaceFillingColumnsWhenDraggingColumnDivider { get { return updateSpaceFillingColumnsWhenDraggingColumnDivider; } set { updateSpaceFillingColumnsWhenDraggingColumnDivider = value; } } private bool updateSpaceFillingColumnsWhenDraggingColumnDivider = false; /// /// Should the list give a different background color to every second row? /// /// The color of the alternate rows is given by AlternateRowBackColor. /// There is a "feature" in .NET for listviews in non-full-row-select mode, where /// selected rows are not drawn with their correct background color. [Category("Appearance"), Description("Should the list view use a different backcolor to alternate rows?"), DefaultValue(false)] public bool UseAlternatingBackColors { get { return useAlternatingBackColors; } set { useAlternatingBackColors = value; } } private bool useAlternatingBackColors; /// /// Get/set the style of view that this listview is using /// /// Switching to tile or details view installs the columns appropriate to that view. /// Confusingly, in tile view, every column is shown as a row of information. new public View View { get { return base.View; } set { if (base.View == value) return; if (this.Frozen) { base.View = value; return; } this.Freeze(); // If we are switching to a Detail or Tile view, setup the columns needed for that view if (value == View.Details || value == View.Tile) { this.ChangeToFilteredColumns(value); if (value == View.Tile) this.CalculateReasonableTileSize(); } base.View = value; this.Unfreeze(); } } #endregion #region Callbacks /// /// This delegate can be used to sort the table in a custom fasion. /// /// /// /// What the delegate has to do depends on the type of ObjectListView it is sorting: /// /// /// /// If it is sorting a normal ObjectListView, the delegate must install a ListViewItemSorter on the ObjectListView. This install ItemSorter will actually do the work of sorting the ListViewItems. See ColumnComparer in the code for an example of what an ItemSorter has to do. /// /// /// If the delegate is sorting a VirtualObjectListView or a FastObjectListView, the delegate must sort the model objects that are sourcing the list (remember, in a virtual list, the application holds the model objects and the list just askes for them as it needs them). /// /// /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public SortDelegate CustomSorter { get { return customSorter; } set { customSorter = value; } } private SortDelegate customSorter; /// /// This delegate can be used to format a OLVListItem before it is added to the control. /// /// /// The model object for the row can be found through the RowObject property of the OLVListItem object. /// All subitems normally have the same style as list item, so setting the forecolor on one /// subitem changes the forecolor of all subitems. /// To allow subitems to have different attributes, do this:myListViewItem.UseItemStyleForSubItems = false;. /// /// If UseAlternatingBackColors is true, the backcolor of the listitem will be calculated /// by the control and cannot be controlled by the RowFormatter delegate. In general, trying to use a RowFormatter /// when UseAlternatingBackColors is true does not work well. [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public RowFormatterDelegate RowFormatter { get { return rowFormatter; } set { rowFormatter = value; } } private RowFormatterDelegate rowFormatter; /// /// This delegate will be called whenever the ObjectListView needs to know the check state /// of the row associated with a given model object /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public CheckStateGetterDelegate CheckStateGetter { get { return checkStateGetter; } set { checkStateGetter = value; } } private CheckStateGetterDelegate checkStateGetter; /// /// This delegate will be called whenever the user tries to change the check state /// of a row. The delegate should return the value that the listview should actuall /// use, which may be different to the one given to the delegate. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public CheckStatePutterDelegate CheckStatePutter { get { return checkStatePutter; } set { checkStatePutter = value; } } private CheckStatePutterDelegate checkStatePutter; #endregion #region List commands /// /// Set the collection of objects that will be shown in this list view. /// /// This method can safely be called from background threads. /// The list is updated immediately /// The objects to be displayed virtual public void SetObjects(IEnumerable collection) { if (this.InvokeRequired) { this.Invoke((MethodInvoker)delegate { this.SetObjects(collection); }); return; } // If we own the current list and they change to another list, we don't own it anymore if (this.isOwnerOfObjects && this.objects != collection) this.isOwnerOfObjects = false; this.objects = collection; this.BuildList(false); } /// /// Add the given model object to this control. /// /// The model object to be displayed /// See AddObjects() for more details public void AddObject(object modelObject) { this.AddObjects(new object[] { modelObject }); } /// /// Add the given collection of model objects to this control. /// /// A collection of model objects /// /// The added objects will appear in their correct sort position, if sorting /// is active. Otherwise, they will appear at the end of the list. /// No check is performed to see if any of the objects are already in the ListView. /// The method uses the ObjectsAsList property. See that property for a /// description of what is does. /// Null objects are silently ignored. /// virtual public void AddObjects(ICollection modelObjects) { if (modelObjects == null) return; this.BeginUpdate(); this.TakeOwnershipOfObjects(); ArrayList ourObjects = (ArrayList)this.Objects; List itemList = new List(); foreach (object modelObject in modelObjects) { if (modelObject != null) { ourObjects.Add(modelObject); OLVListItem lvi = new OLVListItem(modelObject); this.FillInValues(lvi, modelObject); itemList.Add(lvi); } } this.Items.AddRange(itemList.ToArray()); this.Sort(this.lastSortColumn); foreach (OLVListItem lvi in itemList) { this.SetSubItemImages(lvi.Index, lvi); } this.EndUpdate(); } /// /// Remove the given model object from the ListView /// /// The model to be removed /// See RemoveObjects() for more details public void RemoveObject(object modelObject) { this.RemoveObjects(new object[] { modelObject }); } /// /// Remove all of the given objects from the control /// /// Collection of objects to be removed /// /// Nulls and model objects that are not in the ListView are silently ignored. /// virtual public void RemoveObjects(ICollection modelObjects) { if (modelObjects == null) return; this.BeginUpdate(); this.TakeOwnershipOfObjects(); ArrayList ourObjects = (ArrayList)this.Objects; foreach (object modelObject in modelObjects) { if (modelObject != null) { ourObjects.Remove(modelObject); int i = this.IndexOf(modelObject); if (i >= 0) this.Items.RemoveAt(i); } } this.EndUpdate(); } /// /// Update the list to reflect the contents of the given collection, without affecting /// the scrolling position, selection or sort order. /// /// The objects to be displayed /// /// This method is about twice as slow as SetObjects(). /// This method is experimental -- it may disappear in later versions of the code. /// There has to be a better way to do this! JPP 15/1/2008 /// In most situations, if you need this functionality, use a FastObjectListView instead. JPP 2/2/2008 /// [Obsolete("Use a FastObjectListView instead of this method.", false)] virtual public void IncrementalUpdate(IEnumerable collection) { if (this.InvokeRequired) { this.Invoke((MethodInvoker)delegate { this.IncrementalUpdate(collection); }); return; } this.BeginUpdate(); this.ListViewItemSorter = null; ArrayList previousSelection = this.SelectedObjects; // Replace existing rows, creating new listviewitems if we get to the end of the list List newItems = new List(); int rowIndex = 0; int itemCount = this.Items.Count; foreach (object model in collection) { if (rowIndex < itemCount) { OLVListItem lvi = this.GetItem(rowIndex); lvi.RowObject = model; this.RefreshItem(lvi); } else { OLVListItem lvi = new OLVListItem(model); this.FillInValues(lvi, model); newItems.Add(lvi); } rowIndex++; } // Delete any excess rows int numRowsToDelete = itemCount - rowIndex; for (int i = 0; i < numRowsToDelete; i++) this.Items.RemoveAt(rowIndex); this.Items.AddRange(newItems.ToArray()); this.Sort(this.lastSortColumn); SetAllSubItemImages(); this.SelectedObjects = previousSelection; this.EndUpdate(); this.objects = collection; } /// /// Remove all items from this list /// /// This method can safely be called from background threads. virtual public void ClearObjects() { if (this.InvokeRequired) this.Invoke(new MethodInvoker(ClearObjects)); else this.Items.Clear(); } /// /// Build/rebuild all the list view items in the list /// virtual public void BuildList() { this.BuildList(true); } /// /// Build/rebuild all the list view items in the list /// /// If this is true, the control will try to preserve the selection /// and the scroll position (see Remarks) /// /// /// /// Use this method in situations were the contents of the list is basically the same /// as previously. /// /// /// Due to limitations in .NET's ListView, the scroll position is only preserved if /// the control is in Details view AND it is not showing groups. /// /// virtual public void BuildList(bool shouldPreserveState) { if (this.Frozen) return; ArrayList previousSelection = new ArrayList(); int previousTopIndex = this.TopItemIndex; if (shouldPreserveState && this.objects != null) previousSelection = this.SelectedObjects; this.BeginUpdate(); this.Items.Clear(); this.ListViewItemSorter = null; if (this.objects != null) { // Build a list of all our items and then display them. (Building // a list and then doing one AddRange is about 10-15% faster than individual adds) List itemList = new List(); foreach (object rowObject in this.objects) { OLVListItem lvi = new OLVListItem(rowObject); this.FillInValues(lvi, rowObject); itemList.Add(lvi); } this.Items.AddRange(itemList.ToArray()); this.SetAllSubItemImages(); this.Sort(this.lastSortColumn); if (shouldPreserveState) this.SelectedObjects = previousSelection; } this.EndUpdate(); // We can only restore the scroll position after the EndUpdate() because // of caching that the ListView does internally during a BeginUpdate/EndUpdate pair. if (shouldPreserveState) this.TopItemIndex = previousTopIndex; } /// /// Get or set the index of the top item of this listview /// /// /// /// This property only works when the listview is in Details view and not showing groups. /// /// /// The reason that it does not work when showing groups is that, when groups are enabled, /// the Windows message LVM_GETTOPINDEX always returns 0, regardless of the /// scroll position. /// /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public int TopItemIndex { get { if (this.View == View.Details && this.TopItem != null) return this.TopItem.Index; else return -1; } set { int newTopIndex = Math.Min(value, this.GetItemCount() - 1); if (this.View == View.Details && newTopIndex >= 0) { this.TopItem = this.Items[newTopIndex]; // Setting the TopItem sometimes gives off by one errors, // that (bizarrely) are correct on a second attempt if (this.TopItem != null && this.TopItem.Index != newTopIndex) this.TopItem = this.GetItem(newTopIndex); } } } /// /// Sort the items by the last sort column /// new public void Sort() { this.Sort(this.lastSortColumn); } /// /// Organise the view items into groups, based on the last sort column or the first column /// if there is no last sort column /// public void BuildGroups() { this.BuildGroups(this.lastSortColumn); } /// /// Organise the view items into groups, based on the given column /// /// If the AlwaysGroupByColumn property is not null, /// the list view items will be organisd by that column, /// and the 'column' parameter will be ignored. /// The column whose values should be used for sorting. virtual public void BuildGroups(OLVColumn column) { if (column == null) column = this.GetColumn(0); // If a specific column has been given as the group by column, we always // group by that column, regardless of what the user just clicked. OLVColumn groupByColumn = this.AlwaysGroupByColumn; if (groupByColumn == null) groupByColumn = column; SortOrder groupSortOrder = this.AlwaysGroupBySortOrder; if (groupSortOrder == SortOrder.None) groupSortOrder = this.lastSortOrder; this.Groups.Clear(); // Getting the Count forces any internal cache of the ListView to be flushed. Without // this, iterating over the Items will not work correctly if the ListView handle // has not yet been created. int dummy = this.Items.Count; // Separate the list view items into groups, using the group key as the descrimanent Dictionary> map = new Dictionary>(); foreach (OLVListItem olvi in this.Items) { object key = groupByColumn.GetGroupKey(olvi.RowObject); if (key == null) key = "{null}"; // null can't be used as the key for a dictionary if (!map.ContainsKey(key)) map[key] = new List(); map[key].Add(olvi); } // Make a list of the required groups List groups = new List(); foreach (object key in map.Keys) { ListViewGroup lvg = new ListViewGroup(groupByColumn.ConvertGroupKeyToTitle(key)); lvg.Tag = key; groups.Add(lvg); } // Sort the groups groups.Sort(new ListViewGroupComparer(groupSortOrder)); // Put each group into the list view, and give each group its member items. // The order of statements is important here: // - the header must be calculate before the group is added to the list view, // otherwise changing the header causes a nasty redraw (even in the middle of a BeginUpdate...EndUpdate pair) // - the group must be added before it is given items, otherwise an exception is thrown (is this documented?) string fmt = groupByColumn.GroupWithItemCountFormatOrDefault; string singularFmt = groupByColumn.GroupWithItemCountSingularFormatOrDefault; ColumnComparer itemSorter = new ColumnComparer((this.SortGroupItemsByPrimaryColumn ? this.GetColumn(0) : column), this.lastSortOrder, this.SecondarySortColumn, this.SecondarySortOrder); foreach (ListViewGroup group in groups) { if (this.ShowItemCountOnGroups) { int count = map[group.Tag].Count; group.Header = String.Format((count == 1 ? singularFmt : fmt), group.Header, count); } this.Groups.Add(group); // If there is no sort order, don't sort since the sort isn't stable if (this.lastSortOrder != SortOrder.None) map[group.Tag].Sort(itemSorter); group.Items.AddRange(map[group.Tag].ToArray()); } } /// /// Pause (or unpause) all animations in the list /// /// true to pause, false to unpause public void PauseAnimations(bool isPause) { for (int i = 0; i < this.Columns.Count; i++) { OLVColumn col = this.GetColumn(i); if (col.Renderer is ImageRenderer) ((ImageRenderer)col.Renderer).Paused = isPause; } } /// /// Give the listview a reasonable size of its tiles, based on the number of lines of /// information that each tile is going to display. /// public void CalculateReasonableTileSize() { if (this.Columns.Count <= 0) return; int imageHeight = (this.LargeImageList == null ? 16 : this.LargeImageList.ImageSize.Height); int dataHeight = (this.Font.Height + 1) * this.Columns.Count; int tileWidth = (this.TileSize.Width == 0 ? 200 : this.TileSize.Width); int tileHeight = Math.Max(this.TileSize.Height, Math.Max(imageHeight, dataHeight)); this.TileSize = new Size(tileWidth, tileHeight); } /// /// Rebuild this list for the given view /// /// internal void ChangeToFilteredColumns(View view) { // Store the state ArrayList previousSelection = this.SelectedObjects; int previousTopIndex = this.TopItemIndex; this.Freeze(); this.Clear(); List cols = this.GetFilteredColumns(view); this.Columns.AddRange(cols.ToArray()); if (view == View.Details) { foreach (OLVColumn x in cols) { if (x.LastDisplayIndex == -1 || x.LastDisplayIndex > cols.Count - 1) x.DisplayIndex = cols.Count - 1; else x.DisplayIndex = x.LastDisplayIndex; } this.ShowSortIndicator(); } this.BuildList(); this.Unfreeze(); // Restore the state this.SelectedObjects = previousSelection; this.TopItemIndex = previousTopIndex; } /// /// Rebuild the columns based upon its current view and column visibility settings /// public void RebuildColumns() { this.ChangeToFilteredColumns(this.View); } /// /// Copy a text and html representation of the selected rows onto the clipboard. /// /// 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. public void CopySelectionToClipboard() { //THINK: Do we want to include something like this? //if (this.SelectedIndices.Count > 10000) // return; this.CopyObjectsToClipboard(this.SelectedObjects); } /// /// Copy a text and html representation of the given objects onto the clipboard. /// public void CopyObjectsToClipboard(IList objectsToCopy) { if (objectsToCopy.Count == 0) return; List columns = this.ColumnsInDisplayOrder; // Build text and html versions of the selection StringBuilder sbText = new StringBuilder(); StringBuilder sbHtml = new StringBuilder(""); foreach (object modelObject in objectsToCopy) { sbHtml.Append(""); } sbHtml.AppendLine("
"); foreach (OLVColumn col in columns) { if (col != columns[0]) { sbText.Append("\t"); sbHtml.Append(""); } string strValue = col.GetStringValue(modelObject); sbText.Append(strValue); sbHtml.Append(strValue); //TODO: Should encode the string value } sbText.AppendLine(); sbHtml.AppendLine("
"); // Put both the text and html versions onto the clipboard DataObject dataObject = new DataObject(); dataObject.SetText(sbText.ToString(), TextDataFormat.UnicodeText); dataObject.SetText(ConvertToHtmlFragment(sbHtml.ToString()), TextDataFormat.Html); Clipboard.SetDataObject(dataObject); } /// /// Convert the fragment of HTML into the Clipboards HTML format. /// /// The HTML format is found here http://msdn2.microsoft.com/en-us/library/aa767917.aspx /// /// The HTML to put onto the clipboard. It must be valid HTML! /// A string that can be put onto the clipboard and will be recognized as HTML private string ConvertToHtmlFragment(string fragment) { // Minimal implementation of HTML clipboard format string source = "http://www.codeproject.com/KB/list/ObjectListView.aspx"; const String MARKER_BLOCK = "Version:1.0\r\n" + "StartHTML:{0,8}\r\n" + "EndHTML:{1,8}\r\n" + "StartFragment:{2,8}\r\n" + "EndFragment:{3,8}\r\n" + "StartSelection:{2,8}\r\n" + "EndSelection:{3,8}\r\n" + "SourceURL:{4}\r\n" + "{5}"; int prefixLength = String.Format(MARKER_BLOCK, 0, 0, 0, 0, source, "").Length; const String DEFAULT_HTML_BODY = "" + "{0}"; string html = String.Format(DEFAULT_HTML_BODY, fragment); int startFragment = prefixLength + html.IndexOf(fragment); int endFragment = startFragment + fragment.Length; return String.Format(MARKER_BLOCK, prefixLength, prefixLength + html.Length, startFragment, endFragment, source, html); } /// /// Return a byte array that represents the current state of the ObjectListView, such /// that the state can be restored by RestoreState() /// /// /// The state of an ObjectListView includes the attributes that the user can modify: /// /// current view (i.e. Details, Tile, Large Icon...) /// sort column and direction /// column order /// column widths /// column visibility /// /// /// /// It does not include selection or the scroll position. /// /// /// A byte array representing the state of the ObjectListView public byte[] SaveState() { ObjectListViewState olvState = new ObjectListViewState(); olvState.VersionNumber = 1; olvState.NumberOfColumns = this.AllColumns.Count; olvState.CurrentView = this.View; // If we have a sort column, it is possible that it is not currently being shown, in which // case, it's Index will be -1. So we calculate its index directly. Technically, the sort // column does not even have to a member of AllColumns, in which case IndexOf will return -1, // which is works fine since we have no way of restoring such a column anyway. if (this.lastSortColumn != null) olvState.SortColumn = this.AllColumns.IndexOf(this.lastSortColumn); olvState.LastSortOrder = this.lastSortOrder; olvState.IsShowingGroups = this.ShowGroups; if (this.AllColumns.Count > 0 && this.AllColumns[0].LastDisplayIndex == -1) this.RememberDisplayIndicies(); foreach (OLVColumn column in this.AllColumns) { olvState.ColumnIsVisible.Add(column.IsVisible); olvState.ColumnDisplayIndicies.Add(column.LastDisplayIndex); olvState.ColumnWidths.Add(column.Width); } // Now that we have stored our state, convert it to a byte array MemoryStream ms = new MemoryStream(); BinaryFormatter serializer = new BinaryFormatter(); serializer.Serialize(ms, olvState); return ms.ToArray(); } /// /// Restore the state of the control from the given string, which must have been /// produced by SaveState() /// /// A byte array returned from SaveState() /// Returns true if the state was restored public bool RestoreState(byte[] state) { MemoryStream ms = new MemoryStream(state); BinaryFormatter deserializer = new BinaryFormatter(); ObjectListViewState olvState; try { olvState = deserializer.Deserialize(ms) as ObjectListViewState; } catch (System.Runtime.Serialization.SerializationException) { return false; } // The number of columns has changed. We have no way to match old // columns to the new ones, so we just give up. if (olvState.NumberOfColumns != this.AllColumns.Count) return false; if (olvState.SortColumn == -1) { this.lastSortColumn = null; this.lastSortOrder = SortOrder.None; } else { this.lastSortColumn = this.AllColumns[olvState.SortColumn]; this.lastSortOrder = olvState.LastSortOrder; } for (int i = 0; i < olvState.NumberOfColumns; i++) { OLVColumn column = this.AllColumns[i]; column.Width = (int)olvState.ColumnWidths[i]; column.IsVisible = (bool)olvState.ColumnIsVisible[i]; column.LastDisplayIndex = (int)olvState.ColumnDisplayIndicies[i]; } if (olvState.IsShowingGroups != this.ShowGroups) this.ShowGroups = olvState.IsShowingGroups; if (this.View == olvState.CurrentView) this.RebuildColumns(); else this.View = olvState.CurrentView; return true; } /// /// Instances of this class are used to store the state of an ObjectListView. /// [Serializable] internal class ObjectListViewState { public int VersionNumber = 1; public int NumberOfColumns = 1; public View CurrentView; public int SortColumn = -1; public bool IsShowingGroups; public SortOrder LastSortOrder = SortOrder.None; public ArrayList ColumnIsVisible = new ArrayList(); public ArrayList ColumnDisplayIndicies = new ArrayList(); public ArrayList ColumnWidths = new ArrayList(); } #endregion #region Event handlers /// /// Event handler for the column click event /// virtual protected void HandleColumnClick(object sender, ColumnClickEventArgs e) { if (!this.PossibleFinishCellEditing()) return; // Toggle the sorting direction on successive clicks on the same column if (this.lastSortColumn != null && e.Column == this.lastSortColumn.Index) this.lastSortOrder = (this.lastSortOrder == SortOrder.Descending ? SortOrder.Ascending : SortOrder.Descending); else this.lastSortOrder = SortOrder.Ascending; this.BeginUpdate(); this.Sort(e.Column); this.EndUpdate(); } /// /// Handle when a user checks/unchecks a row /// protected void HandleItemCheck(object sender, ItemCheckEventArgs e) { if (this.CheckStatePutter != null) e.NewValue = this.CheckStatePutter(this.GetModelObject(e.Index), e.NewValue); } #endregion #region Low level Windows message handling /// /// Override the basic message pump for this control /// /// protected override void WndProc(ref Message m) { switch (m.Msg) { case 0x0F: // WM_PAINT this.HandlePrePaint(); base.WndProc(ref m); this.HandlePostPaint(); break; case 0x4E: // WM_NOTIFY if (!this.HandleNotify(ref m)) base.WndProc(ref m); break; case 0x114: // WM_HSCROLL: case 0x115: // WM_VSCROLL: case 0x201: // WM_LBUTTONDOWN: case 0x20A: // WM_MOUSEWHEEL: case 0x20E: // WM_MOUSEHWHEEL: if (this.PossibleFinishCellEditing()) base.WndProc(ref m); break; case 0x7B: // WM_CONTEXTMENU if (!this.HandleContextMenu(ref m)) base.WndProc(ref m); break; default: base.WndProc(ref m); break; } } #endregion #region Empty List Msg handling /// /// Perform any steps needed before painting the control /// protected void HandlePrePaint() { // When we get a WM_PAINT msg, remember the rectangle that is being updated. // We can't get this information later, since the BeginPaint call wipes it out. this.lastUpdateRectangle = NativeMethods.GetUpdateRect(this); // When the list is empty, we want to handle the drawing of the control by ourselves. // Unfortunately, there is no easy way to tell our superclass that we want to do this. // So we resort to guile and deception. We validate the list area of the control, which // effectively tells our superclass that this area does not need to be painted. // Our superclass will then not paint the control, leaving us free to do so ourselves. // Without doing this trickery, the superclass will draw the // list as empty, and then moments later, we will draw the empty msg, giving a nasty flicker if (this.GetItemCount() == 0 && this.HasEmptyListMsg) NativeMethods.ValidateRect(this, this.ClientRectangle); } /// /// Perform any steps needed after painting the control /// protected void HandlePostPaint() { // If the list isn't empty or there isn't an emptyList msg, do nothing if (this.GetItemCount() != 0 || !this.HasEmptyListMsg) return; // Draw the empty list msg centered in the client area of the control using (BufferedGraphics buffered = BufferedGraphicsManager.Current.Allocate(this.CreateGraphics(), this.ClientRectangle)) { Graphics g = buffered.Graphics; g.Clear(this.BackColor); StringFormat sf = new StringFormat(); sf.Alignment = StringAlignment.Center; sf.LineAlignment = StringAlignment.Center; sf.Trimming = StringTrimming.EllipsisCharacter; g.DrawString(this.EmptyListMsg, this.EmptyListMsgFontOrDefault, SystemBrushes.ControlDark, this.ClientRectangle, sf); buffered.Render(); } } #endregion #region Column header clicking, column hiding and resizing /// /// When the control is created capture the messages for the header. /// protected override void OnCreateControl() { base.OnCreateControl(); #if !MONO hdrCtrl = new HeaderControl(this); #endif } #if !MONO private HeaderControl hdrCtrl = null; /// /// Class used to capture window messages for the header of the list view /// control. /// /// We only need this class in order to not change the cursor /// when the cursor is over the divider of a fixed width column. It /// really is a little too perfectionist even for me. private class HeaderControl : NativeWindow { private ObjectListView parentListView = null; public HeaderControl(ObjectListView olv) { this.parentListView = olv; this.AssignHandle(NativeMethods.GetHeaderControl(olv)); } /// /// Return the Windows handle behind this control /// /// /// When an ObjectListView is initialized as part of a UserControl, the /// GetHeaderControl() method returns 0 until the UserControl is /// completely initialized. So the AssignHandle() call in the constructor /// doesn't work. So we override the Handle property so value is always /// current. /// public new IntPtr Handle { get { return NativeMethods.GetHeaderControl(this.parentListView); } } protected override void WndProc(ref Message message) { const int WM_SETCURSOR = 0x0020; switch (message.Msg) { case WM_SETCURSOR: if (IsCursorOverLockedDivider()) { message.Result = (IntPtr)1; // Don't change the cursor return; } break; } base.WndProc(ref message); } private bool IsCursorOverLockedDivider() { Point pt = this.parentListView.PointToClient(Cursor.Position); pt.X += NativeMethods.GetScrollPosition(this.parentListView.Handle, true); int dividerIndex = NativeMethods.GetDividerUnderPoint(this.Handle, pt); if (dividerIndex >= 0 && dividerIndex < this.parentListView.Columns.Count) { OLVColumn column = this.parentListView.GetColumn(dividerIndex); return column.IsFixedWidth || column.FillsFreeSpace; } else return false; } /// /// Return the index of the column under the current cursor position, /// or -1 if the cursor is not over a column /// /// Index of the column under the cursor, or -1 public int GetColumnIndexUnderCursor() { Point pt = this.parentListView.PointToClient(Cursor.Position); pt.X += NativeMethods.GetScrollPosition(this.parentListView.Handle, true); return NativeMethods.GetColumnUnderPoint(this.Handle, pt); } } #endif /// /// The user wants to see the context menu. /// /// The windows message /// A bool indicating if this message has been handled /// /// We want to ignore context menu requests that are triggered by right clicks on the header /// protected bool HandleContextMenu(ref Message m) { // Don't try to handle context menu commands at design time. if (this.DesignMode) return false; // If the context menu command was generated by the keyboard, LParam will be -1. // We don't want to process these. if (((int)m.LParam) == -1) return false; // If the context menu came from somewhere other than the header control, // we also don't want to ignore it if (m.WParam != this.hdrCtrl.Handle) return false; // OK. Looks like a right click in the header if (!this.PossibleFinishCellEditing()) return true; int columnIndex = this.hdrCtrl.GetColumnIndexUnderCursor(); return this.HandleHeaderRightClick(columnIndex); } /// /// In the notification messages, we handle attempts to change the width of our columns /// /// The msg to be processed /// bool to indicate if the msg has been handled protected bool HandleNotify(ref Message m) { bool isMsgHandled = false; const int HDN_FIRST = (0 - 300); const int HDN_ITEMCHANGINGA = (HDN_FIRST - 0); const int HDN_ITEMCHANGINGW = (HDN_FIRST - 20); const int HDN_ITEMCLICKA = (HDN_FIRST - 2); const int HDN_ITEMCLICKW = (HDN_FIRST - 22); const int HDN_DIVIDERDBLCLICKA = (HDN_FIRST - 5); const int HDN_DIVIDERDBLCLICKW = (HDN_FIRST - 25); const int HDN_BEGINTRACKA = (HDN_FIRST - 6); const int HDN_BEGINTRACKW = (HDN_FIRST - 26); //const int HDN_ENDTRACKA = (HDN_FIRST - 7); //const int HDN_ENDTRACKW = (HDN_FIRST - 27); const int HDN_TRACKA = (HDN_FIRST - 8); const int HDN_TRACKW = (HDN_FIRST - 28); // Handle the notification, remembering to handle both ANSI and Unicode versions NativeMethods.NMHDR nmhdr = (NativeMethods.NMHDR)m.GetLParam(typeof(NativeMethods.NMHDR)); //if (nmhdr.code < HDN_FIRST) // System.Diagnostics.Debug.WriteLine(nmhdr.code); // In KB Article #183258, MS states that when a header control has the HDS_FULLDRAG style, it will receive // ITEMCHANGING events rather than TRACK events. Under XP SP2 (at least) this is not always true, which may be // why MS has withdrawn that particular KB article. It is true that the header is always given the HDS_FULLDRAG // style. But even while window style set, the control doesn't always received ITEMCHANGING events. // The controlling setting seems to be the Explorer option "Show Window Contents While Dragging"! // In the category of "truly bizarre side effects", if the this option is turned on, we will receive // ITEMCHANGING events instead of TRACK events. But if it is turned off, we receive lots of TRACK events and // only one ITEMCHANGING event at the very end of the process. // If we receive HDN_TRACK messages, it's harder to control the resizing process. If we return a result of 1, we // cancel the whole drag operation, not just that particular track event, which is clearly not what we want. // If we are willing to compile with unsafe code enabled, we can modify the size of the column in place, using the // commented out code below. But without unsafe code, the best we can do is allow the user to drag the column to // any width, and then spring it back to within bounds once they release the mouse button. UI-wise it's very ugly. NativeMethods.NMHEADER nmheader; switch (nmhdr.code) { case HDN_ITEMCLICKA: case HDN_ITEMCLICKW: if (!this.PossibleFinishCellEditing()) { m.Result = (IntPtr)1; // prevent the change from happening isMsgHandled = true; } break; case HDN_DIVIDERDBLCLICKA: case HDN_DIVIDERDBLCLICKW: case HDN_BEGINTRACKA: case HDN_BEGINTRACKW: if (!this.PossibleFinishCellEditing()) { m.Result = (IntPtr)1; // prevent the change from happening isMsgHandled = true; break; } nmheader = (NativeMethods.NMHEADER)m.GetLParam(typeof(NativeMethods.NMHEADER)); if (nmheader.iItem >= 0 && nmheader.iItem < this.Columns.Count) { OLVColumn column = this.GetColumn(nmheader.iItem); // Space filling columns can't be dragged or double-click resized if (column.FillsFreeSpace) { m.Result = (IntPtr)1; // prevent the change from happening isMsgHandled = true; } } break; case HDN_TRACKA: case HDN_TRACKW: nmheader = (NativeMethods.NMHEADER)m.GetLParam(typeof(NativeMethods.NMHEADER)); if (nmheader.iItem >= 0 && nmheader.iItem < this.Columns.Count) { // unsafe { // NativeMethods.HDITEM *hditem = (NativeMethods.HDITEM*)nmheader.pHDITEM; // OLVColumn column = this.GetColumn(nmheader.iItem); // if (hditem->cxy < column.MiniumWidth) // hditem->cxy = column.MiniumWidth; // else if (column.MaxiumWidth != -1 && hditem->cxy > column.MaxiumWidth) // hditem->cxy = column.MaxiumWidth; // } } break; case HDN_ITEMCHANGINGA: case HDN_ITEMCHANGINGW: nmheader = (NativeMethods.NMHEADER)m.GetLParam(typeof(NativeMethods.NMHEADER)); if (nmheader.iItem >= 0 && nmheader.iItem < this.Columns.Count) { NativeMethods.HDITEM hditem = (NativeMethods.HDITEM)Marshal.PtrToStructure(nmheader.pHDITEM, typeof(NativeMethods.HDITEM)); OLVColumn column = this.GetColumn(nmheader.iItem); // Check the mask to see if the width field is valid, and if it is, make sure it's within range if ((hditem.mask & 1) == 1) { if (hditem.cxy < column.MinimumWidth || (column.MaximumWidth != -1 && hditem.cxy > column.MaximumWidth)) { m.Result = (IntPtr)1; // prevent the change from happening isMsgHandled = true; } } } break; default: break; } return isMsgHandled; } /// /// The user has right clicked on the column headers. Do whatever is required /// /// Return true if this event has been handle virtual protected bool HandleHeaderRightClick(int columnIndex) { ColumnClickEventArgs eventArgs = new ColumnClickEventArgs(columnIndex); this.OnColumnRightClick(eventArgs); if (this.SelectColumnsOnRightClick) this.ShowColumnSelectMenu(Cursor.Position); return this.SelectColumnsOnRightClick; } /// /// The user has right clicked on the column headers. Do whatever is required /// /// Return true if this event has been handle [Obsolete("Use HandleHeaderRightClick(int) instead")] virtual protected bool HandleHeaderRightClick() { return false; } /// /// Tell the world when a cell is about to finish being edited. /// protected virtual void OnColumnRightClick(ColumnClickEventArgs e) { if (this.ColumnRightClick != null) this.ColumnRightClick(this, e); } /// /// The callbacks for RightColumnClick events /// public delegate void ColumnRightClickEventHandler(object sender, ColumnClickEventArgs e); /// /// Triggered when a column header is right clicked. /// [Category("Behavior")] public event ColumnRightClickEventHandler ColumnRightClick; /// /// Show a popup menu at the given point which will allow the user to choose which columns /// are visible on this listview /// /// Where should the menu be placed protected void ShowColumnSelectMenu(Point pt) { ContextMenuStrip m = this.MakeColumnSelectMenu(null); m.Show(pt); } /// /// Append the column selection menu items to the given menu strip. /// /// The menu to which the items will be added. If this is null, a new /// ContextMenuStrip will be created /// Return the menu to which the items were added public ContextMenuStrip MakeColumnSelectMenu(ContextMenuStrip strip) { if (strip == null) strip = new ContextMenuStrip(); strip.ItemClicked += new ToolStripItemClickedEventHandler(ColumnSelectMenu_ItemClicked); strip.Closing += new ToolStripDropDownClosingEventHandler(ColumnSelectMenu_Closing); List columns = new List(this.AllColumns); columns.Sort(delegate(OLVColumn x, OLVColumn y) { return String.Compare(x.Text, y.Text, true); }); foreach (OLVColumn col in columns) { ToolStripMenuItem mi = new ToolStripMenuItem(col.Text); mi.Checked = col.IsVisible; mi.Tag = col; // The 'Index' property returns -1 when the column is not visible, so if the // column isn't visible we have to enable the item. Also the first column can't be turned off mi.Enabled = !col.IsVisible || (col.Index > 0); strip.Items.Add(mi); } return strip; } private void ColumnSelectMenu_ItemClicked(object sender, ToolStripItemClickedEventArgs e) { ToolStripMenuItem mi = (ToolStripMenuItem)e.ClickedItem; OLVColumn col = (OLVColumn)mi.Tag; mi.Checked = !mi.Checked; col.IsVisible = mi.Checked; this.BeginInvoke(new MethodInvoker(this.RebuildColumns)); } private void ColumnSelectMenu_Closing(object sender, ToolStripDropDownClosingEventArgs e) { e.Cancel = (this.SelectColumnsMenuStaysOpen && e.CloseReason == ToolStripDropDownCloseReason.ItemClicked); } /// /// Override the OnColumnReordered method to do what we want /// /// protected override void OnColumnReordered(ColumnReorderedEventArgs e) { base.OnColumnReordered(e); // The internal logic of the .NET code behind a ENDDRAG event means that, // at this point, the DisplayIndex's of the columns are not yet as they are // going to be. So we have to invoke a method to run later that will remember // what the real DisplayIndex's are. this.BeginInvoke(new MethodInvoker(this.RememberDisplayIndicies)); } private void RememberDisplayIndicies() { // Remember the display indexes so we can put them back at a later date foreach (OLVColumn x in this.AllColumns) x.LastDisplayIndex = x.DisplayIndex; } void HandleColumnWidthChanging(object sender, ColumnWidthChangingEventArgs e) { if (this.UpdateSpaceFillingColumnsWhenDraggingColumnDivider && !this.GetColumn(e.ColumnIndex).FillsFreeSpace) this.ResizeFreeSpaceFillingColumns(); } void HandleColumnWidthChanged(object sender, ColumnWidthChangedEventArgs e) { if (!this.GetColumn(e.ColumnIndex).FillsFreeSpace) this.ResizeFreeSpaceFillingColumns(); } void HandleLayout(object sender, LayoutEventArgs e) { this.ResizeFreeSpaceFillingColumns(); } /// /// Resize our space filling columns so they fill any unoccupied width in the control /// protected void ResizeFreeSpaceFillingColumns() { // It's too confusing to dynamically resize columns at design time. if (this.DesignMode) return; // Calculate the free space available int freeSpace = this.ClientSize.Width - 2; int totalProportion = 0; List spaceFillingColumns = new List(); for (int i = 0; i < this.Columns.Count; i++) { OLVColumn col = this.GetColumn(i); if (col.FillsFreeSpace) { spaceFillingColumns.Add(col); totalProportion += col.FreeSpaceProportion; } else freeSpace -= col.Width; } freeSpace = Math.Max(0, freeSpace); // Any space filling column that would hit it's Minimum or Maximum // width must be treated as a fixed column. foreach (OLVColumn col in spaceFillingColumns.ToArray()) { int newWidth = (freeSpace * col.FreeSpaceProportion) / totalProportion; if (col.MinimumWidth != -1 && newWidth < col.MinimumWidth) newWidth = col.MinimumWidth; else if (col.MaximumWidth != -1 && newWidth > col.MaximumWidth) newWidth = col.MaximumWidth; else newWidth = 0; if (newWidth > 0) { col.Width = newWidth; freeSpace -= newWidth; totalProportion -= col.FreeSpaceProportion; spaceFillingColumns.Remove(col); } } // Distribute the free space between the columns foreach (OLVColumn col in spaceFillingColumns) { col.Width = (freeSpace * col.FreeSpaceProportion) / totalProportion; } } #endregion #region Checkboxes /// /// Change the given item from the old check value to a new one /// /// The item to be change /// The old value of the check /// The new value of the check protected void ChangeCheckItem(OLVListItem olvi, bool oldValue, bool newValue) { this.ChangeCheckItem(olvi, (oldValue ? CheckState.Checked : CheckState.Unchecked), (newValue ? CheckState.Checked : CheckState.Unchecked)); } /// /// Change the given item from the old check value to a new one /// /// The item to be change /// The old value of the check /// The new value of the check protected void ChangeCheckItem(OLVListItem olvi, CheckState oldValue, CheckState newValue) { olvi.Checked = (newValue == CheckState.Checked); if (this.CheckStatePutter != null) this.CheckStatePutter(olvi.RowObject, newValue); this.RefreshItem(olvi); } /// /// Return true of the given object is checked /// /// The model object whose checkedness is returned /// Is the given object checked? /// If the given object is not in the list, this method returns false. public bool IsChecked(object modelObject) { OLVListItem olvi = this.ModelToItem(modelObject); if (olvi == null) return false; else return olvi.Checked; } /// /// Return the OLVListItem that displays the given model object /// /// The modelObject whose item is to be found /// The OLVListItem that displays the model, or null /// This method has O(n) performance. protected OLVListItem ModelToItem(object modelObject) { if (modelObject == null) return null; OLVListItem olvi; foreach (ListViewItem lvi in this.Items) { olvi = (OLVListItem)lvi; if (olvi.RowObject == modelObject) return olvi; } return null; } /// /// Toggle the checkedness of the given object /// /// The model object to be checked public void ToggleCheckObject(object modelObject) { OLVListItem olvi = this.ModelToItem(modelObject); if (olvi != null) this.ChangeCheckItem(olvi, olvi.Checked, !olvi.Checked); } /// /// Mark the given object as checked in the list /// /// The model object to be checked public void CheckObject(object modelObject) { OLVListItem olvi = this.ModelToItem(modelObject); if (olvi != null && !olvi.Checked) this.ChangeCheckItem(olvi, false, true); } /// /// Mark the given object as unchecked in the list /// /// The model object to be unchecked public void UncheckObject(object modelObject) { OLVListItem olvi = this.ModelToItem(modelObject); if (olvi != null && olvi.Checked) this.ChangeCheckItem(olvi, true, false); } #endregion #region OLV accessing /// /// Return the column at the given index /// /// Index of the column to be returned /// An OLVColumn public OLVColumn GetColumn(int index) { return (OLVColumn)this.Columns[index]; } /// /// Return the column at the given title. /// /// Name of the column to be returned /// An OLVColumn public OLVColumn GetColumn(string name) { foreach (ColumnHeader column in this.Columns) { if (column.Text == name) return (OLVColumn)column; } return null; } /// /// Return the number of items in the list /// /// the number of items in the list virtual public int GetItemCount() { return this.Items.Count; } /// /// Return the item at the given index /// /// Index of the item to be returned /// An OLVListItem virtual public OLVListItem GetItem(int index) { if (index >= 0 && index < this.GetItemCount()) return (OLVListItem)this.Items[index]; else return null; } /// /// Return the model object at the given index /// /// Index of the model object to be returned /// A model object virtual public object GetModelObject(int index) { return this.GetItem(index).RowObject; } /// /// Find the item and column that are under the given co-ords /// /// X co-ord /// Y co-ord /// The column under the given point /// The item under the given point. Can be null. public OLVListItem GetItemAt(int x, int y, out OLVColumn selectedColumn) { selectedColumn = null; ListViewHitTestInfo info = this.HitTest(x, y); if (info.Item == null) return null; if (info.SubItem != null) { int subItemIndex = info.Item.SubItems.IndexOf(info.SubItem); selectedColumn = this.GetColumn(subItemIndex); } return (OLVListItem)info.Item; } #endregion #region Object manipulation /// /// Select all rows in the listview /// public void SelectAll() { NativeMethods.SelectAllItems(this); } /// /// Deselect all rows in the listview /// public void DeselectAll() { NativeMethods.DeselectAllItems(this); } /// /// Return the model object of the row that is selected or null if there is no selection or more than one selection /// /// Model object or null virtual public object GetSelectedObject() { if (this.SelectedIndices.Count == 1) return this.GetModelObject(this.SelectedIndices[0]); else return null; } /// /// Return the model objects of the rows that are selected or an empty collection if there is no selection /// /// ArrayList virtual public ArrayList GetSelectedObjects() { ArrayList objects = new ArrayList(this.SelectedIndices.Count); foreach (int index in this.SelectedIndices) objects.Add(this.GetModelObject(index)); return objects; } /// /// Return the model object of the row that is checked or null if no row is checked /// or more than one row is checked /// /// Model object or null /// Use CheckedObject property instead of this method virtual public object GetCheckedObject() { return this.CheckedObject; } /// /// Get the collection of model objects that are checked. /// /// Use CheckedObjects property instead of this method virtual public ArrayList GetCheckedObjects() { return (ArrayList)this.CheckedObjects; } /// /// Select the row that is displaying the given model object. All other rows are deselected. /// /// The object to be selected or null to deselect all virtual public void SelectObject(object modelObject) { // If the given model is already selected, don't do anything else (prevents an flicker) if (this.SelectedItems.Count == 1 && ((OLVListItem)this.SelectedItems[0]).RowObject == modelObject) return; this.SelectedItems.Clear(); OLVListItem olvi = this.ModelToItem(modelObject); if (olvi != null) olvi.Selected = true; } /// /// Select the rows that is displaying any of the given model object. All other rows are deselected. /// /// A collection of model objects virtual public void SelectObjects(IList modelObjects) { this.SelectedItems.Clear(); foreach (object modelObject in modelObjects) { OLVListItem olvi = this.ModelToItem(modelObject); if (olvi != null) olvi.Selected = true; } } /// /// Update the ListViewItem with the data from its associated model. /// /// This method does not resort or regroup the view. It simply updates /// the displayed data of the given item virtual public void RefreshItem(OLVListItem olvi) { // For some reason, clearing the subitems also wipes out the back color, // so we need to store it and then put it back again later Color c = olvi.BackColor; olvi.SubItems.Clear(); this.FillInValues(olvi, olvi.RowObject); this.SetSubItemImages(olvi.Index, olvi, true); olvi.BackColor = c; } /// /// Update the rows that are showing the given objects /// /// This method does not resort or regroup the view. virtual public void RefreshObject(object modelObject) { this.RefreshObjects(new object[] { modelObject }); } /// /// Update the rows that are showing the given objects /// /// /// This method does not resort or regroup the view. /// This method can safely be called from background threads. /// virtual public void RefreshObjects(IList modelObjects) { if (this.InvokeRequired) { this.Invoke((MethodInvoker)delegate { this.RefreshObjects(modelObjects); }); return; } foreach (object modelObject in modelObjects) { OLVListItem olvi = this.ModelToItem(modelObject); if (olvi != null) this.RefreshItem(olvi); } } /// /// Update the rows that are selected /// /// This method does not resort or regroup the view. public void RefreshSelectedObjects() { foreach (ListViewItem lvi in this.SelectedItems) this.RefreshItem((OLVListItem)lvi); } /// /// Find the given model object within the listview and return its index /// /// Technically, this method will work with virtual lists, but it will /// probably be very slow. /// The model object to be found /// The index of the object. -1 means the object was not present public int IndexOf(Object modelObject) { for (int i = 0; i < this.GetItemCount(); i++) { if (this.GetModelObject(i) == modelObject) return i; } return -1; } /// /// 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. /// /// The item that is before the item that is returned, or null /// A ListViewItem public ListViewItem GetNextItem(ListViewItem itemToFind) { if (this.ShowGroups) { bool isFound = (itemToFind == null); foreach (ListViewGroup group in this.Groups) { foreach (ListViewItem lvi in group.Items) { if (isFound) return lvi; isFound = (lvi == itemToFind); } } return null; } else { if (this.GetItemCount() == 0) return null; if (itemToFind == null) return this.GetItem(0); if (itemToFind.Index == this.GetItemCount() - 1) return null; return this.GetItem(itemToFind.Index + 1); } } /// /// 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. /// /// The item that is before the item that is returned /// A ListViewItem public ListViewItem GetPreviousItem(ListViewItem itemToFind) { if (this.ShowGroups) { ListViewItem previousItem = null; foreach (ListViewGroup group in this.Groups) { foreach (ListViewItem lvi in group.Items) { if (lvi == itemToFind) return previousItem; else previousItem = lvi; } } if (itemToFind == null) return previousItem; else return null; } else { if (this.GetItemCount() == 0) return null; if (itemToFind == null) return this.GetItem(this.GetItemCount() - 1); if (itemToFind.Index == 0) return null; return this.GetItem(itemToFind.Index - 1); } } #endregion #region Freezing /// /// Freeze the listview so that it no longer updates itself. /// /// Freeze()/Unfreeze() calls nest correctly public void Freeze() { freezeCount++; } /// /// Unfreeze the listview. If this call is the outermost Unfreeze(), /// the contents of the listview will be rebuilt. /// /// Freeze()/Unfreeze() calls nest correctly public void Unfreeze() { if (freezeCount <= 0) return; freezeCount--; if (freezeCount == 0) DoUnfreeze(); } /// /// Do the actual work required when the listview is unfrozen /// virtual protected void DoUnfreeze() { BuildList(); } #endregion #region Column Sorting /// /// Sort the items in the list view by the values in the given column. /// If ShowGroups is true, the rows will be grouped by the given column, /// otherwise, it will be a straight sort. /// /// The name of the column whose values will be used for the sorting public void Sort(string columnToSortName) { this.Sort(this.GetColumn(columnToSortName)); } /// /// Sort the items in the list view by the values in the given column. /// If ShowGroups is true, the rows will be grouped by the given column, /// otherwise, it will be a straight sort. /// /// The index of the column whose values will be used for the sorting public void Sort(int columnToSortIndex) { if (columnToSortIndex >= 0 && columnToSortIndex < this.Columns.Count) this.Sort(this.GetColumn(columnToSortIndex)); } /// /// Sort the items in the list view by the values in the given column. /// If ShowGroups is true, the rows will be grouped by the given column, /// otherwise, it will be a straight sort. /// /// The column whose values will be used for the sorting virtual public void Sort(OLVColumn columnToSort) { if (this.InvokeRequired) { this.Invoke((MethodInvoker)delegate { this.Sort(columnToSort); }); return; } if (this.Columns.Count < 1) return; if (columnToSort == null) columnToSort = this.GetColumn(0); if (lastSortOrder == SortOrder.None) lastSortOrder = this.Sorting; if (this.ShowGroups) this.BuildGroups(columnToSort); else if (this.CustomSorter != null) this.CustomSorter(columnToSort, lastSortOrder); else this.ListViewItemSorter = new ColumnComparer(columnToSort, lastSortOrder, this.SecondarySortColumn, this.SecondarySortOrder); if (this.ShowSortIndicators) this.ShowSortIndicator(columnToSort, lastSortOrder); if (this.UseAlternatingBackColors && this.View == View.Details) PrepareAlternateBackColors(); this.lastSortColumn = columnToSort; } /// /// Put a sort indicator next to the text of the sort column /// public void ShowSortIndicator() { if (this.ShowSortIndicators && this.lastSortOrder != SortOrder.None) this.ShowSortIndicator(this.lastSortColumn, this.lastSortOrder); } /// /// Put a sort indicator next to the text of the given given column /// /// The column to be marked /// The sort order in effect on that column protected void ShowSortIndicator(OLVColumn columnToSort, SortOrder sortOrder) { int imageIndex = -1; if (!NativeMethods.HasBuiltinSortIndicators()) { // If we can't use builtin image, we have to make and then locate the index of the // sort indicator we want to use. SortOrder.None doesn't show an image. if (this.SmallImageList == null || !this.SmallImageList.Images.ContainsKey(SORT_INDICATOR_UP_KEY)) MakeSortIndicatorImages(); if (sortOrder == SortOrder.Ascending) imageIndex = this.SmallImageList.Images.IndexOfKey(SORT_INDICATOR_UP_KEY); else if (sortOrder == SortOrder.Descending) imageIndex = this.SmallImageList.Images.IndexOfKey(SORT_INDICATOR_DOWN_KEY); } // Set the image for each column for (int i = 0; i < this.Columns.Count; i++) { if (i == columnToSort.Index) NativeMethods.SetColumnImage(this, i, sortOrder, imageIndex); else NativeMethods.SetColumnImage(this, i, SortOrder.None, -1); } } /// /// The name of the image used when a column is sorted ascending /// /// This image is only used on pre-XP systems. System images are used for XP and later public const string SORT_INDICATOR_UP_KEY = "sort-indicator-up"; /// /// The name of the image used when a column is sorted descending /// /// This image is only used on pre-XP systems. System images are used for XP and later public const string SORT_INDICATOR_DOWN_KEY = "sort-indicator-down"; /// /// If the sort indicator images don't already exist, this method will make and install them /// protected void MakeSortIndicatorImages() { ImageList il = this.SmallImageList; if (il == null) { il = new ImageList(); il.ImageSize = new Size(16, 16); } // This arrangement of points works well with (16,16) images, and OK with others int midX = il.ImageSize.Width / 2; int midY = (il.ImageSize.Height / 2) - 1; int deltaX = midX - 2; int deltaY = deltaX / 2; if (il.Images.IndexOfKey(SORT_INDICATOR_UP_KEY) == -1) { Point pt1 = new Point(midX - deltaX, midY + deltaY); Point pt2 = new Point(midX, midY - deltaY - 1); Point pt3 = new Point(midX + deltaX, midY + deltaY); il.Images.Add(SORT_INDICATOR_UP_KEY, this.MakeTriangleBitmap(il.ImageSize, new Point[] { pt1, pt2, pt3 })); } if (il.Images.IndexOfKey(SORT_INDICATOR_DOWN_KEY) == -1) { Point pt1 = new Point(midX - deltaX, midY - deltaY); Point pt2 = new Point(midX, midY + deltaY); Point pt3 = new Point(midX + deltaX, midY - deltaY); il.Images.Add(SORT_INDICATOR_DOWN_KEY, this.MakeTriangleBitmap(il.ImageSize, new Point[] { pt1, pt2, pt3 })); } this.SmallImageList = il; } private Bitmap MakeTriangleBitmap(Size sz, Point[] pts) { Bitmap bm = new Bitmap(sz.Width, sz.Height); Graphics g = Graphics.FromImage(bm); g.FillPolygon(new SolidBrush(Color.Gray), pts); return bm; } #endregion #region Utilities /// /// Fill in the given OLVListItem with values of the given row /// /// the OLVListItem that is to be stuff with values /// the model object from which values will be taken protected void FillInValues(OLVListItem lvi, object rowObject) { if (this.Columns.Count == 0) return; OLVColumn column = this.GetColumn(0); lvi.Text = column.GetStringValue(rowObject); lvi.ImageSelector = column.GetImage(rowObject); for (int i = 1; i < this.Columns.Count; i++) { column = this.GetColumn(i); lvi.SubItems.Add(new OLVListSubItem(column.GetStringValue(rowObject), column.GetImage(rowObject))); } // Give the row formatter a chance to mess with the item if (this.RowFormatter != null) this.RowFormatter(lvi); this.CorrectSubItemColors(lvi); // Get the check state of the row, if we are showing check boxes if (this.CheckBoxes && this.CheckStateGetter != null) lvi.Checked = this.CheckStateGetter(lvi.RowObject); } /// /// Setup all subitem images on all rows /// protected void SetAllSubItemImages() { if (!this.ShowImagesOnSubItems) return; this.ForceSubItemImagesExStyle(); for (int rowIndex = 0; rowIndex < this.GetItemCount(); rowIndex++) SetSubItemImages(rowIndex, this.GetItem(rowIndex)); } /// /// Tell the underlying list control which images to show against the subitems /// /// the index at which the item occurs /// the item whose subitems are to be set protected void SetSubItemImages(int rowIndex, OLVListItem item) { this.SetSubItemImages(rowIndex, item, false); } /// /// Tell the underlying list control which images to show against the subitems /// /// the index at which the item occurs /// the item whose subitems are to be set /// will existing images be cleared if no new image is provided? protected void SetSubItemImages(int rowIndex, OLVListItem item, bool shouldClearImages) { if (!this.ShowImagesOnSubItems) return; for (int i = 1; i < item.SubItems.Count; i++) { int imageIndex = this.GetActualImageIndex(((OLVListSubItem)item.SubItems[i]).ImageSelector); if (shouldClearImages || imageIndex != -1) this.SetSubItemImage(rowIndex, i, imageIndex); } } /// /// Prepare the listview to show alternate row backcolors /// /// We cannot rely on lvi.Index in this method. /// In a straight list, lvi.Index is the display index, and can be used to determine /// whether the row should be colored. But when organised by groups, lvi.Index is not /// useable because it still refers to the position in the overall list, not the display order. /// virtual protected void PrepareAlternateBackColors() { Color rowBackColor = this.AlternateRowBackColorOrDefault; int i = 0; if (this.ShowGroups) { foreach (ListViewGroup group in this.Groups) { foreach (ListViewItem lvi in group.Items) { if (i % 2 == 0) lvi.BackColor = this.BackColor; else lvi.BackColor = rowBackColor; CorrectSubItemColors(lvi); i++; } } } else { foreach (ListViewItem lvi in this.Items) { if (i % 2 == 0) lvi.BackColor = this.BackColor; else lvi.BackColor = rowBackColor; CorrectSubItemColors(lvi); i++; } } } /// /// For some reason, UseItemStyleForSubItems doesn't work for the colors /// when owner drawing the list, so we have to specifically give each subitem /// the desired colors /// /// The item whose subitems are to be corrected protected void CorrectSubItemColors(ListViewItem olvi) { if (this.OwnerDraw && olvi.UseItemStyleForSubItems) foreach (ListViewItem.ListViewSubItem si in olvi.SubItems) { si.BackColor = olvi.BackColor; si.ForeColor = olvi.ForeColor; } } /// /// Convert the given image selector to an index into our image list. /// Return -1 if that's not possible /// /// /// Index of the image in the imageList, or -1 public int GetActualImageIndex(Object imageSelector) { if (imageSelector == null) return -1; if (imageSelector is Int32) return (int)imageSelector; if (imageSelector is String && this.SmallImageList != null) return this.SmallImageList.Images.IndexOfKey((String)imageSelector); return -1; } /// /// Make sure the ListView has the extended style that says to display subitem images. /// /// This method must be called after any .NET call that update the extended styles /// since they seem to erase this setting. protected void ForceSubItemImagesExStyle() { NativeMethods.ForceSubItemImagesExStyle(this); } /// /// For the given item and subitem, make it display the given image /// /// row number (0 based) /// subitem (0 is the item itself) /// index into the image list protected void SetSubItemImage(int itemIndex, int subItemIndex, int imageIndex) { NativeMethods.SetSubItemImage(this, itemIndex, subItemIndex, imageIndex); } #endregion #region ISupportInitialize Members void ISupportInitialize.BeginInit() { this.Frozen = true; } void ISupportInitialize.EndInit() { this.Frozen = false; } #endregion #region Image list manipulation /// /// Update our externally visible image list so it holds the same images as our shadow list, but sized correctly /// private void SetupExternalImageList() { // If a row height hasn't been set, or an image list has been give which is the required size, just assign it if (rowHeight == -1 || (this.shadowedImageList != null && this.shadowedImageList.ImageSize.Height == rowHeight)) base.SmallImageList = this.shadowedImageList; else base.SmallImageList = this.MakeResizedImageList(rowHeight, shadowedImageList); } /// /// Return a copy of the given source image list, where each image has been resized to be height x height in size. /// If source is null, an empty image list of the given size is returned /// /// Height and width of the new images /// Source of the images (can be null) /// A new image list private ImageList MakeResizedImageList(int height, ImageList source) { ImageList il = new ImageList(); il.ImageSize = new Size(height, height); // If there's nothing to copy, just return the new list if (source == null) return il; il.TransparentColor = source.TransparentColor; il.ColorDepth = source.ColorDepth; // Fill the imagelist with resized copies from the source for (int i = 0; i < source.Images.Count; i++) { Bitmap bm = this.MakeResizedImage(height, source.Images[i], source.TransparentColor); il.Images.Add(bm); } // Give each image the same key it has in the original foreach (String key in source.Images.Keys) { il.Images.SetKeyName(source.Images.IndexOfKey(key), key); } return il; } /// /// Return a bitmap of the given height x height, which shows the given image, centred. /// /// Height and width of new bitmap /// Image to be centred /// The background color /// A new bitmap private Bitmap MakeResizedImage(int height, Image image, Color transparent) { Bitmap bm = new Bitmap(height, height); Graphics g = Graphics.FromImage(bm); g.Clear(transparent); int x = Math.Max(0, (bm.Size.Width - image.Size.Width) / 2); int y = Math.Max(0, (bm.Size.Height - image.Size.Height) / 2); g.DrawImage(image, x, y, image.Size.Width, image.Size.Height); return bm; } #endregion #region Owner drawing /// /// Owner draw the column header /// /// protected override void OnDrawColumnHeader(DrawListViewColumnHeaderEventArgs e) { e.DrawDefault = true; base.OnDrawColumnHeader(e); } /// /// Owner draw the item /// /// protected override void OnDrawItem(DrawListViewItemEventArgs e) { // If there is a custom renderer installed for the primary column, // and we're not in details view, give it a chance to draw the item. // So the renderer on the primary column can have two distinct tasks, // in details view, it draws the primary cell; in non-details view, // it draws the whole item. OLVColumn column = this.GetColumn(0); if (this.View != View.Details && column.RendererDelegate != null) { Object row = ((OLVListItem)e.Item).RowObject; e.DrawDefault = !column.RendererDelegate(e, e.Graphics, e.Bounds, row); } else e.DrawDefault = (this.View != View.Details); if (e.DrawDefault) base.OnDrawItem(e); } int[] columnRightEdge = new int[256]; // will anyone ever want more than 256 columns?? /// /// Owner draw a single subitem /// /// protected override void OnDrawSubItem(DrawListViewSubItemEventArgs e) { // Get the special renderer for this column. // If there isn't one, use the default draw mechanism. OLVColumn column = this.GetColumn(e.ColumnIndex); if (column.RendererDelegate == null) { e.DrawDefault = true; return; } // Calculate where the subitem should be drawn // It should be as simple as 'e.Bounds', but it isn't :-( // There seems to be a bug in .NET where the left edge of the bounds of subitem 0 // is always 0. This is normally what is required, but it's wrong when // someone drags column 0 to somewhere else in the listview. We could // drop down into Windows-ville and use LVM_GETSUBITEMRECT, but just to be different // we keep track of the right edge of all columns, and when subitem 0 // isn't being shown at column 0, we make its left edge to be the right // edge of the previous column plus a little bit. //TODO: Replace with LVM_GETSUBITEMRECT Rectangle r = e.Bounds; if (e.ColumnIndex == 0 && e.Header.DisplayIndex != 0) { r.X = this.columnRightEdge[e.Header.DisplayIndex - 1] + 1; } else this.columnRightEdge[e.Header.DisplayIndex] = e.Bounds.Right; // Optimize drawing by only redrawing subitems that touch the area that was damaged #if !MONO if (!r.IntersectsWith(this.lastUpdateRectangle)) { return; } #endif // Get a graphics context for the renderer to use. // But we have more complications. Virtual lists have a nasty habit of drawing column 0 // whenever there is any mouse move events over a row, and doing it in an un-double buffered manner, // which results in nasty flickers! There are also some unbuffered draw when a mouse is first // hovered over column 0 of a normal row. So, to avoid all complications, // we always manually double-buffer the drawing. // Except with Mono, which doesn't seem to handle double buffering at all :-( Graphics g = e.Graphics; BufferedGraphics buffer = null; #if !MONO bool avoidFlickerMode = true; // set this to false to see the probems with flicker if (avoidFlickerMode) { buffer = BufferedGraphicsManager.Current.Allocate(e.Graphics, r); g = buffer.Graphics; } #endif // Finally, give the renderer a chance to draw something Object row = ((OLVListItem)e.Item).RowObject; e.DrawDefault = !column.RendererDelegate(e, g, r, row); if (!e.DrawDefault && buffer != null) { buffer.Render(); buffer.Dispose(); } } #endregion #region Selection Event Handling /// /// This method is called every time a row is selected or deselected. This can be /// a pain if the user shift-clicks 100 rows. We override this method so we can /// trigger one event for any number of select/deselects that come from one user action /// /// protected override void OnSelectedIndexChanged(EventArgs e) { base.OnSelectedIndexChanged(e); // If we haven't already scheduled an event, schedule it to be triggered // By using idle time, we will wait until all select events for the same // user action have finished before triggering the event. if (!this.hasIdleHandler) { this.hasIdleHandler = true; Application.Idle += new EventHandler(Application_Idle); } } private bool hasIdleHandler = false; /// /// The application is idle. Trigger a SelectionChanged event. /// /// /// protected void Application_Idle(object sender, EventArgs e) { // Remove the handler before triggering the event Application.Idle -= new EventHandler(Application_Idle); this.hasIdleHandler = false; this.OnSelectionChanged(new EventArgs()); } /// /// This event is triggered once per user action that changes the selection state /// of one or more rows. /// [Category("Behavior"), Description("This event is triggered once per user action that changes the selection state of one or more rows.")] public event EventHandler SelectionChanged; /// /// Trigger the SelectionChanged event /// /// virtual protected void OnSelectionChanged(EventArgs e) { if (this.SelectionChanged != null) this.SelectionChanged(this, e); } #endregion #region Cell editing // NOTES: // // - What event should we listen to? // // We can't use OnMouseClick, OnMouseDoubleClick, OnClick, or OnDoubleClick // since they are not triggered for clicks on subitems without Full Row Select. // // We could use OnMouseDown, but selecting rows is done in OnMouseUp. This means // that if we start the editing during OnMouseDown, the editor will automatically // lose focus when mouse up happens. // /// /// We need the click count in the mouse up event, but that is always 1. /// So we have to remember the click count from the preceding mouse down event. /// /// protected override void OnMouseDown(MouseEventArgs e) { base.OnMouseDown(e); this.lastMouseDownClickCount = e.Clicks; } private int lastMouseDownClickCount = 0; /// /// Check to see if we need to start editing a cell /// /// protected override void OnMouseUp(MouseEventArgs e) { base.OnMouseUp(e); // If it was an unmodified left click, check to see if we should start editing if (this.ShouldStartCellEdit(e)) { ListViewHitTestInfo info = this.HitTest(e.Location); if (info.Item != null && info.SubItem != null) { int subItemIndex = info.Item.SubItems.IndexOf(info.SubItem); // We don't edit the primary column by single clicks -- only subitems. if (this.CellEditActivation != CellEditActivateMode.SingleClick || subItemIndex > 0) this.EditSubItem((OLVListItem)info.Item, subItemIndex); } } } /// /// Should we start editing the cell? /// /// /// protected bool ShouldStartCellEdit(MouseEventArgs e) { if (e.Button != MouseButtons.Left) return false; if ((Control.ModifierKeys & (Keys.Shift | Keys.Control | Keys.Alt)) != 0) return false; if (this.lastMouseDownClickCount == 1 && this.CellEditActivation == CellEditActivateMode.SingleClick) return true; return (this.lastMouseDownClickCount == 2 && this.CellEditActivation == CellEditActivateMode.DoubleClick); } /// /// Handle a key press on this control. We specifically look for F2 which edits the primary column, /// or a Tab character during an edit operation, which tries to start editing on the next (or previous) cell. /// /// /// protected override bool ProcessDialogKey(Keys keyData) { bool isSimpleTabKey = ((keyData & Keys.KeyCode) == Keys.Tab) && ((keyData & (Keys.Alt | Keys.Control)) == Keys.None); if (isSimpleTabKey && this.IsCellEditing) { // Tab key while editing // If the cell editing was cancelled, don't handle the tab if (!this.PossibleFinishCellEditing()) return true; // We can only Tab between columns when we are in Details view if (this.View != View.Details) return true; OLVListItem olvi = this.cellEditEventArgs.ListViewItem; int subItemIndex = this.cellEditEventArgs.SubItemIndex; int displayIndex = this.GetColumn(subItemIndex).DisplayIndex; // Move to the next or previous editable subitem, depending on Shift key. Wrap at the edges List columnsInDisplayOrder = this.ColumnsInDisplayOrder; do { if ((keyData & Keys.Shift) == Keys.Shift) displayIndex = (olvi.SubItems.Count + displayIndex - 1) % olvi.SubItems.Count; else displayIndex = (displayIndex + 1) % olvi.SubItems.Count; } while (!columnsInDisplayOrder[displayIndex].IsEditable); // If we found a different editable cell, start editing it subItemIndex = columnsInDisplayOrder[displayIndex].Index; if (this.cellEditEventArgs.SubItemIndex != subItemIndex) { this.StartCellEdit(olvi, subItemIndex); return true; } } // Treat F2 as a request to edit the primary column if (keyData == Keys.F2 && !this.IsCellEditing) { this.EditSubItem((OLVListItem)this.FocusedItem, 0); return true; } // We have to catch Return/Enter/Escape here since some types of controls // (e.g. ComboBox, UserControl) don't trigger key events that we can listen for. // Treat Return or Enter as committing the current edit operation if ((keyData == Keys.Return || keyData == Keys.Enter) && this.IsCellEditing) { this.PossibleFinishCellEditing(); return true; } // Treat Escaoe as cancel the current edit operation if (keyData == Keys.Escape && this.IsCellEditing) { this.CancelCellEdit(); return true; } // Treat Ctrl-C as Copy To Clipboard. We still allow the default processing if ((keyData & Keys.Control) == Keys.Control && (keyData & Keys.KeyCode) == Keys.C) this.CopySelectionToClipboard(); return base.ProcessDialogKey(keyData); } /// /// Begin an edit operation on the given cell. /// /// This performs various sanity checks and passes off the real work to StartCellEdit(). /// The row to be edited /// The index of the cell to be edited public void EditSubItem(OLVListItem item, int subItemIndex) { if (item == null) return; if (subItemIndex < 0 && subItemIndex >= item.SubItems.Count) return; if (this.CellEditActivation == CellEditActivateMode.None) return; if (!this.GetColumn(subItemIndex).IsEditable) return; this.StartCellEdit(item, subItemIndex); } /// /// Really start an edit operation on a given cell. The parameters are assumed to be sane. /// /// The row to be edited /// The index of the cell to be edited protected void StartCellEdit(OLVListItem item, int subItemIndex) { OLVColumn column = this.GetColumn(subItemIndex); Rectangle r = this.CalculateCellBounds(item, subItemIndex); Control c = this.GetCellEditor(item, subItemIndex); c.Bounds = r; // Try to align the control as the column is aligned. Not all controls support this property PropertyInfo pinfo = c.GetType().GetProperty("TextAlign"); if (pinfo != null) pinfo.SetValue(c, column.TextAlign, null); // Give the control the value from the model this.SetControlValue(c, column.GetValue(item.RowObject), column.GetStringValue(item.RowObject)); // Give the outside world the chance to munge with the process this.cellEditEventArgs = new CellEditEventArgs(column, c, r, item, subItemIndex); this.OnCellEditStarting(this.cellEditEventArgs); if (this.cellEditEventArgs.Cancel) return; // The event handler may have completely changed the control, so we need to remember it this.cellEditor = this.cellEditEventArgs.Control; // If the control isn't the height of the cell, centre it vertically. We don't // need to do this when in Tile view. if (this.View != View.Tile && this.cellEditor.Height != r.Height) this.cellEditor.Top += (r.Height - this.cellEditor.Height) / 2; this.Controls.Add(this.cellEditor); this.ConfigureControl(); this.PauseAnimations(true); } private Control cellEditor = null; private CellEditEventArgs cellEditEventArgs = null; /// /// Try to give the given value to the provided control. Fall back to assigning a string /// if the value assignment fails. /// /// A control /// The value to be given to the control /// The string to be given if the value doesn't work protected void SetControlValue(Control c, Object value, String stringValue) { // Look for a property called "Value". We have to look twice, the first time might get an ambiguous PropertyInfo pinfo = null; try { pinfo = c.GetType().GetProperty("Value"); } catch (AmbiguousMatchException) { // The lowest level class of the control must have overridden the "Value" property. // We now have to specifically look for only public instance properties declared in the lowest level class. pinfo = c.GetType().GetProperty("Value", BindingFlags.DeclaredOnly | BindingFlags.Instance | BindingFlags.Public); } // If we found it, use it to assign a value, otherwise simply set the text if (pinfo != null) { try { pinfo.SetValue(c, value, null); return; } catch (TargetInvocationException) { // Not a lot we can do about this one. Something went wrong in the bowels // of the method. Let's take the ostrich approach and just ignore it :-) } catch (ArgumentException) { } } // There wasn't a Value property, or we couldn't set it, so set the text instead try { if (value is String) c.Text = (String)value; else c.Text = stringValue; } catch (ArgumentOutOfRangeException) { // The value couldn't be set via the Text property. } } /// /// Setup the given control to be a cell editor /// protected void ConfigureControl() { this.cellEditor.Validating += new CancelEventHandler(CellEditor_Validating); this.cellEditor.Select(); } /// /// Return the value that the given control is showing /// /// /// protected Object GetControlValue(Control c) { try { return c.GetType().InvokeMember("Value", BindingFlags.GetProperty, null, c, null); } catch (MissingMethodException) { // Microsoft throws this return c.Text; } catch (MissingFieldException) { // Mono throws this return c.Text; } } /// /// Called when the cell editor could be about to lose focus. Time to commit the change /// /// /// private void CellEditor_Validating(object sender, CancelEventArgs e) { this.cellEditEventArgs.Cancel = false; this.OnCellEditorValidating(this.cellEditEventArgs); if (this.cellEditEventArgs.Cancel) { this.cellEditEventArgs.Control.Select(); e.Cancel = true; } else FinishCellEdit(); } /// /// Return the bounds of the given cell /// /// The row to be edited /// The index of the cell to be edited /// A Rectangle protected Rectangle CalculateCellBounds(OLVListItem item, int subItemIndex) { // Item 0 is special. Its bounds include all subitems. To get just the bounds // of cell for item 0, we have to use GetItemRect(). if (subItemIndex == 0) { return this.GetItemRect(item.Index, ItemBoundsPortion.Label); } else return item.SubItems[subItemIndex].Bounds; } /// /// Return a control that can be used to edit the value of the given cell. /// /// The row to be edited /// The index of the cell to be edited /// protected Control GetCellEditor(OLVListItem item, int subItemIndex) { OLVColumn column = this.GetColumn(subItemIndex); Object value = column.GetValue(item.RowObject); //THINK: Do we want to use a Registry instead of this cascade? if (value is Boolean) return new BooleanCellEditor(); if (value is DateTime) { DateTimePicker c = new DateTimePicker(); c.Format = DateTimePickerFormat.Short; return c; } if (value is Int32 || value is Int16 || value is Int64) return new IntUpDown(); if (value is UInt16 || value is UInt32 || value is UInt64) return new UintUpDown(); if (value is Single || value is Double) return new FloatCellEditor(); return this.MakeDefaultCellEditor(column); } /// /// Return a TextBox that can be used as a default cell editor. /// /// What column does the cell belong to? /// private Control MakeDefaultCellEditor(OLVColumn column) { TextBox tb = new TextBox(); String str; // Build a list of unique values, to be used as autocomplete on the editor Dictionary alreadySeen = new Dictionary(); for (int i = 0; i < Math.Min(this.GetItemCount(), 1000); i++) { Object value = column.GetValue(this.GetModelObject(i)); if (value is String) str = (String)value; else str = column.ValueToString(value); if (!alreadySeen.ContainsKey(str)) { tb.AutoCompleteCustomSource.Add(str); alreadySeen[str] = true; } } tb.AutoCompleteSource = AutoCompleteSource.CustomSource; tb.AutoCompleteMode = AutoCompleteMode.Append; return tb; } /// /// Stop editing a cell and throw away any changes. /// protected void CancelCellEdit() { // Let the world know that the user has cancelled the edit operation this.cellEditEventArgs.Cancel = true; this.OnCellEditFinishing(this.cellEditEventArgs); // Now cleanup the editing process this.CleanupCellEdit(); } /// /// If a cell edit is in progress, finish the edit /// /// Returns false if the finishing process was cancelled /// (i.e. the cell editor is still on screen) protected bool PossibleFinishCellEditing() { if (this.IsCellEditing) { this.cellEditEventArgs.Cancel = false; this.OnCellEditorValidating(this.cellEditEventArgs); if (this.cellEditEventArgs.Cancel) return false; FinishCellEdit(); } return true; } /// /// Finish the cell edit operation, writing changed data back to the model object /// protected void FinishCellEdit() { this.cellEditEventArgs.Cancel = false; this.OnCellEditFinishing(this.cellEditEventArgs); // If someone doesn't cancel the editing process, write the value back into the model if (!this.cellEditEventArgs.Cancel) { Object value = this.GetControlValue(this.cellEditor); this.cellEditEventArgs.Column.PutValue(this.cellEditEventArgs.RowObject, value); this.RefreshItem(this.cellEditEventArgs.ListViewItem); } this.CleanupCellEdit(); } /// /// Remove all trace of any existing cell edit operation /// protected void CleanupCellEdit() { if (this.cellEditor == null) return; this.cellEditor.Validating -= new CancelEventHandler(CellEditor_Validating); this.Controls.Remove(this.cellEditor); this.cellEditor.Dispose(); //THINK: do we need to call this? this.cellEditor = null; this.Select(); this.PauseAnimations(false); } /// /// The callbacks for CellEditing events /// public delegate void CellEditEventHandler(object sender, CellEditEventArgs e); /// /// Triggered when a cell is about to be edited. /// /// Set Cancel to true to prevent the cell being edited. /// You can change the the Control to be something completely different. [Category("Behavior")] public event CellEditEventHandler CellEditStarting; /// /// Triggered when a cell editor needs to be validated /// /// /// If this event is cancelled, focus will remain on the cell editor. /// [Category("Behavior")] public event CellEditEventHandler CellEditValidating; /// /// Triggered when a cell is about to finish being edited. /// /// If Cancel is already true, the user is cancelling the edit operation. /// Set Cancel to true to prevent the value from the cell being written into the model. /// You cannot prevent the editing from finishing. [Category("Behavior")] public event CellEditEventHandler CellEditFinishing; /// /// Tell the world when a cell is about to be edited. /// protected virtual void OnCellEditStarting(CellEditEventArgs e) { if (this.CellEditStarting != null) this.CellEditStarting(this, e); } /// /// Tell the world when a cell is about to finish being edited. /// protected virtual void OnCellEditorValidating(CellEditEventArgs e) { // Hack. ListView is an imperfect control container. It does not manage validation // perfectly. If the ListView is part of a TabControl, and the cell editor loses // focus by the user clicking on another tab, the TabControl processes the click // and switches tabs, even if this Validating event cancels. This results in the // strange situation where the cell editor is active, but isn't visible. When the // user switches back to the tab with the ListView, composite controls like spin // controls, DateTimePicker and ComboBoxes do not work properly. Specifically, // keyboard input still works fine, but the controls do not respond to mouse // input. SO, if the validation fails, we have to specifically give focus back to // the cell editor. (this is the Select() call in the code below). But (there is // always a 'but'), doing that changes the focus so the cell editor // triggers another Validating event -- which fails again. From the user's point // of view, they click away from the cell editor, and the validating code // complains twice. So we only trigger a Validating event if more than 0.1 seconds // has elapsed since the last validate event. // I know it's a hack. I'm very open to hear a neater solution. // Also, this timed response stops us from sending a series of validation events // if the user clicks and holds on the OLV scroll bar. if ((Environment.TickCount - lastValidatingEvent) < 500) { e.Cancel = true; } else { lastValidatingEvent = Environment.TickCount; if (this.CellEditValidating != null) this.CellEditValidating(this, e); } lastValidatingEvent = Environment.TickCount; } private int lastValidatingEvent = 0; /// /// Tell the world when a cell is about to finish being edited. /// protected virtual void OnCellEditFinishing(CellEditEventArgs e) { if (this.CellEditFinishing != null) this.CellEditFinishing(this, e); } /// /// Let the world know that a cell edit operation is beginning or ending /// public class CellEditEventArgs : EventArgs { /// /// Create an event args /// /// /// /// /// /// public CellEditEventArgs(OLVColumn column, Control c, Rectangle r, OLVListItem item, int subItemIndex) { this.Cancel = false; this.Control = c; this.column = column; this.cellBounds = r; this.listViewItem = item; this.rowObject = item.RowObject; this.subItemIndex = subItemIndex; this.value = column.GetValue(item.RowObject); } /// /// Change this to true to cancel the cell editing operation. /// /// /// During the CellEditStarting event, setting this to true will prevent the cell from being edited. /// During the CellEditFinishing event, if this value is already true, this indicates that the user has /// cancelled the edit operation and that the handler should perform cleanup only. Setting this to true, /// will prevent the ObjectListView from trying to write the new value into the model object. /// public bool Cancel = false; /// /// During the CellEditStarting event, this can be modified to be the control that you want /// to edit the value. You must fully configure the control before returning from the event, /// including its bounds and the value it is showing. /// During the CellEditFinishing event, you can use this to get the value that the user /// entered and commit that value to the model. Changing the control during the finishing /// event has no effect. /// public Control Control = null; /// /// The column of the cell that is going to be or has been edited. /// public OLVColumn Column { get { return this.column; } } private OLVColumn column; /// /// The model object of the row of the cell that is going to be or has been edited. /// public Object RowObject { get { return this.rowObject; } } private Object rowObject; /// /// The listview item of the cell that is going to be or has been edited. /// public OLVListItem ListViewItem { get { return this.listViewItem; } } private OLVListItem listViewItem; /// /// The index of the cell that is going to be or has been edited. /// public int SubItemIndex { get { return this.subItemIndex; } } private int subItemIndex; /// /// The data value of the cell before the edit operation began. /// public Object Value { get { return this.value; } } private Object value; /// /// The bounds of the cell that is going to be or has been edited. /// public Rectangle CellBounds { get { return this.cellBounds; } } private Rectangle cellBounds; } //----------------------------------------------------------------------- // Cell editors // These classes are simple cell editors that make it easier to get and set // the value that the control is showing. /// /// This editor simply shows and edits integer values. /// internal class IntUpDown : NumericUpDown { public IntUpDown() { this.DecimalPlaces = 0; this.Minimum = -9999999; this.Maximum = 9999999; } new public int Value { get { return Decimal.ToInt32(base.Value); } set { base.Value = new Decimal(value); } } } /// /// This editor simply shows and edits unsigned integer values. /// internal class UintUpDown : NumericUpDown { public UintUpDown() { this.DecimalPlaces = 0; this.Minimum = 0; this.Maximum = 9999999; } new public uint Value { get { return Decimal.ToUInt32(base.Value); } set { base.Value = new Decimal(value); } } } /// /// This editor simply shows and edits boolean values. /// /// You can intercept the CellEditStarting event if you want /// to change the characteristics of the editor. For example, by changing /// the labels to "No" and "Yes". The false value must come first. internal class BooleanCellEditor : ComboBox { public BooleanCellEditor() { this.DropDownStyle = ComboBoxStyle.DropDownList; this.Items.AddRange(new String[] { "False", "True" }); // needs to be localizable } public bool Value { get { return this.SelectedIndex == 1; } set { if (value) this.SelectedIndex = 1; else this.SelectedIndex = 0; } } } /// /// This editor simply shows and edits floating point values. /// /// You can intercept the CellEditStarting event if you want /// to change the characteristics of the editor. For example, by increasing /// the number of decimal places. internal class FloatCellEditor : NumericUpDown { public FloatCellEditor() { this.DecimalPlaces = 2; this.Minimum = -9999999; this.Maximum = 9999999; } new public double Value { get { return Convert.ToDouble(base.Value); } set { base.Value = Convert.ToDecimal(value); } } } /// /// This editor shows and auto completes values from the given listview column. /// internal class AutoCompleteCellEditor : ComboBox { public AutoCompleteCellEditor(ObjectListView lv, OLVColumn column) { this.DropDownStyle = ComboBoxStyle.DropDown; Dictionary alreadySeen = new Dictionary(); for (int i = 0; i < Math.Min(lv.GetItemCount(), 1000); i++) { String str = column.GetStringValue(lv.GetModelObject(i)); if (!alreadySeen.ContainsKey(str)) { this.Items.Add(str); alreadySeen[str] = true; } } this.Sorted = true; this.AutoCompleteSource = AutoCompleteSource.ListItems; this.AutoCompleteMode = AutoCompleteMode.Append; } } /// /// Return a collection of columns that are appropriate to the given view. /// Only Tile and Details have columns; all other views have 0 columns. /// /// Which view are the columns being calculate for? /// A list of columns public List GetFilteredColumns(View view) { // For both detail and tile view, the first column must be included. Normally, we would // use the ColumnHeader.Index property, but if the header is not currently part of a ListView // that property returns -1. So, we track the index of // the column header, and always include the first header. int index = 0; switch (view) { case View.Details: return this.AllColumns.FindAll(delegate(OLVColumn x) { return (index++ == 0) || x.IsVisible; }); case View.Tile: return this.AllColumns.FindAll(delegate(OLVColumn x) { return (index++ == 0) || x.IsTileViewColumn; }); default: return new List(); ; } } #endregion #region Design Time /// /// This class works in conjunction with the OLVColumns property to allow OLVColumns /// to be added to the ObjectListView. /// internal class OLVColumnCollectionEditor : System.ComponentModel.Design.CollectionEditor { public OLVColumnCollectionEditor(Type t) : base(t) { } protected override Type CreateCollectionItemType() { return typeof(OLVColumn); } public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) { ListView.ColumnHeaderCollection cols = (ListView.ColumnHeaderCollection)value; // Hack to figure out which ObjectListView we are working on ObjectListView olv; if (cols.Count == 0) { cols.Add(new OLVColumn()); olv = (ObjectListView)cols[0].ListView; cols.Clear(); olv.AllColumns.Clear(); } else olv = (ObjectListView)cols[0].ListView; // Edit all the columns, not just the ones that are visible base.EditValue(context, provider, olv.AllColumns); // Calculate just the visible columns List newColumns = olv.GetFilteredColumns(View.Details); olv.Columns.Clear(); olv.Columns.AddRange(newColumns.ToArray()); return olv.Columns; } } /// /// Return Columns for this list. We hide the original so we can associate /// a specialised editor with it. /// [Editor(typeof(OLVColumnCollectionEditor), typeof(System.Drawing.Design.UITypeEditor))] new public ListView.ColumnHeaderCollection Columns { get { return base.Columns; } } #endregion /// /// Which column did we last sort by /// public OLVColumn LastSortColumn { get { return lastSortColumn; } set { lastSortColumn = value; } } private OLVColumn lastSortColumn; /// /// Which direction did we last sort /// public SortOrder LastSortOrder { get { return lastSortOrder; } set { lastSortOrder = value; } } private SortOrder lastSortOrder; private Rectangle lastUpdateRectangle; // remember the update rect from the last WM_PAINT msg private bool isOwnerOfObjects; // does this ObjectListView own the Objects collection? } /// /// Wrapper for all native method calls on ListView controls /// internal class NativeMethods { private const int LVM_FIRST = 0x1000; private const int LVM_GETHEADER = LVM_FIRST + 31; private const int LVM_SETITEMSTATE = LVM_FIRST + 43; private const int LVM_SETEXTENDEDLISTVIEWSTYLE = LVM_FIRST + 54; private const int LVM_SETITEM = LVM_FIRST + 76; private const int LVM_GETCOLUMN = LVM_FIRST + 95; private const int LVM_SETCOLUMN = LVM_FIRST + 96; private const int LVS_EX_SUBITEMIMAGES = 0x0002; private const int LVIF_TEXT = 0x0001; private const int LVIF_IMAGE = 0x0002; private const int LVIF_PARAM = 0x0004; private const int LVIF_STATE = 0x0008; private const int LVIF_INDENT = 0x0010; private const int LVIF_NORECOMPUTE = 0x0800; private const int LVCF_FMT = 0x0001; private const int LVCF_WIDTH = 0x0002; private const int LVCF_TEXT = 0x0004; private const int LVCF_SUBITEM = 0x0008; private const int LVCF_IMAGE = 0x0010; private const int LVCF_ORDER = 0x0020; private const int LVCFMT_LEFT = 0x0000; private const int LVCFMT_RIGHT = 0x0001; private const int LVCFMT_CENTER = 0x0002; private const int LVCFMT_JUSTIFYMASK = 0x0003; private const int LVCFMT_IMAGE = 0x0800; private const int LVCFMT_BITMAP_ON_RIGHT = 0x1000; private const int LVCFMT_COL_HAS_IMAGES = 0x8000; private const int HDM_FIRST = 0x1200; private const int HDM_HITTEST = HDM_FIRST + 6; private const int HDM_GETITEM = HDM_FIRST + 11; private const int HDM_SETITEM = HDM_FIRST + 12; private const int HDI_WIDTH = 0x0001; private const int HDI_TEXT = 0x0002; private const int HDI_FORMAT = 0x0004; private const int HDI_BITMAP = 0x0010; private const int HDI_IMAGE = 0x0020; private const int HDF_LEFT = 0x0000; private const int HDF_RIGHT = 0x0001; private const int HDF_CENTER = 0x0002; private const int HDF_JUSTIFYMASK = 0x0003; private const int HDF_RTLREADING = 0x0004; private const int HDF_STRING = 0x4000; private const int HDF_BITMAP = 0x2000; private const int HDF_BITMAP_ON_RIGHT = 0x1000; private const int HDF_IMAGE = 0x0800; private const int HDF_SORTUP = 0x0400; private const int HDF_SORTDOWN = 0x0200; private const int SB_HORZ = 0; private const int SB_VERT = 1; private const int SB_CTL = 2; private const int SB_BOTH = 3; private const int SIF_RANGE = 0x0001; private const int SIF_PAGE = 0x0002; private const int SIF_POS = 0x0004; private const int SIF_DISABLENOSCROLL = 0x0008; private const int SIF_TRACKPOS = 0x0010; private const int SIF_ALL = (SIF_RANGE | SIF_PAGE | SIF_POS | SIF_TRACKPOS); [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Auto)] private struct LVITEM { public int mask; public int iItem; public int iSubItem; public int state; public int stateMask; [MarshalAs(UnmanagedType.LPTStr)] public string pszText; public int cchTextMax; public int iImage; public IntPtr lParam; // These are available in Common Controls >= 0x0300 public int iIndent; // These are available in Common Controls >= 0x056 public int iGroupId; public int cColumns; public IntPtr puColumns; }; [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Auto)] private struct LVCOLUMN { public int mask; public int fmt; public int cx; [MarshalAs(UnmanagedType.LPTStr)] public string pszText; public int cchTextMax; public int iSubItem; // These are available in Common Controls >= 0x0300 public int iImage; public int iOrder; }; /// /// Notify message header structure. /// [StructLayout(LayoutKind.Sequential)] public struct NMHDR { public IntPtr hwndFrom; public IntPtr idFrom; public int code; } [StructLayout(LayoutKind.Sequential)] public struct NMHEADER { public NMHDR nhdr; public int iItem; public int iButton; public IntPtr pHDITEM; } [StructLayout(LayoutKind.Sequential)] public struct HDITEM { public int mask; public int cxy; public IntPtr pszText; public IntPtr hbm; public int cchTextMax; public int fmt; public IntPtr lParam; public int iImage; public int iOrder; //if (_WIN32_IE >= 0x0500) public int type; public IntPtr pvFilter; } [StructLayout(LayoutKind.Sequential)] public class HDHITTESTINFO { public int pt_x; public int pt_y; public int flags; public int iItem; } [StructLayout(LayoutKind.Sequential)] public class SCROLLINFO { public int cbSize; public int fMask; public int nMin; public int nMax; public int nPage; public int nPos; public int nTrackPos; public SCROLLINFO() { this.cbSize = Marshal.SizeOf(typeof(NativeMethods.SCROLLINFO)); } } // Various flavours of SendMessage: plain vanilla, and passing references to various structures [DllImport("user32.dll", CharSet = CharSet.Auto)] public static extern IntPtr SendMessage(IntPtr hWnd, int msg, int wParam, int lParam); [DllImport("user32.dll", EntryPoint = "SendMessage", CharSet = CharSet.Auto)] private static extern IntPtr SendMessageLVItem(IntPtr hWnd, int msg, int wParam, ref LVITEM lvi); [DllImport("user32.dll", EntryPoint = "SendMessage", CharSet = CharSet.Auto)] private static extern IntPtr SendMessageLVColumn(IntPtr hWnd, int msg, int wParam, ref LVCOLUMN lvc); [DllImport("user32.dll", EntryPoint = "SendMessage", CharSet = CharSet.Auto)] private static extern IntPtr SendMessageHDItem(IntPtr hWnd, int msg, int wParam, ref HDITEM hdi); [DllImport("user32.dll", EntryPoint = "SendMessage", CharSet = CharSet.Auto)] public static extern IntPtr SendMessageHDHITTESTINFO(IntPtr hWnd, int Msg, IntPtr wParam, [In, Out] HDHITTESTINFO lParam); // Entry points used by this code [DllImport("user32.dll", CharSet = CharSet.Auto, ExactSpelling = true)] public static extern bool GetScrollInfo(IntPtr hWnd, int fnBar, SCROLLINFO si); [DllImport("user32.dll", EntryPoint = "GetUpdateRect", CharSet = CharSet.Auto)] private static extern IntPtr GetUpdateRectInternal(IntPtr hWnd, ref Rectangle r, bool eraseBackground); [DllImport("user32.dll", CharSet = CharSet.Auto, ExactSpelling = true)] public static extern bool SetScrollInfo(IntPtr hWnd, int fnBar, SCROLLINFO si, bool fRedraw); [DllImport("user32.dll", EntryPoint = "ValidateRect", CharSet = CharSet.Auto)] private static extern IntPtr ValidatedRectInternal(IntPtr hWnd, ref Rectangle r); /// /// Make sure the ListView has the extended style that says to display subitem images. /// /// This method must be called after any .NET call that update the extended styles /// since they seem to erase this setting. /// The listview to send a message to public static void ForceSubItemImagesExStyle(ListView list) { SendMessage(list.Handle, LVM_SETEXTENDEDLISTVIEWSTYLE, LVS_EX_SUBITEMIMAGES, LVS_EX_SUBITEMIMAGES); } /// /// For the given item and subitem, make it display the given image /// /// The listview to send a message to /// row number (0 based) /// subitem (0 is the item itself) /// index into the image list public static void SetSubItemImage(ListView list, int itemIndex, int subItemIndex, int imageIndex) { LVITEM lvItem = new LVITEM(); lvItem.mask = LVIF_IMAGE; lvItem.iItem = itemIndex; lvItem.iSubItem = subItemIndex; lvItem.iImage = imageIndex; SendMessageLVItem(list.Handle, LVM_SETITEM, 0, ref lvItem); } /// /// Setup the given column of the listview to show the given image to the right of the text. /// If the image index is -1, any previous image is cleared /// /// The listview to send a message to /// Index of the column to modifiy /// /// Index into the small image list public static void SetColumnImage(ListView list, int columnIndex, SortOrder order, int imageIndex) { IntPtr hdrCntl = NativeMethods.GetHeaderControl(list); if (hdrCntl.ToInt32() == 0) return; HDITEM item = new HDITEM(); item.mask = HDI_FORMAT; IntPtr result = SendMessageHDItem(hdrCntl, HDM_GETITEM, columnIndex, ref item); item.fmt &= ~(HDF_SORTUP | HDF_SORTDOWN | HDF_IMAGE | HDF_BITMAP_ON_RIGHT); if (NativeMethods.HasBuiltinSortIndicators()) { if (order == SortOrder.Ascending) item.fmt |= HDF_SORTUP; if (order == SortOrder.Descending) item.fmt |= HDF_SORTDOWN; } else { item.mask |= HDI_IMAGE; item.fmt |= (HDF_IMAGE | HDF_BITMAP_ON_RIGHT); item.iImage = imageIndex; } result = SendMessageHDItem(hdrCntl, HDM_SETITEM, columnIndex, ref item); } /// /// Does this version of the operating system have builtin sort indicators? /// /// Are there builtin sort indicators /// XP and later have these public static bool HasBuiltinSortIndicators() { return OSFeature.Feature.GetVersionPresent(OSFeature.Themes) != null; } /// /// Return the bounds of the update region on the given control. /// /// The BeginPaint() system call validates the update region, effectively wiping out this information. /// So this call has to be made before the BeginPaint() call. /// The control whose update region is be calculated /// A rectangle public static Rectangle GetUpdateRect(Control cntl) { Rectangle r = new Rectangle(); GetUpdateRectInternal(cntl.Handle, ref r, false); return r; } /// /// Validate an area of the given control. A validated area will not be repainted at the next redraw. /// /// The control to be validated /// The area of the control to be validated public static void ValidateRect(Control cntl, Rectangle r) { ValidatedRectInternal(cntl.Handle, ref r); } /// /// Select all rows on the given listview /// /// The listview whose items are to be selected public static void SelectAllItems(ListView list) { NativeMethods.SetItemState(list, -1, 2, 2); } /// /// Deselect all rows on the given listview /// /// The listview whose items are to be deselected public static void DeselectAllItems(ListView list) { NativeMethods.SetItemState(list, -1, 2, 0); } /// /// Set the item state on the given item /// /// The listview whose item's state is to be changed /// The index of the item to be changed /// Which bits of the value are to be set? /// The value to be set public static void SetItemState(ListView list, int itemIndex, int mask, int value) { LVITEM lvItem = new LVITEM(); lvItem.stateMask = mask; lvItem.state = value; SendMessageLVItem(list.Handle, LVM_SETITEMSTATE, itemIndex, ref lvItem); } /// /// Return the handle to the header control on the given list /// /// The listview whose header control is to be returned /// The handle to the header control public static IntPtr GetHeaderControl(ListView list) { return SendMessage(list.Handle, LVM_GETHEADER, 0, 0); } /// /// Return the index of the divider under the given point. Return -1 if no divider is under the pt /// /// The list we are interested in /// The client co-ords /// The index of the divider under the point, or -1 if no divider is under that point public static int GetDividerUnderPoint(IntPtr handle, Point pt) { const int HHT_ONDIVIDER = 4; return NativeMethods.HeaderControlHitTest(handle, pt, HHT_ONDIVIDER); } /// /// Return the index of the column of the header that is under the given point. /// Return -1 if no column is under the pt /// /// The list we are interested in /// The client co-ords /// The index of the column under the point, or -1 if no column header is under that point public static int GetColumnUnderPoint(IntPtr handle, Point pt) { const int HHT_ONHEADER = 2; return NativeMethods.HeaderControlHitTest(handle, pt, HHT_ONHEADER); } private static int HeaderControlHitTest(IntPtr handle, Point pt, int flag) { HDHITTESTINFO testInfo = new HDHITTESTINFO(); testInfo.pt_x = pt.X; testInfo.pt_y = pt.Y; IntPtr result = NativeMethods.SendMessageHDHITTESTINFO(handle, HDM_HITTEST, IntPtr.Zero, testInfo); if ((testInfo.flags & flag) != 0) return result.ToInt32(); else return -1; } /// /// Get the scroll position of the given scroll bar /// /// /// /// public static int GetScrollPosition(IntPtr handle, bool horizontalBar) { int fnBar = (horizontalBar ? SB_HORZ : SB_VERT); SCROLLINFO si = new SCROLLINFO(); si.fMask = SIF_POS; if (GetScrollInfo(handle, fnBar, si)) return si.nPos; else return -1; } } /// /// 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. /// /// 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. /// Virtual lists can never iterate their contents. That would defeat the whole purpose. /// Given the above, grouping and sorting are not possible on virtual lists. But if the backing data store has /// a sorting mechanism, a CustomSorter can be installed which will be called when the sorting is required. /// For the same reason, animate 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. /// You really do not want to keep state information for 10 million animations! /// public class VirtualObjectListView : ObjectListView { /// /// Create a VirtualObjectListView /// public VirtualObjectListView() : base() { this.ShowGroups = false; // virtual lists can never show groups this.VirtualMode = true; this.RetrieveVirtualItem += new RetrieveVirtualItemEventHandler(this.HandleRetrieveVirtualItem); // Install a null custom sorter to turn off sorting. Who wants to fetch and sort 10 million items? this.CustomSorter = delegate(OLVColumn column, SortOrder sortOrder) { }; } #region Public Properties /// /// This delegate is used to fetch a rowObject, given it's index within the list /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public RowGetterDelegate RowGetter { get { return rowGetter; } set { rowGetter = value; } } #endregion #region OLV accessing /// /// Return the number of items in the list /// /// the number of items in the list override public int GetItemCount() { return this.VirtualListSize; } /// /// Return the item at the given index /// /// Index of the item to be returned /// An OLVListItem override public OLVListItem GetItem(int index) { return (OLVListItem)this.Items[index]; } /// /// Return the model object at the given index /// /// Index of the model object to be returned /// A model object override public object GetModelObject(int index) { return this.GetRowObjectAt(index); } #endregion #region Object manipulation /// /// Remove all items from this list /// /// This method can safely be called from background threads. override public void ClearObjects() { if (this.InvokeRequired) this.Invoke(new MethodInvoker(ClearObjects)); else { this.ClearCachedInfo(); this.VirtualListSize = 0; } } /// /// Select the row that is displaying the given model object. /// This does nothing in virtual lists. /// /// This is a no-op for virtual lists, since there is no way to map the model /// object back to the ListViewItem that represents it. /// The object that gave data override public void SelectObject(object modelObject) { // do nothing } /// /// Select the rows that is displaying any of the given model object. /// This does nothing in virtual lists. /// /// This is a no-op for virtual lists, since there is no way to map the model /// objects back to the ListViewItem that represents them. /// A collection of model objects override public void SelectObjects(IList modelObjects) { // do nothing } /// /// Update the rows that are showing the given objects /// /// This is a no-op for virtual lists, since there is no way to map the model /// objects back to the ListViewItem that represents them. override public void RefreshObjects(IList modelObjects) { // do nothing } /// /// Add the given collection of model objects to this control. /// /// A collection of model objects /// This is a no-op for virtual lists, since the control /// does not have a list of model objects to which it can add this new one. /// All model object management is done by the application. override public void AddObjects(ICollection modelObjects) { } /// /// Remove all of the given objects from the control /// /// Collection of objects to be removed /// This is a no-op for virtual lists, since the control /// does not have a list of model objects from which it can remove these ones. /// All model object management is done by the application. override public void RemoveObjects(ICollection modelObjects) { } #endregion #region Commands /// /// Invalidate any cached information when we rebuild the list. /// public override void BuildList(bool shouldPreserveSelection) { this.ClearCachedInfo(); this.Invalidate(); } /// /// Prepare the listview to show alternate row backcolors /// /// Alternate colored backrows can't be handle in the same way as our base class. /// With virtual lists, they are handled at RetrieveVirtualItem time. protected override void PrepareAlternateBackColors() { // do nothing } /// /// Refresh the given item in the list /// /// The item to refresh public override void RefreshItem(OLVListItem olvi) { this.ClearCachedInfo(); this.Invalidate(); } #endregion #region Event handlers /// /// Handle a mouse down event /// /// protected override void OnMouseDown(MouseEventArgs e) { base.OnMouseDown(e); // Did the user click the state icon? If so and check boxes are enable, toggle // the clicked row. If the given row is selected, all selected rows are given // the same checkedness. ListViewHitTestInfo htInfo = this.HitTest(e.Location); if (this.CheckBoxes && (htInfo.Location & ListViewHitTestLocations.StateImage) != 0) { OLVListItem clickedItem = (OLVListItem)htInfo.Item; this.ChangeCheckItem(clickedItem, clickedItem.Checked, !clickedItem.Checked); if (clickedItem.Selected) { foreach (int i in this.SelectedIndices) { OLVListItem olvi = this.GetItem(i); if (olvi.Checked != clickedItem.Checked) this.ChangeCheckItem(olvi, olvi.Checked, clickedItem.Checked); } } } } /// /// Handle a RetrieveVirtualItem /// /// /// protected void HandleRetrieveVirtualItem(object sender, RetrieveVirtualItemEventArgs e) { // .NET 2.0 seems to generate a lot of these events. Before drawing *each* sub-item, // this event is triggered 4-8 times for the same index. So we save lots of CPU time // by caching the last result. if (this.lastRetrieveVirtualItemIndex != e.ItemIndex) { this.lastRetrieveVirtualItemIndex = e.ItemIndex; this.lastRetrieveVirtualItem = this.MakeListViewItem(e.ItemIndex); } e.Item = this.lastRetrieveVirtualItem; } /// /// Create a OLVListItem for given row index /// /// The index of the row that is needed /// An OLVListItem public OLVListItem MakeListViewItem(int itemIndex) { OLVListItem olvi = new OLVListItem(this.GetRowObjectAt(itemIndex)); this.FillInValues(olvi, olvi.RowObject); if (this.UseAlternatingBackColors) { if (this.View == View.Details && itemIndex % 2 == 1) olvi.BackColor = this.AlternateRowBackColorOrDefault; else olvi.BackColor = this.BackColor; this.CorrectSubItemColors(olvi); } if (this.CheckBoxes) olvi.StateImageIndex = (olvi.Checked ? 1 : 0); this.SetSubItemImages(itemIndex, olvi); return olvi; } /// /// Return the row object for the given row index /// /// index of the row whose object is to be fetched /// A model object or null if no delegate is installed virtual protected object GetRowObjectAt(int index) { if (this.RowGetter == null) return null; else return this.RowGetter(index); } /// /// Clear any cached info this list may have been using /// public void ClearCachedInfo() { this.lastRetrieveVirtualItemIndex = -1; } #endregion #region Variable declaractions private RowGetterDelegate rowGetter; private int lastRetrieveVirtualItemIndex = -1; private OLVListItem lastRetrieveVirtualItem; #endregion } /// /// A FastObjectListView trades function for speed. /// /// /// On my mid-range laptop, this view builds a list of 10,000 objects in 0.1 seconds, /// as opposed to a normal ObjectListView which takes 10-15 seconds. Lists of up to 50,000 items should be /// able to be handled with sub-second response times even on low end machines. /// /// A FastObjectListView is implemented as a virtual list with some of the virtual modes limits (e.g. no sorting) /// fixed through coding. There are some functions that simply cannot be provided. Specifically, a FastObjectListView cannot: /// /// shows groups /// use Tile view /// display images on subitems /// /// /// You can circumvent the limit on subitem images by making the list owner drawn, and giving the column /// a Renderer of BaseRenderer, e.g. myColumnWithImage.Renderer = new BaseRenderer(); /// /// Although it isn't documented, virtual lists cannot have checkboxes. A FastObjectListView codes around this limitation, /// but you must use the functions provided by FastObjectListView. If you call the normal "CheckedItems", it will throw an /// exception. If you use CheckedObjects and its friends (declared in ObjectListView), you should not have any trouble. /// The only exception is the "CheckBoxes" property itself. Once this is set, trying to unset it will throw an exception, /// since the list is a virtual list. /// /// public class FastObjectListView : VirtualObjectListView { /// /// Make a FastObjectListView /// public FastObjectListView() { this.SearchForVirtualItem += new SearchForVirtualItemEventHandler(FastObjectListView_SearchForVirtualItem); this.CustomSorter = delegate(OLVColumn column, SortOrder sortOrder) { this.ClearCachedInfo(); if (sortOrder != SortOrder.None) this.objectList.Sort(new ModelObjectComparer(column, sortOrder, this.SecondarySortColumn, this.SecondarySortOrder)); this.RebuildIndexMap(); }; } #region Public properties /// /// Get/set the list of objects that are shown by the control. /// /// /// This method preserves selection, if possible. Use SetObjects() if /// you do not want to preserve the selection. Preserving selection is the slowest part of this /// code and performance is O(n) where n is the number of selected rows. /// This method is not thread safe. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] new public ArrayList Objects { get { return this.objectList; } set { this.BeginUpdate(); ArrayList previousSelection = this.SelectedObjects; this.SetObjects(value); this.SelectedObjects = previousSelection; this.EndUpdate(); } } private ArrayList objectList = new ArrayList(); /// /// When the user types into a list, should the values in the current sort column be searched to find a match? /// If this is false, the primary column will always be used regardless of the sort column. /// /// When this is true, the behavior is like that of ITunes. [Category("Behavior"), Description("When the user types into a list, should the values in the current sort column be searched to find a match?"), DefaultValue(false)] public bool IsSearchOnSortColumn { get { return isSearchOnSortColumn; } set { isSearchOnSortColumn = value; } } private bool isSearchOnSortColumn = false; #endregion #region Commands /// /// Set the collection of objects that this control will show. /// /// /// This method can safely be called from background threads. override public void SetObjects(IEnumerable collection) { if (this.InvokeRequired) { this.Invoke((MethodInvoker)delegate { this.SetObjects(collection); }); return; } //if (this.CheckBoxes && this.StateImageList == null) // this.InitializeStateImageList(); this.BeginUpdate(); ArrayList newObjects = new ArrayList(); if (collection != null) { if (collection is ICollection) newObjects = new ArrayList((ICollection)collection); else { foreach (object x in collection) newObjects.Add(x); } } // There is a bug in ListView where if a virtual ListView is cleared // (i.e. VirtuaListSize set to 0) when it is // scrolled vertically, the scroll position is wrong when the list is subsequently // filled in again. To avoid this, before clearing a virtual list, // we make sure the list is scrolled to the top. if (newObjects.Count == 0 && this.TopItemIndex > 0) this.TopItemIndex = 0; this.objectList = newObjects; this.VirtualListSize = this.objectList.Count; this.Sort(); this.EndUpdate(); } private void InitializeStateImageList() { this.StateImageList = new ImageList(); this.StateImageList.ImageSize = new Size(16, 16); this.AddCheckedImage(this.StateImageList, System.Windows.Forms.VisualStyles.CheckBoxState.CheckedNormal); this.AddCheckedImage(this.StateImageList, System.Windows.Forms.VisualStyles.CheckBoxState.UncheckedNormal); } private void AddCheckedImage(ImageList imageList, System.Windows.Forms.VisualStyles.CheckBoxState checkBoxState) { Bitmap bm = new Bitmap(imageList.ImageSize.Width, imageList.ImageSize.Height); Graphics g = Graphics.FromImage(bm); g.Clear(imageList.TransparentColor); CheckBoxRenderer.DrawCheckBox(g, new Point(0, 0), checkBoxState); imageList.Images.Add(bm); } /// /// Add the given collection of model objects to this control. /// /// A collection of model objects /// /// The added objects will appear in their correct sort position, if sorting /// is active. Otherwise, they will appear at the end of the list. /// No check is performed to see if any of the objects are already in the ListView. /// Null objects are silently ignored. /// override public void AddObjects(ICollection modelObjects) { this.TakeOwnershipOfObjects(); foreach (object modelObject in modelObjects) { if (modelObject != null) this.objectList.Add(modelObject); } this.Objects = this.objectList; } /// /// Remove all of the given objects from the control /// /// Collection of objects to be removed /// /// Nulls and model objects that are not in the ListView are silently ignored. /// override public void RemoveObjects(ICollection modelObjects) { this.TakeOwnershipOfObjects(); ArrayList selectedObjects = this.SelectedObjects; foreach (object modelObject in modelObjects) { if (modelObject != null) { this.objectList.Remove(modelObject); selectedObjects.Remove(modelObject); } } this.SetObjects(this.objectList); this.SelectedObjects = selectedObjects; } /// /// Take ownership of the 'objects' collection. This separats our collection from the source. /// /// /// /// This method /// separates the 'objects' instance variable from its source, so that any AddObject/RemoveObject /// calls will modify our collection and not the original colleciton. /// /// /// FastObjectListViews always own their collections, so this is a no-op. /// /// override protected void TakeOwnershipOfObjects() { // FastObjectListViews always own their collections, so we don't need to do anything. } #endregion #region Event Handlers /// /// Event handler for the column click event /// /// /// This differs from its base version by trying to preserve selection. The base class, /// being a pure virtual list, cannot maintain selection since it cannot map a /// model objects to the row that is responsible for displaying it. This class can do that. /// override protected void HandleColumnClick(object sender, ColumnClickEventArgs e) { if (!this.PossibleFinishCellEditing()) return; // Toggle the sorting direction on successive clicks on the same column if (this.LastSortColumn != null && e.Column == this.LastSortColumn.Index) this.LastSortOrder = (this.LastSortOrder == SortOrder.Descending ? SortOrder.Ascending : SortOrder.Descending); else this.LastSortOrder = SortOrder.Ascending; this.BeginUpdate(); ArrayList previousSelection = this.SelectedObjects; this.Sort(e.Column); this.SelectedObjects = previousSelection; this.EndUpdate(); } void FastObjectListView_SearchForVirtualItem(object sender, SearchForVirtualItemEventArgs e) { // The event has e.IsPrefixSearch, but as far as I can tell, this is always false (maybe that's different under Vista) // So we ignore IsPrefixSearch and IsTextSearch and always to a case insensitve prefix match int increment = (e.Direction == SearchDirectionHint.Up ? -1 : 1); OLVColumn column = this.GetColumn(0); if (this.IsSearchOnSortColumn && this.View == View.Details && this.LastSortColumn != null) column = this.LastSortColumn; int i; for (i = e.StartIndex; i >= 0 && i < this.objectList.Count; i += increment) { string data = column.GetStringValue(this.objectList[i]); if (data.StartsWith(e.Text, StringComparison.CurrentCultureIgnoreCase)) { e.Index = i; return; } } // Also the LVFINDINFO has a LV_WRAP flag, but the SearchForVirtualItemEventArgs does not. Why? // We always wrap i = (increment < 0 ? this.objectList.Count : 0); while ((increment < 0 && i > e.StartIndex) || (increment > 0 && i < e.StartIndex)) { string data = column.GetStringValue(this.objectList[i]); if (data.StartsWith(e.Text, StringComparison.CurrentCultureIgnoreCase)) { e.Index = i; return; } i += increment; } } #endregion #region Object manipulation /// /// Select the row that is displaying the given model object. /// /// The object that gave data override public void SelectObject(object modelObject) { if (modelObject == null) return; if (!this.objectsToIndexMap.ContainsKey(modelObject)) return; int index = (int)this.objectsToIndexMap[modelObject]; // If this object is already selected, we don't need to do anything if (this.SelectedIndices.Count == 1 && this.SelectedIndices[0] == index) return; this.SelectedIndices.Clear(); if (index >= 0) this.SelectedIndices.Add(index); } /// /// Select the rows that is displaying any of the given model object. /// /// A collection of model objects override public void SelectObjects(IList modelObjects) { this.SelectedIndices.Clear(); foreach (object model in modelObjects) { if (this.objectsToIndexMap.ContainsKey(model)) { int index = (int)this.objectsToIndexMap[model]; if (index >= 0) this.SelectedIndices.Add(index); } } } /// /// Update the rows that are showing the given objects /// override public void RefreshObjects(IList modelObjects) { this.Invalidate(); } #endregion #region Implementation /// /// Rebuild the map that remembers which model object is displayed at which line /// protected void RebuildIndexMap() { this.objectsToIndexMap.Clear(); for (int i = 0; i < this.objectList.Count; i++) this.objectsToIndexMap[this.objectList[i]] = i; } Hashtable objectsToIndexMap = new Hashtable(); /// /// Return the row object for the given row index /// /// index of the row whose object is to be fetched /// A model object or null if no delegate is installed override protected object GetRowObjectAt(int index) { if (index >= 0 && index < this.objectList.Count) return this.objectList[index]; else return null; } internal class ModelObjectComparer : IComparer { public ModelObjectComparer(OLVColumn col, SortOrder order) { this.column = col; this.sortOrder = order; this.secondComparer = null; } public ModelObjectComparer(OLVColumn col, SortOrder order, OLVColumn col2, SortOrder order2) : this(col, order) { // There is no point in secondary sorting on the same column if (col != col2) this.secondComparer = new ModelObjectComparer(col2, order2); } public int Compare(object x, object y) { int result = 0; object x1 = this.column.GetValue(x); object y1 = this.column.GetValue(y); if (this.sortOrder == SortOrder.None) return 0; // Handle nulls. Null values come last bool xIsNull = (x1 == null || x1 == System.DBNull.Value); bool yIsNull = (y1 == null || y1 == System.DBNull.Value); if (xIsNull || yIsNull) { if (xIsNull && yIsNull) result = 0; else result = (xIsNull ? -1 : 1); } else { result = this.CompareValues(x1, y1); } if (this.sortOrder == SortOrder.Descending) result = 0 - result; // If the result was equality, use the secondary comparer to resolve it if (result == 0 && this.secondComparer != null) result = this.secondComparer.Compare(x, y); return result; } public int CompareValues(object x, object y) { // Force case insensitive compares on strings if (x is String) return String.Compare((String)x, (String)y, true); else { IComparable comparable = x as IComparable; if (comparable != null) return comparable.CompareTo(y); else return 0; } } private OLVColumn column; private SortOrder sortOrder; private ModelObjectComparer secondComparer; } #endregion } /// /// A DataListView is a ListView that can be bound to a datasource (which would normally be a DataTable or DataView). /// /// /// This listview keeps itself in sync with its source datatable by listening for change events. /// If the listview has no columns when given a data source, it will automatically create columns to show all of the datatables columns. /// This will be only the simplest view of the world, and would look more interesting with a few delegates installed. /// This listview will also automatically generate missing aspect getters to fetch the values from the data view. /// Changing data sources is possible, but error prone. Before changing data sources, the programmer is responsible for modifying/resetting /// the column collection to be valid for the new data source. /// public class DataListView : ObjectListView { /// /// Make a DataListView /// public DataListView() : base() { } #region Public Properties /// /// Get or set the DataSource that will be displayed in this list view. /// /// The DataSource should implement either , , /// or . Some common examples are the following types of objects: /// /// /// /// /// /// /// /// When binding to a list container (i.e. one that implements the /// interface, such as ) /// you must also set the property in order /// to identify which particular list you would like to display. You /// may also set the property even when /// DataSource refers to a list, since can /// also be used to navigate relations between lists. /// [Category("Data"), TypeConverter("System.Windows.Forms.Design.DataSourceConverter, System.Design")] public Object DataSource { get { return dataSource; } set { //THINK: Should we only assign it if it is changed? //if (dataSource != value) { dataSource = value; this.RebindDataSource(true); //} } } private Object dataSource; /// /// Gets or sets the name of the list or table in the data source for which the DataListView is displaying data. /// /// If the data source is not a DataSet or DataViewManager, this property has no effect [Category("Data"), Editor("System.Windows.Forms.Design.DataMemberListEditor, System.Design", typeof(UITypeEditor)), DefaultValue("")] public string DataMember { get { return dataMember; } set { if (dataMember != value) { dataMember = value; RebindDataSource(); } } } private string dataMember = ""; #endregion #region Initialization private CurrencyManager currencyManager = null; /// /// Our data source has changed. Figure out how to handle the new source /// protected void RebindDataSource() { RebindDataSource(false); } /// /// Our data source has changed. Figure out how to handle the new source /// protected void RebindDataSource(bool forceDataInitialization) { if (this.BindingContext == null) return; // Obtain the CurrencyManager for the current data source. CurrencyManager tempCurrencyManager = null; if (this.DataSource != null) { tempCurrencyManager = (CurrencyManager)this.BindingContext[this.DataSource, this.DataMember]; } // Has our currency manager changed? if (this.currencyManager != tempCurrencyManager) { // Stop listening for events on our old currency manager if (this.currencyManager != null) { this.currencyManager.MetaDataChanged -= new EventHandler(currencyManager_MetaDataChanged); this.currencyManager.PositionChanged -= new EventHandler(currencyManager_PositionChanged); this.currencyManager.ListChanged -= new ListChangedEventHandler(currencyManager_ListChanged); } this.currencyManager = tempCurrencyManager; // Start listening for events on our new currency manager if (this.currencyManager != null) { this.currencyManager.MetaDataChanged += new EventHandler(currencyManager_MetaDataChanged); this.currencyManager.PositionChanged += new EventHandler(currencyManager_PositionChanged); this.currencyManager.ListChanged += new ListChangedEventHandler(currencyManager_ListChanged); } // Our currency manager has changed so we have to initialize a new data source forceDataInitialization = true; } if (forceDataInitialization) InitializeDataSource(); } /// /// The data source for this control has changed. Reconfigure the control for the new source /// protected void InitializeDataSource() { if (this.Frozen || this.currencyManager == null) return; this.CreateColumnsFromSource(); this.CreateMissingAspectGettersAndPutters(); this.SetObjects(this.currencyManager.List); // If we have some data, resize the new columns based on the data available. if (this.Items.Count > 0) { foreach (ColumnHeader column in this.Columns) { if (column.Width == 0) this.AutoResizeColumn(column.Index, ColumnHeaderAutoResizeStyle.ColumnContent); } } } /// /// Create columns for the listview based on what properties are available in the data source /// /// /// This method will not replace existing columns. /// protected void CreateColumnsFromSource() { if (this.currencyManager == null || this.Columns.Count != 0) return; PropertyDescriptorCollection properties = this.currencyManager.GetItemProperties(); if (properties.Count == 0) return; for (int i = 0; i < properties.Count; i++) { // Make a stack variable to hold the property so it can be used in the AspectGetter delegate PropertyDescriptor property = properties[i]; // Relationships to other tables turn up as IBindibleLists. Don't make columns to show them. // CHECK: Is this always true? What other things could be here? Constraints? Triggers? if (property.PropertyType == typeof(IBindingList)) continue; // Create a column OLVColumn column = new OLVColumn(property.DisplayName, property.Name); column.Width = 0; // zero-width since we will resize it once we have some data column.AspectGetter = delegate(object row) { return property.GetValue(row); }; // If our column is a BLOB, it could be an image, so assign a renderer to draw it. // CONSIDER: Is this a common enough case to warrant this code? if (property.PropertyType == typeof(System.Byte[])) column.Renderer = new ImageRenderer(); // Add it to our list this.Columns.Add(column); } } /// /// Generate aspect getters and putters for any columns that are missing them (and for which we have /// enough information to actually generate a getter) /// protected void CreateMissingAspectGettersAndPutters() { for (int i = 0; i < this.Columns.Count; i++) { OLVColumn column = this.GetColumn(i); if (column.AspectGetter == null && !String.IsNullOrEmpty(column.AspectName)) { column.AspectGetter = delegate(object row) { // In most cases, rows will be DataRowView objects DataRowView drv = row as DataRowView; if (drv != null) return drv[column.AspectName]; else return column.GetAspectByName(row); }; } if (column.IsEditable && column.AspectPutter == null && !String.IsNullOrEmpty(column.AspectName)) { column.AspectPutter = delegate(object row, object newValue) { // In most cases, rows will be DataRowView objects DataRowView drv = row as DataRowView; if (drv != null) drv[column.AspectName] = newValue; else column.PutAspectByName(row, newValue); }; } } } #endregion #region Object manipulations /// /// Add the given collection of model objects to this control. /// /// A collection of model objects /// This is a no-op for data lists, since the data /// is controlled by the DataSource. Manipulate the data source /// rather than this view of the data source. override public void AddObjects(ICollection modelObjects) { } /// /// Remove the given collection of model objects from this control. /// /// This is a no-op for data lists, since the data /// is controlled by the DataSource. Manipulate the data source /// rather than this view of the data source. override public void RemoveObjects(ICollection modelObjects) { } #endregion #region Event Handlers /// /// What should we do when the list is unfrozen /// override protected void DoUnfreeze() { // Clear any previous currency manager so the rebind will always work from scratch this.RebindDataSource(true); } /// /// Handles binding context changes /// /// The EventArgs that will be passed to any handlers /// of the BindingContextChanged event. protected override void OnBindingContextChanged(EventArgs e) { base.OnBindingContextChanged(e); // If our binding context changes, we must rebind, since we will // have a new currency managers, even if we are still bound to the // same data source. this.RebindDataSource(false); } /// /// Handles parent binding context changes /// /// Unused EventArgs. protected override void OnParentBindingContextChanged(EventArgs e) { base.OnParentBindingContextChanged(e); // BindingContext is an ambient property - by default it simply picks // up the parent control's context (unless something has explicitly // given us our own). So we must respond to changes in our parent's // binding context in the same way we would changes to our own // binding context. this.RebindDataSource(false); } // CurrencyManager ListChanged event handler. // Deals with fine-grained changes to list items. // It's actually difficult to deal with these changes in a fine-grained manner. // If our listview is grouped, then any change may make a new group appear or // an old group disappear. It is rarely enough to simply update the affected row. private void currencyManager_ListChanged(object sender, ListChangedEventArgs e) { switch (e.ListChangedType) { // Well, usually fine-grained... The whole list has changed utterly, so reload it. case ListChangedType.Reset: this.InitializeDataSource(); break; // A single item has changed, so just refresh that. // TODO: Even in this simple case, we should probably rebuild the list. case ListChangedType.ItemChanged: Object changedRow = this.currencyManager.List[e.NewIndex]; this.RefreshObject(changedRow); break; // A new item has appeared, so add that. // We get this event twice if certain grid controls are used to add a new row to a // datatable: once when the editing of a new row begins, and once again when that // editing commits. (If the user cancels the creation of the new row, we never see // the second creation.) We detect this by seeing if this is a view on a row in a // DataTable, and if it is, testing to see if it's a new row under creation. case ListChangedType.ItemAdded: Object newRow = this.currencyManager.List[e.NewIndex]; DataRowView drv = newRow as DataRowView; if (drv == null || !drv.IsNew) { // Either we're not dealing with a view on a data table, or this is the commit // notification. Either way, this is the final notification, so we want to // handle the new row now! this.InitializeDataSource(); } break; // An item has gone away. case ListChangedType.ItemDeleted: this.InitializeDataSource(); break; // An item has changed its index. case ListChangedType.ItemMoved: this.InitializeDataSource(); break; // Something has changed in the metadata. // CHECK: When are these events actually fired? case ListChangedType.PropertyDescriptorAdded: case ListChangedType.PropertyDescriptorChanged: case ListChangedType.PropertyDescriptorDeleted: this.InitializeDataSource(); break; } } // The CurrencyManager calls this if the data source looks // different. We just reload everything. // CHECK: Do we need this if we are handle ListChanged metadata events? private void currencyManager_MetaDataChanged(object sender, EventArgs e) { this.InitializeDataSource(); } // Called by the CurrencyManager when the currently selected item // changes. We update the ListView selection so that we stay in sync // with any other controls bound to the same source. private void currencyManager_PositionChanged(object sender, EventArgs e) { int index = this.currencyManager.Position; // Make sure the index is sane (-1 pops up from time to time) if (index < 0 || index >= this.Items.Count) return; // Avoid recursion. If we are currently changing the index, don't // start the process again. if (this.isChangingIndex) return; try { this.isChangingIndex = true; // We can't use the index directly, since our listview may be sorted this.SelectedObject = this.currencyManager.List[index]; // THINK: Do we always want to bring it into view? if (this.SelectedItems.Count > 0) this.SelectedItems[0].EnsureVisible(); } finally { this.isChangingIndex = false; } } private bool isChangingIndex = false; /// /// Handle a SelectedIndexChanged event /// /// The event /// /// Called by Windows Forms when the currently selected index of the /// control changes. This usually happens because the user clicked on /// the control. In this case we want to notify the CurrencyManager so /// that any other bound controls will remain in sync. This method will /// also be called when we changed our index as a result of a /// notification that originated from the CurrencyManager, and in that /// case we avoid notifying the CurrencyManager back! /// protected override void OnSelectedIndexChanged(EventArgs e) { base.OnSelectedIndexChanged(e); // Prevent recursion if (this.isChangingIndex) return; // If we are bound to a datasource, and only one item is selected, // tell the currency manager which item is selected. if (this.SelectedIndices.Count == 1 && this.currencyManager != null) { try { this.isChangingIndex = true; // We can't use the selectedIndex directly, since our listview may be sorted. // So we have to find the index of the selected object within the original list. this.currencyManager.Position = this.currencyManager.List.IndexOf(this.SelectedObject); } finally { this.isChangingIndex = false; } } } #endregion } #region Delegate declarations /// /// These delegates are used to extract an aspect from a row object /// public delegate Object AspectGetterDelegate(Object rowObject); /// /// These delegates are used to put a changed value back into a model object /// public delegate void AspectPutterDelegate(Object rowObject, Object newValue); /// /// These delegates can be used to convert an aspect value to a display string, /// instead of using the default ToString() /// public delegate string AspectToStringConverterDelegate(Object value); /// /// These delegates are used to the state of the checkbox for a row object. /// /// For reasons known only to someone in Microsoft, we can only set /// a boolean on the ListViewItem to indicate it's "checked-ness", but when /// we receive update events, we have to use a tristate CheckState. So we can /// be told about an indeterminate state, but we can't set it ourselves. public delegate bool CheckStateGetterDelegate(Object rowObject); /// /// These delegates are used to put a changed check state back into a model object /// public delegate CheckState CheckStatePutterDelegate(Object rowObject, CheckState newValue); /// /// These delegates are used to retrieve the object that is the key of the group to which the given row belongs. /// public delegate Object GroupKeyGetterDelegate(Object rowObject); /// /// These delegates are used to convert a group key into a title for the group /// public delegate string GroupKeyToTitleConverterDelegate(Object groupKey); /// /// These delegates are used to fetch the image selector that should be used /// to choose an image for this column. /// public delegate Object ImageGetterDelegate(Object rowObject); /// /// These delegates are used to draw a cell /// public delegate bool RenderDelegate(EventArgs e, Graphics g, Rectangle r, Object rowObject); /// /// These delegates are used to fetch a row object for virtual lists /// public delegate Object RowGetterDelegate(int rowIndex); /// /// These delegates are used to format a listviewitem before it is added to the control. /// public delegate void RowFormatterDelegate(OLVListItem olvItem); /// /// These delegates are used to sort the listview in some custom fashion /// public delegate void SortDelegate(OLVColumn column, SortOrder sortOrder); #endregion #region Column /// /// An OLVColumn knows which aspect of an object it should present. /// /// /// The column knows how to: /// /// extract its aspect from the row object /// convert an aspect to a string /// calculate the image for the row object /// extract a group "key" from the row object /// convert a group "key" into a title for the group /// /// For sorting to work correctly, aspects from the same column /// must be of the same type, that is, the same aspect cannot sometimes /// return strings and other times integers. /// [Browsable(false)] public partial class OLVColumn : ColumnHeader { /// /// Create an OLVColumn /// public OLVColumn() : base() { } /// /// Initialize a column to have the given title, and show the given aspect /// /// The title of the column /// The aspect to be shown in the column public OLVColumn(string title, string aspect) : this() { this.Text = title; this.AspectName = aspect; } #region Public Properties /// /// The name of the property or method that should be called to get the value to display in this column. /// This is only used if a ValueGetterDelegate has not been given. /// /// This name can be dotted to chain references to properties or methods. /// "DateOfBirth" /// "Owner.HomeAddress.Postcode" [Category("Behavior"), Description("The name of the property or method that should be called to get the aspect to display in this column")] public string AspectName { get { return aspectName; } set { aspectName = value; } } private string aspectName; /// /// This format string will be used to convert an aspect to its string representation. /// /// /// This string is passed as the first parameter to the String.Format() method. /// This is only used if ToStringDelegate has not been set. /// "{0:C}" to convert a number to currency [Category("Behavior"), Description("The format string that will be used to convert an aspect to its string representation"), DefaultValue(null)] public string AspectToStringFormat { get { return aspectToStringFormat; } set { aspectToStringFormat = value; } } private string aspectToStringFormat; /// /// Group objects by the initial letter of the aspect of the column /// /// /// One common pattern is to group column by the initial letter of the value for that group. /// The aspect must be a string (obviously). /// [Category("Behavior"), Description("The name of the property or method that should be called to get the aspect to display in this column"), DefaultValue(false)] public bool UseInitialLetterForGroup { get { return useInitialLetterForGroup; } set { useInitialLetterForGroup = value; } } private bool useInitialLetterForGroup; /// /// Get/set whether this column should be used when the view is switched to tile view. /// /// Column 0 is always included in tileview regardless of this setting. /// Tile views do not work well with many "columns" of information, 2 or 3 works best. [Category("Behavior"), Description("Will this column be used when the view is switched to tile view"), DefaultValue(false)] public bool IsTileViewColumn { get { return isTileViewColumn; } set { isTileViewColumn = value; } } private bool isTileViewColumn = false; /// /// This delegate will be used to extract a value to be displayed in this column. /// /// /// If this is set, AspectName is ignored. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public AspectGetterDelegate AspectGetter { get { return aspectGetter; } set { aspectGetter = value; aspectGetterAutoGenerated = false; } } private AspectGetterDelegate aspectGetter; /// /// The delegate that will be used to translate the aspect to display in this column into a string. /// /// If this value is set, ValueToStringFormat will be ignored. [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public AspectToStringConverterDelegate AspectToStringConverter { get { return aspectToStringConverter; } set { aspectToStringConverter = value; } } private AspectToStringConverterDelegate aspectToStringConverter; /// /// This delegate is called to get the image selector of the image that should be shown in this column. /// It can return an int, string, Image or null. /// /// This delegate can use these return value to identify the image: /// /// null or -1 -- indicates no image /// an int -- the int value will be used as an index into the image list /// a String -- the string value will be used as a key into the image list /// an Image -- the Image will be drawn directly (only in OwnerDrawn mode) /// /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public ImageGetterDelegate ImageGetter { get { return imageGetter; } set { imageGetter = value; } } private ImageGetterDelegate imageGetter; /// /// This delegate is called to get the object that is the key for the group /// to which the given row belongs. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public GroupKeyGetterDelegate GroupKeyGetter { get { return groupKeyGetter; } set { groupKeyGetter = value; } } private GroupKeyGetterDelegate groupKeyGetter; /// /// This delegate is called to convert a group key into a title for that group. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public GroupKeyToTitleConverterDelegate GroupKeyToTitleConverter { get { return groupKeyToTitleConverter; } set { groupKeyToTitleConverter = value; } } private GroupKeyToTitleConverterDelegate groupKeyToTitleConverter; /// /// This delegate is called when a cell needs to be drawn in OwnerDrawn mode. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public RenderDelegate RendererDelegate { get { return rendererDelegate; } set { rendererDelegate = value; } } private RenderDelegate rendererDelegate; /// /// Get/set the renderer that will be invoked when a cell needs to be redrawn /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public BaseRenderer Renderer { get { return renderer; } set { renderer = value; if (renderer == null) this.RendererDelegate = null; else { renderer.Column = this; this.RendererDelegate = new RenderDelegate(renderer.HandleRendering); } } } private BaseRenderer renderer; /// /// Remember if this aspect getter for this column was generated internally, and can therefore /// be regenerated at will /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public bool AspectGetterAutoGenerated { get { return aspectGetterAutoGenerated; } set { aspectGetterAutoGenerated = value; } } private bool aspectGetterAutoGenerated; /// /// When the listview is grouped by this column and group title has an item count, /// how should the lable be formatted? /// /// /// The given format string can/should have two placeholders: /// /// {0} - the original group title /// {1} - the number of items in the group /// /// If this value is not set, the values from the list view will be used /// /// "{0} [{1} items]" [Category("Behavior"), Description("The format to use when suffixing item counts to group titles"), DefaultValue(null)] public string GroupWithItemCountFormat { get { return groupWithItemCountFormat; } set { groupWithItemCountFormat = value; } } private string groupWithItemCountFormat; /// /// Return this.GroupWithItemCountFormat or a reasonable default /// [Browsable(false)] public string GroupWithItemCountFormatOrDefault { get { if (String.IsNullOrEmpty(this.GroupWithItemCountFormat)) // There is one rare but pathelogically possible case where the ListView can // be null, so we have to provide a workable default for that rare case. if (this.ListView == null) return "{0} [{1} items]"; else return ((ObjectListView)this.ListView).GroupWithItemCountFormatOrDefault; else return this.GroupWithItemCountFormat; } } /// /// When the listview is grouped by this column and a group title has an item count, /// how should the lable be formatted if there is only one item in the group? /// /// /// The given format string can/should have two placeholders: /// /// {0} - the original group title /// {1} - the number of items in the group (always 1) /// /// If this value is not set, the values from the list view will be used /// /// "{0} [{1} item]" [Category("Behavior"), Description("The format to use when suffixing item counts to group titles"), DefaultValue(null)] public string GroupWithItemCountSingularFormat { get { return groupWithItemCountSingularFormat; } set { groupWithItemCountSingularFormat = value; } } private string groupWithItemCountSingularFormat; /// /// Return this.GroupWithItemCountSingularFormat or a reasonable default /// [Browsable(false)] public string GroupWithItemCountSingularFormatOrDefault { get { if (String.IsNullOrEmpty(this.GroupWithItemCountSingularFormat)) // There is one pathelogically rare but still possible case where the ListView can // be null, so we have to provide a workable default for that rare case. if (this.ListView == null) return "{0} [{1} item]"; else return ((ObjectListView)this.ListView).GroupWithItemCountSingularFormatOrDefault; else return this.GroupWithItemCountSingularFormat; } } /// /// What is the minimum width that the user can give to this column? /// /// -1 means there is no minimum width. Give this the same value as MaximumWidth to make a fixed width column. [Category("Misc"), Description("What is the minimum width to which the user can resize this column?"), DefaultValue(-1)] public int MinimumWidth { get { return minWidth; } set { minWidth = value; if (this.Width < minWidth) this.Width = minWidth; } } private int minWidth = -1; /// /// What is the maximum width that the user can give to this column? /// /// -1 means there is no maximum width. Give this the same value as MinimumWidth to make a fixed width column. [Category("Misc"), Description("What is the maximum width to which the user can resize this column?"), DefaultValue(-1)] public int MaximumWidth { get { return maxWidth; } set { maxWidth = value; if (maxWidth != -1 && this.Width > maxWidth) this.Width = maxWidth; } } private int maxWidth = -1; /// /// Is this column a fixed width column? /// [Browsable(false)] public bool IsFixedWidth { get { return (this.MinimumWidth != -1 && this.MaximumWidth != -1 && this.MinimumWidth >= this.MaximumWidth); } } /// /// What proportion of the unoccupied horizontal space in the control should be given to this column? /// /// /// /// There are situations where it would be nice if a column (normally the rightmost one) would expand as /// the list view expands, so that as much of the column was visible as possible without having to scroll /// horizontally (you should never, ever make your users have to scroll anything horizontally!). /// /// /// A space filling column is resized to occupy a proportion of the unoccupied width of the listview (the /// unoccupied width is the width left over once all the the non-filling columns have been given their space). /// This property indicates the relative proportion of that unoccupied space that will be given to this column. /// The actual value of this property is not important -- only its value relative to the value in other columns. /// For example: /// /// /// If there is only one space filling column, it will be given all the free space, regardless of the value in FreeSpaceProportion. /// /// /// If there are two or more space filling columns and they all have the same value for FreeSpaceProportion, /// they will share the free space equally. /// /// /// If there are three space filling columns with values of 3, 2, and 1 /// for FreeSpaceProportion, then the first column with occupy half the free space, the second will /// occupy one-third of the free space, and the third column one-sixth of the free space. /// /// /// /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public int FreeSpaceProportion { get { return freeSpaceProportion; } set { freeSpaceProportion = Math.Max(0, value); } } private int freeSpaceProportion = 0; /// /// Should this column resize to fill the free space in the listview? /// /// /// /// If you want two (or more) columns to equally share the available free space, set this property to True. /// If you want this column to have a larger or smaller share of the free space, you must /// set the FreeSpaceProportion property explicitly. /// /// /// Space filling columns are still governed by the MinimumWidth and MaximumWidth properties. /// /// /// [Category("Misc"), Description("Will this column resize to fill unoccupied horizontal space in the listview?"), DefaultValue(false)] public bool FillsFreeSpace { get { return this.FreeSpaceProportion > 0; } set { if (value) this.freeSpaceProportion = 1; else this.freeSpaceProportion = 0; } } /// /// This delegate will be used to put an edited value back into the model object. /// /// /// This does nothing if IsEditable == false. /// [Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public AspectPutterDelegate AspectPutter { get { return aspectPutter; } set { aspectPutter = value; } } private AspectPutterDelegate aspectPutter; /// /// Can the values shown in this column be edited? /// /// This defaults to true, since the primary means to control the editability of a listview /// is on the listview itself. Once a listview is editable, all the columns are too, unless the /// programmer explicitly marks them as not editable [Category("Misc"), Description("Can the value in this column be edited?"), DefaultValue(true)] public bool IsEditable { get { return isEditable; } set { isEditable = value; } } private bool isEditable = true; /// /// Return the control that should be used to edit cells in this column /// [Browsable(false)] [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public Control CellEditor { get { return cellEditor; } set { cellEditor = value; } } private Control cellEditor; /// /// Can this column be seen by the user? /// /// After changing this value, you must call RebuildColumns() before the changes will be effected. [Category("Misc"), Description("Can this column be seen by the user?"), DefaultValue(true)] public bool IsVisible { get { return isVisible; } set { isVisible = value; } } private bool isVisible = true; /// /// Where was this column last positioned within the Detail view columns /// /// DisplayIndex is volatile. Once a column is removed from the control, /// there is no way to discover where it was in the display order. This property /// guards that information even when the column is not in the listview's active columns. [Browsable(false)] [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public int LastDisplayIndex = -1; #endregion /// /// For a given row object, return the object that is to be displayed in this column. /// /// The row object that is being displayed /// An object, which is the aspect to be displayed public object GetValue(object rowObject) { if (this.aspectGetter == null) return this.GetAspectByName(rowObject); else return this.aspectGetter(rowObject); } /// /// For a given row object, extract the value indicated by the AspectName property of this column. /// /// The row object that is being displayed /// An object, which is the aspect named by AspectName public object GetAspectByName(object rowObject) { if (string.IsNullOrEmpty(this.aspectName)) return null; //CONSIDER: Should we include NonPublic in this list? BindingFlags flags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.InvokeMethod | BindingFlags.GetProperty | BindingFlags.GetField; object source = rowObject; foreach (string property in this.aspectName.Split('.')) { try { source = source.GetType().InvokeMember(property, flags, null, source, null); if (source == null) break; } catch (System.MissingMethodException) { return String.Format("Cannot invoke '{0}' on a {1}", property, source.GetType()); } } return source; } /// /// Update the given model object with the given value /// /// The model object to be updated /// The value to be put into the model public void PutValue(Object rowObject, Object newValue) { if (this.aspectPutter == null) this.PutAspectByName(rowObject, newValue); else this.aspectPutter(rowObject, newValue); } /// /// Update the given model object with the given value using the column's /// AspectName. /// /// The model object to be updated /// The value to be put into the model public void PutAspectByName(Object rowObject, Object newValue) { if (string.IsNullOrEmpty(this.aspectName)) return; // Navigated through the dotted path until we reach the target object. // We then try to set the last property on the dotted path on that target. // So, if rowObject is a Person, then an aspect named "HomeAddress.Postcode" // will first fetch the "HomeAddress" property, and then try to set the // "Postcode" property on the home address object. //CONSIDER: Should we include NonPublic in this list? BindingFlags flags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.InvokeMethod | BindingFlags.GetProperty | BindingFlags.GetField; Object target = rowObject; List parentProperties = new List(this.aspectName.Split('.')); String lastProperty = parentProperties[parentProperties.Count - 1]; parentProperties.RemoveAt(parentProperties.Count - 1); foreach (string property in parentProperties) { try { target = target.GetType().InvokeMember(property, flags, null, target, null); } catch (System.MissingMethodException) { System.Diagnostics.Debug.WriteLine(String.Format("Cannot invoke '{0}' on a {1}", property, target.GetType())); return; } } // Now try to set the value try { BindingFlags flags2 = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.SetProperty | BindingFlags.SetField; target.GetType().InvokeMember(lastProperty, flags2, null, target, new Object[] { newValue }); } catch (System.MissingMethodException ex) { System.Diagnostics.Debug.WriteLine("Invoke PutAspectByName failed:"); System.Diagnostics.Debug.WriteLine(ex); } } /// /// For a given row object, return the string representation of the value shown in this column. /// /// /// For aspects that are string (e.g. aPerson.Name), the aspect and its string representation are the same. /// For non-strings (e.g. aPerson.DateOfBirth), the string representation is very different. /// /// /// public string GetStringValue(object rowObject) { return this.ValueToString(this.GetValue(rowObject)); } /// /// Convert the aspect object to its string representation. /// /// /// If the column has been given a ToStringDelegate, that will be used to do /// the conversion, otherwise just use ToString(). Nulls are always converted /// to empty strings. /// /// The value of the aspect that should be displayed /// A string representation of the aspect public string ValueToString(object value) { // CONSIDER: Should we give aspect-to-string converters a chance to work on a null value? if (value == null) return ""; if (this.aspectToStringConverter != null) return this.aspectToStringConverter(value); string fmt = this.AspectToStringFormat; if (String.IsNullOrEmpty(fmt)) return value.ToString(); else return String.Format(fmt, value); } /// /// For a given row object, return the image selector of the image that should displayed in this column. /// /// The row object that is being displayed /// int or string or Image. int or string will be used as index into image list. null or -1 means no image public Object GetImage(object rowObject) { if (this.imageGetter != null) return this.imageGetter(rowObject); if (!String.IsNullOrEmpty(this.ImageKey)) return this.ImageKey; return this.ImageIndex; } /// /// For a given row object, return the object that is the key of the group that this row belongs to. /// /// The row object that is being displayed /// Group key object public object GetGroupKey(object rowObject) { if (this.groupKeyGetter == null) { object key = this.GetValue(rowObject); if (key is string && this.UseInitialLetterForGroup) { String keyAsString = (String)key; if (keyAsString.Length > 0) key = keyAsString.Substring(0, 1).ToUpper(); } return key; } else return this.groupKeyGetter(rowObject); } /// /// For a given group value, return the string that should be used as the groups title. /// /// The group key that is being converted to a title /// string public string ConvertGroupKeyToTitle(object value) { if (this.groupKeyToTitleConverter == null) return this.ValueToString(value); else return this.groupKeyToTitleConverter(value); } #region Utilities /// /// Install delegates that will group the columns aspects into progressive partitions. /// If an aspect is less than value[n], it will be grouped with description[n]. /// If an aspect has a value greater than the last element in "values", it will be grouped /// with the last element in "descriptions". /// /// Array of values. Values must be able to be /// compared to the aspect (using IComparable) /// The description for the matching value. The last element is the default description. /// If there are n values, there must be n+1 descriptions. /// /// this.salaryColumn.MakeGroupies( /// new UInt32[] { 20000, 100000 }, /// new string[] { "Lowly worker", "Middle management", "Rarified elevation"}); /// public void MakeGroupies(T[] values, string[] descriptions) { if (values.Length + 1 != descriptions.Length) throw new ArgumentException("descriptions must have one more element than values."); // Install a delegate that returns the index of the description to be shown this.GroupKeyGetter = delegate(object row) { Object aspect = this.GetValue(row); if (aspect == null || aspect == System.DBNull.Value) return -1; IComparable comparable = (IComparable)aspect; for (int i = 0; i < values.Length; i++) { if (comparable.CompareTo(values[i]) < 0) return i; } // Display the last element in the array return descriptions.Length - 1; }; // Install a delegate that simply looks up the given index in the descriptions. this.GroupKeyToTitleConverter = delegate(object key) { if ((int)key < 0) return ""; return descriptions[(int)key]; }; } #endregion #region Private Variables #endregion } #endregion #region OLVListItem and OLVListSubItem /// /// OLVListItems are specialized ListViewItems that know which row object they came from, /// and the row index at which they are displayed, even when in group view mode. They /// also know the image they should draw against themselves /// public class OLVListItem : ListViewItem { /// /// Create a OLVListItem for the given row object /// public OLVListItem(object rowObject) : base() { this.rowObject = rowObject; } /// /// Create a OLVListItem for the given row object, represented by the given string and image /// public OLVListItem(object rowObject, string text, Object image) : base(text, -1) { this.rowObject = rowObject; this.imageSelector = image; } /// /// RowObject is the model object that is source of the data for this list item. /// public object RowObject { get { return rowObject; } set { rowObject = value; } } private object rowObject; /// /// DisplayIndex is the index of the row where this item is displayed. For flat lists, /// this is the same as ListViewItem.Index, but for grouped views, it is different. /// public int DisplayIndex { get { return displayIndex; } set { displayIndex = value; } } private int displayIndex; /// /// Get or set the image that should be shown against this item /// /// This can be an Image, a string or an int. A string or an int will /// be used as an index into the small image list. public Object ImageSelector { get { return imageSelector; } set { imageSelector = value; if (value is Int32) this.ImageIndex = (Int32)value; else if (value is String) this.ImageKey = (String)value; else this.ImageIndex = -1; } } private Object imageSelector; } /// /// A ListViewSubItem that knows which image should be drawn against it. /// [Browsable(false)] public class OLVListSubItem : ListViewItem.ListViewSubItem { /// /// Create a OLVListSubItem /// public OLVListSubItem() : base() { } /// /// Create a OLVListSubItem that shows the given string and image /// public OLVListSubItem(string text, Object image) : base() { this.Text = text; this.ImageSelector = image; } /// /// Get or set the image that should be shown against this item /// /// This can be an Image, a string or an int. A string or an int will /// be used as an index into the small image list. public Object ImageSelector { get { return imageSelector; } set { imageSelector = value; } } private Object imageSelector; /// /// Return the state of the animatation of the image on this subitem. /// Null means there is either no image, or it is not an animation /// internal ImageRenderer.AnimationState AnimationState { get { return animationState; } set { animationState = value; } } private ImageRenderer.AnimationState animationState; } #endregion #region Comparers /// /// This comparer sort list view groups. /// It does this on the basis of the values in the Tags, if we can figure out how to compare /// objects of that type. Failing that, it uses a case insensitive compare on the group header. /// internal class ListViewGroupComparer : IComparer { public ListViewGroupComparer(SortOrder order) { this.sortOrder = order; } public int Compare(ListViewGroup x, ListViewGroup y) { // If we know how to compare the tags, do that. // Otherwise do a case insensitive compare on the group header. // We have explicitly catch the "almost-null" value of DBNull.Value, // since comparing to that value always produces a type exception. int result; IComparable comparable = x.Tag as IComparable; if (comparable != null && y.Tag != System.DBNull.Value) result = comparable.CompareTo(y.Tag); else result = String.Compare(x.Header, y.Header, true); if (this.sortOrder == SortOrder.Descending) result = 0 - result; return result; } private SortOrder sortOrder; } /// /// ColumnComparer is the workhorse for all comparison between two values of a particular column. /// If the column has a specific comparer, use that to compare the values. Otherwise, do /// a case insensitive string compare of the string representations of the values. /// /// This class inherits from both IComparer and its generic counterpart /// so that it can be used on untyped and typed collections. internal class ColumnComparer : IComparer, IComparer { public ColumnComparer(OLVColumn col, SortOrder order) { this.column = col; this.sortOrder = order; this.secondComparer = null; } public ColumnComparer(OLVColumn col, SortOrder order, OLVColumn col2, SortOrder order2) : this(col, order) { // There is no point in secondary sorting on the same column if (col != col2) this.secondComparer = new ColumnComparer(col2, order2); } public int Compare(object x, object y) { return this.Compare((OLVListItem)x, (OLVListItem)y); } public int Compare(OLVListItem x, OLVListItem y) { int result = 0; object x1 = this.column.GetValue(x.RowObject); object y1 = this.column.GetValue(y.RowObject); if (this.sortOrder == SortOrder.None) return 0; // Handle nulls. Null values come last bool xIsNull = (x1 == null || x1 == System.DBNull.Value); bool yIsNull = (y1 == null || y1 == System.DBNull.Value); if (xIsNull || yIsNull) { if (xIsNull && yIsNull) result = 0; else result = (xIsNull ? -1 : 1); } else { result = this.CompareValues(x1, y1); } if (this.sortOrder == SortOrder.Descending) result = 0 - result; // If the result was equality, use the secondary comparer to resolve it if (result == 0 && this.secondComparer != null) result = this.secondComparer.Compare(x, y); return result; } public int CompareValues(object x, object y) { // Force case insensitive compares on strings if (x is String) return String.Compare((String)x, (String)y, true); else { IComparable comparable = x as IComparable; if (comparable != null) return comparable.CompareTo(y); else return 0; } } private OLVColumn column; private SortOrder sortOrder; private ColumnComparer secondComparer; } #endregion #region Renderers /// /// Renderers are responsible for drawing a single cell within an owner drawn ObjectListView. /// /// /// Methods on this class are called during the DrawItem or DrawSubItemEvent. /// Subclasses can tell which type of event they are handling by examining DrawItemEvent: if this /// is not null, it is a DrawItem event. /// Subclasses will normally override the RenderWithDefault or Render method, and use the other /// methods as helper functions. /// If a renderer is installed on the primary column (column 0), it will be given a chance /// to draw the whole item in all views (Details, Tile, etc.). If the renderer returns true, /// default processing will continue. If it returns false, no other rendering will happen. /// This means that when an ObjectListView is in Details view, the renderer on column 0 /// will be called twice: once to handle the DrawItem event, and then again to draw only the /// first cell. Subclasses must distinguish between these two very different events (using /// the "this.DrawItemEvent == null" test). /// [Browsable(false)] public class BaseRenderer { /// /// Make a simple renderer /// public BaseRenderer() { } #region Properties /// /// Get/set the event that caused this renderer to be called /// public DrawListViewSubItemEventArgs Event { get { return eventArgs; } set { eventArgs = value; } } private DrawListViewSubItemEventArgs eventArgs; /// /// Get/set the event that caused this renderer to be called /// public DrawListViewItemEventArgs DrawItemEvent { get { return drawItemEventArgs; } set { drawItemEventArgs = value; } } private DrawListViewItemEventArgs drawItemEventArgs; /// /// Get/set the listview for which the drawing is to be done /// public ObjectListView ListView { get { return objectListView; } set { objectListView = value; } } private ObjectListView objectListView; /// /// Get or set the OLVColumn that this renderer will draw /// public OLVColumn Column { get { return column; } set { column = value; } } private OLVColumn column; /// /// Get or set the model object that this renderer should draw /// public Object RowObject { get { return rowObject; } set { rowObject = value; } } private Object rowObject; /// /// Get or set the aspect of the model object that this renderer should draw /// public Object Aspect { get { if (aspect == null) aspect = column.GetValue(this.rowObject); return aspect; } set { aspect = value; } } private Object aspect; /// /// Get or set the listitem that this renderer will be drawing /// public OLVListItem ListItem { get { return listItem; } set { listItem = value; } } private OLVListItem listItem; /// /// Get or set the list subitem that this renderer will be drawing /// public ListViewItem.ListViewSubItem SubItem { get { return listSubItem; } set { listSubItem = value; } } private ListViewItem.ListViewSubItem listSubItem; /// /// Get the specialized OLVSubItem that this renderer is drawing /// /// This returns null for column 0. public OLVListSubItem OLVSubItem { get { return listSubItem as OLVListSubItem; } } /// /// Cache whether or not our item is selected /// public bool IsItemSelected { get { return isItemSelected; } set { isItemSelected = value; } } private bool isItemSelected; /// /// Return the font to be used for text in this cell /// /// The font of the subitem public Font Font { get { if (this.font == null) { if (this.ListItem.UseItemStyleForSubItems) return this.ListItem.Font; else return this.SubItem.Font; } else return this.font; } set { this.font = value; } } private Font font; /// /// The brush that will be used to paint the text /// public Brush TextBrush { get { if (textBrush == null) return new SolidBrush(this.GetForegroundColor()); else return this.textBrush; } set { textBrush = value; } } private Brush textBrush; /// /// Should this renderer fill in the background before drawing? /// public bool IsDrawBackground { get { return isDrawBackground; } set { isDrawBackground = value; } } private bool isDrawBackground = true; /// /// Can the renderer wrap lines that do not fit completely within the cell? /// /// This value is currently only used when printing a list view using ListViewPrinter. public bool CanWrap { get { return canWrap; } set { canWrap = value; } } private bool canWrap = false; /// /// When rendering multiple images, how many pixels should be between each image? /// public int Spacing { get { return spacing; } set { spacing = value; } } private int spacing = 1; #endregion #region Utilities /// /// Return the string that should be drawn within this /// /// public string GetText() { if (this.SubItem == null) return this.ListItem.Text; else return this.SubItem.Text; } /// /// Return the image that should be drawn against this subitem /// /// An Image or null if no image should be drawn. public Image GetImage() { if (this.Column.Index == 0) return this.GetImage(this.ListItem.ImageSelector); else return this.GetImage(this.OLVSubItem.ImageSelector); } /// /// Return the actual image that should be drawn when keyed by the given image selector. /// An image selector can be: /// an int, giving the index into the image list /// a string, giving the image key into the image list /// an Image, being the image itself /// /// /// The value that indicates the image to be used /// An Image or null public Image GetImage(Object imageSelector) { if (imageSelector == null || imageSelector == System.DBNull.Value) return null; ImageList il = this.ListView.BaseSmallImageList; if (il != null) { if (imageSelector is Int32) { Int32 index = (Int32)imageSelector; if (index < 0 || index >= il.Images.Count) return null; else return il.Images[index]; } if (imageSelector is String) { if (il.Images.ContainsKey((String)imageSelector)) return il.Images[(String)imageSelector]; else return null; } } return imageSelector as Image; } /// /// Return the Color that is the background color for this item's cell /// /// The background color of the subitem public Color GetBackgroundColor() { if (this.IsItemSelected && this.ListView.FullRowSelect) { if (this.ListView.Focused) return this.ListView.HighlightBackgroundColorOrDefault; else if (!this.ListView.HideSelection) return SystemColors.Control; //TODO: What color should this be? } if (this.ListItem.UseItemStyleForSubItems) return this.ListItem.BackColor; else return this.SubItem.BackColor; } /// /// Return the Color that is the background color for this item's text /// /// The background color of the subitem's text protected Color GetTextBackgroundColor() { if (this.IsItemSelected && (this.Column.Index == 0 || this.ListView.FullRowSelect)) return this.ListView.HighlightBackgroundColorOrDefault; else if (this.ListItem.UseItemStyleForSubItems) return this.ListItem.BackColor; else return this.SubItem.BackColor; } /// /// Return the color to be used for text in this cell /// /// The text color of the subitem protected Color GetForegroundColor() { if (this.IsItemSelected && (this.Column.Index == 0 || this.ListView.FullRowSelect)) return this.ListView.HighlightForegroundColorOrDefault; else if (this.ListItem.UseItemStyleForSubItems) return this.ListItem.ForeColor; else return this.SubItem.ForeColor; } /// /// Align the second rectangle with the first rectangle, /// according to the alignment of the column /// /// The cell's bounds /// The rectangle to be aligned within the bounds /// An aligned rectangle protected Rectangle AlignRectangle(Rectangle outer, Rectangle inner) { Rectangle r = new Rectangle(outer.Location, inner.Size); // Centre horizontally depending on the column alignment if (inner.Width < outer.Width) { switch (this.Column.TextAlign) { case HorizontalAlignment.Left: r.X = outer.Left; break; case HorizontalAlignment.Center: r.X = outer.Left + ((outer.Width - inner.Width) / 2); break; case HorizontalAlignment.Right: r.X = outer.Right - inner.Width - 1; break; } } // Centre vertically too if (inner.Height < outer.Height) r.Y = outer.Top + ((outer.Height - inner.Height) / 2); return r; } /// /// Draw the given image aligned horizontally within the column. /// /// /// Over tall images are scaled to fit. Over-wide images are /// truncated. This is by design! /// /// Graphics context to use for drawing /// Bounds of the cell /// The image to be drawn protected void DrawAlignedImage(Graphics g, Rectangle r, Image image) { if (image == null) return; // By default, the image goes in the top left of the rectangle Rectangle imageBounds = new Rectangle(r.Location, image.Size); // If the image is too tall to be drawn in the space provided, proportionally scale it down. // Too wide images are not scaled. if (image.Height > r.Height) { float scaleRatio = (float)r.Height / (float)image.Height; imageBounds.Width = (int)((float)image.Width * scaleRatio); imageBounds.Height = r.Height - 1; } // Align and draw our (possibly scaled) image g.DrawImage(image, this.AlignRectangle(r, imageBounds)); } /// /// Fill in the background of this cell /// /// Graphics context to use for drawing /// Bounds of the cell protected void DrawBackground(Graphics g, Rectangle r) { if (this.IsDrawBackground) { using (Brush brush = new SolidBrush(this.GetBackgroundColor())) { g.FillRectangle(brush, r); } } } #endregion /// /// The delegate that is called from the list view. This is the main entry point, but /// subclasses should override Render instead of this method. /// /// The event that caused this redraw /// The context that our drawing should be done using /// The bounds of the cell within which the renderer can draw /// The model object for this row /// A boolean indicating whether the default process should occur public bool HandleRendering(EventArgs e, Graphics g, Rectangle r, Object rowObject) { this.ListView = (ObjectListView)this.Column.ListView; if (e is DrawListViewSubItemEventArgs) { this.Event = (DrawListViewSubItemEventArgs)e; this.ListItem = this.Event.Item as OLVListItem; this.SubItem = this.Event.SubItem; this.Column = this.ListView.GetColumn(this.Event.ColumnIndex); } else { this.DrawItemEvent = (DrawListViewItemEventArgs)e; this.ListItem = this.DrawItemEvent.Item as OLVListItem; this.SubItem = null; this.Column = this.ListView.GetColumn(0); } this.RowObject = rowObject; this.Aspect = null; // uncache previous result this.IsItemSelected = this.ListItem.Selected; // ((e.ItemState & ListViewItemStates.Selected) == ListViewItemStates.Selected); this.IsDrawBackground = true; this.Font = null; this.TextBrush = null; return this.OptionalRender(g, r); } /// /// Draw our data into the given rectangle using the given graphics context. /// /// /// Subclasses should override this method. /// The graphics context that should be used for drawing /// The bounds of the subitem cell /// Returns whether the renderering has already taken place. /// If this returns false, the default processing will take over. /// virtual public bool OptionalRender(Graphics g, Rectangle r) { this.Render(g, r); return true; } /// /// Draw our data into the given rectangle using the given graphics context. /// /// /// Subclasses should override this method if they never want /// to fall back on the default processing /// The graphics context that should be used for drawing /// The bounds of the subitem cell virtual public void Render(Graphics g, Rectangle r) { this.DrawBackground(g, r); // Adjust the rectangle to match the padding used by the native mode of the ListView Rectangle r2 = r; r2.X += 4; r2.Width -= 4; this.DrawImageAndText(g, r2); } /// /// Draw our subitems image and text /// /// Graphics context to use for drawing /// Bounds of the cell protected void DrawImageAndText(Graphics g, Rectangle r) { this.DrawImageAndText(g, r, this.GetText(), this.GetImage()); } /// /// Draw the given text and optional image in the "normal" fashion /// /// Graphics context to use for drawing /// Bounds of the cell /// The string to be drawn /// The optional image to be drawn protected void DrawImageAndText(Graphics g, Rectangle r, String txt, Image image) { // Draw the image if (image != null) { int top = r.Y; if (image.Size.Height < r.Height) top += ((r.Height - image.Size.Height) / 2); g.DrawImageUnscaled(image, r.X, top); r.X += image.Width; r.Width -= image.Width; } StringFormat fmt = new StringFormat(); fmt.LineAlignment = StringAlignment.Center; fmt.Trimming = StringTrimming.EllipsisCharacter; if (!this.CanWrap) fmt.FormatFlags = StringFormatFlags.NoWrap; switch (this.Column.TextAlign) { case HorizontalAlignment.Center: fmt.Alignment = StringAlignment.Center; break; case HorizontalAlignment.Left: fmt.Alignment = StringAlignment.Near; break; case HorizontalAlignment.Right: fmt.Alignment = StringAlignment.Far; break; } // Draw the background of the text as selected, if it's the primary column // and it's selected and it's not in FullRowSelect mode. if (this.IsDrawBackground && this.IsItemSelected && this.Column.Index == 0 && !this.ListView.FullRowSelect) { SizeF size = g.MeasureString(txt, this.Font, r.Width, fmt); // This is a tighter selection box //Rectangle r2 = this.AlignRectangle(r, new Rectangle(0, 0, (int)(size.Width + 1), (int)(size.Height + 1))); Rectangle r2 = r; r2.Width = (int)size.Width + 1; using (Brush brush = new SolidBrush(this.ListView.HighlightBackgroundColorOrDefault)) g.FillRectangle(brush, r2); } RectangleF rf = r; g.DrawString(txt, this.Font, this.TextBrush, rf, fmt); // We should put a focus rectange around the column 0 text if it's selected -- // but we don't because: // - I really dislike this UI convention // - we are using buffered graphics, so the DrawFocusRecatangle method of the event doesn't work //if (this.Column.Index == 0) { // Size size = TextRenderer.MeasureText(this.SubItem.Text, this.ListView.ListFont); // if (r.Width > size.Width) // r.Width = size.Width; // this.Event.DrawFocusRectangle(r); //} } } /// /// This class maps a data value to an image that should be drawn for that value. /// /// It is useful for drawing data that is represented as an enum or boolean. public class MappedImageRenderer : BaseRenderer { /// /// Return a renderer that draw boolean values using the given images /// /// Draw this when our data value is true /// Draw this when our data value is false /// A Renderer static public MappedImageRenderer Boolean(Object trueImage, Object falseImage) { return new MappedImageRenderer(true, trueImage, false, falseImage); } /// /// Return a renderer that draw tristate boolean values using the given images /// /// Draw this when our data value is true /// Draw this when our data value is false /// Draw this when our data value is null /// A Renderer static public MappedImageRenderer TriState(Object trueImage, Object falseImage, Object nullImage) { return new MappedImageRenderer(new Object[] { true, trueImage, false, falseImage, null, nullImage }); } /// /// Make a new empty renderer /// public MappedImageRenderer() : base() { map = new System.Collections.Hashtable(); } /// /// Make a new renderer that will show the given image when the given key is the aspect value /// /// The data value to be matched /// The image to be shown when the key is matched public MappedImageRenderer(Object key, Object image) : this() { this.Add(key, image); } /// /// Make a new renderer that will show the given images when it receives the given keys /// /// /// /// /// public MappedImageRenderer(Object key1, Object image1, Object key2, Object image2) : this() { this.Add(key1, image1); this.Add(key2, image2); } /// /// Build a renderer from the given array of keys and their matching images /// /// An array of key/image pairs public MappedImageRenderer(Object[] keysAndImages) : this() { if ((keysAndImages.GetLength(0) % 2) != 0) throw new ArgumentException("Array must have key/image pairs"); for (int i = 0; i < keysAndImages.GetLength(0); i += 2) this.Add(keysAndImages[i], keysAndImages[i + 1]); } /// /// Register the image that should be drawn when our Aspect has the data value. /// /// Value that the Aspect must match /// An ImageSelector -- an int, string or image public void Add(Object value, Object image) { if (value == null) this.nullImage = image; else map[value] = image; } /// /// Render our value /// /// /// public override void Render(Graphics g, Rectangle r) { this.DrawBackground(g, r); if (this.Aspect is ICollection) this.RenderCollection(g, r, (ICollection)this.Aspect); else this.RenderOne(g, r, this.Aspect); } private void RenderCollection(Graphics g, Rectangle r, ICollection imageSelectors) { Image image = null; Point pt = r.Location; foreach (Object selector in imageSelectors) { if (selector == null) image = this.GetImage(this.nullImage); else if (map.ContainsKey(selector)) image = this.GetImage(map[selector]); else image = null; if (image != null) { g.DrawImage(image, pt); pt.X += (image.Width + this.Spacing); } } } private void RenderOne(Graphics g, Rectangle r, Object selector) { Image image = null; if (selector == null) image = this.GetImage(this.nullImage); else if (map.ContainsKey(selector)) image = this.GetImage(map[selector]); if (image != null) this.DrawAlignedImage(g, r, image); } #region Private variables private Hashtable map; // Track the association between values and images private Object nullImage; // image to be drawn for null values (since null can't be a key) #endregion } /// /// Render an image that comes from our data source. /// /// The image can be sourced from: /// /// a byte-array (normally when the image to be shown is /// stored as a value in a database) /// an int, which is treated as an index into the image list /// a string, which is treated first as a file name, and failing that as an index into the image list /// /// If an image is an animated GIF, it's state is stored in the SubItem object. /// By default, the image renderer does not render animations (it begins life with animations paused). /// To enable animations, you must call Unpause(). /// public class ImageRenderer : BaseRenderer { /// /// Make an empty image renderer /// public ImageRenderer() : base() { this.tickler = new System.Threading.Timer(new TimerCallback(this.OnTimer), null, Timeout.Infinite, Timeout.Infinite); this.stopwatch = new Stopwatch(); } /// /// Make an empty image renderer that begins life ready for animations /// public ImageRenderer(bool startAnimations) : this() { this.Paused = !startAnimations; } /// /// Draw our image /// /// /// public override void Render(Graphics g, Rectangle r) { this.DrawBackground(g, r); this.DrawAlignedImage(g, r, this.GetImageFromAspect()); } /// /// Translate our Aspect into an image. /// /// The strategy is: /// If its a byte array, we treat it as an in-memory image /// If it's an int, we use that as an index into our image list /// If it's a string, we try to load a file by that name. If we can't, we use the string as an index into our image list. /// /// An image protected Image GetImageFromAspect() { if (this.Aspect == null || this.Aspect == System.DBNull.Value) return null; // If we've already figured out the image, don't do it again if (this.OLVSubItem != null && this.OLVSubItem.ImageSelector is Image) { if (this.OLVSubItem.AnimationState == null) return (Image)this.OLVSubItem.ImageSelector; else return this.OLVSubItem.AnimationState.image; } // Try to convert our Aspect into an Image // If its a byte array, we treat it as an in-memory image // If it's an int, we use that as an index into our image list // If it's a string, we try to find a file by that name. // If we can't, we use the string as an index into our image list. Image image = null; if (this.Aspect is System.Byte[]) { using (MemoryStream stream = new MemoryStream((System.Byte[])this.Aspect)) { try { image = Image.FromStream(stream); } catch (ArgumentException) { // ignore } } } else if (this.Aspect is Int32) { image = this.GetImage(this.Aspect); } else if (this.Aspect is String && ((String)this.Aspect) != "") { try { image = Image.FromFile((String)this.Aspect); } catch (FileNotFoundException) { image = this.GetImage(this.Aspect); } catch (OutOfMemoryException) { image = this.GetImage(this.Aspect); } } // If this image is an animation, initialize the animation process if (this.OLVSubItem != null && AnimationState.IsAnimation(image)) { this.OLVSubItem.AnimationState = new AnimationState(image); } // Cache the image so we don't repeat this dreary process if (this.OLVSubItem != null) this.OLVSubItem.ImageSelector = image; return image; } /// /// Should the animations in this renderer be paused? /// public bool Paused { get { return isPaused; } set { if (isPaused != value) { isPaused = value; if (isPaused) { this.tickler.Change(Timeout.Infinite, Timeout.Infinite); this.stopwatch.Stop(); } else { this.tickler.Change(1, Timeout.Infinite); this.stopwatch.Start(); } } } } private bool isPaused = true; /// /// Pause any animations /// public void Pause() { this.Paused = true; } /// /// Unpause any animations /// public void Unpause() { this.Paused = false; } /// /// This is the method that is invoked by the timer. It basically switches control to the listview thread. /// /// not used public void OnTimer(Object state) { if (this.ListView == null || this.Paused) this.tickler.Change(1000, Timeout.Infinite); else { if (this.ListView.InvokeRequired) this.ListView.Invoke((MethodInvoker)delegate { this.OnTimer(state); }); else this.OnTimerInThread(); } } /// /// This is the OnTimer callback, but invoked in the same thread as the creator of the ListView. /// This method can use all of ListViews methods without creating a CrossThread exception. /// protected void OnTimerInThread() { // MAINTAINER NOTE: This method must renew the tickler. If it doesn't the animations will stop. // If this listview has been destroyed, we can't do anything, so we return without // renewing the tickler, effectively killing all animations on this renderer if (this.ListView.IsDisposed) return; // If we're not in Detail view or our column has been removed from the list, // we can't do anything at the moment, but we still renew the tickler because the view may change later. if (this.ListView.View != System.Windows.Forms.View.Details || this.Column.Index < 0) { this.tickler.Change(1000, Timeout.Infinite); return; } long elapsedMilliseconds = this.stopwatch.ElapsedMilliseconds; int subItemIndex = this.Column.Index; long nextCheckAt = elapsedMilliseconds + 1000; // wait at most one second before checking again Rectangle updateRect = new Rectangle(); // what part of the view must be updated to draw the changed gifs? // Run through all the subitems in the view for our column, and for each one that // has an animation attached to it, see if the frame needs updating. foreach (ListViewItem lvi in this.ListView.Items) { // Get the gif state from the subitem. If there isn't an animation state, skip this row. OLVListSubItem lvsi = (OLVListSubItem)lvi.SubItems[subItemIndex]; AnimationState state = lvsi.AnimationState; if (state == null || !state.IsValid) continue; // Has this frame of the animation expired? if (elapsedMilliseconds >= state.currentFrameExpiresAt) { state.AdvanceFrame(elapsedMilliseconds); // Track the area of the view that needs to be redrawn to show the changed images if (updateRect.IsEmpty) updateRect = lvsi.Bounds; else updateRect = Rectangle.Union(updateRect, lvsi.Bounds); } // Remember the minimum time at which a frame is next due to change nextCheckAt = Math.Min(nextCheckAt, state.currentFrameExpiresAt); } // Update the part of the listview where frames have changed if (!updateRect.IsEmpty) this.ListView.Invalidate(updateRect); // Renew the tickler in time for the next frame change this.tickler.Change(nextCheckAt - elapsedMilliseconds, Timeout.Infinite); } /// /// Instances of this class kept track of the animation state of a single image. /// internal class AnimationState { const int PropertyTagTypeShort = 3; const int PropertyTagTypeLong = 4; const int PropertyTagFrameDelay = 0x5100; const int PropertyTagLoopCount = 0x5101; /// /// Is the given image an animation /// /// The image to be tested /// Is the image an animation? static public bool IsAnimation(Image image) { if (image == null) return false; else return (new List(image.FrameDimensionsList)).Contains(FrameDimension.Time.Guid); } /// /// Create an AnimationState in a quiet state /// public AnimationState() { this.currentFrame = 0; this.frameCount = 0; this.imageDuration = new List(); this.image = null; } /// /// Create an animation state for the given image, which may or may not /// be an animation /// /// The image to be rendered public AnimationState(Image image) : this() { if (!AnimationState.IsAnimation(image)) return; // How many frames in the animation? this.image = image; this.frameCount = this.image.GetFrameCount(FrameDimension.Time); // Find the delay between each frame. // The delays are stored an array of 4-byte ints. Each int is the // number of 1/100th of a second that should elapsed before the frame expires foreach (PropertyItem pi in this.image.PropertyItems) { if (pi.Id == PropertyTagFrameDelay) { for (int i = 0; i < pi.Len; i += 4) { //TODO: There must be a better way to convert 4-bytes to an int int delay = (pi.Value[i + 3] << 24) + (pi.Value[i + 2] << 16) + (pi.Value[i + 1] << 8) + pi.Value[i]; this.imageDuration.Add(delay * 10); // store delays as milliseconds } break; } } // There should be as many frame durations as frames Debug.Assert(this.imageDuration.Count == this.frameCount, "There should be as many frame durations as there are frames."); } /// /// Does this state represent a valid animation /// public bool IsValid { get { return (this.image != null && this.frameCount > 0); } } /// /// Advance our images current frame and calculate when it will expire /// public void AdvanceFrame(long millisecondsNow) { this.currentFrame = (this.currentFrame + 1) % this.frameCount; this.currentFrameExpiresAt = millisecondsNow + this.imageDuration[this.currentFrame]; this.image.SelectActiveFrame(FrameDimension.Time, this.currentFrame); } internal int currentFrame; internal long currentFrameExpiresAt; internal Image image; internal List imageDuration; internal int frameCount; } #region Private variables private System.Threading.Timer tickler; // timer used to tickle the animations private Stopwatch stopwatch; // clock used to time the animation frame changes #endregion } /// /// Render our Aspect as a progress bar /// public class BarRenderer : BaseRenderer { #region Constructors /// /// Make a BarRenderer /// public BarRenderer() : base() { this.Pen = new Pen(Color.Blue, 1); this.Brush = Brushes.Aquamarine; this.BackgroundBrush = Brushes.White; this.StartColor = Color.Empty; } /// /// Make a BarRenderer for the given range of data values /// public BarRenderer(int minimum, int maximum) : this() { this.MinimumValue = minimum; this.MaximumValue = maximum; } /// /// Make a BarRenderer using a custom bar scheme /// public BarRenderer(Pen aPen, Brush aBrush) : this() { this.Pen = aPen; this.Brush = aBrush; this.UseStandardBar = false; } /// /// Make a BarRenderer using a custom bar scheme /// public BarRenderer(int minimum, int maximum, Pen aPen, Brush aBrush) : this(minimum, maximum) { this.Pen = aPen; this.Brush = aBrush; this.UseStandardBar = false; } /// /// Make a BarRenderer that uses a horizontal gradient /// public BarRenderer(Pen aPen, Color start, Color end) : this() { this.Pen = aPen; this.SetGradient(start, end); } /// /// Make a BarRenderer that uses a horizontal gradient /// public BarRenderer(int minimum, int maximum, Pen aPen, Color start, Color end) : this(minimum, maximum) { this.Pen = aPen; this.SetGradient(start, end); } #endregion #region Public variables /// /// Should this bar be drawn in the system style /// public bool UseStandardBar = true; /// /// How many pixels in from our cell border will this bar be drawn /// public int Padding = 2; /// /// The Pen that will draw the frame surrounding this bar /// public Pen Pen; /// /// The brush that will be used to fill the bar /// public Brush Brush; /// /// The brush that will be used to fill the background of the bar /// public Brush BackgroundBrush; /// /// The first color when a gradient is used to fill the bar /// public Color StartColor; /// /// The end color when a gradient is used to fill the bar /// public Color EndColor; /// /// Regardless of how wide the column become the progress bar will never be wider than this /// public int MaximumWidth = 100; /// /// Regardless of how high the cell is the progress bar will never be taller than this /// public int MaximumHeight = 16; /// /// The minimum data value expected. Values less than this will given an empty bar /// public int MinimumValue = 0; /// /// The maximum value for the range. Values greater than this will give a full bar /// public int MaximumValue = 100; #endregion /// /// Draw this progress bar using a gradient /// /// /// public void SetGradient(Color start, Color end) { this.StartColor = start; this.EndColor = end; this.UseStandardBar = false; } /// /// Draw our aspect /// /// /// public override void Render(Graphics g, Rectangle r) { this.DrawBackground(g, r); Rectangle frameRect = Rectangle.Inflate(r, 0 - this.Padding, 0 - this.Padding); frameRect.Width = Math.Min(frameRect.Width, this.MaximumWidth); frameRect.Height = Math.Min(frameRect.Width, this.MaximumHeight); frameRect = this.AlignRectangle(r, frameRect); // Convert our aspect to a numeric value // CONSIDER: Is this the best way to do this? if (!(this.Aspect is IConvertible)) return; double aspectValue = ((IConvertible)this.Aspect).ToDouble(NumberFormatInfo.InvariantInfo); Rectangle fillRect = Rectangle.Inflate(frameRect, -1, -1); if (aspectValue <= this.MinimumValue) fillRect.Width = 0; else if (aspectValue < this.MaximumValue) fillRect.Width = (int)(fillRect.Width * (aspectValue - this.MinimumValue) / this.MaximumValue); if (this.UseStandardBar && ProgressBarRenderer.IsSupported) { ProgressBarRenderer.DrawHorizontalBar(g, frameRect); ProgressBarRenderer.DrawHorizontalChunks(g, fillRect); } else { g.FillRectangle(this.BackgroundBrush, frameRect); if (fillRect.Width > 0) { fillRect.Height++; if (this.StartColor == Color.Empty) g.FillRectangle(this.Brush, fillRect); else { using (LinearGradientBrush gradient = new LinearGradientBrush(frameRect, this.StartColor, this.EndColor, LinearGradientMode.Horizontal)) { g.FillRectangle(gradient, fillRect); } } } g.DrawRectangle(this.Pen, frameRect); } } } /// /// An ImagesRenderer draws zero or more images depending on the data returned by its Aspect. /// /// This renderer's Aspect must return a ICollection of ints, strings or Images, /// each of which will be drawn horizontally one after the other. public class ImagesRenderer : BaseRenderer { /// /// Draw our data value /// /// /// public override void Render(Graphics g, Rectangle r) { this.DrawBackground(g, r); ICollection imageSelectors = this.Aspect as ICollection; if (imageSelectors == null) return; Point pt = r.Location; foreach (Object selector in imageSelectors) { Image image = this.GetImage(selector); if (image != null) { g.DrawImage(image, pt); pt.X += (image.Width + this.Spacing); } } } } /// /// A MultiImageRenderer draws the same image a number of times based on our data value /// /// The stars in the Rating column of iTunes is a good example of this type of renderer. public class MultiImageRenderer : BaseRenderer { /// /// Make a quiet rendererer /// public MultiImageRenderer() : base() { } /// /// Make an image renderer that will draw the indicated image, at most maxImages times. /// /// /// /// /// public MultiImageRenderer(Object imageSelector, int maxImages, int minValue, int maxValue) : this() { this.ImageSelector = imageSelector; this.MaxNumberImages = maxImages; this.MinimumValue = minValue; this.MaximumValue = maxValue; } /// /// The image selector that will give the image to be drawn /// public Object ImageSelector; /// /// What is the maximum number of images that this renderer should draw? /// public int MaxNumberImages = 10; /// /// Values less than or equal to this will have 0 images drawn /// public int MinimumValue = 0; /// /// Values greater than or equal to this will have MaxNumberImages images drawn /// public int MaximumValue = 100; /// /// Draw our data value /// /// /// public override void Render(Graphics g, Rectangle r) { this.DrawBackground(g, r); Image image = this.GetImage(this.ImageSelector); if (image == null) return; // Convert our aspect to a numeric value // CONSIDER: Is this the best way to do this? if (!(this.Aspect is IConvertible)) return; double aspectValue = ((IConvertible)this.Aspect).ToDouble(NumberFormatInfo.InvariantInfo); // Calculate how many images we need to draw to represent our aspect value int numberOfImages; if (aspectValue <= this.MinimumValue) numberOfImages = 0; else if (aspectValue < this.MaximumValue) numberOfImages = 1 + (int)(this.MaxNumberImages * (aspectValue - this.MinimumValue) / this.MaximumValue); else numberOfImages = this.MaxNumberImages; // If we need to shrink the image, what will its on-screen dimensions be? int imageScaledWidth = image.Width; int imageScaledHeight = image.Height; if (r.Height < image.Height) { imageScaledWidth = (int)((float)image.Width * (float)r.Height / (float)image.Height); imageScaledHeight = r.Height; } // Calculate where the images should be drawn Rectangle imageBounds = r; imageBounds.Width = (this.MaxNumberImages * (imageScaledWidth + this.Spacing)) - this.Spacing; imageBounds.Height = imageScaledHeight; imageBounds = this.AlignRectangle(r, imageBounds); // Finally, draw the images for (int i = 0; i < numberOfImages; i++) { g.DrawImage(image, imageBounds.X, imageBounds.Y, imageScaledWidth, imageScaledHeight); imageBounds.X += (imageScaledWidth + this.Spacing); } } } /// /// A class to render a value that contains a bitwise-OR'ed collection of values. /// /// The type of value that holds the bit-OR'ed flag public class FlagRenderer : BaseRenderer //where T : IConvertible { /// /// Register the given image to the given value /// /// When this flag is present... /// ...draw this image public void Add(T key, Object imageSelector) { Int32 k2 = ((IConvertible)key).ToInt32(NumberFormatInfo.InvariantInfo); this.imageMap[k2] = imageSelector; this.keysInOrder.Remove(k2); this.keysInOrder.Add(k2); } /// /// Draw the flags /// /// /// public override void Render(Graphics g, Rectangle r) { this.DrawBackground(g, r); Int32 v2 = ((IConvertible)this.Aspect).ToInt32(NumberFormatInfo.InvariantInfo); Point pt = r.Location; foreach (Int32 key in this.keysInOrder) { if ((v2 & key) == key) { Image image = this.GetImage(this.imageMap[key]); if (image != null) { g.DrawImage(image, pt); pt.X += (image.Width + this.Spacing); } } } } private List keysInOrder = new List(); private Dictionary imageMap = new Dictionary(); } #endregion }