2 // System.Web.UI.WebControls.DataGrid.cs
5 // Jackson Harper (jackson@ximian.com)
6 // Gonzalo Paniagua Javier (gonzalo@ximian.com)
8 // (C) 2005 Novell, Inc (http://www.novell.com)
10 // Permission is hereby granted, free of charge, to any person obtaining
11 // a copy of this software and associated documentation files (the
12 // "Software"), to deal in the Software without restriction, including
13 // without limitation the rights to use, copy, modify, merge, publish,
14 // distribute, sublicense, and/or sell copies of the Software, and to
15 // permit persons to whom the Software is furnished to do so, subject to
16 // the following conditions:
18 // The above copyright notice and this permission notice shall be
19 // included in all copies or substantial portions of the Software.
21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
25 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
26 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
27 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
30 using System.Web.Util;
31 using System.Collections;
32 using System.Globalization;
33 using System.ComponentModel;
34 using System.Reflection;
35 using System.Security.Permissions;
37 namespace System.Web.UI.WebControls {
40 [AspNetHostingPermissionAttribute (SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
41 [AspNetHostingPermissionAttribute (SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
43 [Editor("System.Web.UI.Design.WebControls.DataGridComponentEditor, " + Consts.AssemblySystem_Design, typeof(System.ComponentModel.ComponentEditor))]
44 [Designer("System.Web.UI.Design.WebControls.DataGridDesigner, " + Consts.AssemblySystem_Design, "System.ComponentModel.Design.IDesigner")]
45 public class DataGrid : BaseDataList, INamingContainer {
47 public const string CancelCommandName = "Cancel";
48 public const string DeleteCommandName = "Delete";
49 public const string EditCommandName = "Edit";
50 public const string SelectCommandName = "Select";
51 public const string SortCommandName = "Sort";
52 public const string UpdateCommandName = "Update";
54 public const string PageCommandName = "Page";
55 public const string NextPageCommandArgument = "Next";
56 public const string PrevPageCommandArgument = "Prev";
58 private static readonly object CancelCommandEvent = new object ();
59 private static readonly object DeleteCommandEvent = new object ();
60 private static readonly object EditCommandEvent = new object ();
61 private static readonly object ItemCommandEvent = new object ();
62 private static readonly object ItemCreatedEvent = new object ();
63 private static readonly object ItemDataBoundEvent = new object ();
64 private static readonly object PageIndexChangedEvent = new object ();
65 private static readonly object SortCommandEvent = new object ();
66 private static readonly object UpdateCommandEvent = new object ();
68 private TableItemStyle alt_item_style;
69 private TableItemStyle edit_item_style;
70 private TableItemStyle footer_style;
71 private TableItemStyle header_style;
72 private TableItemStyle item_style;
73 private TableItemStyle selected_style;
74 private DataGridPagerStyle pager_style;
76 private ArrayList items_list;
77 private DataGridItemCollection items;
79 private ArrayList columns_list;
80 private DataGridColumnCollection columns;
82 private ArrayList data_source_columns_list;
83 private DataGridColumnCollection data_source_columns;
85 private Table render_table;
86 private DataGridColumn [] render_columns;
87 private PagedDataSource paged_data_source;
88 private IEnumerator data_enumerator;
91 [WebSysDescription ("")]
92 [WebCategory ("Paging")]
93 public virtual bool AllowCustomPaging {
94 get { return ViewState.GetBool ("AllowCustomPaging", false); }
95 set { ViewState ["AllowCustomPaging"] = value; }
99 [WebSysDescription ("")]
100 [WebCategory ("Paging")]
101 public virtual bool AllowPaging {
102 get { return ViewState.GetBool ("AllowPaging", false); }
103 set { ViewState ["AllowPaging"] = value; }
106 [DefaultValue(false)]
107 [WebSysDescription ("")]
108 [WebCategory ("Behavior")]
109 public virtual bool AllowSorting {
110 get { return ViewState.GetBool ("AllowSorting", false); }
111 set { ViewState ["AllowSorting"] = value; }
115 [WebSysDescription ("")]
116 [WebCategory ("Behavior")]
117 public virtual bool AutoGenerateColumns {
118 get { return ViewState.GetBool ("AutoGenerateColumns", true); }
119 set { ViewState ["AutoGenerateColumns"] = value; }
128 [Editor("System.Web.UI.Design.ImageUrlEditor, " + Consts.AssemblySystem_Design, typeof(System.Drawing.Design.UITypeEditor))]
129 [WebSysDescription ("")]
130 [WebCategory ("Appearance")]
131 public virtual string BackImageUrl {
132 get { return TableStyle.BackImageUrl; }
133 set { TableStyle.BackImageUrl = value; }
140 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
141 [WebSysDescription ("")]
142 [WebCategory ("Behavior")]
143 public int CurrentPageIndex {
144 get { return ViewState.GetInt ("CurrentPageIndex", 0); }
147 throw new ArgumentOutOfRangeException ("value");
148 ViewState ["CurrentPageIndex"] = value;
153 [WebSysDescription ("")]
154 [WebCategory ("Misc")]
155 public virtual int EditItemIndex {
156 get { return ViewState.GetInt ("EditItemIndex", -1); }
159 throw new ArgumentOutOfRangeException ("value");
160 ViewState ["EditItemIndex"] = value;
165 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
166 [WebSysDescription ("")]
167 [WebCategory ("Style")]
168 public int PageCount {
170 if (paged_data_source != null)
171 return paged_data_source.PageCount;
173 return ViewState.GetInt ("PageCount", 0);
178 [WebSysDescription ("")]
179 [WebCategory ("Paging")]
180 public virtual int PageSize {
181 get { return ViewState.GetInt ("PageSize", 10); }
184 throw new ArgumentOutOfRangeException ("value");
185 ViewState ["PageSize"] = value;
189 void AdjustItemTypes (int prev_select, int new_select)
191 if (items_list == null)
192 return; // nothing to select
194 int count = items_list.Count;
196 return; // nothing to select
199 // Restore item type for the previously selected one.
200 if (prev_select >= 0 && prev_select < count) {
201 item = (DataGridItem) items_list [prev_select];
203 if (item.ItemType == ListItemType.EditItem) {
204 // nothing to do. This has priority.
205 } else if ((item.ItemIndex % 2) != 0) {
206 item.SetItemType (ListItemType.AlternatingItem);
208 item.SetItemType (ListItemType.Item);
212 if (new_select == -1 || new_select >= count)
213 return; // nothing to select
215 item = (DataGridItem) items_list [new_select];
216 if (item.ItemType != ListItemType.EditItem) // EditItem takes precedence
217 item.SetItemType (ListItemType.SelectedItem);
222 [WebSysDescription ("")]
223 [WebCategory ("Paging")]
224 public virtual int SelectedIndex {
225 get { return ViewState.GetInt ("SelectedIndex", -1); }
228 throw new ArgumentOutOfRangeException ("value");
230 int selected_index = ViewState.GetInt ("SelectedIndex", -1);
231 AdjustItemTypes (selected_index, value);
232 ViewState ["SelectedIndex"] = value;
236 [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
237 [NotifyParentProperty(true)]
238 [PersistenceMode(PersistenceMode.InnerProperty)]
239 [WebSysDescription ("")]
240 [WebCategory ("Style")]
241 public virtual TableItemStyle AlternatingItemStyle {
243 if (alt_item_style == null) {
244 alt_item_style = new TableItemStyle ();
245 if (IsTrackingViewState)
246 alt_item_style.TrackViewState ();
248 return alt_item_style;
252 [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
253 [NotifyParentProperty(true)]
254 [PersistenceMode(PersistenceMode.InnerProperty)]
255 [WebSysDescription ("")]
256 [WebCategory ("Style")]
257 public virtual TableItemStyle EditItemStyle {
259 if (edit_item_style == null) {
260 edit_item_style = new TableItemStyle ();
261 if (IsTrackingViewState)
262 edit_item_style.TrackViewState ();
264 return edit_item_style;
269 [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
270 [NotifyParentProperty(true)]
271 [PersistenceMode(PersistenceMode.InnerProperty)]
272 [WebSysDescription ("")]
273 [WebCategory ("Style")]
274 public virtual TableItemStyle FooterStyle {
276 if (footer_style == null) {
277 footer_style = new TableItemStyle ();
278 if (IsTrackingViewState)
279 footer_style.TrackViewState ();
286 [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
287 [NotifyParentProperty(true)]
288 [PersistenceMode(PersistenceMode.InnerProperty)]
289 [WebSysDescription ("")]
290 [WebCategory ("Style")]
291 public virtual TableItemStyle HeaderStyle {
293 if (header_style == null) {
294 header_style = new TableItemStyle ();
295 if (IsTrackingViewState)
296 header_style.TrackViewState ();
302 [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
303 [NotifyParentProperty(true)]
304 [PersistenceMode(PersistenceMode.InnerProperty)]
305 [WebSysDescription ("")]
306 [WebCategory ("Style")]
307 public virtual TableItemStyle ItemStyle {
309 if (item_style == null) {
310 item_style = new TableItemStyle ();
311 if (IsTrackingViewState)
312 item_style.TrackViewState ();
318 [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
319 [NotifyParentProperty(true)]
320 [PersistenceMode(PersistenceMode.InnerProperty)]
321 [WebSysDescription ("")]
322 [WebCategory ("Style")]
323 public virtual TableItemStyle SelectedItemStyle {
325 if (selected_style == null) {
326 selected_style = new TableItemStyle ();
327 if (IsTrackingViewState)
328 selected_style.TrackViewState ();
330 return selected_style;
334 [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
335 [NotifyParentProperty(true)]
336 [PersistenceMode(PersistenceMode.InnerProperty)]
337 [WebSysDescription ("")]
338 [WebCategory ("Style")]
339 public virtual DataGridPagerStyle PagerStyle {
341 if (pager_style == null) {
342 pager_style = new DataGridPagerStyle ();
343 if (IsTrackingViewState)
344 pager_style.TrackViewState ();
351 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
352 [WebSysDescription ("")]
353 [WebCategory ("Style")]
354 public virtual DataGridItemCollection Items {
357 if (items_list == null)
358 items_list = new ArrayList ();
359 items = new DataGridItemCollection (items_list);
365 [DefaultValue (null)]
366 [Editor ("System.Web.UI.Design.WebControls.DataGridColumnCollectionEditor, " + Consts.AssemblySystem_Design, typeof(System.Drawing.Design.UITypeEditor))]
367 [MergableProperty (false)]
368 [PersistenceMode (PersistenceMode.InnerProperty)]
369 [WebSysDescription ("")]
370 [WebCategory ("Behavior")]
371 public virtual DataGridColumnCollection Columns {
373 if (columns == null) {
374 columns_list = new ArrayList ();
375 columns = new DataGridColumnCollection (this, columns_list);
376 if (IsTrackingViewState) {
377 IStateManager manager = (IStateManager) columns;
378 manager.TrackViewState ();
385 private DataGridColumnCollection DataSourceColumns {
387 if (data_source_columns == null) {
388 data_source_columns_list = new ArrayList ();
389 data_source_columns = new DataGridColumnCollection (this,
390 data_source_columns_list);
391 if (IsTrackingViewState) {
392 IStateManager manager = (IStateManager) data_source_columns;
393 manager.TrackViewState ();
396 return data_source_columns;
400 class TableID : Table {
403 public TableID (Control parent)
405 this.parent = parent;
408 protected override void AddAttributesToRender (HtmlTextWriter writer)
410 base.AddAttributesToRender (writer);
412 writer.AddAttribute ("id", parent.ClientID);
416 private Table RenderTable {
418 if (render_table == null) {
419 render_table = new TableID (this);
420 render_table.AutoID = false;
426 private void CreateRenderColumns (PagedDataSource paged, bool useDataSource)
429 ArrayList columns_list = CreateColumnSet (paged, useDataSource);
430 render_columns = new DataGridColumn [columns_list.Count];
432 for (int c = 0; c < render_columns.Length; c++) {
433 DataGridColumn col = (DataGridColumn) columns_list [c];
434 col.Set_Owner (this);
436 render_columns [c] = col;
439 render_columns = new DataGridColumn [Columns.Count];
440 Columns.CopyTo (render_columns, 0);
446 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
447 [WebSysDescription ("")]
448 [WebCategory ("Paging")]
449 public virtual DataGridItem SelectedItem {
451 if (SelectedIndex == -1)
453 return Items [SelectedIndex];
460 [DefaultValue(false)]
461 [WebSysDescription ("")]
462 [WebCategory ("Appearance")]
463 public virtual bool ShowFooter {
464 get { return ViewState.GetBool ("ShowFooter", false); }
465 set { ViewState ["ShowFooter"] = value; }
472 [WebSysDescription ("")]
473 [WebCategory ("Appearance")]
474 public virtual bool ShowHeader {
475 get { return ViewState.GetBool ("ShowHeader", true); }
476 set { ViewState ["ShowHeader"] = value; }
480 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
481 [WebSysDescription ("")]
482 [WebCategory ("Appearance")]
483 public virtual int VirtualItemCount {
484 get { return ViewState.GetInt ("VirtualItemCount", 0); }
487 throw new ArgumentOutOfRangeException ("value");
488 ViewState ["VirtualItemCount"] = value;
493 protected override HtmlTextWriterTag TagKey {
494 get { return HtmlTextWriterTag.Table; }
498 private TableStyle TableStyle {
499 get { return (TableStyle) ControlStyle; }
502 static Type [] item_args = new Type [] {typeof (int) };
503 void AddColumnsFromSource (PagedDataSource data_source)
505 PropertyDescriptorCollection props = null;
507 bool no_items = false;
509 // Use plain reflection for the Item property.
510 // If we use TypeDescriptor, props will hold
511 // all of the Type properties, which will be listed as columns
512 Type ds_type = data_source.GetType ();
513 PropertyInfo pinfo = ds_type.GetProperty ("Item", item_args);
515 IEnumerator items = (data_source.DataSource != null) ? data_source.GetEnumerator () : null;
516 if (items != null && items.MoveNext ()) {
517 object data = items.Current;
518 if ((data is ICustomTypeDescriptor) || (!IsBindableType(data.GetType())))
519 props = TypeDescriptor.GetProperties (data);
520 else if (data != null)
521 ptype = data.GetType ();
522 data_enumerator = items;
527 ptype = pinfo.PropertyType;
531 // Found the "Item" property
532 AddPropertyToColumns ();
533 } else if (props != null) {
534 foreach (PropertyDescriptor pd in props)
535 AddPropertyToColumns (pd, false);
536 } else if (!no_items) {
537 // This is not thrown for an empty ArrayList.
538 string msg = String.Format ("DataGrid '{0}' cannot autogenerate " +
539 "columns from the given datasource. {1}", ID, ptype);
540 throw new HttpException (msg);
544 protected virtual ArrayList CreateColumnSet (PagedDataSource dataSource, bool useDataSource)
546 ArrayList res = new ArrayList ();
547 if (columns_list != null)
548 res.AddRange (columns_list);
550 if (AutoGenerateColumns) {
552 data_enumerator = null;
553 PropertyDescriptorCollection props = dataSource.GetItemProperties (null);
554 DataSourceColumns.Clear ();
556 foreach (PropertyDescriptor d in props)
557 AddPropertyToColumns (d, false);
559 AddColumnsFromSource (dataSource);
563 if (data_source_columns != null && data_source_columns.Count > 0)
564 res.AddRange (data_source_columns);
570 private void AddPropertyToColumns ()
572 BoundColumn b = new BoundColumn ();
573 if (IsTrackingViewState) {
574 IStateManager m = (IStateManager) b;
578 b.HeaderText = "Item";
579 b.SortExpression = "Item";
580 b.DataField = BoundColumn.thisExpr;
581 DataSourceColumns.Add (b);
584 private void AddPropertyToColumns (PropertyDescriptor prop, bool tothis)
586 BoundColumn b = new BoundColumn ();
588 if (IsTrackingViewState) {
589 IStateManager m = (IStateManager) b;
592 b.HeaderText = prop.Name;
593 b.DataField = (tothis ? BoundColumn.thisExpr : prop.Name);
594 b.SortExpression = prop.Name;
595 DataSourceColumns.Add (b);
598 protected override void TrackViewState ()
600 base.TrackViewState ();
602 if (pager_style != null)
603 pager_style.TrackViewState ();
604 if (header_style != null)
605 header_style.TrackViewState ();
606 if (footer_style != null)
607 footer_style.TrackViewState ();
608 if (item_style != null)
609 item_style.TrackViewState ();
610 if (alt_item_style != null)
611 alt_item_style.TrackViewState ();
612 if (selected_style != null)
613 selected_style.TrackViewState ();
614 if (edit_item_style != null)
615 edit_item_style.TrackViewState ();
617 IStateManager manager = (IStateManager) columns;
619 manager.TrackViewState ();
622 protected override object SaveViewState ()
624 object [] res = new object [10];
626 res [0] = base.SaveViewState ();
627 if (columns != null) {
628 IStateManager cm = (IStateManager) columns;
629 res [1] = cm.SaveViewState ();
631 if (pager_style != null)
632 res [2] = pager_style.SaveViewState ();
633 if (header_style != null)
634 res [3] = header_style.SaveViewState ();
635 if (footer_style != null)
636 res [4] = footer_style.SaveViewState ();
637 if (item_style != null)
638 res [5] = item_style.SaveViewState ();
639 if (alt_item_style != null)
640 res [6] = alt_item_style.SaveViewState ();
641 if (selected_style != null)
642 res [7] = selected_style.SaveViewState ();
643 if (edit_item_style != null)
644 res [8] = edit_item_style.SaveViewState ();
646 if (data_source_columns != null) {
647 IStateManager m = (IStateManager) data_source_columns;
648 res [9] = m.SaveViewState ();
654 protected override void LoadViewState (object savedState)
656 object [] pieces = savedState as object [];
661 base.LoadViewState (pieces [0]);
662 if (columns != null) {
663 IStateManager cm = (IStateManager) columns;
664 cm.LoadViewState (pieces [1]);
666 if (pieces [2] != null)
667 PagerStyle.LoadViewState (pieces [2]);
668 if (pieces [3] != null)
669 HeaderStyle.LoadViewState (pieces [3]);
670 if (pieces [4] != null)
671 FooterStyle.LoadViewState (pieces [4]);
672 if (pieces [5] != null)
673 ItemStyle.LoadViewState (pieces [5]);
674 if (pieces [6] != null)
675 AlternatingItemStyle.LoadViewState (pieces [6]);
676 if (pieces [7] != null)
677 SelectedItemStyle.LoadViewState (pieces [7]);
678 if (pieces [8] != null)
679 EditItemStyle.LoadViewState (pieces [8]);
681 if (pieces [9] != null) {
682 // IStateManager manager = (IStateManager) DataSourceColumns;
683 // manager.LoadViewState (pieces [9]);
684 object [] cols = (object []) pieces [9];
685 foreach (object o in cols) {
686 BoundColumn c = new BoundColumn ();
688 ((IStateManager) c).LoadViewState (o);
689 DataSourceColumns.Add (c);
694 protected override Style CreateControlStyle ()
696 TableStyle res = new TableStyle (ViewState);
697 res.GridLines = GridLines.Both;
702 protected virtual void InitializeItem (DataGridItem item, DataGridColumn [] columns)
704 bool th = UseAccessibleHeader && item.ItemType == ListItemType.Header;
705 for (int i = 0; i < columns.Length; i++) {
706 TableCell cell = (th) ? new TableHeaderCell () : new TableCell ();
707 columns [i].InitializeCell (cell, i, item.ItemType);
708 item.Cells.Add (cell);
712 protected virtual void InitializePager (DataGridItem item, int columnSpan, PagedDataSource pagedDataSource)
714 TableCell pager_cell;
715 if (PagerStyle.Mode == PagerMode.NextPrev)
716 pager_cell = InitializeNextPrevPager (item, columnSpan, pagedDataSource);
718 pager_cell = InitializeNumericPager (item, columnSpan, pagedDataSource);
720 item.Controls.Add (pager_cell);
723 private TableCell InitializeNumericPager (DataGridItem item, int columnSpan,
724 PagedDataSource paged)
726 TableCell res = new TableCell ();
727 res.ColumnSpan = columnSpan;
729 int button_count = PagerStyle.PageButtonCount;
730 int current = paged.CurrentPageIndex;
731 int start = current - (current % button_count);
732 int end = start + button_count;
734 if (end > paged.PageCount)
735 end = paged.PageCount;
738 LinkButton link = new LinkButton ();
740 link.CommandName = PageCommandName;
741 link.CommandArgument = start.ToString (CultureInfo.InvariantCulture);
742 link.CausesValidation = false;
743 res.Controls.Add (link);
744 res.Controls.Add (new LiteralControl (" "));
747 for (int i = start; i < end; i++) {
748 Control number = null;
749 string page = (i + 1).ToString (CultureInfo.InvariantCulture);
750 if (i != paged.CurrentPageIndex) {
751 LinkButton link = new LinkButton ();
753 link.CommandName = PageCommandName;
754 link.CommandArgument = page;
755 link.CausesValidation = false;
758 Label pageLabel = new Label();
759 pageLabel.Text = page;
763 res.Controls.Add (number);
765 res.Controls.Add (new LiteralControl (" "));
768 if (end < paged.PageCount) {
769 res.Controls.Add (new LiteralControl (" "));
770 LinkButton link = new LinkButton ();
772 link.CommandName = PageCommandName;
773 link.CommandArgument = (end + 1).ToString (CultureInfo.InvariantCulture);
774 link.CausesValidation = false;
775 res.Controls.Add (link);
781 private TableCell InitializeNextPrevPager (DataGridItem item, int columnSpan, PagedDataSource paged)
783 TableCell res = new TableCell ();
784 res.ColumnSpan = columnSpan;
789 if (paged.IsFirstPage) {
790 Label l = new Label ();
791 l.Text = PagerStyle.PrevPageText;
794 LinkButton l = new LinkButton ();
795 l.Text = PagerStyle.PrevPageText;
796 l.CommandName = PageCommandName;
797 l.CommandArgument = PrevPageCommandArgument;
798 l.CausesValidation = false;
802 if (paged.Count > 0 && !paged.IsLastPage) {
803 LinkButton l = new LinkButton ();
804 l.Text = PagerStyle.NextPageText;
805 l.CommandName = PageCommandName;
806 l.CommandArgument = NextPageCommandArgument;
807 l.CausesValidation = false;
810 Label l = new Label ();
811 l.Text = PagerStyle.NextPageText;
815 res.Controls.Add (prev);
816 res.Controls.Add (new LiteralControl (" "));
817 res.Controls.Add (next);
822 protected virtual DataGridItem CreateItem (int itemIndex, int dataSourceIndex,
823 ListItemType itemType)
825 DataGridItem res = new DataGridItem (itemIndex, dataSourceIndex, itemType);
829 private DataGridItem CreateItem (int item_index, int data_source_index,
830 ListItemType type, bool data_bind, object data_item,
831 PagedDataSource paged)
833 DataGridItem res = CreateItem (item_index, data_source_index, type);
834 DataGridItemEventArgs args = new DataGridItemEventArgs (res);
835 bool no_pager = (type != ListItemType.Pager);
838 InitializeItem (res, render_columns);
840 res.DataItem = data_item;
841 OnItemCreated (args);
843 InitializePager (res, render_columns.Length, paged);
844 if (pager_style != null)
845 res.ApplyStyle (pager_style);
846 OnItemCreated (args);
849 // Add before the column is bound, so that the
850 // value is saved in the viewstate
851 RenderTable.Controls.Add (res);
853 if (no_pager && data_bind) {
855 OnItemDataBound (args);
861 class NCollection : ICollection {
864 class SequenceEnumerator : IEnumerator {
867 public SequenceEnumerator(int max) {
872 public bool MoveNext() {
873 _current = (int)_current + 1;
874 return (int)_current >= 0 && (int)_current < _max;
877 public void Reset() {
881 public object Current {
882 get { return _current; }
887 public NCollection (int n)
892 public IEnumerator GetEnumerator ()
895 return new SequenceEnumerator(n);
897 for (int i = 0; i < n; i++)
906 public bool IsSynchronized {
907 get { return false; }
910 public object SyncRoot {
914 public void CopyTo (Array array, int index)
916 throw new NotImplementedException ("This should never be called");
920 protected override void CreateControlHierarchy (bool useDataSource)
923 RenderTable.Controls.Clear ();
925 IEnumerable data_source;
926 ArrayList keys = null;
928 data_source = DataSourceResolver.ResolveDataSource (DataSource, DataMember);
929 keys = DataKeysArray;
932 int nitems = ViewState.GetInt ("Items", 0);
933 data_source = new NCollection (nitems);
936 paged_data_source = new PagedDataSource ();
937 PagedDataSource pds = paged_data_source;
938 pds.AllowPaging = AllowPaging;
939 pds.AllowCustomPaging = AllowCustomPaging;
940 pds.DataSource = data_source;
941 pds.CurrentPageIndex = CurrentPageIndex;
942 pds.PageSize = PageSize;
943 pds.VirtualCount = VirtualItemCount;
945 if ((pds.IsPagingEnabled) && (pds.PageCount < pds.CurrentPageIndex))
946 throw new HttpException ("Invalid DataGrid PageIndex");
948 CreateRenderColumns (paged_data_source, useDataSource);
950 if (DataSource != null)
951 Controls.Add (RenderTable);
953 Controls.Add (RenderTable);
956 if (pds.IsPagingEnabled)
957 CreateItem (-1, -1, ListItemType.Pager, false, null, pds);
959 CreateItem (-1, -1, ListItemType.Header, useDataSource, null, pds);
961 // No indexer on PagedDataSource so we have to do
962 // this silly foreach and index++
963 if (items_list == null)
964 items_list = new ArrayList ();
968 bool skip_first = false;
969 IEnumerator enumerator = null;
970 if (data_enumerator != null) {
971 // replaced when creating bound columns
972 enumerator = data_enumerator;
974 } else if (pds.DataSource != null) {
975 enumerator = pds.GetEnumerator ();
983 int dataset_index = pds.FirstIndexInPage;
984 int selected_index = SelectedIndex;
985 int edit_item_index = EditItemIndex;
986 while (enumerator != null && (skip_first || enumerator.MoveNext ())) {
987 // MS does not render <table blah></table> on empty datasource.
993 object data = enumerator.Current;
994 // This will throw if the DataKeyField is not there. As on MS, this
995 // will not be hit on an empty datasource.
996 // The values stored here can be used in events so that you can
997 // get, for example, the row that was clicked
998 // (data.Rows.Find (ItemsGrid.DataKeys [e.Item.ItemIndex]))
999 // BaseDataList will keep the array across postbacks.
1000 if (useDataSource && key != "")
1001 keys.Add (DataBinder.GetPropertyValue (data, key));
1003 ListItemType type = ListItemType.Item;
1004 if (index == edit_item_index)
1005 type = ListItemType.EditItem;
1006 else if (index == selected_index)
1007 type = ListItemType.SelectedItem;
1008 else if (index % 2 != 0)
1009 type = ListItemType.AlternatingItem;
1011 items_list.Add (CreateItem (index, dataset_index, type, useDataSource, data, pds));
1016 CreateItem (-1, -1, ListItemType.Footer, useDataSource, null, paged_data_source);
1017 if (pds.IsPagingEnabled) {
1018 CreateItem (-1, -1, ListItemType.Pager, false, null, paged_data_source);
1020 ViewState ["Items"] = pds.IsCustomPagingEnabled ? index : pds.DataSourceCount;
1021 } else if (useDataSource) {
1022 ViewState ["Items"] = index;
1026 void ApplyColumnStyle (TableCellCollection cells, ListItemType type)
1028 int ncells = Math.Min (cells.Count, render_columns.Length);
1032 for (int i = 0; i < ncells; i++) {
1034 TableCell cell = cells [i];
1035 DataGridColumn column = render_columns [i];
1036 if (!column.Visible) {
1037 cell.Visible = false;
1041 style = column.GetStyle (type);
1043 cell.MergeStyle (style);
1047 protected override void PrepareControlHierarchy ()
1049 if (!HasControls () || Controls.Count == 0)
1050 return; // No one called CreateControlHierarchy() with DataSource != null
1052 Table rt = render_table;
1053 rt.CopyBaseAttributes (this);
1054 rt.ApplyStyle (ControlStyle);
1056 rt.Caption = Caption;
1057 rt.CaptionAlign = CaptionAlign;
1058 rt.Enabled = Enabled;
1060 bool top_pager = true;
1062 foreach (DataGridItem item in rt.Rows) {
1064 switch (item.ItemType) {
1065 case ListItemType.Item:
1066 item.MergeStyle (item_style);
1067 ApplyColumnStyle (item.Cells, ListItemType.Item);
1069 case ListItemType.AlternatingItem:
1071 if (alt_item_style != null) {
1072 alt = new TableItemStyle ();
1073 alt.CopyFrom (item_style);
1074 alt.CopyFrom (alt_item_style);
1080 item.MergeStyle (alt);
1081 ApplyColumnStyle (item.Cells, ListItemType.AlternatingItem);
1083 case ListItemType.EditItem:
1084 item.MergeStyle (edit_item_style);
1085 ApplyColumnStyle (item.Cells, ListItemType.EditItem);
1087 case ListItemType.Footer:
1089 item.Visible = false;
1092 if (footer_style != null)
1093 item.MergeStyle (footer_style);
1094 ApplyColumnStyle (item.Cells, ListItemType.Footer);
1096 case ListItemType.Header:
1098 item.Visible = false;
1101 if (header_style != null)
1102 item.MergeStyle (header_style);
1103 ApplyColumnStyle (item.Cells, ListItemType.Header);
1105 case ListItemType.SelectedItem:
1106 if (selected_style != null)
1107 item.MergeStyle (selected_style);
1109 item.MergeStyle (item_style);
1110 ApplyColumnStyle (item.Cells, ListItemType.SelectedItem);
1112 case ListItemType.Separator:
1113 ApplyColumnStyle (item.Cells, ListItemType.Separator);
1115 case ListItemType.Pager:
1116 DataGridPagerStyle ps = PagerStyle;
1117 if (ps.Visible == false || !paged_data_source.IsPagingEnabled) {
1118 item.Visible = false;
1121 item.Visible = (ps.Position != PagerPosition.Bottom);
1123 item.Visible = (ps.Position != PagerPosition.Top);
1128 item.MergeStyle (pager_style);
1134 protected override bool OnBubbleEvent (object source, EventArgs e)
1136 DataGridCommandEventArgs de = e as DataGridCommandEventArgs;
1141 string cn = de.CommandName;
1142 CultureInfo inv = CultureInfo.InvariantCulture;
1145 if (String.Compare (cn, CancelCommandName, true, inv) == 0) {
1146 OnCancelCommand (de);
1147 } else if (String.Compare (cn, DeleteCommandName, true, inv) == 0) {
1148 OnDeleteCommand (de);
1149 } else if (String.Compare (cn, EditCommandName, true, inv) == 0) {
1151 } else if (String.Compare (cn, SelectCommandName, true, inv) == 0) {
1152 SelectedIndex = de.Item.ItemIndex;
1153 OnSelectedIndexChanged (de);
1154 } else if (String.Compare (cn, SortCommandName, true, inv) == 0) {
1155 DataGridSortCommandEventArgs se = new DataGridSortCommandEventArgs (de.CommandSource, de);
1157 } else if (String.Compare (cn, UpdateCommandName, true, inv) == 0) {
1158 OnUpdateCommand (de);
1159 } else if (String.Compare (cn, PageCommandName, true, inv) == 0) {
1161 if (String.Compare ((string) de.CommandArgument,
1162 NextPageCommandArgument, true, inv) == 0) {
1163 new_index = CurrentPageIndex + 1;
1164 } else if (String.Compare ((string) de.CommandArgument,
1165 PrevPageCommandArgument, true, inv) == 0) {
1166 new_index = CurrentPageIndex - 1;
1168 // It seems to just assume it's an int and parses, no
1169 // checks to make sure its valid or anything.
1170 // also it's always one less then specified, not sure
1172 new_index = Int32.Parse ((string) de.CommandArgument, inv) - 1;
1174 DataGridPageChangedEventArgs pc = new DataGridPageChangedEventArgs (
1175 de.CommandSource, new_index);
1176 OnPageIndexChanged (pc);
1182 protected virtual void OnCancelCommand (DataGridCommandEventArgs e)
1184 DataGridCommandEventHandler handler = (DataGridCommandEventHandler) Events [CancelCommandEvent];
1185 if (handler != null)
1189 protected virtual void OnDeleteCommand (DataGridCommandEventArgs e)
1191 DataGridCommandEventHandler handler = (DataGridCommandEventHandler) Events [DeleteCommandEvent];
1192 if (handler != null)
1196 protected virtual void OnEditCommand (DataGridCommandEventArgs e)
1198 DataGridCommandEventHandler handler = (DataGridCommandEventHandler) Events [EditCommandEvent];
1199 if (handler != null)
1203 protected virtual void OnItemCommand (DataGridCommandEventArgs e)
1205 DataGridCommandEventHandler handler = (DataGridCommandEventHandler) Events [ItemCommandEvent];
1206 if (handler != null)
1210 protected virtual void OnItemCreated (DataGridItemEventArgs e)
1212 DataGridItemEventHandler handler = (DataGridItemEventHandler) Events [ItemCreatedEvent];
1213 if (handler != null)
1217 protected virtual void OnItemDataBound (DataGridItemEventArgs e)
1219 DataGridItemEventHandler handler = (DataGridItemEventHandler) Events [ItemDataBoundEvent];
1220 if (handler != null)
1224 protected virtual void OnPageIndexChanged (DataGridPageChangedEventArgs e)
1226 DataGridPageChangedEventHandler handler = (DataGridPageChangedEventHandler) Events [PageIndexChangedEvent];
1227 if (handler != null)
1231 protected virtual void OnSortCommand (DataGridSortCommandEventArgs e)
1233 DataGridSortCommandEventHandler handler = (DataGridSortCommandEventHandler) Events [SortCommandEvent];
1234 if (handler != null)
1238 protected virtual void OnUpdateCommand (DataGridCommandEventArgs e)
1240 DataGridCommandEventHandler handler = (DataGridCommandEventHandler) Events [UpdateCommandEvent];
1241 if (handler != null)
1245 [WebSysDescription ("")]
1246 [WebCategory ("Action")]
1247 public event DataGridCommandEventHandler CancelCommand {
1248 add { Events.AddHandler (CancelCommandEvent, value); }
1249 remove { Events.RemoveHandler (CancelCommandEvent, value); }
1252 [WebSysDescription ("")]
1253 [WebCategory ("Action")]
1254 public event DataGridCommandEventHandler DeleteCommand {
1255 add { Events.AddHandler (DeleteCommandEvent, value); }
1256 remove { Events.RemoveHandler (DeleteCommandEvent, value); }
1259 [WebSysDescription ("")]
1260 [WebCategory ("Action")]
1261 public event DataGridCommandEventHandler EditCommand {
1262 add { Events.AddHandler (EditCommandEvent, value); }
1263 remove { Events.RemoveHandler (EditCommandEvent, value); }
1266 [WebSysDescription ("")]
1267 [WebCategory ("Action")]
1268 public event DataGridCommandEventHandler ItemCommand {
1269 add { Events.AddHandler (ItemCommandEvent, value); }
1270 remove { Events.RemoveHandler (ItemCommandEvent, value); }
1274 [WebSysDescription ("")]
1275 [WebCategory ("Action")]
1276 public event DataGridItemEventHandler ItemCreated {
1277 add { Events.AddHandler (ItemCreatedEvent, value); }
1278 remove { Events.RemoveHandler (ItemCreatedEvent, value); }
1281 [WebSysDescription ("")]
1282 [WebCategory ("Action")]
1283 public event DataGridItemEventHandler ItemDataBound {
1284 add { Events.AddHandler (ItemDataBoundEvent, value); }
1285 remove { Events.RemoveHandler (ItemDataBoundEvent, value); }
1288 [WebSysDescription ("")]
1289 [WebCategory ("Action")]
1290 public event DataGridPageChangedEventHandler PageIndexChanged {
1291 add { Events.AddHandler (PageIndexChangedEvent, value); }
1292 remove { Events.RemoveHandler (PageIndexChangedEvent, value); }
1295 [WebSysDescription ("")]
1296 [WebCategory ("Action")]
1297 public event DataGridSortCommandEventHandler SortCommand {
1298 add { Events.AddHandler (SortCommandEvent, value); }
1299 remove { Events.RemoveHandler (SortCommandEvent, value); }
1302 [WebSysDescription ("")]
1303 [WebCategory ("Action")]
1304 public event DataGridCommandEventHandler UpdateCommand {
1305 add { Events.AddHandler (UpdateCommandEvent, value); }
1306 remove { Events.AddHandler (UpdateCommandEvent, value); }