PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TDataGrid

TDataGrid class

TDataGrid represents a data bound and updatable grid control.

To populate data into the datagrid, sets its setDataSource DataSource to a tabular data source and call TDataBoundControl::dataBind(). Each row of data will be represented by an item in the getItems 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 setEditItemIndex EditItemIndex or setSelectedItemIndex SelectedItemIndex property.

Each datagrid item has a TDataGridItem::getItemType type 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.
  • TDropDownListColumn, displaying a dropdown list when the item is in edit state
  • 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 setAutoGenerateColumns 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 Columns property of the datagrid. For example,
      $column=new TBoundColumn;
      $datagrid->Columns[]=$column;
    
Note, automatically generated columns cannot be accessed via the getColumns Columns property.

TDataGrid supports sorting. If the setAllowSorting AllowSorting is set to true, a column with nonempty setSortExpression SortExpression will have its header text displayed as a clickable link button. Clicking on the link button will raise onSortCommand 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 setAllowPaging 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 getPagerStyle PagerStyle property. Clicking on a pager button will raise an onPageIndexChanged OnPageIndexChanged event. You can respond to this event, specify the page to be displayed by setting setCurrentPageIndex CurrentPageIndex 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 getPageCount PageCount is calculated based the item number and the setPageSize PageSize property. The datagrid will manage which section of the data source to be displayed based on the setCurrentPageIndex CurrentPageIndex property. The second approach calculates the page number based on the setVirtualItemCount VirtualItemCount property and the setPageSize PageSize property. The datagrid will always display from the beginning of the datasource up to the number of setPageSize 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 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 OnItemCommand event is raised in addition to the above specific command events.

TDataGrid also raises an onItemCreated 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 OnItemDataBound event
  • Use getDataKeys 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.
TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TWebControl implements IStyleable
Extended by TDataBoundControl
Extended by TBaseDataList
Extended by TDataGrid implements INamingContainer

Direct known subclasses

TActiveDataGrid
Package: System\Web\UI\WebControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0
Located at Web/UI/WebControls/TDataGrid.php
Methods summary
protected string
# getTagName( )

Returns

string
tag name (table) of the datagrid

Overrides

TWebControl::getTagName()
protected string
# getAutoGenerateColumnName( )

Returns

string
Name of the class used in AutoGenerateColumns mode
public
# addParsedObject( mixed $object )

Adds objects parsed in template to datagrid. Datagrid columns are added into getColumns Columns collection.

Adds objects parsed in template to datagrid. Datagrid columns are added into getColumns Columns collection.

Parameters

$object
mixed
object parsed in template

Overrides

TControl::addParsedObject()
public TDataGridColumnCollection
# getColumns( )

Returns

TDataGridColumnCollection
manually specified datagrid columns
public TDataGridColumnCollection
# getAutoColumns( )

Returns

TDataGridColumnCollection
automatically generated datagrid columns
public TDataGridItemCollection
# getItems( )

Returns

TDataGridItemCollection
datagrid item collection
public integer
# getItemCount( )

Returns

integer
number of items
protected TTableStyle
# createStyle( )

Creates a style object for the control. This method creates a TTableStyle to be used by datagrid.

Creates a style object for the control. This method creates a TTableStyle to be used by datagrid.

Returns

TTableStyle
control style to be used

Overrides

TBaseDataList::createStyle()
public string
# getBackImageUrl( )

Returns

string
the URL of the background image for the datagrid
public
# setBackImageUrl( string $value )

Parameters

$value
string
the URL of the background image for the datagrid
public TTableItemStyle
# getItemStyle( )

Returns

TTableItemStyle
the style for every item
public TTableItemStyle
# getAlternatingItemStyle( )

Returns

TTableItemStyle
the style for each alternating item
public TTableItemStyle
# getSelectedItemStyle( )

Returns

TTableItemStyle
the style for selected item
public TTableItemStyle
# getEditItemStyle( )

Returns

TTableItemStyle
the style for edit item
public TTableItemStyle
# getHeaderStyle( )

Returns

TTableItemStyle
the style for header
public TTableItemStyle
# getFooterStyle( )

Returns

TTableItemStyle
the style for footer
public TDataGridPagerStyle
# getPagerStyle( )

Returns

TDataGridPagerStyle
the style for pager
public TStyle
# getTableHeadStyle( )

Returns

TStyle
the style for thead element, if any

Since

3.1.1
public TStyle
# getTableBodyStyle( )

Returns

TStyle
the style for tbody element, if any

Since

3.1.1
public TStyle
# getTableFootStyle( )

Returns

TStyle
the style for tfoot element, if any

Since

3.1.1
public string
# getCaption( )

Returns

string
caption for the datagrid
public
# setCaption( string $value )

Parameters

$value
string
caption for the datagrid
public TTableCaptionAlign
# getCaptionAlign( )

Returns

TTableCaptionAlign
datagrid caption alignment. Defaults to TTableCaptionAlign::NotSet.
public
# setCaptionAlign( TTableCaptionAlign $value )

Parameters

$value
TTableCaptionAlign
datagrid caption alignment. Valid values include
public TDataGridItem
# getHeader( )

Returns

TDataGridItem
the header item
public TDataGridItem
# getFooter( )

Returns

TDataGridItem
the footer item
public TDataGridPager
# getTopPager( )

Returns

TDataGridPager
the pager displayed at the top of datagrid. It could be null if paging is disabled.
public TDataGridPager
# getBottomPager( )

Returns

TDataGridPager
the pager displayed at the bottom of datagrid. It could be null if paging is disabled.
public TDataGridItem
# getSelectedItem( )

Returns

TDataGridItem
the selected item, null if no item is selected.
public integer
# getSelectedItemIndex( )

Returns

integer
the zero-based index of the selected item in getItems Items. A value -1 means no item selected.
public
# setSelectedItemIndex( integer $value )

Selects an item by its index in getItems Items. 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.

Selects an item by its index in getItems Items. 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.

Parameters

$value
integer
the selected item index
public TDataGridItem
# getEditItem( )

Returns

TDataGridItem
the edit item
public integer
# getEditItemIndex( )

Returns

integer
the zero-based index of the edit item in getItems Items. A value -1 means no item is in edit mode.
public
# setEditItemIndex( integer $value )

Edits an item by its index in getItems Items. Previously editting item will change to normal item state. If the index is less than 0, any existing edit item will be cleared up.

Edits an item by its index in getItems Items. Previously editting item will change to normal item state. If the index is less than 0, any existing edit item will be cleared up.

Parameters

$value
integer
the edit item index
public boolean
# getAllowSorting( )

Returns

boolean
whether sorting is enabled. Defaults to false.
public
# setAllowSorting( boolean $value )

Parameters

$value
boolean
whether sorting is enabled
public boolean
# getAutoGenerateColumns( )

Returns

boolean
whether datagrid columns should be automatically generated. Defaults to true.
public
# setAutoGenerateColumns( boolean $value )

Parameters

$value
boolean
whether datagrid columns should be automatically generated
public boolean
# getShowHeader( )

Returns

boolean
whether the header should be displayed. Defaults to true.
public
# setShowHeader( boolean $value )

Parameters

$value
boolean
whether the header should be displayed
public boolean
# getShowFooter( )

Returns

boolean
whether the footer should be displayed. Defaults to false.
public
# setShowFooter( boolean $value )

Parameters

$value
boolean
whether the footer should be displayed
public ITemplate
# getEmptyTemplate( )

Returns

ITemplate
the template applied when no data is bound to the datagrid
public
# setEmptyTemplate( ITemplate $value )

Parameters

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

Throws

TInvalidDataTypeException
if the input is not an ITemplate or not null.
public boolean
# bubbleEvent( TControl $sender, TEventParameter $param )

This method overrides parent's implementation to handle onItemCommand 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 OnEditCommand). This method should only be used by control developers.

This method overrides parent's implementation to handle onItemCommand 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 OnEditCommand). This method should only be used by control developers.

Parameters

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

Returns

boolean
whether the event bubbling should stop here.

Overrides

TControl::bubbleEvent()
public
# onCancelCommand( TDataGridCommandEventParameter $param )

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

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

Parameters

$param
TDataGridCommandEventParameter
event parameter
public
# onDeleteCommand( TDataGridCommandEventParameter $param )

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

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

Parameters

$param
TDataGridCommandEventParameter
event parameter
public
# onEditCommand( TDataGridCommandEventParameter $param )

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

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

Parameters

$param
TDataGridCommandEventParameter
event parameter
public
# onItemCommand( TDataGridCommandEventParameter $param )

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

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

Parameters

$param
TDataGridCommandEventParameter
event parameter
public
# onSortCommand( TDataGridSortCommandEventParameter $param )

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

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

Parameters

$param
TDataGridSortCommandEventParameter
event parameter
public
# onUpdateCommand( TDataGridCommandEventParameter $param )

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

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

Parameters

$param
TDataGridCommandEventParameter
event parameter
public
# onItemCreated( TDataGridItemEventParameter $param )

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

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

Parameters

$param
TDataGridItemEventParameter
event parameter
public
# onPagerCreated( TDataGridPagerEventParameter $param )

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

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

Parameters

$param
TDataGridPagerEventParameter
event parameter
public
# onItemDataBound( TDataGridItemEventParameter $param )

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

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

Parameters

$param
TDataGridItemEventParameter
event parameter
public
# onPageIndexChanged( TDataGridPageChangedEventParameter $param )

Raises OnPageIndexChanged event. This method is invoked when current page is changed.

Raises OnPageIndexChanged event. This method is invoked when current page is changed.

Parameters

$param
TDataGridPageChangedEventParameter
event parameter
public
# saveState( )

Saves item count in viewstate. This method is invoked right before control state is to be saved.

Saves item count in viewstate. This method is invoked right before control state is to be saved.

Overrides

TControl::saveState()
public
# loadState( )

Loads item count information from viewstate. This method is invoked right after control state is loaded.

Loads item count information from viewstate. This method is invoked right after control state is loaded.

Overrides

TControl::loadState()
public
# reset( )

Clears up all items in the datagrid.

Clears up all items in the datagrid.

protected
# restoreGridFromViewState( )

Restores datagrid content from viewstate.

Restores datagrid content from viewstate.

protected
# performDataBinding( Traversable $data )

Performs databinding to populate datagrid items from data source. This method is invoked by TDataBoundControl::dataBind(). You may override this function to provide your own way of data population.

Performs databinding to populate datagrid items from data source. This method is invoked by TDataBoundControl::dataBind(). You may override this function to provide your own way of data population.

Parameters

$data
Traversable
the bound data
protected TDataGridItem
# createItem( integer $itemIndex, TListItemType $dataSourceIndex, mixed $itemType )

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

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

Parameters

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

Returns

TDataGridItem
created data list item
protected
# initializeItem( TDataGrid $item, TDataGridColumnCollection $columns )

Initializes a datagrid item and cells inside it

Initializes a datagrid item and cells inside it

Parameters

$item
TDataGrid
datagrid item to be initialized
$columns
TDataGridColumnCollection
datagrid columns to be used to initialize the cells in the item
protected
# createPager( )
protected
# buildPager( TDataGridPager $pager )

Builds the pager content based on pager style.

Builds the pager content based on pager style.

Parameters

$pager
TDataGridPager
the container for the pager
protected mixed
# createPagerButton( mixed $pager, string $buttonType, boolean $enabled, string $text, string $commandName, string $commandParameter )

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.

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.

Parameters

$pager
mixed
the container pager instance of TActiveDatagridPager
$buttonType
string
button type, either LinkButton or PushButton
$enabled
boolean
whether the button should be enabled
$text
string
caption of the button
$commandName
string
CommandName corresponding to the OnCommand event of the button
$commandParameter
string
CommandParameter corresponding to the OnCommand event of the button

Returns

mixed
the button instance
protected
# buildNextPrevPager( TDataGridPager $pager )

Builds a next-prev pager

Builds a next-prev pager

Parameters

$pager
TDataGridPager
the container for the pager
protected
# buildNumericPager( TDataGridPager $pager )

Builds a numeric pager

Builds a numeric pager

Parameters

$pager
TDataGridPager
the container for the pager
protected TDataGridColumnCollection
# createAutoColumns( Traversable $dataSource )

Automatically generates datagrid columns based on datasource schema

Automatically generates datagrid columns based on datasource schema

Parameters

$dataSource
Traversable
data source bound to the datagrid

Returns

TDataGridColumnCollection
protected
# applyItemStyles( )

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, getItemStyle ItemStyle, getAlternatingItemStyle AlternatingItemStyle, getSelectedItemStyle SelectedItemStyle, and getEditItemStyle EditItemStyle. Therefore, if background color is set as red in getItemStyle ItemStyle, getEditItemStyle EditItemStyle will also have red background color unless it is set to a different value explicitly.

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, getItemStyle ItemStyle, getAlternatingItemStyle AlternatingItemStyle, getSelectedItemStyle SelectedItemStyle, and getEditItemStyle EditItemStyle. Therefore, if background color is set as red in getItemStyle ItemStyle, getEditItemStyle EditItemStyle will also have red background color unless it is set to a different value explicitly.

public
# renderBeginTag( THtmlWriter $writer )

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

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

Parameters

$writer
THtmlWriter
the writer used for the rendering purpose

Overrides

TWebControl::renderBeginTag()
public
# render( THtmlWriter $writer )

Renders the datagrid.

Renders the datagrid.

Parameters

$writer
THtmlWriter
writer for the rendering purpose

Overrides

TWebControl::render()
protected
# renderTable( THtmlWriter $writer )

Renders the tabular data.

Renders the tabular data.

Parameters

$writer
THtmlWriter
writer
Methods inherited from TBaseDataList
getCellPadding(), getCellSpacing(), getDataFieldValue(), getDataKeyField(), getDataKeys(), getGridLines(), getHorizontalAlign(), onSelectedIndexChanged(), setCellPadding(), setCellSpacing(), setDataKeyField(), setGridLines(), setHorizontalAlign()
Methods inherited from TDataBoundControl
createPagedDataSource(), dataBind(), dataSourceViewChanged(), determineDataSource(), ensureDataBound(), getAllowCustomPaging(), getAllowPaging(), getCurrentPageIndex(), getDataMember(), getDataSource(), getDataSourceID(), getDataSourceView(), getInitialized(), getIsDataBound(), getPageCount(), getPageSize(), getRequiresDataBinding(), getSelectParameters(), getUsingDataSourceID(), getVirtualItemCount(), onDataBound(), onDataSourceChanged(), onInit(), onPreRender(), pagePreLoad(), setAllowCustomPaging(), setAllowPaging(), setCurrentPageIndex(), setDataMember(), setDataSource(), setDataSourceID(), setInitialized(), setIsDataBound(), setPageSize(), setRequiresDataBinding(), setVirtualItemCount(), validateDataSource()
Methods inherited from TWebControl
addAttributesToRender(), clearStyle(), copyBaseAttributes(), getAccessKey(), getBackColor(), getBorderColor(), getBorderStyle(), getBorderWidth(), getCssClass(), getDecorator(), getDisplay(), getEnsureId(), getFont(), getForeColor(), getHasStyle(), getHeight(), getStyle(), getTabIndex(), getToolTip(), getWidth(), renderContents(), renderEndTag(), setAccessKey(), setBackColor(), setBorderColor(), setBorderStyle(), setBorderWidth(), setCssClass(), setDisplay(), setEnsureId(), setForeColor(), setHeight(), setStyle(), setTabIndex(), setToolTip(), setWidth()
Methods inherited from TControl
__construct(), __get(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createChildControls(), createControlCollection(), dataBindChildren(), dataBindProperties(), ensureChildControls(), findControl(), findControlsByID(), findControlsByType(), focus(), getAdapter(), getAllowChildControls(), getAttribute(), getAttributes(), getChildControlsCreated(), getClientID(), getControlStage(), getControlState(), getControls(), getCustomData(), getEnableTheming(), getEnableViewState(), getEnabled(), getHasAdapter(), getHasAttributes(), getHasChildInitialized(), getHasControls(), getHasInitialized(), getHasLoaded(), getHasLoadedPostData(), getHasPreRendered(), getID(), getIsSkinApplied(), getNamingContainer(), getPage(), getParent(), getRegisteredObject(), getSkinID(), getSourceTemplateControl(), getTemplateControl(), getUniqueID(), getViewState(), getVisible(), hasAttribute(), initRecursive(), isDescendentOf(), isObjectRegistered(), loadRecursive(), loadStateRecursive(), onDataBinding(), onLoad(), onUnload(), preRenderRecursive(), raiseBubbleEvent(), registerObject(), removeAttribute(), removedControl(), renderChildren(), renderControl(), saveStateRecursive(), setAdapter(), setAttribute(), setChildControlsCreated(), setControlStage(), setControlState(), setCustomData(), setEnableTheming(), setEnableViewState(), setEnabled(), setID(), setPage(), setSkinID(), setTemplateControl(), setViewState(), setVisible(), trackViewState(), traverseChildControls(), unbindProperty(), unloadRecursive(), unregisterObject()
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __destruct(), __isset(), __set(), __sleep(), __unset(), __wakeup(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants summary
string IT_HEADER 'Header'
#

datagrid item types

datagrid item types

Deprecated

deprecated since version 3.0.4. Use TListItemType constants instead.
string IT_FOOTER 'Footer'
#
string IT_ITEM 'Item'
#
string IT_SEPARATOR 'Separator'
#
string IT_ALTERNATINGITEM 'AlternatingItem'
#
string IT_EDITITEM 'EditItem'
#
string IT_SELECTEDITEM 'SelectedItem'
#
string IT_PAGER 'Pager'
#
string CMD_SELECT 'Select'
#

Command name that TDataGrid understands.

Command name that TDataGrid understands.

string CMD_EDIT 'Edit'
#
string CMD_UPDATE 'Update'
#
string CMD_DELETE 'Delete'
#
string CMD_CANCEL 'Cancel'
#
string CMD_SORT 'Sort'
#
string CMD_PAGE 'Page'
#
string CMD_PAGE_NEXT 'Next'
#
string CMD_PAGE_PREV 'Previous'
#
string CMD_PAGE_FIRST 'First'
#
string CMD_PAGE_LAST 'Last'
#
Constants inherited from TControl
AUTOMATIC_ID_PREFIX, CLIENT_ID_SEPARATOR, CS_CHILD_INITIALIZED, CS_CONSTRUCTED, CS_INITIALIZED, CS_LOADED, CS_PRERENDERED, CS_STATE_LOADED, ID_FORMAT, ID_SEPARATOR, IS_CHILD_CREATED, IS_CREATING_CHILD, IS_DISABLE_THEMING, IS_DISABLE_VIEWSTATE, IS_ID_SET, IS_SKIN_APPLIED, IS_STYLESHEET_APPLIED, RF_ADAPTER, RF_AUTO_BINDINGS, RF_CHILD_STATE, RF_CONTROLS, RF_CONTROLSTATE, RF_DATA_BINDINGS, RF_EVENTS, RF_NAMED_CONTROLS, RF_NAMED_CONTROLS_ID, RF_NAMED_OBJECTS, RF_SKIN_ID
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Properties inherited from TWebControl
$_decorator
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO