API Manual

TDataList represents a data bound and updatable list control. Like TRepeater, TDataList displays its content repeatedly based on the data fetched from DataSource. The repeated contents in TDataList are called items, which are controls and can be accessed through Items. When dataBind() is invoked, TDataList creates an item for each row of data and binds the data row to the item. Optionally, a TDataList can have a header, a footer and/or separators between items.

TDataList differs from TRepeater in that it introduces the concept of item state and allows applying different styles to items in different states. In addition, TDataList supports tiling the repeated items in various ways.

The layout of the repeated contents in TDataList are specified by inline templates. TDataList items, header, footer, etc. are being instantiated with the corresponding templates when data is being bound to the repeater.

Since v3.1.0, the layout can also be by renderers. A renderer is a control class that can be instantiated as datalist items, header, etc. A renderer can thus be viewed as an external template (in fact, it can also be non-templated controls). For more details, see the explanation about renderer in the TRepeater tutorial.

The following properties are used to specify different types of template and renderer for a datalist. If a content type is defined with both a template and a renderer, the latter takes precedence.

  • ItemTemplate, ItemRenderer: for each repeated row of data
  • AlternatingItemTemplate, AlternatingItemRenderer: for each alternating row of data. If not set, ItemTemplate or ItemRenderer will be used instead.
  • HeaderTemplate, HeaderRenderer: for the datalist header.
  • FooterTemplate, FooterRenderer: for the datalist footer.
  • SeparatorTemplate, SeparatorRenderer: for content to be displayed between items.
  • EmptyTemplate, EmptyRenderer: used when data bound to the datalist is empty.
  • EditItemTemplate, EditItemRenderer: for the row being editted.
  • SelectedItemTemplate, SelectedItemRenderer: for the row being selected.

When dataBind() is called, TDataList undergoes the following lifecycles for each row of data:

  1. create item based on templates or renderers
  2. set the row of data to the item
  3. raise an OnItemCreated event
  4. add the item as a child control
  5. call dataBind() of the item
  6. raise an OnItemDataBound event

TDataList raises an OnItemCommand whenever a button control within some datalist item raises an OnCommand event. Therefore, you can handle all sorts of OnCommand event in a central place by writing an event handler for OnItemCommand. An additional event is raised if the OnCommand event has one of the following command names (case-insensitive):

  • edit - user wants to edit an item. OnEditCommand event will be raised.
  • update - user wants to save the change to an item. OnUpdateCommand event will be raised.
  • select - user selects an item. OnSelectedIndexChanged event will be raised.
  • delete - user deletes an item. OnDeleteCommand event will be raised.
  • cancel - user cancels previously editting action. OnCancelCommand event will be raised.

TDataList provides a few properties to support tiling the items. The number of columns used to display the data items is specified via RepeatColumns property, while the RepeatDirection governs the order of the items being rendered. The layout of the data items in the list is specified via RepeatLayout, which takes one of the following values:

  • Table (default) - items are organized using HTML table and cells. When using this layout, one can set CellPadding and CellSpacing to adjust the cellpadding and cellspacing of the table, and Caption and CaptionAlign to add a table caption with the specified alignment.
  • Flow - items are organized using HTML spans and breaks.
  • Raw - TDataList does not generate any HTML tags to do the tiling.

Items in TDataList can be in one of the three states: being browsed, being editted and being selected. To change the state of a particular item, set SelectedItemIndex or EditItemIndex. The former will change the indicated item to selected mode, which will cause the item to use SelectedItemTemplate or SelectedItemRenderer for presentation. The latter will change the indicated item to edit mode and to use corresponding template or renderer. Note, if an item is in edit mode, then selecting this item will have no effect.

Different styles may be applied to items in different status. The style application is performed in a hierarchical way: Style in higher hierarchy will inherit from styles in lower hierarchy. Starting from the lowest hierarchy, the item styles include:

  • item's own style
  • ItemStyle
  • AlternatingItemStyle
  • SelectedItemStyle
  • EditItemStyle

Therefore, if background color is set as red in ItemStyle, EditItemStyle will also have red background color unless it is set to a different value explicitly.

When a page containing a datalist is post back, the datalist will restore automatically all its contents, including items, header, footer and separators. However, the data row associated with each item will not be recovered and become null. To access the data, use one of the following ways:

  • Use DataKeys to obtain the data key associated with the specified repeater item and use the key to fetch the corresponding data from some persistent storage such as DB.
  • Save the whole dataset in viewstate, which will restore the dataset automatically upon postback. Be aware though, if the size of your dataset is big, your page size will become big. Some complex data may also have serializing problem if saved in viewstate.

The following example shows how to use TDataList to display tabular data, with different layout and styles.

A common use of TDataList is for maintaining tabular data, including browsing, editing, deleting data items. This is enabled by the command events and various item templates of TDataList.

The following example displays a computer product information. Users can add new products, modify or delete existing ones. In order to locate the data item for updating or deleting, DataKeys property is used.

Be aware, for simplicity, this application does not do any input validation. In real applications, make sure user inputs are valid before saving them into databases.