1 // Permission is hereby granted, free of charge, to any person obtaining
2 // a copy of this software and associated documentation files (the
3 // "Software"), to deal in the Software without restriction, including
4 // without limitation the rights to use, copy, modify, merge, publish,
5 // distribute, sublicense, and/or sell copies of the Software, and to
6 // permit persons to whom the Software is furnished to do so, subject to
7 // the following conditions:
9 // The above copyright notice and this permission notice shall be
10 // included in all copies or substantial portions of the Software.
12 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
13 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
14 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
15 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
16 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
17 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
18 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20 // Copyright (c) 2005 Novell, Inc. (http://www.novell.com)
23 // Jordi Mas i Hernandez <jordi@ximian.com>
24 // Chris Toshok <toshok@ximian.com>
28 using System.ComponentModel;
29 using System.Runtime.InteropServices;
30 using System.Diagnostics;
32 namespace System.Windows.Forms
34 [DesignTimeVisible(false)]
35 [DefaultProperty("Header")]
37 public abstract class DataGridColumnStyle : Component, IDataGridColumnStyleEditingNotificationService
40 protected class DataGridColumnHeaderAccessibleObject : AccessibleObject
42 #region Local Variables
43 private new DataGridColumnStyle owner;
47 public DataGridColumnHeaderAccessibleObject (DataGridColumnStyle columnstyle)
51 #endregion //Constructors
53 #region Public Instance Properties
55 public override Rectangle Bounds {
57 throw new NotImplementedException ();
61 public override string Name {
63 throw new NotImplementedException ();
67 protected DataGridColumnStyle Owner {
71 public override AccessibleObject Parent {
73 throw new NotImplementedException ();
77 public override AccessibleRole Role {
79 throw new NotImplementedException ();
84 #region Public Instance Methods
86 public override AccessibleObject Navigate (AccessibleNavigation navdir)
88 throw new NotImplementedException ();
90 #endregion Public Instance Methods
93 protected class CompModSwitches
95 public CompModSwitches ()
99 #region Public Instance Methods
101 public static TraceSwitch DGEditColumnEditing {
103 throw new NotImplementedException ();
106 #endregion Public Instance Methods
109 internal enum ArrowDrawing
116 #region Local Variables
117 internal HorizontalAlignment alignment;
118 private int fontheight;
119 internal DataGridTableStyle table_style;
120 private string header_text;
121 private string mapping_name;
122 private string null_text;
123 private PropertyDescriptor property_descriptor;
124 private bool _readonly;
126 internal bool is_default;
127 internal DataGrid grid;
128 private DataGridColumnHeaderAccessibleObject accesible_object;
129 private StringFormat string_format_hdr;
130 static string def_null_text = "(null)";
131 private ArrowDrawing arrow_drawing = ArrowDrawing.No;
133 #endregion // Local Variables
136 public DataGridColumnStyle () : this (null)
140 public DataGridColumnStyle (PropertyDescriptor prop)
142 property_descriptor = prop;
146 header_text = string.Empty;
147 mapping_name = string.Empty;
148 null_text = def_null_text;
149 accesible_object = new DataGridColumnHeaderAccessibleObject (this);
150 _readonly = prop == null ? false : prop.IsReadOnly;
154 alignment = HorizontalAlignment.Left;
155 string_format_hdr = new StringFormat ();
156 string_format_hdr.FormatFlags |= StringFormatFlags.NoWrap;
157 string_format_hdr.LineAlignment = StringAlignment.Center;
158 string_format_hdr.Trimming = StringTrimming.Character;
163 #region Public Instance Properties
165 [DefaultValue(HorizontalAlignment.Left)]
166 public virtual HorizontalAlignment Alignment {
171 if (value != alignment) {
174 if (table_style != null && table_style.DataGrid != null) {
175 table_style.DataGrid.Invalidate ();
178 EventHandler eh = (EventHandler)(Events [AlignmentChangedEvent]);
180 eh (this, EventArgs.Empty);
186 public virtual DataGridTableStyle DataGridTableStyle {
187 get { return table_style; }
190 protected int FontHeight {
192 if (fontheight != -1) {
196 if (table_style != null) {
197 //return table_style.DataGrid.FontHeight
201 // TODO: Default Datagrid font height
207 public AccessibleObject HeaderAccessibleObject {
209 return accesible_object;
214 public virtual string HeaderText {
219 if (value != header_text) {
224 EventHandler eh = (EventHandler)(Events [HeaderTextChangedEvent]);
226 eh (this, EventArgs.Empty);
232 [Editor("System.Windows.Forms.Design.DataGridColumnStyleMappingNameEditor, " + Consts.AssemblySystem_Design, typeof(System.Drawing.Design.UITypeEditor))]
237 public string MappingName {
242 if (value != mapping_name) {
243 mapping_name = value;
245 EventHandler eh = (EventHandler)(Events [MappingNameChangedEvent]);
247 eh (this, EventArgs.Empty);
253 public virtual string NullText {
258 if (value != null_text) {
261 if (table_style != null && table_style.DataGrid != null) {
262 table_style.DataGrid.Invalidate ();
265 EventHandler eh = (EventHandler)(Events [NullTextChangedEvent]);
267 eh (this, EventArgs.Empty);
274 [EditorBrowsable(EditorBrowsableState.Advanced)]
275 public virtual PropertyDescriptor PropertyDescriptor {
277 return property_descriptor;
280 if (value != property_descriptor) {
281 property_descriptor = value;
283 EventHandler eh = (EventHandler)(Events [PropertyDescriptorChangedEvent]);
285 eh (this, EventArgs.Empty);
290 [DefaultValue(false)]
291 public virtual bool ReadOnly {
296 if (value != _readonly) {
299 if (table_style != null && table_style.DataGrid != null) {
300 table_style.DataGrid.CalcAreasAndInvalidate ();
303 EventHandler eh = (EventHandler)(Events [ReadOnlyChangedEvent]);
305 eh (this, EventArgs.Empty);
312 public virtual int Width {
317 if (value != width) {
320 if (table_style != null && table_style.DataGrid != null) {
321 table_style.DataGrid.CalcAreasAndInvalidate ();
324 EventHandler eh = (EventHandler)(Events [WidthChangedEvent]);
326 eh (this, EventArgs.Empty);
331 #endregion // Public Instance Properties
333 #region Private Instance Properties
335 internal ArrowDrawing ArrowDrawingMode {
336 get { return arrow_drawing; }
337 set { arrow_drawing = value; }
340 internal bool TableStyleReadOnly {
342 return table_style != null && table_style.ReadOnly;
346 internal DataGridTableStyle TableStyle {
347 set { table_style = value; }
350 internal bool IsDefault {
351 get { return is_default; }
353 #endregion Private Instance Properties
355 #region Public Instance Methods
356 protected internal abstract void Abort (int rowNum);
359 protected void BeginUpdate ()
363 protected void CheckValidDataSource (CurrencyManager value)
366 throw new ArgumentNullException ("CurrencyManager cannot be null");
369 if (property_descriptor == null) {
370 property_descriptor = value.GetItemProperties ()[mapping_name];
372 // Console.WriteLine ("mapping name = {0}", mapping_name);
373 // foreach (PropertyDescriptor prop in value.GetItemProperties ()) {
374 // Console.WriteLine (" + prop = {0}", prop.Name);
377 if (property_descriptor == null)
378 throw new InvalidOperationException ("The PropertyDescriptor for this column is a null reference");
380 /*MonoTests.System.Windows.Forms.DataGridColumnStyleTest.GetColumnValueAtRow : System.InvalidOperationException : The 'foo' DataGridColumnStyle cannot be used because it is not associated with a Property or Column in the DataSource.*/
387 protected internal virtual void ColumnStartedEditing (Control editingControl)
391 protected internal abstract bool Commit (CurrencyManager dataSource, int rowNum);
394 protected internal virtual void ConcedeFocus ()
398 protected virtual AccessibleObject CreateHeaderAccessibleObject ()
400 return new DataGridColumnHeaderAccessibleObject (this);
403 protected internal virtual void Edit (CurrencyManager source, int rowNum, Rectangle bounds, bool readOnly)
405 Edit (source, rowNum, bounds, readOnly, string.Empty);
408 protected internal virtual void Edit (CurrencyManager source, int rowNum, Rectangle bounds, bool readOnly, string instantText)
410 Edit (source, rowNum, bounds, readOnly, instantText, true);
413 protected internal abstract void Edit (CurrencyManager source, int rowNum, Rectangle bounds, bool readOnly, string instantText, bool cellIsVisible);
416 protected void EndUpdate ()
420 protected internal virtual void EnterNullValue () {}
422 protected internal virtual object GetColumnValueAtRow (CurrencyManager source, int rowNum)
424 CheckValidDataSource (source);
425 if (rowNum >= source.Count)
427 return property_descriptor.GetValue (source [rowNum]);
430 protected internal abstract int GetMinimumHeight ();
432 protected internal abstract int GetPreferredHeight (Graphics g, object value);
434 protected internal abstract Size GetPreferredSize (Graphics g, object value);
436 void IDataGridColumnStyleEditingNotificationService.ColumnStartedEditing (Control editingControl)
438 ColumnStartedEditing (editingControl);
441 protected virtual void Invalidate ()
444 grid.InvalidateColumn (this);
447 protected internal abstract void Paint (Graphics g, Rectangle bounds, CurrencyManager source, int rowNum);
448 protected internal abstract void Paint (Graphics g, Rectangle bounds, CurrencyManager source, int rowNum, bool alignToRight);
450 protected internal virtual void Paint (Graphics g, Rectangle bounds, CurrencyManager source, int rowNum,
451 Brush backBrush, Brush foreBrush, bool alignToRight) {}
453 protected internal virtual void ReleaseHostedControl () {}
455 public void ResetHeaderText ()
457 HeaderText = string.Empty;
460 protected internal virtual void SetColumnValueAtRow (CurrencyManager source, int rowNum, object value)
462 CheckValidDataSource (source);
464 IEditableObject editable = source [rowNum] as IEditableObject;
466 if (editable != null)
467 editable.BeginEdit ();
469 property_descriptor.SetValue (source [rowNum], value);
471 if (editable != null)
475 protected virtual void SetDataGrid (DataGrid value)
479 property_descriptor = null;
481 if (value != null && value.ListManager != null)
482 CheckValidDataSource (value.ListManager);
485 protected virtual void SetDataGridInColumn (DataGrid value)
490 internal void SetDataGridInternal (DataGrid value)
492 SetDataGridInColumn (value);
495 protected internal virtual void UpdateUI (CurrencyManager source, int rowNum, string instantText)
499 #endregion // Public Instance Methods
501 #region Private Instance Methods
502 virtual internal void OnMouseDown (MouseEventArgs e, int row, int column) {}
503 virtual internal void OnKeyDown (KeyEventArgs ke, int row, int column) {}
505 internal void PaintHeader (Graphics g, Rectangle bounds, int colNum)
508 g.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (DataGridTableStyle.CurrentHeaderBackColor),
511 if (!grid.FlatMode) {
513 g.DrawLine (ThemeEngine.Current.ResPool.GetPen (ThemeEngine.Current.ColorControlLight),
514 bounds.X, bounds.Y, bounds.X + bounds.Width, bounds.Y);
517 g.DrawLine (ThemeEngine.Current.ResPool.GetPen (ThemeEngine.Current.ColorControlLight),
518 bounds.X, bounds.Y, bounds.X, bounds.Y + bounds.Height);
520 g.DrawLine (ThemeEngine.Current.ResPool.GetPen (ThemeEngine.Current.ColorControlLight),
521 bounds.X, bounds.Y + 2, bounds.X, bounds.Y + bounds.Height - 2);
524 g.DrawLine (ThemeEngine.Current.ResPool.GetPen (ThemeEngine.Current.ColorControlDark),
525 bounds.X + bounds.Width - 1, bounds.Y + 2 , bounds.X + bounds.Width - 1, bounds.Y + bounds.Height - 2);
531 if (arrow_drawing != ArrowDrawing.No)
534 g.DrawString (HeaderText, DataGridTableStyle.HeaderFont, ThemeEngine.Current.ResPool.GetSolidBrush (DataGridTableStyle.CurrentHeaderForeColor),
535 bounds, string_format_hdr);
537 if (arrow_drawing != ArrowDrawing.No) {
539 Point pnt = new Point (bounds.X + bounds.Width + 4, bounds.Y + ((bounds.Height - 6)/2));
541 if (arrow_drawing == ArrowDrawing.Ascending) {
542 g.DrawLine (SystemPens.ControlLightLight, pnt.X + 6, pnt.Y + 6, pnt.X + 3, pnt.Y);
543 g.DrawLine (SystemPens.ControlDark, pnt.X, pnt.Y + 6, pnt.X + 6, pnt.Y + 6);
544 g.DrawLine (SystemPens.ControlDark, pnt.X, pnt.Y + 6, pnt.X + 3, pnt.Y);
546 g.DrawLine (SystemPens.ControlLightLight, pnt.X + 6, pnt.Y, pnt.X + 3, pnt.Y + 6);
547 g.DrawLine (SystemPens.ControlDark, pnt.X, pnt.Y, pnt.X + 6, pnt.Y);
548 g.DrawLine (SystemPens.ControlDark, pnt.X, pnt.Y, pnt.X + 3, pnt.Y + 6);
554 internal void PaintNewRow (Graphics g, Rectangle bounds, Brush backBrush, Brush foreBrush)
556 g.FillRectangle (backBrush, bounds);
557 PaintGridLine (g, bounds);
560 internal void PaintGridLine (Graphics g, Rectangle bounds)
562 if (table_style.CurrentGridLineStyle != DataGridLineStyle.Solid) {
566 g.DrawLine (ThemeEngine.Current.ResPool.GetPen (table_style.CurrentGridLineColor),
567 bounds.X, bounds.Y + bounds.Height - 1, bounds.X + bounds.Width - 1, bounds.Y + bounds.Height - 1);
569 g.DrawLine (ThemeEngine.Current.ResPool.GetPen (table_style.CurrentGridLineColor),
570 bounds.X + bounds.Width - 1, bounds.Y , bounds.X + bounds.Width - 1, bounds.Y + bounds.Height);
573 #endregion Private Instance Methods
576 static object AlignmentChangedEvent = new object ();
577 static object FontChangedEvent = new object ();
578 static object HeaderTextChangedEvent = new object ();
579 static object MappingNameChangedEvent = new object ();
580 static object NullTextChangedEvent = new object ();
581 static object PropertyDescriptorChangedEvent = new object ();
582 static object ReadOnlyChangedEvent = new object ();
583 static object WidthChangedEvent = new object ();
585 public event EventHandler AlignmentChanged {
586 add { Events.AddHandler (AlignmentChangedEvent, value); }
587 remove { Events.RemoveHandler (AlignmentChangedEvent, value); }
590 public event EventHandler FontChanged {
591 add { Events.AddHandler (FontChangedEvent, value); }
592 remove { Events.RemoveHandler (FontChangedEvent, value); }
595 public event EventHandler HeaderTextChanged {
596 add { Events.AddHandler (HeaderTextChangedEvent, value); }
597 remove { Events.RemoveHandler (HeaderTextChangedEvent, value); }
600 public event EventHandler MappingNameChanged {
601 add { Events.AddHandler (MappingNameChangedEvent, value); }
602 remove { Events.RemoveHandler (MappingNameChangedEvent, value); }
605 public event EventHandler NullTextChanged {
606 add { Events.AddHandler (NullTextChangedEvent, value); }
607 remove { Events.RemoveHandler (NullTextChangedEvent, value); }
611 [EditorBrowsable(EditorBrowsableState.Advanced)]
612 public event EventHandler PropertyDescriptorChanged {
613 add { Events.AddHandler (PropertyDescriptorChangedEvent, value); }
614 remove { Events.RemoveHandler (PropertyDescriptorChangedEvent, value); }
617 public event EventHandler ReadOnlyChanged {
618 add { Events.AddHandler (ReadOnlyChangedEvent, value); }
619 remove { Events.RemoveHandler (ReadOnlyChangedEvent, value); }
622 public event EventHandler WidthChanged {
623 add { Events.AddHandler (WidthChangedEvent, value); }
624 remove { Events.RemoveHandler (WidthChangedEvent, value); }