RadGrid for ASP.NET

RadGrid Send comments on this topic.
GridTableView Class Members
See Also  Properties  Methods  Events
Telerik.WebControls Namespace : GridTableView Class


The following tables list the members exposed by GridTableView.

Public Constructors

 NameDescription
Public ConstructorGridTableView ConstructorOverloaded.  Constructs a new GridTableView and sets as its owner the RadGrid object.  
Top

Public Properties

 NameDescription
Public PropertyAccessKey (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyAdditionalDataFieldNames Gets or sets values indicating DataFieldNames that should be sorted, grouped, etc and are not included as columns, in case the property RetrieveAllDataFields is false.  
Public PropertyAllowAutomaticDeletes Gets or sets a value indicating whether Telerik RadGrid will perform automatic deletes, i.e. using the DataSource controls functionality.  
Public PropertyAllowAutomaticInserts Gets or sets a value indicating whether Telerik RadGrid will perform automatic inserts, i.e. using the DataSource controls functionality.  
Public PropertyAllowAutomaticUpdates Gets or sets a value indicating whether Telerik RadGrid will perform automatic updates, i.e. using the DataSource controls functionality.  
Public PropertyAllowCustomPagingGets or sets if the custom paging feature is enabled.  
Public PropertyAllowCustomSortingGets or sets if the custom sorting feature is enabled.  
Public PropertyAllowFilteringByColumnGets or sets a value indicating whether the filtering by column feature is enabled.  
Public PropertyAllowMultiColumnSorting Gets or sets the value indicating wheather more than one column can be sorted in a single GridTableView. The order is the same as the sequence of expressions in SortExpressions.  
Public PropertyAllowNaturalSort Gets or sets the value indicated whether the no-sort state when changing sort order will be allowed.  
Public PropertyAllowPagingGets or sets a value indicating whether the paging feature is enabled.  
Public PropertyAllowSortingGets or sets a value indicating whether the sorting feature is enabled.  
Public PropertyAlternatingItemStyleGets a reference to the GridTableItemStyle object that allows you to set the appearance of alternating items in a GridTableView control.  
Public PropertyAppRelativeTemplateSourceDirectory (Inherited from System.Web.UI.Control)
Public PropertyAttributes (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyAutoGenerateColumns Gets or sets a value indicating whether Telerik RadGrid will automatically generate columns at runtime based on its DataSource.  
Public PropertyAutoGeneratedColumns Get an array of automatically generated columns. This array is available when RadGrid.AutoGenerateColumns is set to true. Autogenerated columns appear always after GridTableView.Columns when rendering.  
Public PropertyBackColor (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBorderColor (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBorderStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyBorderWidth (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyCaptionGets or sets a string that specifies a brief description of a GridTableView. Related to Telerik RadGrid accessibility compliance.  
Public PropertyCellPadding (Inherited from GridTableViewBase)
Public PropertyCellSpacing (Inherited from GridTableViewBase)
Public PropertyChildEditItems Gets all items among the hierarchy of GridTableView items that are in edit mode. The edit items in a GridTableView are cleared when ParentItem collapses.  
Public PropertyChildSelectedItems Gets all items among the hierarchy of GridTableView items that are selected. The selected items in a GridTableView are cleared when ParentItem collapses and the ParentItem becomes selected.  
Public PropertyClientID (Inherited from System.Web.UI.Control)
Public PropertyColumnsGets a collection of GridColumn objects that represent the column fields in a GridTableView control.  
Public PropertyCommandItemDisplay

Gets or sets the default position of the GridCommandItem as defined by the GridCommandItemDisplay. The possible values are:

  • None - this is the default value - the command item will not be rendered
  • Top - the command item will be rendered on the top of the grid
  • Bottom - the command item will be rendered on the bottom of the grid
  • TopAndBottom - the command item will be rendered both on top and bottom of the grid.
 
Public PropertyCommandItemSettingsGets a set the options for GridTableView's command item.  
Public PropertyCommandItemStyle Gets a referenct to the GridTableItemStyle object that allows you to set the appearance of the command item in a GridTableView control.  
Public PropertyCommandItemTemplateGets or sets the template that will be instantiated in the CommandItem. If this template is set, RadGrid will not create the default CommandItem controls.  
Public PropertyControls (Inherited from GridTableViewBase)
Public PropertyControlStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyControlStyleCreated (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyCssClass (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyCurrentPageIndex Gets or sets a value indicating the index of the currently active page in case paging is enabled (RadGrid.AllowPaging is true).  
Public PropertyCurrentResetPageIndexAction Gets or sets a value that describes how RadGrid would respond if the CurrentPageIndex is invalid when data-binding.  
Public PropertyDataKeyNames Gets or sets an array of data-field names that will be used to populate the DataKeyValues collection, when the GridTableView control is databinding.  
Public PropertyDataKeyValues Gets a collection of DataKeyValue objects that represent the data key value of the corresponding item (specified with its ItemIndex) and the DataKeyName (case-sensitive!). The DataKeyName should be one of the specified in the GridTableView.DataKeyNames array.  
Public PropertyDataMember (Inherited from System.Web.UI.WebControls.DataBoundControl)
Public PropertyDataSourceOverridden. Gets or sets the object from which the data-bound control retrieves its list of data items.  
Public PropertyDataSourceCountGets the number of pages if paging is enabled.  
Public PropertyDataSourceIDOverridden.  Gets or sets the ID of the DataSource control used for population of this GridTableView data items.  
Public PropertyDataSourcePersistenceMode Use this property to determine how DataSource of the GridTableView will be persisted on PostBack.  
Public PropertyDetailTablesGets or sets the collection of detail table views for this GridTableView.  
Public PropertyDir

Gets or sets the text direction. This property is related to Telerik RadGrid support for Right-To-Left lanugages. It has two possible vales defined by GridTableTextDirection enumeration:

  • LTR - left-to-right text
  • RTL - right-to-left text
 
Public PropertyEditFormSettings Gets a value defining the setting that will be applied when an Item is in edit mode and the GridTableView.EditMode property is set to EditForms.  
Public PropertyEditItemStyleGets a reference to the GridTableItemStyle object that allows you to set the appearance of the item selected for editing in a GridTableView control.  
Public PropertyEditModeFormsGets or sets a value indicating how a GridItem will look in edit mode.  
Public PropertyEnableColumnsViewState Gets or sets a value indicating whether all columns settings will be persisted in the ViewState or not.  
Public PropertyEnabled (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyEnableNoRecordsTemplate Gets or sets a value indicating whether RadGrid will show NoRecordsTemplate instead of the corresponding GridTableView if there is no items to display.  
Public PropertyEnableTheming (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyEnableViewState (Inherited from System.Web.UI.Control)
Public PropertyExpandCollapseColumn Gets a reference to the ExpandCollapseColumn object, allowing you to customize its settings.  
Public PropertyFilterExpressionGets or sets the filtering options for grid columns.  
Public PropertyFilterItemStyle Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the filter item in a GridTableView control.  
Public PropertyFont (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyFooterStyleManage visual style of the footer item.  
Public PropertyForeColor (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyFrameGets or sets a value specifying the frame table attribute.  
Public PropertyGridLinesOverridden.  Gets or sets a value indicating whether the border lines for grid cells will be displayed.  
Public PropertyGroupByExpressions Adding GridGroupByExpression to this collection will cause the current table-view to display items sorted and devided in groups separated by GridGroupHeaderItems, that display common group and aggregate field values. See Expression on details of expressions syntax.  
Public PropertyGroupHeaderItemStyleManage visual style of the group header items.  
Public PropertyGroupLoadMode

Specifies where the grouping will be handled. There are two options:

  • Server-side - GridTableView.GroupLoadMode.Server
  • Client-side - GridTableView.GroupLoadMode.Client
 
Public PropertyGroupsDefaultExpanded Gets or sets a value indicating whether the groups will be expanded on grid load (true by default).  
Public PropertyHasAttributes (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyHasDetailTables Gets a value indicating if the GridTableView instance has children (Detail) tables.  
Public PropertyHeaderStyleGets a reference to the GridTableItemStyle object that allows you to set the appearance of the header item in a GridTableView control.  
Public PropertyHeight (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyHierarchyDefaultExpanded Gets or sets a value indicating whether the hierarchy will be expanded by default.  
Public PropertyHierarchyIndex The unique hierarchy index of the current table view, generated when it is binding.  
Public PropertyHierarchyLoadMode Gets or sets a value indicating when the DataBind of the child GridTableView will occur when working in hierarchy mode. Accepts values from GridChildLoadMode enumeration. See the remars for details.  
Public PropertyHorizontalAlignOverridden. Gets or sets a value indicating the horizontal alignment of the grid table.  
Public PropertyIDOverridden.  Gets or sets the programmatic identifier assigned to the current GridTableView.  
Public PropertyIsItemInserted Gets or sets a value indicating if the GridTableView is currently in insert mode.  
Public PropertyItemsGets a collection of GridDataItem objects that represent the data items in a GridDataItem control.  
Public PropertyItemsCreated Indicates whether the items have been created, generally by data-binding.  
Public PropertyItemsHierarchy Gets a collection of all data items of a grid table view and items that belong to child tables of the GridTableView if the hierarchy is expanded. The items are collected depth-first. The property RadGrid.Items actually referres to ItemsHierarchy of
RadGrid.MasterTableView. This property can be used to traverse all
DataItems items in the hiearchy of a GridTableView.  
Public PropertyItemStyleGets a reference to the GridTableItemStyle object that allows you to set the appearance of items in a GridTableView control.  
Public PropertyName Gets or sets the name of the GridTableView.  
Public PropertyNamingContainer (Inherited from System.Web.UI.Control)
Public PropertyNoDetailRecordsText Gets or sets the text that will be displayed in there is no NoRecordsTemplate defined and no records in the Detail tables.  
Public PropertyNoMasterRecordsText Gets or sets the text that will be displayed in there is no NoRecordsTemplate defined and no records in the MasterTableView.  
Public PropertyNoRecordsTemplateGets or sets the template that will be displayed if a GridTableView control is bound to a data source that does not contain any records.  
Public PropertyOwnerGridGets the owner RadGrid object. (Inherited from GridTableViewBase)
Public PropertyOwnerIDGets the ClientID of the RadGrid object that contains this instance.  
Public PropertyPage (Inherited from System.Web.UI.Control)
Public PropertyPageCountGets the number of pages required to display the records of the data source in a GridTableView control.  
Public PropertyPagerStyle Gets a reference to the GridPagerStyle object that allows you to set the appearance of the pager item in a GridTableView control.  
Public PropertyPagerTemplateGets or sets the custom content for the pager item in a GridTableView control.  
Public PropertyPageSize Specify the maximum number of items that would appear in a page, when paging is enabled by AllowPaging or AllowCustomPaging property. Default value is the value of RadGrid.PageSize.  
Public PropertyPagingManager Gets a Paging object that is the result of paging settings and runtime paging state of the grid.  
Public PropertyParent (Inherited from System.Web.UI.Control)
Public PropertyParentItem Gets a reference to a GridItem that is a parent of this GridTableView, when this GridTableView represents a child table in a hierarchical structure.  
Public PropertyParentTableRelation Gets or sets the collection of data-field pairs that describe the relations in a hierarchical grid.  
Public PropertyRenderActiveItemStyleGets the rendering style of an ActiveItem.  
Public PropertyRenderAlternatingItemStyleGets the rendering style of the AlternatingItem.  
Public PropertyRenderColumns Gets an array of all columns that are used when rendering the grid instance.  
Public PropertyRenderCommandItemStyleGets the rendering style of a CommandItem.  
Public PropertyRenderEditItemStyleGets the rendering style of an edit Item.  
Public PropertyRenderFilterItemStyleGets the rendering style of a FilterItem.  
Public PropertyRenderFooterStyleGets the rendering style of an FooterItem.  
Public PropertyRenderGroupHeaderItemStyleGets the rendering style of the group header items.  
Public PropertyRenderHeaderStyleGets the rendering style of a GridHeaderItem.  
Public PropertyRenderItemStyleGets the rendering style of an Item.  
Public PropertyRenderPagerStyleGets the rendering style of the Pager item.  
Public PropertyRequiresBinding Gets or sets a value indicating whether RadGrid will be built on PreRender unless it was built before that. This property is supposed for Telerik RadGrid internal usage, yet you can set it with care.  
Public PropertyResolvedDataSourceView Gets a DataView object that represents the data sent to the GridTableView to be displayed.  
Public PropertyRetrieveAllDataFieldsGets or sets a value indicating whether the GridTableView will extract all bindable properties from the DataSource when binding, to perform operations like sorting, grouping, etc on DataFields that are not included in the column declarations.  
Public PropertyRetrieveNullAsDBNullGets or sets a value indicating whether null values in the database will be retrieved as dbnull values.  
Public PropertyRowIndicatorColumn Gets a reference to the RowIndicatorColumn object, allowing you to customize its settings.  
Public PropertySelectedItemStyle Gets a reference to the Style object that allows you to set the appearance of the selected item in a GridTableView control.  
Public PropertySelfHierarchySettings Gets a set the options for GridTableView's self-hierarchy behavior.  
Public PropertyShowFooter Gets or sets a value indicating if the GridFooterItem will be shown in the current GridTableView.  
Public PropertyShowHeader Gets or sets a value indicating if the GridHeaderItem will be shown in the current GridTableView.  
Public PropertyShowHeadersWhenNoRecords If set to true (the default) GridNoRecordsItem is used to display no records template. This item is the only one displayed in the GridTableView in this case.  
Public PropertySite (Inherited from System.Web.UI.Control)
Public PropertySkinID (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertySortExpressions Gets a collection of sort expressions for this table view instance, associated with the column or columns being sorted.  
Public PropertyStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertySummaryGets or sets the 'summary' attribute for the respective table.  
Public PropertyTabIndex (Inherited from GridTableViewBase)
Public PropertyTableLayoutGets or sets a string that indicates whether the table layout is fixed.  
Public PropertyTemplateControl (Inherited from System.Web.UI.Control)
Public PropertyTemplateSourceDirectory (Inherited from System.Web.UI.Control)
Public PropertyToolTip (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyUniqueID (Inherited from System.Web.UI.Control)
Public PropertyVirtualItemCountGets or sets a value, indicating the number of items that will be shown when custom paging is used.

Gets or sets a value, indicating the total number of items in the data source when custom paging is used. Thus the grid "understands" that the data source contains the specified number of records and it should fetch merely part of them at a time to execute requested operation.

 
Public PropertyVisible (Inherited from System.Web.UI.Control)
Public PropertyWidth (Inherited from System.Web.UI.WebControls.WebControl)
Top

Public Methods

 NameDescription
Public MethodApplyStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodApplyStyleSheetSkin (Inherited from System.Web.UI.Control)
Public MethodClearEditItems Removes all edit items that belong to the GridTableView instance.  
Public MethodClearSelectedItems Removes all selected items that belong to this GridTableView instance.  
Public MethodCopyBaseAttributes (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodCreateColumnSetOverloaded. For internal usage.  
Public MethodDataBindOverridden. Binds the data source to the RadGrid instance.  
Public MethodDispose (Inherited from System.Web.UI.Control)
Public MethodExportToCSV Exports the grid data in CSV format using the properties set in the ExportSettings.  
Public MethodExportToExcelOverloaded.  Exports the grid data in Microsoft Excel ® format using the properties set in the ExportSettings.  
Public MethodExportToExcel2007Overloaded.  Exports the grid data in Microsoft Excel 2007 ® format using the properties set in the ExportSettings.  
Public MethodExportToPdf Exports the grid data in PDF format using the properties set in the ExportSettings.  
Public MethodExportToWordOverloaded.  Exports the grid data in Microsoft Word ® format based on the selected ExportSettings.  
Public MethodExportToWord2007Overloaded.  Exports the grid data in Microsoft Word 2007 ® format based on the selected ExportSettings.  
Public MethodExtractValuesFromItem The passed IDictionary object (like Hashtable for example) will be filled with the names/values of the corresponding column data-fields and their values. Only instances of type GridEditableColumn support extracting values.  
Public MethodFindControl (Inherited from System.Web.UI.Control)
Public MethodFindItemByKeyValue  
Public MethodFindItemsByKeyValues  
Public MethodFocus (Inherited from System.Web.UI.Control)
Public MethodGetColumn Returns a GridColumn based on its GridColumn.UniqueName.  
Public MethodGetColumnSafe Returns a GridColumn based on its GridColumn.UniqueName.  
Public MethodGetInsertItem Get the item that appears when grid is in Insert Mode.  
Public MethodGetItems Returns a collection of GridItem objects based on their GridItem.ItemType.  
Public MethodHasControls (Inherited from System.Web.UI.Control)
Public MethodInsertItemOverloaded.  Places the GridTableView in insert mode, allowing user to insert a new data-item values. The CurrentPageIndex will be set to display the last page. You can use also the IsItemInserted to place the GridTableView in insert mode.  
Public MethodMergeStyle (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodPerformDeleteOverloaded.  Perform asynchronous delete operation, using the DataSourceControl API the Rebinds the grid. Please make sure you have specified the correct DataKeyNames for the GridTableView. When the asynchronous operation calls back, RadGrid will fire RadGrid.ItemDeleted event.  
Public MethodPerformInsertOverloaded.  Perform asynchronous insert of the new item, diplayed by RadGrid when in edit mode, using the DataSourceControl API, then Rebind. When the asynchronous operation calls back, RadGrid will fire RadGrid.ItemInserted event.  
Public MethodPerformUpdateOverloaded.  Perform asynchronous update operation, using the DataSource control API and the Rebind method. Please, make sure you have specified the correct DataKeyNames for the GridTableView. When the asynchronous operation calls back, RadGrid will fire RadGrid.ItemUpdated event.  
Public MethodRebind Forces the Owner RadGrid to fire RadGrid.NeedDataSource event then calls DataBind.  
Public MethodRenderBeginTag (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodRenderControl (Inherited from System.Web.UI.Control)
Public MethodRenderEndTag (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodResolveClientUrl (Inherited from System.Web.UI.Control)
Public MethodResolveUrl (Inherited from System.Web.UI.Control)
Public MethodSetRenderMethodDelegate (Inherited from System.Web.UI.Control)
Public MethodSwapColumnsOverloaded.  Swaps columns appearance position using the unique names of the two columns.  
Top

Public Events

 NameDescription
Public EventDataBinding (Inherited from System.Web.UI.Control)
Public EventDataBound (Inherited from System.Web.UI.WebControls.BaseDataBoundControl)
Public EventDisposed (Inherited from System.Web.UI.Control)
Public EventInit (Inherited from System.Web.UI.Control)
Public EventLoad (Inherited from System.Web.UI.Control)
Public EventPreRender (Inherited from System.Web.UI.Control)
Public EventSelectedIndexChanged (Inherited from GridTableViewBase)
Public EventUnload (Inherited from System.Web.UI.Control)
Top

See Also