AxpDataGrid

AxpDataGrid Properties

The properties of the AxpDataGrid class are listed below. For a complete list of AxpDataGrid class members, see the AxpDataGrid Members topic.

Public Instance Properties

AccessKey 
ApplyCellFormattingToExcelWheter data column formatting should be applied to the Excel export if GridFormatCellFunction is set for selected columns.
ApplyCellFormattingToFormWheter the GridFreeFormatCell and GridFormatCellFunction formatting should apply to Form view as well as Grid view.
ApplyColFormattingToFormWhether the Column formatting set using SetGridColAttributes or GridColumns.CellHtmlAttributes should apply to Form view as well as Grid view.
Attributes (inherited from WebControl) Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
AxConnectionDatabase connection available after setting the connection string
BackColor 
BindingContainer (inherited from Control) 
BorderColor 
BorderStyle 
BorderWidth 
ClearStateWheter the grid state as a result of user interaction should be cleared.
ClientID (inherited from Control) Gets the server control identifier generated by ASP.NET.
CommandTimeoutSet command execution timeout in seconds.
ConnectionStringA standard OleDB database connection string.
Controls (inherited from Control) Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
ControlStyle (inherited from WebControl) Gets the style of the Web server control. This property is used primarily by control developers.
ControlStyleCreated (inherited from WebControl) Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.
CopyFieldsA string containing either '*" for all fields, the empty string to disable copying of data records or a comma separated list of field names.
CountRecordsWhether the grid should count and display the total number of records in the query.
CountSQLCustom SQL SELECT query for counting records in the datasource.
CssClass 
CurrentDataRowGets the current data record as a .NET DataRow object
CurrentDataViewA .NET DataView that either contains all records (if the property DataSource is set) OR the data records on the current page in all other cases.
CurrentModeGets a value representing the current display mode.
DataExportEncodingGets or sets the character encoding for the Excel export.
DataMemberDataTable Name in DataSet if the property DataSource is set to a DataSet.
DataSourceA datasource for the Grid and Form View mode if SQL properties are not used.
DeleteSQLSQL statement specifying how a record should be deleted in the database
DisableNavBarLastPageBtnWhether the "Last page" button on the navigation bar should be disabled.
DisplayDebugWhether Debug information should be displayed.
DisplayErrorMessageWhether messages from exception handled by the grid should be displayed.
DisplayExcelIconWhether the Excel icon should be visible in the navigation bar.
DisplayHeaderWhether the Grid Column Headers and Form Captions should be visible.
DisplayNavBarGets or sets the placement of the Page Navigation Bar.
DisplayNavBarFirstLastBtnIndicates if the "First Page" and "Last Page" button is visible on the Navigation Bar
DisplayNavBarTextOptionsSet the Navigation Bar display options.
DisplayRecordsPerPageSelectWhether the Drop-down list for selecting the number of Records per Page should be visible.
DisplayTypeDetermine if AxpDataGrid should display as a grid, a form, or support both display modes.
EditConfirmDeleteStringIf set, the user will get a confirmation prompt containing this string when the Delete button is clicked.
EditFieldsReadOnlyList of field names (or column numbers) that should be treated as read only in the edit form.
EditLookupAsStringGets the look-up values as a string for a column
EditNewPKStatementControl if primary keys are autoincremented or require a separate SQL statement (eg for Oracle Sequences)
EditOptionsControls what type of data updates should be supported
EditPerformUpdatesWhether the grid should issue database Insert, Update and Delete commands or not.
EditPrimaryKeysGets or sets the Primary key names.
EditSQLThe SQL Select statement to use as a datasource for the Form Edit mode.
Enabled (inherited from WebControl) Gets or sets a value indicating whether the Web server control is enabled.
EnableViewStateAxpDataGrid does not utilize ViewState (with a few exceptions)
ErrorMessageContains error messages from Exceptions handled by AxpDataGrid
ExcelFileNameThe name given to the Excel file when exporting to Excel. Do not include any file extensions.
Font 
FooterTextGets or sets the Html code and text displayed in the Grid Footer placed below the grid navigation bar.
ForeColor 
FormButtonBarPlacementDetermines the position of the Data Editing Button Bar when in Form mode.
FormCellWidthsThe width of the two main columns (Caption and Value) used in the Form View and Form Edit.
FormDisplayFieldNamesUser defined Column Captions used in Form View and Edit Mode.
FormFieldsHideHide columns in form mode
FormFieldsShowData fields to be displayed in the Form mode
FormSQLThe SQL statement that should be used in the Form display mode.
FormTableTagAdditional HTML attributes for the form TABLE tag
FormTDTagAdditional HTML attributes for the form TD tag
FormViewColumnsGets the collection of DataColumn items available in Grid's Load Event
FromRowGets or sets the start row number for the current page.
GridButtonBarPlacementDetermines the position of the Data editing button bar when in Grid mode (the button bar will only contain the Add button)
GridCellsNoBrKept for backward compatibilty. Use GridColsNoWrap instead.
GridCellWidthsControl the width of columns in the datagrid
GridColAttributesNormal html attributes including style and scripting for specified column number
GridColHeadAttributesNormal html attributes including style and scripting for specified Grid Header column
GridColsNoSortIndicates columns where User interface ordering should not be allowed
GridColsNoWrapSpecify grid columns where the text should not wrap.
GridColumnsGets the collection of DataColumn items available in Grid's Load Event
GridDisplayFieldNamesCustom Column Header names
GridDisplayIndexDisplay a sequential number in the first Grid Column for each record (1,2,3,4 etc). As default this column will be used as a hyperlink to the form page.
GridFieldsHideHide columns in Grid mode
GridFieldsShowSpecify which columns should be visible in the grid
GridFieldsSupressDupHide grid data values for columns where the data values repeats the previous value.
GridFormatCellFunctionData value formatting and functions
GridFreeFormatCellThe GridFreeFormatCell and (Set)GridFreeFormatCellByCol allows combining the values of data columns with your own text or html code.
GridFreeFormatCellByColSee SetGridFreeFormatCellByCol
GridFreeFormatCellColumnDelimiterThe string used to denote data column names in the property GridFreeFormatCell can be set manually. This is useful if a cell contains javascript functions calls with several parameters. The Default Delimiter is ',' (a comma). Alternatively (recommended), use the SetGridFreeFormatCellByCol method.
GridFreeFormatCellDataFieldDelimiterOverride the string used to denote data column names in GridFreeFormatCell functions
GridLinkIndexSpecify what grid column should be used as a hyperlink to the form mode.
GridLinkIndexWidthThe width of the Grid column containing record numbers (column 0)
GridTableTagAdditional HTML attributes for the Form and Grid TABLE tag.
GridTDEvenTagAdditional HTML attributes for the data cells (TD cells) of even numbered Grid rows
GridTDOddTagAdditional HTML attributes for the data cells (TD cells) of odd numbered Grid rows.
GridTDTagHTML attributes for the data cells (TD cells) of Grid rows.
GridTREvenTagHTML attributes for the even numbered Grid data rows (TR tag).
GridTROddTagHTML attributes for the odd numbered Grid data rows (TR tag).
GridTRTagHTML attributes for the Grid data rows (TR tag).
HeaderTextGets or sets the Html code and text displayed in the Grid Header placed above the grid.
Height (inherited from WebControl) Gets or sets the height of the Web server control.
ID (inherited from Control) Gets or sets the programmatic identifier assigned to the server control.
ImageDirThe relative or full URL to the directory where the navigation bar gif files are stored.
IsPrimaryKeysUpdateableWhether update of primary keys is allowed.
LanguageSet user interface strings in local language. English, Norwegian and German is supported.

For other languages, set the appropriate string properties.
LanguageBtnStringConfigurable strings for Grid and Form buttons
LanguageStringConfigurable language strings
LangUpdStringConfigurable messages appearing when updating data
LookupDataSetDataSet containing lookup values for Form Edit input fields. There should be one DataTable per lookup in this DataSet. See also AddEditLookup
MemoFieldLimitMaximum number of characters to display in "memo" data columns.
NamingContainer (inherited from Control) Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.
OracleDatePatternOracle Date Pattern to be used if primary field is an Oracle Date Field.
OrderByDescWhether the ordering specified in OrderByFields is descending.
OrderByFieldsInitial data ordering.
Page (inherited from Control) Gets a reference to the Page instance that contains the server control.
Parent (inherited from Control) Gets a reference to the server control's parent control in the page control hierarchy.
RecordCountGets or sets the number of records (total number of rows) in the recordset.
RecordsMaxLimitLimit the number of rows the grid should handle.
RecordsPerPageThe initial page size (number of records/rows per page)
RecordsPerPageOptionsGets or sets the content of the Drop-down list for selecting Number of Records per page.
RecordsPerPageSelectPlacementDetermine where the Record Per Page drop down list should appear.
RequiredFieldIndicatorText appearing after a required field. Html code is allowed.
RowClickActionAction to take when user clicks a row.
RowRollOverEffectWhether mouse row roll over effect in the grid should be enabled.
ScrollEnable scrollable grid
ScrollBarWidthWidth of dummy filler column header at the very right used for scrolling grids.
ScrollHeightThe height of the scrollable area of the grid.
Site (inherited from Control) Gets information about the Web site to which the server control belongs.
SQLThe main SQL SELECT statement for this grid and form. For stored procedures, just type in the Stored Procedure name.
StoredProcCommandIf a stored procedure name is set in the SQL property, the stored procedure parameters can be set through this object afterwards.
Style (inherited from WebControl) Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
TabIndex 
TableTagAdditional HTML attributes for the form and grid Html TABLE tag.
TagThe AxpDataGrid unique Tag. Unique values are set automatically from Version 2 of the grid
TDEvenTagAdditional HTML attributes for TD cells of even numbered rows.
TDOddTagAdditional HTML attributes for TD cells of odd numbered rows.
TDTagAdditional HTML attributes for the Data Cell (TD tag).
TemplateSourceDirectory (inherited from Control) Gets the virtual directory of the Page or UserControl that contains the current server control.
THTagAdditional HTML attributes for the Column Header (TH tag).
ToolTip 
ToRowGets the row number of the last record on current page.
UniqueID (inherited from Control) Gets the unique, hierarchically-qualified identifier for the server control.
UseDataBindingSet to True to disable the automatic built in data binding of the AxpDataGrid control
Visible (inherited from Control) Gets or sets a value that indicates whether a server control is rendered as UI on the page.
Width (inherited from WebControl) Gets or sets the width of the Web server control.

Protected Instance Properties

ChildControlsCreated (inherited from Control) Gets a value that indicates whether the server control's child controls have been created.
Context (inherited from Control) Gets the HttpContext object associated with the server control for the current Web request.
Events (inherited from Control) Gets a list of event handler delegates for the control. This property is read-only.
HasChildViewState (inherited from Control) Gets a value indicating whether the current server control's child controls have any saved view-state settings.
IsTrackingViewState (inherited from Control) Gets a value that indicates whether the server control is saving changes to its view state.
TagKey (inherited from WebControl) Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.
TagName (inherited from WebControl) Gets the name of the control tag. This property is used primarily by control developers.
ViewState (inherited from Control) Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
ViewStateIgnoresCase (inherited from Control) Gets a value that indicates whether the StateBag object is case-insensitive.

See Also

AxpDataGrid Class | Axezz.WebControls Namespace