APNSoft.WebControls Namespace (APNSoft DataGrid)

APNSoftDataGrid Members

APNSoftDataGrid overview

Public Static (Shared) Properties

EditFormMethod Gets a value indicating the Edit Form is opened for INSERT or UPDATE. Default value is Undefined. When you open the Edit Form for UPDATE, fill in form fields with selected row data. Use the EditFormRow property to get the selected row.
EditFormRow Gets the selected row, used to fill in the Edit Form before update.

Public Instance Constructors

APNSoftDataGrid Constructor Initializes a new instance of the APNSoftDataGrid class.

Public Instance Properties

AutoPostBackOnSelect Specifies whether the control causes a postback to the server when a row is selected. Default value is false.
AutoResize Gets or sets a value specifying the way for DataGrid to be resized (if necessary) when data is loaded. Default value is None. When the property's value is WidthAndHeight, DataGrid displays data without scrollbars.
BasePage Gets or sets the reference to the Base Page. Used only in Code Behind.
BottomBar Gets the Bottom Bar.
CellEditingEnabled Gets or sets a value specifying whether the cell editing is enabled. Triggered by clicking twice on a cell. Default value is false.
ClientScriptSource Gets or sets the source of the client-side script. Default value is GeneratedByComponent.
ClientSideAfterCallBack Gets or sets the name of the client-side function to be called after CallBack request. The function must accept three parameters: GridID, Command and Parameter.
ClientSideAfterInit Gets or sets the name of the client-side function to be called after DataGrid initialization. The function must accept single parameter: GridID.
ClientSideOnContextMenuHeader Gets or sets the name of the client-side function to be called before the context menu for header is displayed. The function must accept three parameters: ContextMenu, GridID and ColumnIndex. The ContextMenu is a DIV element with context menu data.
ClientSideOnContextMenuRow Gets or sets the name of the client-side function to be called before the context menu for rows is displayed. The function must accept four parameters: ContextMenu, GridID, RowID and CellValue. The ContextMenu is a DIV element with context menu data.
ClientSideOnPage Gets or sets the name of the client-side function to be called when a new page is opened. The function must accept two parameters: GridID and PageNum.
ClientSideOnSelect Gets or sets the name of the client-side function to be called when a row is selected. The function must accept four parameters: GridID, RowID, ColumnName and CellValue.
Columns Gets the collection of columns.
ConfirmTextDelete Gets or sets the text to be shown on the confirmation dialog before the record is deleted. The prompt is automatically enabled if this property is set.
ConfirmTextInsert Gets or sets the text to be shown on the confirmation dialog before the record is inserted. The prompt is automatically enabled if this property is set.
ConfirmTextUpdate Gets or sets the text to be shown on the confirmation dialog before the record is updated. The prompt is automatically enabled if this property is set.
ContextMenuHeader Gets the Context Menu for Header.
ContextMenuRow Gets the Context Menu for Row.
CSSClassesPrefix Gets or sets the prefix for CSS Style classes. Used for association between the set of classes and one DataGrid instance.
CssClassRowHovered Gets or sets the name of a cascading style sheet (CSS) class used to assign style characteristics to the row, which is hovered. This class should be included in the CSS Style.
CssClassRowSelectedHovered Gets or sets the name of a cascading style sheet (CSS) class used to assign style characteristics to the row, which is selected and hovered. This class should be included in the CSS Style.
CSSSource Gets or sets the location of the DataGrid CSS Style. Default value is SkinFolder.
DataSource Gets or sets the data source that populates the rows of the DataGrid control.
EditForm Gets the Edit Form.
EnableViewState Gets or sets a value indicating whether the server control persists its view state.
FixedColumnsOpacity Gets or sets the opacity factor applied to the fixed columns. Range: 0-100. Default value is 100 (columns are NOT transparent).
Height Gets or sets a value indicating the height of the DataGrid in pixels. Range: 60-2048.
HighlightSelectedRow Gets or sets a value specifying whether the selected row is highlighted. Default value is true.
KeyFieldName Gets or sets the name of column that uniquely identifies each record stored in the table. The key field is commonly used in a handler for an event, such as UpdateCommand or DeleteCommand, as part of an update query string to revise a specific record in the data source. The key field helps the update query string identify the appropriate record to modify.
LicenseFileName Specifies the name of the file that includes component License Key. Default value is DataGrid_Lic.xml.
Mode Gets or sets the running mode of the DataGrid.
OutputFooter Gets or sets the data used as a footer for the output DHTML code. Use the "Default" keyword for the standard comment.
OutputHeader Gets or sets the data used as a header for the output DHTML code. Use the "Default" keyword for the standard comment.
PageCount Gets the total number of pages in the grid.
PageSize Gets or sets the maximum number of rows to be displayed on a single page of the DataGrid control. Range: 1-10000. The default value is 20. The total number of pages is calculated automatically depending on data amount.
RightClickSelect Gets or sets a value specifying whether a row is selected when the user right-clicks on the row. Default value is true. Note that the property value must be true if you use context menu for rows.
RowFilter Gets or sets the expression used to filter which rows are viewed in the DataGrid.
Rows Gets the collection of rows.
SEOEnabled Gets or sets a value indicating whether the DataGrid renders an additional NOSCRIPT section with links which correspond to DataGrid rows. Default value is false.
SkinFolder Gets or sets the URL for a Skin Folder. Skin Folder includes all component skin parts (CSS Style, images, etc.). The property value can be an absolute or relative URI.
WarningsEnabled Gets or sets a value indicating whether the DataGrid generates a client-side JavaScript messages which allow developers to control the DataGrid status. Default value is true.
Width Gets or sets a value indicating the width of the DataGrid in pixels. Range: 100-4096.
zIndex Gets or sets the z-index style value for the Grid. Default value is 200.

Public Instance Methods

AddContextMenu Adds Context Menu into the collection.
DataBind Creates a binding between the DataGrid control and a data source.
GetSelectedRow Returns the Selected Row.
GetSortedColumn Returns the Sorted Column.
RaisePostBackEvent Enables a server control to process an event raised when a form is posted to the server.
RemoveRowFilter This method removes the filter on the DataGrid control to show all rows.
ResetColumnWidths This method sets all columns at an equal percent fraction of the DataGrid width.
ResetPageNumber This method sets a Page Number to its default value.
ResetSelectedRow This method removes the 'Selected' attribute from the row.
ResetSortedColumn This method removes the 'Sorted' attribute from the column.

Public Instance Events

CallTheServer Occurs when we call the server from client side by launching the dg.CallTheServer(); procedure.
CellValueChanged Occurs when the cell value is changed.
DeleteCommand Occurs when a delete command is fired.
ExportToExcel Occurs when the Export To Excel command is fired.
ExportToHTML Occurs when the Export To HTML command is fired.
InsertCommand Occurs when an insert command is fired.
PageNumberChanged Fires after the page is changed.
SelectCommand Occurs when a select command is fired.
SortCommand Occurs when a sort command is fired.
UpdateCommand Occurs when an update command is fired.

See Also

APNSoftDataGrid Class | APNSoft.WebControls Namespace