GridTableView Class

GridTableView Class

Grid table

Inheritance Hierarchy

SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      System.Web.UI.WebControlsBaseDataBoundControl
        System.Web.UI.WebControlsDataBoundControl
          System.Web.UI.WebControlsCompositeDataBoundControl
            Kettic.AspNet.ControlsGridTableViewBase
              Kettic.AspNet.ControlsGridTableView

Namespace: Kettic.AspNet.Controls
Assembly: Kettic.AspNet.Controls (in Kettic.AspNet.Controls.dll) Version: 2014.4.1129.0 (2014.04.1129.0)

Syntax

C++

Copy

public class GridTableView : GridTableViewBase, 
	INamingContainer

Public Class GridTableView
	Inherits GridTableViewBase
	Implements INamingContainer

public ref class GridTableView : public GridTableViewBase, 
	INamingContainer

type GridTableView =  
    class
        inherit GridTableViewBase
        interface INamingContainer
    end

The GridTableView type exposes the following members.

Constructors

	Name	Description
	GridTableView	Default contructor for GridTableView - generally used by Page serializer only.
	GridTableView(KaxGrid)	Constructs a new GridTableView and sets as its owner the KaxGrid object.
	GridTableView(KaxGrid, Boolean)	Constructs a new GridTableView and sets as its owner the KaxGrid object. Sets the IsTrackingViewState property to the corresponding value of the boolean parameter.

Top

Methods

	Name	Description
	ClearEditItems	Removes all edit items that belong to the GridTableView instance.
	ClearSelectedItems	Removes all selected items that belong to this GridTableView instance.
	DataBind	Binds the data source to the KaxGrid instance. (Overrides BaseDataBoundControlDataBind.)
	ExportToCSV	Exports the grid data in CSV format using the properties set in the ExportSettings.
	ExportToExcel	Exports the grid data in Microsoft Excel � format using the properties set in the ExportSettings.
	ExportToPdf	Exports the grid data in PDF format using the properties set in the ExportSettings.
	ExportToWord	Exports the grid data in Microsoft Word � format based on the selected ExportSettings.
	ExtractValuesFromItem	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.
	FindItemByKeyValue
	FindItemsByKeyValues
	GetColumn	Returns a GridColumn based on its UniqueName.
	GetColumnSafe	Returns a GridColumn based on its UniqueName.
	GetInsertItem	Get the item that appears when grid is in Insert Mode.
	GetItems	Returns a collection of GridItem objects based on their ItemType.
	GetSelectedItems
	HasAggregates
	InsertItem	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.
	InsertItem(IDictionary)	Places the GridTableView in insert mode, allowing the user to insert a new data-item values. The GridInsertItem created will be bound to values found in newValues dictionary; The CurrentPageIndex will be set to display the last page. You can use also the IsItemInserted to place the GridTableView in insert mode.
	InsertItem(Object)	Places the GridTableView in insert mode, allowing the user to insert a new data-item values. The GridInsertItem created will be bound to values of the newDataItem object. The CurrentPageIndex will be set to display the last page. You can use also the IsItemInserted property to place the GridTableView in insert mode.
	PerformDelete(GridEditableItem)	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, KaxGrid will fire ItemDeleted event.
	PerformDelete(GridEditableItem, Boolean)	Perform delete operation, using the DataSourceControl API. Please make sure you have specified the correct DataKeyNames for the GridTableView.
	PerformInsert	Perform asynchronous insert of the new item, diplayed by KaxGrid when in edit mode, using the DataSourceControl API, then Rebind. When the asynchronous operation calls back, KaxGrid will fire ItemInserted event.
	PerformInsert(GridEditableItem)	Performs asynchronous insert operation, using the DataSourceControl API, then Rebinds. When the asynchronous operation calls back, KaxGrid will fire ItemInserted event.
	PerformInsert(GridEditableItem, Boolean)	Perform asynchronous insert operation, using the DataSource control API. When the asynchronous operation calls back, KaxGrid will fire ItemInserted event.
	PerformUpdate(GridEditableItem)	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, KaxGrid will fire ItemUpdated event.
	PerformUpdate(GridEditableItem, Boolean)	Perform asynchronous update operation, using the DataSource control API. Please make sure you have specified the correct DataKeyNames for the GridTableView. When the asynchronous operation calls back, KaxGrid will fire ItemUpdated event. The boolean property defines if KaxGrid will Rebind after the update.
	Rebind	Forces the Owner KaxGrid to fire NeedDataSource event then calls DataBind.
	SwapColumns(Int32, Int32)	Swaps columns appearance position using order indexes of the two columns.
	SwapColumns(String, String)	Swaps columns appearance position using the unique names of the two columns.
	SwapColumns(GridColumn, GridColumn)

Top

Properties

	Name	Description
	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.
	AllowAutomaticDeletes	Gets or sets a value indicating whether Kettic KaxGrid will perform automatic deletes, i.e. using the DataSource controls functionality.
	AllowAutomaticInserts	Gets or sets a value indicating whether Kettic KaxGrid will perform automatic inserts, i.e. using the DataSource controls functionality.
	AllowAutomaticUpdates	Gets or sets a value indicating whether Kettic KaxGrid will perform automatic updates, i.e. using the DataSource controls functionality.
	AllowCustomPaging	Gets or sets if the custom paging feature is enabled.
	AllowCustomSorting	Gets or sets if the custom sorting feature is enabled.
	AllowFilteringByColumn	Gets or sets a value indicating whether the filtering by column feature is enabled.
	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.
	AllowNaturalSort	Gets or sets the value indicated whether the no-sort state when changing sort order will be allowed.
	AllowPaging	Gets or sets a value indicating whether the paging feature is enabled.
	AllowSorting	Gets or sets a value indicating whether the sorting feature is enabled.
	AlternatingItemStyle	Gets a reference to the GridTableItemStyle object that allows you to set the appearance of alternating items in a GridTableView control.
	AutoGenerateColumns	Gets or sets a value indicating whether Kettic KaxGrid will automatically generate columns at runtime based on its DataSource.
	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.
	CanRetrieveAllData	Gets or sets a value indicating whether Kettic KaxGrid should retrieve all data and ignore server paging in case of filtering or grouping.
	Caption	Gets or sets a string that specifies a brief description of a GridTableView. Related to Kettic KaxGrid accessibility compliance.
	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.
	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.
	ClientDataKeyNames
	ClientID	(Overrides ControlClientID.)
	Columns	Gets a collection of GridColumn objects that represent the column fields in a GridTableView control.
	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.
	CommandItemSettings	Gets a set the options for GridTableView's command item.
	CommandItemStyle	Gets a referenct to the GridTableItemStyle object that allows you to set the appearance of the command item in a GridTableView control.
	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.
	CurrentPageIndex	Gets or sets a value indicating the index of the currently active page in case paging is enabled (AllowPaging is true).
	CurrentResetPageIndexAction	Gets or sets a value that describes how KaxGrid would respond if the CurrentPageIndex is invalid when data-binding.
	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.
	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.
	DataSource	Gets or sets the object from which the data-bound control retrieves its list of data items. (Overrides BaseDataBoundControlDataSource.)
	DataSourceCount	Gets the number of pages if paging is enabled.
	DataSourceID	Gets or sets the data source id in KaxGrid. (Overrides DataBoundControlDataSourceID.)
	DetailTables	Gets or sets the collection of detail table views for this GridTableView
	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
	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.
	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.
	EditItemTemplate	Gets or sets the EditItemTemplate, which is rendered in the control in edit mode.
	EditMode	FormsGets or sets a value indicating how a GridItem will look in edit mode.
	EnableColumnsViewState	Gets or sets a value indicating whether all columns settings will be persisted in the ViewState or not.
	EnableHeaderContextFilterMenu	Gets or sets a value indicating whether the header context filter menu should be enabled.
	EnableHeaderContextMenu	Gets or sets a value indicating whether the header context menu should be enabled.
	EnableNoRecordsTemplate	Gets or sets a value indicating whether KaxGrid will show NoRecordsTemplate instead of the corresponding GridTableView if there is no items to display.
	ExpandCollapseColumn	Gets a reference to the ExpandCollapseColumn object, allowing you to customize its settings.
	FilterExpression	Gets or sets the filtering options for grid columns.
	FilterItemStyle	Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the filter item in a GridTableView control.
	FooterStyle	Manage visual style of the footer item.
	Frame	Gets or sets a value specifying the frame table attribute.
	GridLines	Gets or sets an enumeration value, indicating the appearance of the data table border between cells. (Overrides GridTableViewBaseGridLines.)
	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.
	GroupHeaderItemStyle	Manage visual style of the group header items.
	GroupLoadMode	Specifies where the grouping will be handled. There are two options: Server-side - GridTableView.GroupLoadMode.Server Client-side - GridTableView.GroupLoadMode.Client
	GroupsDefaultExpanded	Gets or sets a value indicating whether the groups will be expanded on grid load (true by default).
	HasDetailTables	Gets a value indicating if the GridTableView instance has children (Detail) tables.
	HeaderStyle	Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the header item in a GridTableView control.
	HierarchyDefaultExpanded	Gets or sets a value indicating whether the hierarchy will be expanded by default. The default value of the property is false.
	HierarchyIndex	The unique hierarchy index of the current table view, generated when it is binding.
	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.
	HorizontalAlign	Gets or sets horizontal alignment style in the data table. (Overrides GridTableViewBaseHorizontalAlign.)
	ID	Gets or sets the programmatic identifier assigned to the current GridTableView. (Overrides ControlID.)
	InsertItemDisplay
	InsertItemPageIndexAction
	IsFilterItemExpanded
	IsItemInserted	Gets or sets a value indicating if the GridTableView is currently in insert mode.
	Items	Gets a collection of GridDataItem objects that represent the data items in a GridDataItem control.
	ItemsCreated	Indicates whether the items have been created, generally by data-binding.
	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.
	ItemStyle	Gets a reference to the GridTableItemStyle object that allows you to set the appearance of items in a GridTableView control.
	ItemTemplate	Gets or sets the ItemTemplate, which is rendered in the control in normal (non-Edit) mode.
	Name	Gets or sets the name of the GridTableView.
	NestedViewSettings	Gets a set of options for the GridTableView's data-bound nested view template.
	NestedViewTemplate	Gets or sets the ItemTemplate, which is rendered in the control in normal (non-Edit) mode.
	NoDetailRecordsText	Gets or sets the text that will be displayed in there is no NoRecordsTemplate defined and no records in the Detail tables.
	NoMasterRecordsText	Gets or sets the text that will be displayed in there is no NoRecordsTemplate defined and no records in the MainView.
	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.
	OverrideDataSourceControlSorting	Gets or sets a value indicating if the GridTableView should override the default DataSourceControl sorting with grid native sorting.
	OwnerID	Gets the ClientID of the KaxGrid object that contains this instance.
	PageCount	Gets the number of pages required to display the records of the data source in a GridTableView control.
	PagerStyle	Gets a reference to the GridPagerStyle object that allows you to set the appearance of the pager item in a GridTableView control.
	PagerTemplate	Gets or sets the custom content for the pager item in a GridTableView control.
	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.
	PagingManager	Gets a Paging object that is the result of paging settings and runtime paging state of the grid.
	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.
	ParentTableRelation	Gets or sets the collection of data-field pairs that describe the relations in a hierarchical grid.
	RenderActiveItemStyle	Gets the rendering style of an ActiveItem.
	RenderAlternatingItemStyle	Gets the rendering style of the AlternatingItem.
	RenderColumns	Gets an array of all columns that are used when rendering the grid instance.
	RenderCommandItemStyle	Gets the rendering style of a CommandItem.
	RenderEditItemStyle	Gets the rendering style of an edit Item.
	RenderFilterItemStyle	Gets the rendering style of a FilterItem.
	RenderFooterStyle	Gets the rendering style of an FooterItem.
	RenderGroupHeaderItemStyle	Gets the rendering style of the group header items.
	RenderHeaderStyle	Gets the rendering style of a GridHeaderItem.
	RenderItemStyle	Gets the rendering style of an Item.
	RenderPagerStyle	Gets the rendering style of the Pager item.
	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.
	ResolvedDataSourceView	Gets a DataView object that represents the data sent to the GridTableView to be displayed.
	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.
	RetrieveDataTypeFromFirstItem	Gets or sets a value indicating whether items' data type should be retrieved from supplied enumerable's first item.
	RetrieveNullAsDBNull	Gets or sets a value indicating whether null values in the database will be retrieved as dbnull values.
	RowIndicatorColumn	Gets a reference to the RowIndicatorColumn object, allowing you to customize its settings.
	SelectedItemStyle	Gets a reference to the Style object that allows you to set the appearance of the selected item in a GridTableView control.
	SelfHierarchySettings	Gets a set the options for GridTableView's self-hierarchy behavior.
	ShowFooter	Gets or sets a value indicating if the GridFooterItem will be shown in the current GridTableView.
	ShowGroupFooter	Gets or sets a value indicating if the GridGroupFooterItem will be shown in the current GridTableView.
	ShowHeader	Gets or sets a value indicating if the GridHeaderItem will be shown in the current GridTableView.
	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.
	SortExpressions	Gets a collection of sort expressions for this table view instance, associated with the column or columns being sorted.
	Summary	Gets or sets the 'summary' attribute for the respective table.
	TableLayout	Gets or sets a string that indicates whether the table layout is fixed.
	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.
	VirtualItemCount

Top

Reference

Kettic.AspNet.Controls Namespace