523add43be
------ #### ryControls V2.1.2101.1201 - *.[更新]内置的ObjectListView从1.13更新到2.9.1版本,并对主要属性进行汉化。 - *.[修复]修复新版ObjectListView选中项有筛选结果时,筛选结果白色字体看不清的BUG。 - *.[改进]TextBoxEx2默认事件改为TextChanged2。
322 lines
12 KiB
C#
322 lines
12 KiB
C#
/*
|
|
* OLVListItem - A row in an ObjectListView
|
|
*
|
|
* Author: Phillip Piper
|
|
* Date: 31-March-2011 5:53 pm
|
|
*
|
|
* Change log:
|
|
* 2015-08-22 JPP - Added OLVListItem.SelectedBackColor and SelectedForeColor
|
|
* 2015-06-09 JPP - Added HasAnyHyperlinks property
|
|
* v2.8
|
|
* 2014-09-27 JPP - Remove faulty caching of CheckState
|
|
* 2014-05-06 JPP - Added OLVListItem.Enabled flag
|
|
* vOld
|
|
* 2011-03-31 JPP - Split into its own file
|
|
*
|
|
* Copyright (C) 2011-2015 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 <http://www.gnu.org/licenses/>.
|
|
*
|
|
* If you wish to use this code in a closed source application, please contact phillip.piper@gmail.com.
|
|
*/
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Diagnostics;
|
|
using System.Text;
|
|
using System.Windows.Forms;
|
|
using System.Drawing;
|
|
|
|
namespace BrightIdeasSoftware {
|
|
|
|
/// <summary>
|
|
/// 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
|
|
/// </summary>
|
|
public class OLVListItem : ListViewItem {
|
|
#region Constructors
|
|
|
|
/// <summary>
|
|
/// Create a OLVListItem for the given row object
|
|
/// </summary>
|
|
public OLVListItem(object rowObject) {
|
|
this.rowObject = rowObject;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Create a OLVListItem for the given row object, represented by the given string and image
|
|
/// </summary>
|
|
public OLVListItem(object rowObject, string text, Object image)
|
|
: base(text, -1) {
|
|
this.rowObject = rowObject;
|
|
this.imageSelector = image;
|
|
}
|
|
|
|
#endregion.
|
|
|
|
#region Properties
|
|
|
|
/// <summary>
|
|
/// Gets the bounding rectangle of the item, including all subitems
|
|
/// </summary>
|
|
new public Rectangle Bounds {
|
|
get {
|
|
try {
|
|
return base.Bounds;
|
|
}
|
|
catch (System.ArgumentException) {
|
|
// If the item is part of a collapsed group, Bounds will throw an exception
|
|
return Rectangle.Empty;
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets how many pixels will be left blank around each cell of this item
|
|
/// </summary>
|
|
/// <remarks>This setting only takes effect when the control is owner drawn.</remarks>
|
|
public Rectangle? CellPadding {
|
|
get { return this.cellPadding; }
|
|
set { this.cellPadding = value; }
|
|
}
|
|
private Rectangle? cellPadding;
|
|
|
|
/// <summary>
|
|
/// Gets or sets how the cells of this item will be vertically aligned
|
|
/// </summary>
|
|
/// <remarks>This setting only takes effect when the control is owner drawn.</remarks>
|
|
public StringAlignment? CellVerticalAlignment {
|
|
get { return this.cellVerticalAlignment; }
|
|
set { this.cellVerticalAlignment = value; }
|
|
}
|
|
private StringAlignment? cellVerticalAlignment;
|
|
|
|
/// <summary>
|
|
/// Gets or sets the checkedness of this item.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Virtual lists don't handle checkboxes well, so we have to intercept attempts to change them
|
|
/// through the items, and change them into something that will work.
|
|
/// Unfortunately, this won't work if this property is set through the base class, since
|
|
/// the property is not declared as virtual.
|
|
/// </remarks>
|
|
new public bool Checked {
|
|
get {
|
|
return base.Checked;
|
|
}
|
|
set {
|
|
if (this.Checked != value) {
|
|
if (value)
|
|
((ObjectListView)this.ListView).CheckObject(this.RowObject);
|
|
else
|
|
((ObjectListView)this.ListView).UncheckObject(this.RowObject);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Enable tri-state checkbox.
|
|
/// </summary>
|
|
/// <remarks>.NET's Checked property was not built to handle tri-state checkboxes,
|
|
/// and will return True for both Checked and Indeterminate states.</remarks>
|
|
public CheckState CheckState {
|
|
get {
|
|
switch (this.StateImageIndex) {
|
|
case 0:
|
|
return System.Windows.Forms.CheckState.Unchecked;
|
|
case 1:
|
|
return System.Windows.Forms.CheckState.Checked;
|
|
case 2:
|
|
return System.Windows.Forms.CheckState.Indeterminate;
|
|
default:
|
|
return System.Windows.Forms.CheckState.Unchecked;
|
|
}
|
|
}
|
|
set {
|
|
switch (value) {
|
|
case System.Windows.Forms.CheckState.Unchecked:
|
|
this.StateImageIndex = 0;
|
|
break;
|
|
case System.Windows.Forms.CheckState.Checked:
|
|
this.StateImageIndex = 1;
|
|
break;
|
|
case System.Windows.Forms.CheckState.Indeterminate:
|
|
this.StateImageIndex = 2;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets if this item has any decorations set for it.
|
|
/// </summary>
|
|
public bool HasDecoration {
|
|
get {
|
|
return this.decorations != null && this.decorations.Count > 0;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets or sets the decoration that will be drawn over this item
|
|
/// </summary>
|
|
/// <remarks>Setting this replaces all other decorations</remarks>
|
|
public IDecoration Decoration {
|
|
get {
|
|
if (this.HasDecoration)
|
|
return this.Decorations[0];
|
|
else
|
|
return null;
|
|
}
|
|
set {
|
|
this.Decorations.Clear();
|
|
if (value != null)
|
|
this.Decorations.Add(value);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the collection of decorations that will be drawn over this item
|
|
/// </summary>
|
|
public IList<IDecoration> Decorations {
|
|
get {
|
|
if (this.decorations == null)
|
|
this.decorations = new List<IDecoration>();
|
|
return this.decorations;
|
|
}
|
|
}
|
|
private IList<IDecoration> decorations;
|
|
|
|
/// <summary>
|
|
/// Gets whether or not this row can be selected and activated
|
|
/// </summary>
|
|
public bool Enabled
|
|
{
|
|
get { return this.enabled; }
|
|
internal set { this.enabled = value; }
|
|
}
|
|
private bool enabled;
|
|
|
|
/// <summary>
|
|
/// Gets whether any cell on this item is showing a hyperlink
|
|
/// </summary>
|
|
public bool HasAnyHyperlinks {
|
|
get {
|
|
foreach (OLVListSubItem subItem in this.SubItems) {
|
|
if (!String.IsNullOrEmpty(subItem.Url))
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Get or set the image that should be shown against this item
|
|
/// </summary>
|
|
/// <remarks><para>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.</para></remarks>
|
|
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;
|
|
|
|
/// <summary>
|
|
/// Gets or sets the the model object that is source of the data for this list item.
|
|
/// </summary>
|
|
public object RowObject {
|
|
get { return rowObject; }
|
|
set { rowObject = value; }
|
|
}
|
|
private object rowObject;
|
|
|
|
/// <summary>
|
|
/// Gets or sets the color that will be used for this row's background when it is selected and
|
|
/// the control is focused.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>To work reliably, this property must be set during a FormatRow event.</para>
|
|
/// <para>
|
|
/// If this is not set, the normal selection BackColor will be used.
|
|
/// </para>
|
|
/// </remarks>
|
|
public Color? SelectedBackColor {
|
|
get { return this.selectedBackColor; }
|
|
set { this.selectedBackColor = value; }
|
|
}
|
|
private Color? selectedBackColor;
|
|
|
|
/// <summary>
|
|
/// Gets or sets the color that will be used for this row's foreground when it is selected and
|
|
/// the control is focused.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>To work reliably, this property must be set during a FormatRow event.</para>
|
|
/// <para>
|
|
/// If this is not set, the normal selection ForeColor will be used.
|
|
/// </para>
|
|
/// </remarks>
|
|
public Color? SelectedForeColor
|
|
{
|
|
get { return this.selectedForeColor; }
|
|
set { this.selectedForeColor = value; }
|
|
}
|
|
private Color? selectedForeColor;
|
|
|
|
#endregion
|
|
|
|
#region Accessing
|
|
|
|
/// <summary>
|
|
/// Return the sub item at the given index
|
|
/// </summary>
|
|
/// <param name="index">Index of the subitem to be returned</param>
|
|
/// <returns>An OLVListSubItem</returns>
|
|
public virtual OLVListSubItem GetSubItem(int index) {
|
|
if (index >= 0 && index < this.SubItems.Count)
|
|
return (OLVListSubItem)this.SubItems[index];
|
|
|
|
return null;
|
|
}
|
|
|
|
|
|
/// <summary>
|
|
/// Return bounds of the given subitem
|
|
/// </summary>
|
|
/// <remarks>This correctly calculates the bounds even for column 0.</remarks>
|
|
public virtual Rectangle GetSubItemBounds(int subItemIndex) {
|
|
if (subItemIndex == 0) {
|
|
Rectangle r = this.Bounds;
|
|
Point sides = NativeMethods.GetScrolledColumnSides(this.ListView, subItemIndex);
|
|
r.X = sides.X + 1;
|
|
r.Width = sides.Y - sides.X;
|
|
return r;
|
|
}
|
|
|
|
OLVListSubItem subItem = this.GetSubItem(subItemIndex);
|
|
return subItem == null ? new Rectangle() : subItem.Bounds;
|
|
}
|
|
|
|
#endregion
|
|
}
|
|
}
|