## Class TDataGrid

Description

Implements interfaces:

- INamingContainer

TDataGrid class

TDataGrid represents a data bound and updatable grid control.

To populate data into the datagrid, sets its DataSource to a tabular data source and call dataBind(). Each row of data will be represented by an item in the Items collection of the datagrid.

An item can be at one of three states: browsing, selected and edit. The state determines how the item will be displayed. For example, if an item is in edit state, it may be displayed as a table row with input text boxes if the columns are of type TBoundColumn; and if in browsing state, they are displayed as static text.

To change the state of an item, set EditItemIndex or SelectedItemIndex property.

Each datagrid item has a TDataGridItem::getItemType which tells the position and state of the item in the datalist. An item in the header of the repeater is of type Header. A body item may be of either Item, AlternatingItem, SelectedItem or EditItem, depending whether the item index is odd or even, whether it is being selected or edited.

A datagrid is specified with a list of columns. Each column specifies how the corresponding table column will be displayed. For example, the header/footer text of that column, the cells in that column, and so on. The following column types are currently provided by the framework,

- TBoundColumn, associated with a specific field in datasource and displays the corresponding data.
- TEditCommandColumn, displaying edit/update/cancel command buttons
- TButtonColumn, displaying generic command buttons that may be bound to specific field in datasource.
- THyperLinkColumn, displaying a hyperlink that may be bound to specific field in datasource.
- TCheckBoxColumn, displaying a checkbox that may be bound to specific field in datasource.
- TTemplateColumn, displaying content based on templates.

There are three ways to specify columns for a datagrid.

- Automatically generated based on data source. By setting AutoGenerateColumns to true, a list of columns will be automatically generated based on the schema of the data source. Each column corresponds to a column of the data.
- Specified in template. For example,

           <com:TDataGrid ...>
              <com:TBoundColumn .../>
              <com:TEditCommandColumn .../>
           </com:TDataGrid>

- Manually created in code. Columns can be manipulated via the setColumns property of the datagrid. For example,

          $column=new TBoundColumn;
          $datagrid->Columns[]=$column;

Note, automatically generated columns cannot be accessed via the Columns property.

TDataGrid supports sorting. If the AllowSorting is set to true, a column with nonempty setSortExpression will have its header text displayed as a clickable link button. Clicking on the link button will raise OnSortCommand event. You can respond to this event, sort the data source according to the event parameter, and then invoke databind() on the datagrid to show to end users the sorted data.

TDataGrid supports paging. If the AllowPaging is set to true, a pager will be displayed on top and/or bottom of the table. How the pager will be displayed is determined by the PagerStyle property. Clicking on a pager button will raise an OnPageIndexChanged event. You can respond to this event, specify the page to be displayed by setting CurrentPageIndex</b> property, and then invoke databind() on the datagrid to show to end users a new page of data.

TDataGrid supports two kinds of paging. The first one is based on the number of data items in datasource. The number of pages PageCount is calculated based the item number and the PageSize property. The datagrid will manage which section of the data source to be displayed based on the CurrentPageIndex property. The second approach calculates the page number based on the VirtualItemCount property and the PageSize property. The datagrid will always display from the beginning of the datasource up to the number of PageSize data items. This approach is especially useful when the datasource may contain too many data items to be managed by the datagrid efficiently.

When the datagrid contains a button control that raises an onCommand event, the event will be bubbled up to the datagrid control. If the event's command name is recognizable by the datagrid control, a corresponding item event will be raised. The following item events will be raised upon a specific command:

- OnEditCommand, if CommandName=edit
- OnCancelCommand, if CommandName=cancel
- OnSelectCommand, if CommandName=select
- OnDeleteCommand, if CommandName=delete
- OnUpdateCommand, if CommandName=update
- onPageIndexChanged, if CommandName=page
- OnSortCommand, if CommandName=sort

Note, an OnItemCommand event is raised in addition to the above specific command events.

TDataGrid also raises an OnItemCreated event for every newly created datagrid item. You can respond to this event to customize the content or style of the newly created item.

Note, the data bound to the datagrid are reset to null after databinding. There are several ways to access the data associated with a datagrid row:

- Access the data in OnItemDataBound event
- Use DataKeys to obtain the data key associated with

the specified datagrid row and use the key to fetch the corresponding data from some persistent storage such as DB.

- Save the data in viewstate and get it back during postbacks.

- since: 3.0
- version: $Id: TDataGrid.php 1522 2006-11-27 03:28:24Z xue $
- author: Qiang Xue <qiang.xue@gmail.com>

Located in /Web/UI/WebControls/TDataGrid.php (line 150)

    TComponent
       |
       --TApplicationComponent
          |
          --TControl
             |
             --TWebControl
                |
                --TDataBoundControl
                   |
                   --TBaseDataList
                      |
                      --TDataGrid

Class Constant Summary
CMD_CANCEL = 'Cancel'
CMD_DELETE = 'Delete'
CMD_EDIT = 'Edit'
CMD_PAGE = 'Page'
CMD_PAGE_NEXT = 'Next'
CMD_PAGE_PREV = 'Previous'
CMD_SELECT = 'Select'
CMD_SORT = 'Sort'
CMD_UPDATE = 'Update'
IT_ALTERNATINGITEM = 'AlternatingItem'
IT_EDITITEM = 'EditItem'
IT_FOOTER = 'Footer'
IT_HEADER = 'Header'
IT_ITEM = 'Item'
IT_PAGER = 'Pager'
IT_SELECTEDITEM = 'SelectedItem'
IT_SEPARATOR = 'Separator'
Method Summary
void addParsedObject (mixed $object)
void applyItemStyles ()
boolean bubbleEvent (TControl $sender, TEventParameter $param)
void buildNextPrevPager (TDataGridPager $pager)
void buildNumericPager (TDataGridPager $pager)
void buildPager (TDataGridPager $pager)
TDataGridColumnCollection createAutoColumns (Traversable $dataSource)
TDataGridItem createItem (integer $itemIndex, TListItemType $dataSourceIndex, mixed $itemType)
mixed createPagerButton (string $buttonType, boolean $enabled, string $text, string $commandName, string $commandParameter)
TTableStyle createStyle ()
boolean getAllowSorting ()
TTableItemStyle getAlternatingItemStyle ()
TDataGridColumnCollection getAutoColumns ()
boolean getAutoGenerateColumns ()
string getBackImageUrl ()
TDataGridPager getBottomPager ()
string getCaption ()
TTableCaptionAlign getCaptionAlign ()
TDataGridColumnCollection getColumns ()
TDataGridItem getEditItem ()
integer getEditItemIndex ()
TTableItemStyle getEditItemStyle ()
ITemplate getEmptyTemplate ()
TDataGridItem getFooter ()
TTableItemStyle getFooterStyle ()
TDataGridItem getHeader ()
TTableItemStyle getHeaderStyle ()
integer getItemCount ()
TDataGridItemCollection getItems ()
TTableItemStyle getItemStyle ()
TDataGridPagerStyle getPagerStyle ()
TDataGridItem getSelectedItem ()
integer getSelectedItemIndex ()
TTableItemStyle getSelectedItemStyle ()
boolean getShowFooter ()
boolean getShowHeader ()
string getTagName ()
TDataGridPager getTopPager ()
void initializeItem (TDataGrid $item, TDataGridColumnCollection $columns)
void loadState ()
void onCancelCommand (TDataGridCommandEventParameter $param)
void onDeleteCommand (TDataGridCommandEventParameter $param)
void onEditCommand (TDataGridCommandEventParameter $param)
void onItemCommand (TDataGridCommandEventParameter $param)
void onItemCreated (TDataGridItemEventParameter $param)
void onItemDataBound (TDataGridItemEventParameter $param)
void onPageIndexChanged (TDataGridPageChangedEventParameter $param)
void onPagerCreated (TDataGridPagerEventParameter $param)
void onSortCommand (TDataGridSortCommandEventParameter $param)
void onUpdateCommand (TDataGridCommandEventParameter $param)
void performDataBinding (Traversable $data)
void render (THtmlWriter $writer)
void renderBeginTag (THtmlWriter $writer)
void renderTable (THtmlWriter $writer)
void reset ()
void restoreGridFromViewState ()
void saveState ()
void setAllowSorting (boolean $value)
void setAutoGenerateColumns (boolean $value)
void setBackImageUrl (string $value)
void setCaption (string $value)
void setCaptionAlign (TTableCaptionAlign $value)
void setEditItemIndex (integer $value)
void setEmptyTemplate (ITemplate $value)
void setSelectedItemIndex (integer $value)
void setShowFooter (boolean $value)
void setShowHeader (boolean $value)
Methods
addParsedObject (line 226)

Adds objects parsed in template to datagrid.

Datagrid columns are added into Columns collection.

- access: public

void addParsedObject (mixed $object)

- mixed $object: object parsed in template

Redefinition of:

TControl::addParsedObject()
  Adds the object instantiated on a template to the child control collection.

applyItemStyles (line 1286)

Applies styles to items, header, footer and separators.

Item styles are applied 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, and 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.

- access: protected

void applyItemStyles ()
bubbleEvent (line 647)

This method overrides parent's implementation to handle onItemCommand event which is bubbled from TDataGridItem child controls.

If the event parameter is TDataGridCommandEventParameter and the command name is a recognized one, which includes 'select', 'edit', 'delete', 'update', and 'cancel' (case-insensitive), then a corresponding command event is also raised (such as OnEditCommand). This method should only be used by control developers.

- return: whether the event bubbling should stop here.
- access: public

boolean bubbleEvent (TControl $sender, TEventParameter $param)

- TControl $sender: the sender of the event
- TEventParameter $param: event parameter

Redefinition of:

TControl::bubbleEvent()
  This method responds to a bubbled event.

buildNextPrevPager (line 1150)

Builds a next-prev pager

- access: protected

void buildNextPrevPager (TDataGridPager $pager)

- TDataGridPager $pager: the container for the pager

buildNumericPager (line 1183)

Builds a numeric pager

- access: protected

void buildNumericPager (TDataGridPager $pager)

- TDataGridPager $pager: the container for the pager

buildPager (line 1095)

Builds the pager content based on pager style.

- access: protected

void buildPager (TDataGridPager $pager)

- TDataGridPager $pager: the container for the pager

createAutoColumns (line 1244)

Automatically generates datagrid columns based on datasource schema

- access: protected

TDataGridColumnCollection createAutoColumns (Traversable $dataSource)

- Traversable $dataSource: data source bound to the datagrid

createItem (line 1031)

Creates a datagrid item instance based on the item type and index.

- return: created data list item
- access: protected

TDataGridItem createItem (integer $itemIndex, TListItemType $dataSourceIndex, mixed $itemType)

- integer $itemIndex: zero-based item index
- TListItemType $dataSourceIndex: item type

createPagerButton (line 1120)

Creates a pager button.

Depending on the button type, a TLinkButton or a TButton may be created. If it is enabled (clickable), its command name and parameter will also be set. Derived classes may override this method to create additional types of buttons, such as TImageButton.

- return: the button instance
- access: protected

mixed createPagerButton (string $buttonType, boolean $enabled, string $text, string $commandName, string $commandParameter)

- string $buttonType: button type, either LinkButton or PushButton
- boolean $enabled: whether the button should be enabled
- string $text: caption of the button
- string $commandName: CommandName corresponding to the OnCommand event of the button
- string $commandParameter: CommandParameter corresponding to the OnCommand event of the button

createStyle (line 277)

Creates a style object for the control.

This method creates a TTableStyle to be used by datagrid.

- return: control style to be used
- access: protected

TTableStyle createStyle ()

Redefinition of:

TBaseDataList::createStyle()
  Creates a style object for the control.

getAllowSorting (line 553)

- return: whether sorting is enabled. Defaults to false.
- access: public

boolean getAllowSorting ()
getAlternatingItemStyle (line 314)

- return: the style for each alternating item
- access: public

TTableItemStyle getAlternatingItemStyle ()
getAutoColumns (line 247)

- return: automatically generated datagrid columns
- access: public

TDataGridColumnCollection getAutoColumns ()
getAutoGenerateColumns (line 569)

- return: whether datagrid columns should be automatically generated. Defaults to true.
- access: public

boolean getAutoGenerateColumns ()
getBackImageUrl (line 285)

- return: the URL of the background image for the datagrid
- access: public

string getBackImageUrl ()
getBottomPager (line 448)

- return: the pager displayed at the bottom of datagrid. It could be null if paging is disabled.
- access: public

TDataGridPager getBottomPager ()
getCaption (line 392)

- return: caption for the datagrid
- access: public

string getCaption ()
getCaptionAlign (line 408)

- return: datagrid caption alignment. Defaults to TTableCaptionAlign::NotSet.
- access: public

TTableCaptionAlign getCaptionAlign ()
getColumns (line 237)

- return: manually specified datagrid columns
- access: public

TDataGridColumnCollection getColumns ()
getEditItem (line 509)

- return: the edit item
- access: public

TDataGridItem getEditItem ()
getEditItemIndex (line 523)

- return: the zero-based index of the edit item in Items. A value -1 means no item is in edit mode.
- access: public

integer getEditItemIndex ()
getEditItemStyle (line 340)

- return: the style for edit item
- access: public

TTableItemStyle getEditItemStyle ()
getEmptyTemplate (line 617)

- return: the template applied when no data is bound to the datagrid
- access: public

ITemplate getEmptyTemplate ()
getFooter (line 432)

- return: the footer item
- access: public

TDataGridItem getFooter ()
getFooterStyle (line 366)

- return: the style for footer
- access: public

TTableItemStyle getFooterStyle ()
getHeader (line 424)

- return: the header item
- access: public

TDataGridItem getHeader ()
getHeaderStyle (line 353)

- return: the style for header
- access: public

TTableItemStyle getHeaderStyle ()
getItemCount (line 267)

- return: number of items
- access: public

integer getItemCount ()
getItems (line 257)

- return: datagrid item collection
- access: public

TDataGridItemCollection getItems ()
getItemStyle (line 301)

- return: the style for every item
- access: public

TTableItemStyle getItemStyle ()
getPagerStyle (line 379)

- return: the style for pager
- access: public

TDataGridPagerStyle getPagerStyle ()
getSelectedItem (line 456)

- return: the selected item, null if no item is selected.
- access: public

TDataGridItem getSelectedItem ()
getSelectedItemIndex (line 470)

- return: the zero-based index of the selected item in Items. A value -1 means no item selected.
- access: public

integer getSelectedItemIndex ()
getSelectedItemStyle (line 327)

- return: the style for selected item
- access: public

TTableItemStyle getSelectedItemStyle ()
getShowFooter (line 601)

- return: whether the footer should be displayed. Defaults to false.
- access: public

boolean getShowFooter ()
getShowHeader (line 585)

- return: whether the header should be displayed. Defaults to true.
- access: public

boolean getShowHeader ()
getTagName (line 216)

- return: tag name (table) of the datagrid
- access: protected

string getTagName ()

Redefinition of:

TWebControl::getTagName()
  Returns the tag name used for this control.

getTopPager (line 440)

- return: the pager displayed at the top of datagrid. It could be null if paging is disabled.
- access: public

TDataGridPager getTopPager ()
initializeItem (line 1063)

Initializes a datagrid item and cells inside it

- access: protected

void initializeItem (TDataGrid $item, TDataGridColumnCollection $columns)

- TDataGrid $item: datagrid item to be initialized
- TDataGridColumnCollection $columns: datagrid columns to be used to initialize the cells in the item

loadState (line 845)

Loads item count information from viewstate.

This method is invoked right after control state is loaded.

- access: public

void loadState ()

Redefinition of:

TControl::loadState()
  This method is invoked right after the control has loaded its state.

onCancelCommand (line 706)

Raises OnCancelCommand event.

This method is invoked when a button control raises OnCommand event with cancel command name.

- access: public

void onCancelCommand (TDataGridCommandEventParameter $param)

- TDataGridCommandEventParameter $param: event parameter

onDeleteCommand (line 717)

Raises OnDeleteCommand event.

This method is invoked when a button control raises OnCommand event with delete command name.

- access: public

void onDeleteCommand (TDataGridCommandEventParameter $param)

- TDataGridCommandEventParameter $param: event parameter

onEditCommand (line 728)

Raises OnEditCommand event.

This method is invoked when a button control raises OnCommand event with edit command name.

- access: public

void onEditCommand (TDataGridCommandEventParameter $param)

- TDataGridCommandEventParameter $param: event parameter

onItemCommand (line 738)

Raises OnItemCommand event.

This method is invoked when a button control raises OnCommand event.

- access: public

void onItemCommand (TDataGridCommandEventParameter $param)

- TDataGridCommandEventParameter $param: event parameter

onItemCreated (line 771)

Raises OnItemCreated event.

This method is invoked right after a datagrid item is created and before added to page hierarchy.

- access: public

void onItemCreated (TDataGridItemEventParameter $param)

- TDataGridItemEventParameter $param: event parameter

onItemDataBound (line 793)

Raises OnItemDataBound event.

This method is invoked for each datagrid item after it performs databinding.

- access: public

void onItemDataBound (TDataGridItemEventParameter $param)

- TDataGridItemEventParameter $param: event parameter

onPageIndexChanged (line 803)

Raises OnPageIndexChanged event.

This method is invoked when current page is changed.

- access: public

void onPageIndexChanged (TDataGridPageChangedEventParameter $param)

- TDataGridPageChangedEventParameter $param: event parameter

onPagerCreated (line 782)

Raises OnPagerCreated event.

This method is invoked right after a datagrid pager is created and before added to page hierarchy.

- access: public

void onPagerCreated (TDataGridPagerEventParameter $param)

- TDataGridPagerEventParameter $param: event parameter

onSortCommand (line 749)

Raises OnSortCommand event.

This method is invoked when a button control raises OnCommand event with sort command name.

- access: public

void onSortCommand (TDataGridSortCommandEventParameter $param)

- TDataGridSortCommandEventParameter $param: event parameter

onUpdateCommand (line 760)

Raises OnUpdateCommand event.

This method is invoked when a button control raises OnCommand event with update command name.

- access: public

void onUpdateCommand (TDataGridCommandEventParameter $param)

- TDataGridCommandEventParameter $param: event parameter

performDataBinding (line 955)

Performs databinding to populate datagrid items from data source.

This method is invoked by dataBind(). You may override this function to provide your own way of data population.

- access: protected

void performDataBinding (Traversable $data)

- Traversable $data: the bound data

Redefinition of:

TDataBoundControl::performDataBinding()

render (line 1440)

Renders the datagrid.

- access: public

void render (THtmlWriter $writer)

- THtmlWriter $writer: writer for the rendering purpose

Redefinition of:

TWebControl::render()
  Renders the control.

renderBeginTag (line 1423)

Renders the openning tag for the datagrid control which will render table caption if present.

- access: public

void renderBeginTag (THtmlWriter $writer)

- THtmlWriter $writer: the writer used for the rendering purpose

Redefinition of:

TWebControl::renderBeginTag()
  Renders the openning tag for the control (including attributes)

renderTable (line 1477)

Renders the tabular data.

- access: protected

void renderTable (THtmlWriter $writer)

- THtmlWriter $writer: writer

reset (line 882)

Clears up all items in the datagrid.

- access: public

void reset ()
restoreGridFromViewState (line 896)

Restores datagrid content from viewstate.

- access: protected

void restoreGridFromViewState ()
saveState (line 812)

Saves item count in viewstate.

This method is invoked right before control state is to be saved.

- access: public

void saveState ()

Redefinition of:

TControl::saveState()
  This method is invoked when control state is to be saved.

setAllowSorting (line 561)

- access: public

void setAllowSorting (boolean $value)

- boolean $value: whether sorting is enabled

setAutoGenerateColumns (line 577)

- access: public

void setAutoGenerateColumns (boolean $value)

- boolean $value: whether datagrid columns should be automatically generated

setBackImageUrl (line 293)

- access: public

void setBackImageUrl (string $value)

- string $value: the URL of the background image for the datagrid

setCaption (line 400)

- access: public

void setCaption (string $value)

- string $value: caption for the datagrid

setCaptionAlign (line 416)

- access: public

void setCaptionAlign (TTableCaptionAlign $value)

- TTableCaptionAlign $value: datagrid caption alignment. Valid values include

setEditItemIndex (line 534)

Edits an item by its index in getItems.

Previously editting item will change to normal item state. If the index is less than 0, any existing edit item will be cleared up.

- access: public

void setEditItemIndex (integer $value)

- integer $value: the edit item index

setEmptyTemplate (line 626)

- access: public
- throws: TInvalidDataTypeException if the input is not an ITemplate or not null.

void setEmptyTemplate (ITemplate $value)

- ITemplate $value: the template applied when no data is bound to the datagrid

setSelectedItemIndex (line 482)

Selects an item by its index in getItems.

Previously selected item will be un-selected. If the item to be selected is already in edit mode, it will remain in edit mode. If the index is less than 0, any existing selection will be cleared up.

- access: public

void setSelectedItemIndex (integer $value)

- integer $value: the selected item index

setShowFooter (line 609)

- access: public

void setShowFooter (boolean $value)

- boolean $value: whether the footer should be displayed

setShowHeader (line 593)

- access: public

void setShowHeader (boolean $value)

- boolean $value: whether the header should be displayed

#### Inherited Methods

Inherited From TBaseDataList

> TBaseDataList::createStyle()
> TBaseDataList::getCellPadding()
> TBaseDataList::getCellSpacing()
> TBaseDataList::getDataFieldValue()
> TBaseDataList::getDataKeyField()
> TBaseDataList::getDataKeys()
> TBaseDataList::getGridLines()
> TBaseDataList::getHorizontalAlign()
> TBaseDataList::onSelectedIndexChanged()
> TBaseDataList::setCellPadding()
> TBaseDataList::setCellSpacing()
> TBaseDataList::setDataKeyField()
> TBaseDataList::setGridLines()
> TBaseDataList::setHorizontalAlign()

Inherited From TDataBoundControl

> TDataBoundControl::createPagedDataSource()
> TDataBoundControl::dataBind()
> TDataBoundControl::dataSourceViewChanged()
> TDataBoundControl::determineDataSource()
> TDataBoundControl::ensureDataBound()
> TDataBoundControl::getAllowCustomPaging()
> TDataBoundControl::getAllowPaging()
> TDataBoundControl::getCurrentPageIndex()
> TDataBoundControl::getData()
> TDataBoundControl::getDataMember()
> TDataBoundControl::getDataSource()
> TDataBoundControl::getDataSourceID()
> TDataBoundControl::getDataSourceView()
> TDataBoundControl::getInitialized()
> TDataBoundControl::getIsDataBound()
> TDataBoundControl::getPageCount()
> TDataBoundControl::getPageSize()
> TDataBoundControl::getRequiresDataBinding()
> TDataBoundControl::getSelectParameters()
> TDataBoundControl::getUsingDataSourceID()
> TDataBoundControl::getVirtualItemCount()
> TDataBoundControl::onDataBound()
> TDataBoundControl::onDataSourceChanged()
> TDataBoundControl::onInit()
> TDataBoundControl::onPreRender()
> TDataBoundControl::pagePreLoad()
> TDataBoundControl::performDataBinding()
> TDataBoundControl::setAllowCustomPaging()
> TDataBoundControl::setAllowPaging()
> TDataBoundControl::setCurrentPageIndex()
> TDataBoundControl::setDataMember()
> TDataBoundControl::setDataSource()
> TDataBoundControl::setDataSourceID()
> TDataBoundControl::setInitialized()
> TDataBoundControl::setIsDataBound()
> TDataBoundControl::setPageSize()
> TDataBoundControl::setRequiresDataBinding()
> TDataBoundControl::setVirtualItemCount()
> TDataBoundControl::validateDataSource()

Inherited From TWebControl

> TWebControl::addAttributesToRender()
> TWebControl::copyBaseAttributes()
> TWebControl::createStyle()
> TWebControl::getAccessKey()
> TWebControl::getBackColor()
> TWebControl::getBorderColor()
> TWebControl::getBorderStyle()
> TWebControl::getBorderWidth()
> TWebControl::getCssClass()
> TWebControl::getFont()
> TWebControl::getForeColor()
> TWebControl::getHasStyle()
> TWebControl::getHeight()
> TWebControl::getStyle()
> TWebControl::getTabIndex()
> TWebControl::getTagName()
> TWebControl::getToolTip()
> TWebControl::getWidth()
> TWebControl::render()
> TWebControl::renderBeginTag()
> TWebControl::renderContents()
> TWebControl::renderEndTag()
> TWebControl::setAccessKey()
> TWebControl::setBackColor()
> TWebControl::setBorderColor()
> TWebControl::setBorderStyle()
> TWebControl::setBorderWidth()
> TWebControl::setCssClass()
> TWebControl::setForeColor()
> TWebControl::setHeight()
> TWebControl::setStyle()
> TWebControl::setTabIndex()
> TWebControl::setToolTip()
> TWebControl::setWidth()

Inherited From TControl

> TControl::__construct()
> TControl::addedControl()
> TControl::addParsedObject()
> TControl::addToPostDataLoader()
> TControl::applyStyleSheetSkin()
> TControl::autoBindProperty()
> TControl::autoDataBindProperties()
> TControl::bindProperty()
> TControl::broadcastEvent()
> TControl::bubbleEvent()
> TControl::clearChildState()
> TControl::clearControlState()
> TControl::clearNamingContainer()
> TControl::clearViewState()
> TControl::createChildControls()
> TControl::createControlCollection()
> TControl::dataBind()
> TControl::dataBindChildren()
> TControl::dataBindProperties()
> TControl::ensureChildControls()
> TControl::findControl()
> TControl::findControlsByID()
> TControl::findControlsByType()
> TControl::focus()
> TControl::getAdapter()
> TControl::getAllowChildControls()
> TControl::getAttribute()
> TControl::getAttributes()
> TControl::getChildControlsCreated()
> TControl::getClientID()
> TControl::getControls()
> TControl::getControlStage()
> TControl::getControlState()
> TControl::getCustomData()
> TControl::getEnabled()
> TControl::getEnableTheming()
> TControl::getEnableViewState()
> TControl::getHasAdapter()
> TControl::getHasAttributes()
> TControl::getHasChildInitialized()
> TControl::getHasControls()
> TControl::getHasInitialized()
> TControl::getHasLoaded()
> TControl::getHasLoadedPostData()
> TControl::getHasPreRendered()
> TControl::getID()
> TControl::getNamingContainer()
> TControl::getPage()
> TControl::getParent()
> TControl::getRegisteredObject()
> TControl::getSkinID()
> TControl::getSourceTemplateControl()
> TControl::getTemplateControl()
> TControl::getUniqueID()
> TControl::getViewState()
> TControl::getVisible()
> TControl::hasAttribute()
> TControl::initRecursive()
> TControl::isDescendentOf()
> TControl::isObjectRegistered()
> TControl::loadRecursive()
> TControl::loadState()
> TControl::loadStateRecursive()
> TControl::onDataBinding()
> TControl::onInit()
> TControl::onLoad()
> TControl::onPreRender()
> TControl::onUnload()
> TControl::preRenderRecursive()
> TControl::raiseBubbleEvent()
> TControl::registerObject()
> TControl::removeAttribute()
> TControl::removedControl()
> TControl::render()
> TControl::renderChildren()
> TControl::renderControl()
> TControl::saveState()
> TControl::saveStateRecursive()
> TControl::setAdapter()
> TControl::setAttribute()
> TControl::setChildControlsCreated()
> TControl::setControlStage()
> TControl::setControlState()
> TControl::setCustomData()
> TControl::setEnabled()
> TControl::setEnableTheming()
> TControl::setEnableViewState()
> TControl::setID()
> TControl::setPage()
> TControl::setSkinID()
> TControl::setTemplateControl()
> TControl::setViewState()
> TControl::setVisible()
> TControl::traverseChildControls()
> TControl::unbindProperty()
> TControl::unloadRecursive()
> TControl::unregisterObject()
> TControl::__get()

Inherited From TApplicationComponent

> TApplicationComponent::getApplication()
> TApplicationComponent::getRequest()
> TApplicationComponent::getResponse()
> TApplicationComponent::getService()
> TApplicationComponent::getSession()
> TApplicationComponent::getUser()
> TApplicationComponent::publishAsset()
> TApplicationComponent::publishFilePath()

Inherited From TComponent

> TComponent::addParsedObject()
> TComponent::attachEventHandler()
> TComponent::canGetProperty()
> TComponent::canSetProperty()
> TComponent::createdOnTemplate()
> TComponent::detachEventHandler()
> TComponent::evaluateExpression()
> TComponent::evaluateStatements()
> TComponent::getEventHandlers()
> TComponent::getSubProperty()
> TComponent::hasEvent()
> TComponent::hasEventHandler()
> TComponent::hasProperty()
> TComponent::raiseEvent()
> TComponent::setSubProperty()
> TComponent::__get()
> TComponent::__set()

Class Constants
CMD_CANCEL = 'Cancel' (line 172)
CMD_DELETE = 'Delete' (line 171)
CMD_EDIT = 'Edit' (line 169)
CMD_PAGE = 'Page' (line 174)
CMD_PAGE_NEXT = 'Next' (line 175)
CMD_PAGE_PREV = 'Previous' (line 176)
CMD_SELECT = 'Select' (line 168)

Command name that TDataGrid understands.

CMD_SORT = 'Sort' (line 173)
CMD_UPDATE = 'Update' (line 170)
IT_ALTERNATINGITEM = 'AlternatingItem' (line 160)
IT_EDITITEM = 'EditItem' (line 161)
IT_FOOTER = 'Footer' (line 157)
IT_HEADER = 'Header' (line 156)

datagrid item types

- deprecated: deprecated since version 3.0.4. Use TListItemType constants instead.

IT_ITEM = 'Item' (line 158)
IT_PAGER = 'Pager' (line 163)
IT_SELECTEDITEM = 'SelectedItem' (line 162)
IT_SEPARATOR = 'Separator' (line 159)

#### Inherited Constants

Inherited from TControl

> TControl::AUTOMATIC_ID_PREFIX
> TControl::CLIENT_ID_SEPARATOR
> TControl::CS_CHILD_INITIALIZED
> TControl::CS_CONSTRUCTED
> TControl::CS_INITIALIZED
> TControl::CS_LOADED
> TControl::CS_PRERENDERED
> TControl::CS_STATE_LOADED
> TControl::ID_FORMAT
> TControl::ID_SEPARATOR
> TControl::IS_CHILD_CREATED
> TControl::IS_CREATING_CHILD
> TControl::IS_DISABLE_THEMING
> TControl::IS_DISABLE_VIEWSTATE
> TControl::IS_ID_SET
> TControl::IS_SKIN_APPLIED
> TControl::IS_STYLESHEET_APPLIED
> TControl::RF_ADAPTER
> TControl::RF_AUTO_BINDINGS
> TControl::RF_CHILD_STATE
> TControl::RF_CONTROLS
> TControl::RF_CONTROLSTATE
> TControl::RF_DATA_BINDINGS
> TControl::RF_EVENTS
> TControl::RF_NAMED_CONTROLS
> TControl::RF_NAMED_CONTROLS_ID
> TControl::RF_NAMED_OBJECTS
> TControl::RF_SKIN_ID

Documentation generated on Sun, 14 Jan 2007 21:41:53 -0500 by phpDocumentor 1.3.0RC4