Click or drag to resize
GridTableView Properties

The GridTableView type exposes the following members.

Properties
  Name Description
Public property AdditionalDataFieldNames
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 property AllowAutomaticDeletes
Gets or sets a value indicating whether Kettic KaxGrid will perform automatic deletes, i.e. using the DataSource controls functionality.
Public property AllowAutomaticInserts
Gets or sets a value indicating whether Kettic KaxGrid will perform automatic inserts, i.e. using the DataSource controls functionality.
Public property AllowAutomaticUpdates
Gets or sets a value indicating whether Kettic KaxGrid will perform automatic updates, i.e. using the DataSource controls functionality.
Public property AllowCustomPaging
Gets or sets if the custom paging feature is enabled.
Public property AllowCustomSorting
Gets or sets if the custom sorting feature is enabled.
Public property AllowFilteringByColumn

Gets or sets a value indicating whether the filtering by column feature is enabled.

Public property AllowMultiColumnSorting
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 property AllowNaturalSort
Gets or sets the value indicated whether the no-sort state when changing sort order will be allowed.
Public property AllowPaging

Gets or sets a value indicating whether the paging feature is enabled.

Public property AllowSorting

Gets or sets a value indicating whether the sorting feature is enabled.

Public property AlternatingItemStyle

Gets a reference to the GridTableItemStyle object that allows you to set the appearance of alternating items in a GridTableView control.

Public property AutoGenerateColumns
Gets or sets a value indicating whether Kettic KaxGrid will automatically generate columns at runtime based on its DataSource.
Public property AutoGeneratedColumns
Get an array of automatically generated columns. This array is available when AutoGenerateColumns is set to true. Autogenerated columns appear always after Columns when rendering.
Public property CanRetrieveAllData

Gets or sets a value indicating whether Kettic KaxGrid should retrieve all data and ignore server paging in case of filtering or grouping.

Public property Caption

Gets or sets a string that specifies a brief description of a GridTableView. Related to Kettic KaxGrid accessibility compliance.

Public property ChildEditItems

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 property ChildSelectedItems

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 property ClientDataKeyNames
Public property ClientID (Overrides ControlClientID.)
Public property Columns

Gets a collection of GridColumn objects that represent the column fields in a GridTableView control.

Public property CommandItemDisplay

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 property CommandItemSettings
Gets a set the options for GridTableView's command item.
Public property CommandItemStyle
Gets a referenct to the GridTableItemStyle object that allows you to set the appearance of the command item in a GridTableView control.
Public property CommandItemTemplate

Gets or sets the template that will be instantiated in the CommandItem. If this template is set, KaxGrid will not create the default CommandItem controls.

Public property CurrentPageIndex
Gets or sets a value indicating the index of the currently active page in case paging is enabled (AllowPaging is true).
Public property CurrentResetPageIndexAction

Gets or sets a value that describes how KaxGrid would respond if the CurrentPageIndex is invalid when data-binding.

Public property DataKeyNames

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 property DataKeyValues
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 DataKeyNames array.
Public property DataSource

Gets or sets the object from which the data-bound control retrieves its list of data items.

(Overrides BaseDataBoundControlDataSource.)
Public property DataSourceCount
Gets the number of pages if paging is enabled.
Public property DataSourceID
Gets or sets the data source id in KaxGrid.
(Overrides DataBoundControlDataSourceID.)
Public property DetailTables

Gets or sets the collection of detail table views for this GridTableView

Public property Dir

Gets or sets the text direction. This property is related to Kettic KaxGrid 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 property EditFormSettings
Gets a value defining the setting that will be applied when an Item is in edit mode and the EditMode property is set to EditForms.
Public property EditItemStyle

Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the item selected for editing in a GridTableView control.

Public property EditItemTemplate
Gets or sets the EditItemTemplate, which is rendered in the control in edit mode.
Public property EditMode

FormsGets or sets a value indicating how a GridItem will look in edit mode.

Public property EnableColumnsViewState
Gets or sets a value indicating whether all columns settings will be persisted in the ViewState or not.
Public property EnableHeaderContextFilterMenu

Gets or sets a value indicating whether the header context filter menu should be enabled.

Public property EnableHeaderContextMenu

Gets or sets a value indicating whether the header context menu should be enabled.

Public property EnableNoRecordsTemplate
Gets or sets a value indicating whether KaxGrid will show NoRecordsTemplate instead of the corresponding GridTableView if there is no items to display.
Public property ExpandCollapseColumn
Gets a reference to the ExpandCollapseColumn object, allowing you to customize its settings.
Public property FilterExpression

Gets or sets the filtering options for grid columns.

Public property FilterItemStyle
Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the filter item in a GridTableView control.
Public property FooterStyle
Manage visual style of the footer item.
Public property Frame
Gets or sets a value specifying the frame table attribute.
Public property GridLines
Gets or sets an enumeration value, indicating the appearance of the data table border between cells.
(Overrides GridTableViewBaseGridLines.)
Public property GroupByExpressions
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 property GroupHeaderItemStyle
Manage visual style of the group header items.
Public property GroupLoadMode

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

  • Server-side - GridTableView.GroupLoadMode.Server
  • Client-side - GridTableView.GroupLoadMode.Client
Public property GroupsDefaultExpanded
Gets or sets a value indicating whether the groups will be expanded on grid load (true by default).
Public property HasDetailTables
Gets a value indicating if the GridTableView instance has children (Detail) tables.
Public property HeaderStyle

Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the header item in a GridTableView control.

Public property HierarchyDefaultExpanded
Gets or sets a value indicating whether the hierarchy will be expanded by default. The default value of the property is false.
Public property HierarchyIndex
The unique hierarchy index of the current table view, generated when it is binding.
Public property HierarchyLoadMode

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 property HorizontalAlign
Gets or sets horizontal alignment style in the data table.
(Overrides GridTableViewBaseHorizontalAlign.)
Public property ID
Gets or sets the programmatic identifier assigned to the current GridTableView.
(Overrides ControlID.)
Public property InsertItemDisplay
Public property InsertItemPageIndexAction
Public property IsFilterItemExpanded
Public property IsItemInserted
Gets or sets a value indicating if the GridTableView is currently in insert mode.
Public property Items

Gets a collection of GridDataItem objects that represent the data items in a GridDataItem control.

Public property ItemsCreated
Indicates whether the items have been created, generally by data-binding.
Public property ItemsHierarchy

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 Items actually referres to ItemsHierarchy of
MainView. This property can be used to traverse all
DataItems items in the hiearchy of a GridTableView.

Public property ItemStyle

Gets a reference to the GridTableItemStyle object that allows you to set the appearance of items in a GridTableView control.

Public property ItemTemplate
Gets or sets the ItemTemplate, which is rendered in the control in normal (non-Edit) mode.
Public property Name
Gets or sets the name of the GridTableView.
Public property NestedViewSettings
Gets a set of options for the GridTableView's data-bound nested view template.
Public property NestedViewTemplate
Gets or sets the ItemTemplate, which is rendered in the control in normal (non-Edit) mode.
Public property NoDetailRecordsText
Gets or sets the text that will be displayed in there is no NoRecordsTemplate defined and no records in the Detail tables.
Public property NoMasterRecordsText
Gets or sets the text that will be displayed in there is no NoRecordsTemplate defined and no records in the MainView.
Public property NoRecordsTemplate

Gets 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 property OverrideDataSourceControlSorting
Gets or sets a value indicating if the GridTableView should override the default DataSourceControl sorting with grid native sorting.
Public property OwnerID
Gets the ClientID of the KaxGrid object that contains this instance.
Public property PageCount

Gets the number of pages required to display the records of the data source in a GridTableView control.

Public property PagerStyle
Gets a reference to the GridPagerStyle object that allows you to set the appearance of the pager item in a GridTableView control.
Public property PagerTemplate

Gets or sets the custom content for the pager item in a GridTableView control.

Public property PageSize

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 PageSize.

Public property PagingManager
Gets a Paging object that is the result of paging settings and runtime paging state of the grid.
Public property ParentItem
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 property ParentTableRelation
Gets or sets the collection of data-field pairs that describe the relations in a hierarchical grid.
Public property RenderActiveItemStyle
Gets the rendering style of an ActiveItem.
Public property RenderAlternatingItemStyle
Gets the rendering style of the AlternatingItem.
Public property RenderColumns
Gets an array of all columns that are used when rendering the grid instance.
Public property RenderCommandItemStyle
Gets the rendering style of a CommandItem.
Public property RenderEditItemStyle
Gets the rendering style of an edit Item.
Public property RenderFilterItemStyle
Gets the rendering style of a FilterItem.
Public property RenderFooterStyle
Gets the rendering style of an FooterItem.
Public property RenderGroupHeaderItemStyle
Gets the rendering style of the group header items.
Public property RenderHeaderStyle
Gets the rendering style of a GridHeaderItem.
Public property RenderItemStyle
Gets the rendering style of an Item.
Public property RenderPagerStyle
Gets the rendering style of the Pager item.
Public property RequiresBinding
Gets or sets a value indicating whether KaxGrid will be built on PreRender unless it was built before that. This property is supposed for Kettic KaxGrid internal usage, yet you can set it with care.
Public property ResolvedDataSourceView
Gets a DataView object that represents the data sent to the GridTableView to be displayed.
Public property RetrieveAllDataFields

Gets 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 property RetrieveDataTypeFromFirstItem
Gets or sets a value indicating whether items' data type should be retrieved from supplied enumerable's first item.
Public property RetrieveNullAsDBNull

Gets or sets a value indicating whether null values in the database will be retrieved as dbnull values.

Public property RowIndicatorColumn
Gets a reference to the RowIndicatorColumn object, allowing you to customize its settings.
Public property SelectedItemStyle
Gets a reference to the Style object that allows you to set the appearance of the selected item in a GridTableView control.
Public property SelfHierarchySettings
Gets a set the options for GridTableView's self-hierarchy behavior.
Public property ShowFooter
Gets or sets a value indicating if the GridFooterItem will be shown in the current GridTableView.
Public property ShowGroupFooter
Gets or sets a value indicating if the GridGroupFooterItem will be shown in the current GridTableView.
Public property ShowHeader
Gets or sets a value indicating if the GridHeaderItem will be shown in the current GridTableView.
Public property ShowHeadersWhenNoRecords
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 property SortExpressions
Gets a collection of sort expressions for this table view instance, associated with the column or columns being sorted.
Public property Summary
Gets or sets the 'summary' attribute for the respective table.
Public property TableLayout
Gets or sets a string that indicates whether the table layout is fixed.
Public property UseAllDataFields

Gets or sets a value indicating whether the GridTableView should use all retieved properties from the DataSource when binding, to perform operations like sorting, grouping, etc on DataFields that are not included in the column declarations.

Public property VirtualItemCount
Top
See Also