Class Finder
Properties
 NameTypeDescription
  AccessKey string the access key of the control. (inherited from TWebControl)
  Adapter TControlAdapter control adapter. (inherited from TControl)
R AllowChildControls boolean whether body contents are allowed for this control. (inherited from TControl)
  AllowCustomPaging boolean whether the custom paging is enabled. (inherited from TDataBoundControl)
  AllowPaging boolean whether paging is enabled. (inherited from TDataBoundControl)
  AllowSorting boolean whether sorting is enabled.
R AlternatingItemStyle TTableItemStyle the style for each alternating item.
R Application TApplication current application instance. (inherited from TApplicationComponent)
R Attributes TAttributeCollection Returns the list of custom attributes. (inherited from TControl)
R AutoColumns TDataGridColumnCollection automatically generated datagrid columns.
  AutoGenerateColumns boolean whether datagrid columns should be automatically generated.
  BackColor string the background color of the control. (inherited from TWebControl)
  BackImageUrl string the URL of the background image for the datagrid.
  BorderColor string the border color of the control. (inherited from TWebControl)
  BorderStyle string the border style of the control. (inherited from TWebControl)
  BorderWidth string the border width of the control. (inherited from TWebControl)
R BottomPager TDataGridPager the pager displayed at the bottom of datagrid.
  Caption string caption for the datagrid.
  CaptionAlign TTableCaptionAlign datagrid caption alignment.
  CellPadding integer the cellpadding for the table layout. (inherited from TBaseDataList)
  CellSpacing integer the cellspacing for the table layout. (inherited from TBaseDataList)
P ChildControlsCreated boolean whether child controls have been created. (inherited from TControl)
R ClientID string Returns the client ID of the control. (inherited from TControl)
R Columns TDataGridColumnCollection manually specified datagrid columns.
P ControlStage integer Gets the lifecycle step the control is currently at. (inherited from TControl)
R Controls TControlCollection the child control collection. (inherited from TControl)
  CssClass string the css class of the control. (inherited from TWebControl)
  CurrentPageIndex integer the zero-based index of the current page. (inherited from TDataBoundControl)
  CustomData mixed Returns custom data associated with this control. (inherited from TControl)
  DataKeyField string the field of the data source that provides the keys of the list items. (inherited from TBaseDataList)
R DataKeys TList the keys used in the data listing control. (inherited from TBaseDataList)
  DataMember {unknown} . (inherited from TDataBoundControl)
  DataSource Traversable data source object, defaults to null. (inherited from TDataBoundControl)
  DataSourceID string ID path to the data source control. (inherited from TDataBoundControl)
RP DataSourceView {unknown} . (inherited from TDataBoundControl)
  Display TDisplayStyle display style of the control, default is TDisplayStyle::Fixed. (inherited from TWebControl)
R EditItem TDataGridItem the edit item.
  EditItemIndex integer the zero-based index of the edit item in Items.
R EditItemStyle TTableItemStyle the style for edit item.
  EmptyTemplate ITemplate the template applied when no data is bound to the datagrid.
  EnableTheming boolean whether theming is enabled for this control. (inherited from TControl)
  EnableViewState boolean whether viewstate is enabled. (inherited from TControl)
  Enabled boolean Returns a value indicating whether the control is enabled. (inherited from TControl)
R Font TFont the font of the control. (inherited from TWebControl)
R Footer TDataGridItem the footer item.
R FooterStyle TTableItemStyle the style for footer.
  ForeColor string the foreground color of the control. (inherited from TWebControl)
  GridLines TTableGridLines the grid line setting of the table layout. (inherited from TBaseDataList)
R HasAdapter boolean whether there is an adapter for this control. (inherited from TControl)
R HasAttributes boolean whether the control has custom attributes. (inherited from TControl)
R HasChildInitialized boolean true if the child control has been initialized. (inherited from TControl)
R HasControls boolean whether the control has child controls. (inherited from TControl)
R HasInitialized boolean true if the onInit event has raised. (inherited from TControl)
R HasLoaded boolean true if the onLoad event has raised. (inherited from TControl)
R HasLoadedPostData boolean true if the control has loaded post data. (inherited from TControl)
R HasPreRendered boolean true if onPreRender event has raised. (inherited from TControl)
R HasStyle boolean whether the control has defined any style information. (inherited from TWebControl)
R Header TDataGridItem the header item.
R HeaderStyle TTableItemStyle the style for header.
  Height string the height of the control. (inherited from TWebControl)
  HorizontalAlign THorizontalAlign the horizontal alignment of the table content. (inherited from TBaseDataList)
  ID string Returns the id of the control. (inherited from TControl)
P Initialized boolean whether the databound control has been initialized. (inherited from TDataBoundControl)
P IsDataBound boolean whether databind has been invoked in the previous page request. (inherited from TDataBoundControl)
R ItemCount integer number of items.
R ItemStyle TTableItemStyle the style for every item.
R Items TDataGridItemCollection datagrid item collection.
R NamingContainer TControl the naming container of this control. (inherited from TControl)
  Page TPage the page that contains this control. (inherited from TControl)
R PageCount integer number of pages of data items available. (inherited from TDataBoundControl)
  PageSize integer the number of data items on each page. (inherited from TDataBoundControl)
R PagerStyle TDataGridPagerStyle the style for pager.
R Parent TControl the parent of this control. (inherited from TControl)
R Request THttpRequest the current user request. (inherited from TApplicationComponent)
P RequiresDataBinding boolean whether a databind call is required (by the data bound control). (inherited from TDataBoundControl)
R Response THttpResponse the response. (inherited from TApplicationComponent)
R SelectParameters {unknown} . (inherited from TDataBoundControl)
R SelectedItem TDataGridItem the selected item, null if no item is selected.
  SelectedItemIndex integer the zero-based index of the selected item in Items.
R SelectedItemStyle TTableItemStyle the style for selected item.
R Service IService the current service. (inherited from TApplicationComponent)
R Session THttpSession user session. (inherited from TApplicationComponent)
  ShowFooter boolean whether the footer should be displayed.
  ShowHeader boolean whether the header should be displayed.
  SkinID string the skin ID of this control, '' if not set. (inherited from TControl)
R SourceTemplateControl TTemplateControl the control whose template is loaded from some external storage, such as file, db, and whose template ultimately contains this control. (inherited from TControl)
  Style TStyle the object representing the css style of the control. (inherited from TWebControl)
  TabIndex integer the tab index of the control. (inherited from TWebControl)
R TableBodyStyle TStyle the style for tbody element, if any @since 3.
R TableFootStyle TStyle the style for tfoot element, if any @since 3.
R TableHeadStyle TStyle the style for thead element, if any @since 3.
RP TagName string tag name (table) of the datagrid.
  TemplateControl TTemplateControl the control whose template contains this control. (inherited from TControl)
  ToolTip string the tooltip of the control. (inherited from TWebControl)
R TopPager TDataGridPager the pager displayed at the top of datagrid.
R UniqueID string Returns a unique ID that identifies the control in the page hierarchy. (inherited from TControl)
R User IUser information about the current user. (inherited from TApplicationComponent)
RP UsingDataSourceID boolean if the databound control uses the data source specified by setDataSourceID, or it uses the data source object specified by setDataSource. (inherited from TDataBoundControl)
  VirtualItemCount integer virtual number of data items in the data source. (inherited from TDataBoundControl)
  Visible boolean Checks if a control is visible. (inherited from TControl)
  Width string the width of the control. (inherited from TWebControl)
Events
NameDescription
OnCancelCommand Raises OnCancelCommand event.
OnDataBinding Raises 'OnDataBinding' event. (inherited from TControl)
OnDataBound Raises OnDataBound event. (inherited from TDataBoundControl)
OnDataSourceChanged Sets RequiresDataBinding as true if the control is initialized. (inherited from TDataBoundControl)
OnDeleteCommand Raises OnDeleteCommand event.
OnEditCommand Raises OnEditCommand event.
OnInit Sets page's OnPreLoad event handler as pagePreLoad. (inherited from TDataBoundControl)
OnItemCommand Raises OnItemCommand event.
OnItemCreated Raises OnItemCreated event.
OnItemDataBound Raises OnItemDataBound event.
OnLoad This method is invoked when the control enters 'OnLoad' stage. (inherited from TControl)
OnPageIndexChanged Raises OnPageIndexChanged event.
OnPagerCreated Raises OnPagerCreated event.
OnPreRender Ensures any pending databind is performed. (inherited from TDataBoundControl)
OnSelectedIndexChanged Raises OnSelectedIndexChanged event. (inherited from TBaseDataList)
OnSortCommand Raises OnSortCommand event.
OnUnload This method is invoked when the control enters 'OnUnload' stage. (inherited from TControl)
OnUpdateCommand Raises OnUpdateCommand event.
Methods
 NameDescription
P addAttributesToRender Adds attribute name-value pairs to renderer. (inherited from TWebControl)
  addParsedObject Adds objects parsed in template to datagrid.
P addToPostDataLoader Add controls implementing IPostBackDataHandler to post data loaders. (inherited from TControl)
  addedControl Adds a control into the child collection of the control. (inherited from TControl)
P applyItemStyles Applies styles to items, header, footer and separators.
  applyStyleSheetSkin Applies a stylesheet skin to a control. (inherited from TControl)
  attachEventHandler Attaches an event handler to an event. (inherited from TComponent)
  autoBindProperty Sets up the binding between a property (or property path) and an expression. (inherited from TControl)
P autoDataBindProperties Auto databinding properties of the control. (inherited from TControl)
  bindProperty Sets up the binding between a property (or property path) and an expression. (inherited from TControl)
  broadcastEvent Broadcasts an event. (inherited from TControl)
  bubbleEvent This method overrides parent's implementation to handle OnItemCommand event which is bubbled from TDataGridItem child controls.
P buildNextPrevPager Builds a next-prev pager .
P buildNumericPager Builds a numeric pager .
P buildPager Builds the pager content based on pager style.
  canGetProperty Determines whether a property can be read. (inherited from TComponent)
  canSetProperty Determines whether a property can be set. (inherited from TComponent)
P clearChildState Clears up the child state data. (inherited from TControl)
P clearControlState Clears a controlstate value. (inherited from TControl)
  clearNamingContainer Resets the control as a naming container. (inherited from TControl)
  clearStyle Removes all style data. (inherited from TWebControl)
  clearViewState Clears a viewstate value. (inherited from TControl)
S convertUniqueIdToClientId Converts a unique ID to a client ID. (inherited from TControl)
  copyBaseAttributes Copies basic control attributes from another control. (inherited from TWebControl)
P createAutoColumns Automatically generates datagrid columns based on datasource schema .
  createChildControls Creates child controls. (inherited from TControl)
P createControlCollection Creates a control collection object that is to be used to hold child controls . (inherited from TControl)
P createItem Creates a datagrid item instance based on the item type and index.
P createPagedDataSource creates a paged data source. (inherited from TDataBoundControl)
P createPagerButton Creates a pager button.
P createStyle Creates a style object for the control.
  createdOnTemplate This method is invoked after the component is instantiated by a template. (inherited from TComponent)
  dataBind Performs databinding. (inherited from TDataBoundControl)
P dataBindChildren Databinding child controls. (inherited from TControl)
P dataBindProperties Databinding properties of the control. (inherited from TControl)
  dataSourceViewChanged . (inherited from TDataBoundControl)
  detachEventHandler Detaches an existing event handler. (inherited from TComponent)
P determineDataSource . (inherited from TDataBoundControl)
  ensureChildControls Ensures child controls are created. (inherited from TControl)
P ensureDataBound Ensures any pending dataBind is called. (inherited from TDataBoundControl)
  evaluateExpression Evaluates a PHP expression in the context of this control. (inherited from TComponent)
  evaluateStatements Evaluates a list of PHP statements. (inherited from TComponent)
  findControl Finds a control by ID path within the current naming container. (inherited from TControl)
  findControlsByID Finds all child and grand-child controls with the specified ID. (inherited from TControl)
  findControlsByType Finds all child and grand-child controls that are of the specified type. (inherited from TControl)
  focus Sets input focus to this control. (inherited from TControl)
  getAttribute attribute value, null if attribute does not exist. (inherited from TControl)
P getControlState Returns a controlstate value. (inherited from TControl)
P getDataFieldValue Returns the value of the data at the specified field. (inherited from TBaseDataList)
  getEventHandlers Returns the list of attached event handlers for an event. (inherited from TComponent)
  getRegisteredObject Returns the named registered object. (inherited from TControl)
  getSubProperty Evaluates a property path. (inherited from TComponent)
  getViewState Returns a viewstate value. (inherited from TControl)
  hasAttribute whether the named attribute exists. (inherited from TControl)
  hasEvent Determines whether an event is defined. (inherited from TComponent)
  hasEventHandler whether an event has been attached one or several handlers. (inherited from TComponent)
  hasProperty Determines whether a property is defined. (inherited from TComponent)
P initRecursive Performs the Init step for the control and all its child controls. (inherited from TControl)
P initializeItem Initializes a datagrid item and cells inside it .
P isDescendentOf if the control is a descendent (parent, parent of parent, etc. (inherited from TControl)
  isObjectRegistered whether an object has been registered with the name @see registerObject. (inherited from TControl)
P loadRecursive Performs the Load step for the control and all its child controls. (inherited from TControl)
  loadState Loads item count information from viewstate.
P loadStateRecursive Loads state (viewstate and controlstate) into a control and its children. (inherited from TControl)
  pagePreLoad Sets getInitialized as true. (inherited from TDataBoundControl)
P performDataBinding Performs databinding to populate datagrid items from data source.
P preRenderRecursive Performs the PreRender step for the control and all its child controls. (inherited from TControl)
  publishAsset Publishes a private asset and gets its URL. (inherited from TApplicationComponent)
  publishFilePath Publishes a file or directory and returns its URL. (inherited from TApplicationComponent)
P raiseBubbleEvent Invokes the parent's bubbleEvent method. (inherited from TControl)
  raiseEvent Raises an event. (inherited from TComponent)
  registerObject Registers an object by a name. (inherited from TControl)
  removeAttribute Removes the named attribute. (inherited from TControl)
  removedControl Removes a control from the child collection of the control. (inherited from TControl)
  render Renders the datagrid.
  renderBeginTag Renders the openning tag for the datagrid control which will render table caption if present.
  renderChildren Renders the children of the control. (inherited from TControl)
  renderContents Renders the body content enclosed between the control tag. (inherited from TWebControl)
  renderControl Renders the control. (inherited from TControl)
  renderEndTag Renders the closing tag for the control . (inherited from TWebControl)
P renderTable Renders the tabular data.
  reset Clears up all items in the datagrid.
P restoreGridFromViewState Restores datagrid content from viewstate.
  saveState Saves item count in viewstate.
P saveStateRecursive Saves all control state (viewstate and controlstate) as a collection. (inherited from TControl)
  setAttribute Sets a custom control attribute. (inherited from TControl)
P setControlState Sets a controlstate value. (inherited from TControl)
  setSubProperty Sets a value to a property path. (inherited from TComponent)
  setViewState Sets a viewstate value. (inherited from TControl)
  trackViewState Sets a value indicating whether we should keep data in viewstate. (inherited from TControl)
P traverseChildControls Traverse the whole control hierarchy rooted at this control. (inherited from TControl)
  unbindProperty Breaks the binding between a property (or property path) and an expression. (inherited from TControl)
P unloadRecursive Performs the Unload step for the control and all its child controls. (inherited from TControl)
  unregisterObject Unregisters an object by name. (inherited from TControl)
P validateDataSource Validates if the parameter is a valid data source. (inherited from TDataBoundControl)
Derived classes