Public Static (Shared) Fields
  EDIT_COMMAND_NAME | CommandName for the Edit link-button. Can be used in the SelectButtonFormat event handler to identify the edit buttons. |
Public Static (Shared) Methods
 HTMLEncodeWithLineBreaksAndHyperlinks | HtmlEncodes the given text, converting Urls to hyperlinks and replacing line breaks with BR tags. |
Public Instance Constructors
| TableEditor Constructor | Default constructor |
Public Instance Properties
 AccessKey | Not implemented, use CSS classes instead |
| AddButtonLocation | Indicates if the Add New Button is displayed above or below the grid. This property also indicates if the edit-panel for a new row is displayed above or below the grid. If SmartNaviation is disabled, it is best to set this property to Top, so that the user does not have to scroll to the bottom of the page when adding new rows. |
| AllowSearch | Allows or hides search function |
| AllowSearchReset | Indicates if search reset button is visible |
| Attributes (inherited from WebControl) | Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. |
| AutoRowSelect | Indicates if first row of new page should be selected automatically. Especially useful in updateable and master/detail grids. |
| BackColor | Not implemented, use CSS classes instead |
| BindingContainer (inherited from Control) | |
| BorderColor | Not implemented, use CSS classes instead |
| BorderStyle | Not implemented, use CSS classes instead |
| BorderWidth | Not implemented, use CSS classes instead |
| ClientID (inherited from Control) | Gets the server control identifier generated by ASP.NET. |
| ConfigFilePath | The path to the XML configuration file for this table editor |
| ConnectionString | The OleDb or SQL Server connection string for accessing the tables. If not set, it is read from the configuration file. This property can also be set in the OnInit event of host page (The Page_Load event cannot be used to pass connection string because the control is already loaded by then). |
| 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. |
| CssClass | Not browsable as there is no general css class for this control |
| CssClassButton | CSS style of buttons |
| CssClassCheckBox | CSS style of checkboxes |
| CssClassCombo | CSS style of combo boxes |
| CssClassEditLabelCell | CSS style of field caption labels in edit mode |
| CssClassErrorLabel | CSS style of error message |
| CssClassGrid | CSS style of the data grid |
| CssClassGridHeaderCell | Header cell CSS style |
| CssClassGridItemCell | Grid cell CSS style |
| CssClassGridPager | CSS style of the table cell that displays the data grid pager. The CSS class of the pager row is equal to the regular row class (but all visible attributes like background-color and font-size can be customized using the CssClassGridPager). |
| CssClassGridRow | CSS class of regular grid row |
| CssClassGridRowAlternating | Alternating row CSS class |
| CssClassGridRowChecked | CSS class of a row that is selected by a row selection checkbox |
| CssClassGridRowCheckedAlternating | CSS class of a alternating (odd) row that is selected by a row selection checkbox |
| CssClassGridRowSelected | CSS class of the current row |
| CssClassHeaderLink | Header text link CSS style |
| CssClassHorizontalRule | CSS style of horizontal rules |
| CssClassTableSelectCombo | CSS style of table selection combo box |
| CssClassTableSelectLabel | CSS style of caption label of table selection combo |
| CssClassTextBox | CSS style of text boxes |
| CurrentRow | The current row as selected by the select command in the grid |
| CurrentTableName | Returns the name of the currently selected table |
| DataView | Returns a dataview on the data currently displayed in the grid |
| EditInGrid | Indicates if editing should be done in a panel inside or above the grid |
| EditInGridMode | Indicates if editing should be done directly in the cells of the grid |
| Enabled (inherited from WebControl) | Gets or sets a value indicating whether the Web server control is enabled. |
| EnableViewState | EnableViewState must always be left at its default value of 'true' |
| Font | Not implemented, use CSS classes instead |
| ForeColor | Not implemented, use CSS classes instead |
| HasMasterDetailBinding | Indicates if this is a detail table editor bound to a master table editor |
| Height | Not implemented, use CSS classes instead |
| ID (inherited from Control) | Gets or sets the programmatic identifier assigned to the server control. |
| IsAddButtonVisible | Add New button visible in grid view. Disable this if you provide a custom Add New button on the page, and call OnAddNewClick manually. |
| IsCacheEnabled |
Indicates if the dataset is cached in the ASP.NET cache between postbacks.
|
| IsCurrentRowInEditMode | Indicates if the current row is in edit mode |
| IsDeleteSelectedRowsButtonVisible | Delete Selected Rows button visible in grid view. Disable this if you provide a custom Delete button on the page, and call OnDeleteSelectedRowsClick manually. |
| IsExcelCsvDownloadButtonVisible | Download as Excel CSV file button visible. |
| IsPagingEnabled | Indicates if the grid uses paging |
| IsRowSelectColumnVisible | Indicates if the row selection checkboxes are visible. Note that row selection is not allowed if no primary key is available. Note that you can customize the column order and visibility of the checkboxes, using a selectButton element of type checkbox in the XML configuration file. The SelectCheckBoxFormat event allows customization of individual checkboxes. |
| MasterTableEditorBinding | Defines a master/detail relation between this table editor (the detail) to a master table editor |
| MaxCacheAge |
The time span (entered as hh:mm:ss) after which the cache is automatically cleared.
Useful when data in the underlying table is also modified by other programs than
this instance of TEdit. The value 0:00:00 indicates that the cache remains
valid indefinitely.
Note that the cache can also be invalidated explicitly by
calling InvalidateCache.
The format of the time is [days.]hh:mm:ss, as descibed in the TimeSpan Parse method.
|
| MaxTextBoxColumns | Default maximum number of columns in a text box |
| MaxTextBoxRows | Default maximum number of rows in a text box |
| 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. |
| Page (inherited from Control) | Gets a reference to the Page instance that contains the server control. |
| PageSize | Size of the grid pages (number of rows per page). Use value smaller than 1 to disable paging |
| Parameters | Parameter name/values used to customize the config file using ~paramname~ syntax |
| Parent (inherited from Control) | Gets a reference to the server control's parent control in the page control hierarchy. |
| SelectedRows | Returns and array with all rows for which the selection checkbox is selected |
| ShowErrorsInPopupWindow | Indicates if error messages are reported using a popup window, or as text displayed inline with the page |
| ShowPrevNextPagerButtons | Indicates if Previous and Next page links are present as well as page numbers |
| Site (inherited from Control) | Gets information about the Web site to which the server control belongs. |
| 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 (inherited from WebControl) | Gets or sets the tab index of the Web server control. |
| TemplateSourceDirectory (inherited from Control) | Gets the virtual directory of the Page or UserControl that contains the current server control. |
| TextAddError | Add row error text |
| TextCancelButton | Text displayed in the Cancel button |
| TextCsvDownloadError | Excel download error text |
| TextDeleteButton | Text displayed in the Delete button |
| TextDeleteConfirmation | Text displayed in the Confirm Delete label |
| TextDeleteError | Delete row error text |
| TextDeletePromptMulti | Confirmation prompt displayed on multiple row delete ({0} represents the number of rows) |
| TextDeletePromptSingle | Confirmation prompt displayed on single row delete |
| TextEditButton | Text displayed in the Edit button |
| TextExcelDownloadButton | Excel/CSV download button text |
| TextFalse | Text for display 'false' boolean in grid |
| TextNewButton | Text displayed in the Add button |
| TextNextPage | Next page link button text |
| TextNoRowsSelected | Error message displayed when no rows are selected (e.g. for delete) |
| TextNullDisplay | Replacement text for null values |
| TextPagerCaption | Caption for the pager |
| TextPreviousPage | Previous page link button text |
| TextSearchButton | Text displayed in the search button |
| TextSearchError | Search error text |
| TextSearchLabel | Text displayed in label of search text box |
| TextSearchResetButton | Text of the Show All button |
| TextTableSelectLabel | Text displayed in caption label of table selection combo |
| TextTrue | Text for display 'true' boolean in grid |
| TextUpdateButton | Text displayed in the Save button |
| TextUpdateError | Update row error text |
| ToolTip | Not implemented, use CSS classes instead |
| UniqueID (inherited from Control) | Gets the unique, hierarchically-qualified identifier for the server control. |
| Visible (inherited from Control) | Gets or sets a value that indicates whether a server control is rendered as UI on the page. |
| Width | Not implemented, use CSS classes instead |
Public Instance Methods
| ApplyStyle (inherited from WebControl) | Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. |
| CopyBaseAttributes (inherited from WebControl) | Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. |
| DataBind (inherited from Control) | Binds a data source to the invoked server control and all its child controls. |
| Dispose (inherited from Control) | Enables a server control to perform final clean up before it is released from memory. |
| Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object. |
| ExportToExcel | Returns the current contents of the table editor as Excel-compatible comma separated values (CSV File). |
| FindControl (inherited from Control) | Searches the current naming container for a server control with the specified id parameter. |
| GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. |
| GetType (inherited from Object) | Gets the Type of the current instance. |
| HandleError | Displays an error message for the given exception |
| HasControls (inherited from Control) | Determines if the server control contains any child controls. |
| InvalidateCache |
Invalidates the data in the cache. |
| MergeStyle (inherited from WebControl) | Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. |
| OnAddNewClick | Handles add new button click event. Can be called by the client to implement a custom Add New button. |
| OnDeleteSelectedRowsClick | Handles Delete Selected rows event. Can be called by the client to implement a custom Delete button. |
| OnExcelDownloadClick | Handles Excel CSV download button click event. Can be called by the client to implement a custom Download as CSV button. |
| Rebind | Reloads all data (applies parameters) and displays it. Used by external clients; validates that rebind is called from an eventhandler and not from page_load |
| RenderBeginTag (inherited from WebControl) | Renders the HTML opening tag of the control into the specified writer. This method is used primarily by control developers. |
| RenderControl (inherited from Control) | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. |
| RenderEndTag (inherited from WebControl) | Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. |
| ResolveUrl (inherited from Control) | Converts a URL into one that is usable on the requesting client. |
| SaveChanges | Saves all changes made to data rows in the SelectedRows or DataView collections. |
| SetRenderMethodDelegate (inherited from Control) | |
| ShowPopupMessage | Displays a client-side popup window with the given (error) message |
| TableDisplayName | Returns the display name for the given table. The display name is equal to the alias specified for this table in the configuration file, or the name itself, if no alias was set. |
| ToString (inherited from Object) | Returns a String that represents the current Object. |
Public Instance Events
 AfterRowUpdate | Fired just after a row change (add, edit, delete) is applied to the database. For added rows, the column values in the Row can be accessed to retrieve any autoincrement values generated by the database backend. For deleted rows, the fields are no longer accessible at the time this event is fired. If you need to access data from a deleted row in the AfterRowUpdate event, you should copy the fields to temporary variables in the BeforeRowUpdate event, and then access the saved values when the AfterRowUpdate event fires. See the items.aspx page in the DXTrack sample application. |
| BeforeRowUpdate | Fired just before a row change (add, edit, delete) is applied to the database. The column values in the Row can be validated or massaged in this event. Note that when a new row is added, BeforeRowUpdate is fired twice. First it is called before the row is added to the Table; the row's RowState property is Detached. At this time, any fields that do not allow null values can be given default values After the row is added to the table, but before the changes are applied to the database, BeforeRowUpdate is called once more with a RowState of Added. At this time, validation can be done on the row (you can throw an exception if invalid data is entered by the user). |
| CreateEditControl | Can be used to customize the appearance of edit controls. Can also be used to replace a standard edit control by a self-created control. |
| DataBinding | Not implemented, use GridDataBind instead |
| Disposed (inherited from Control) | Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. |
| Error | Raised when an update error or other exception occurs. Gives the opportunity to handle and display the error in a customized way |
| FieldFormat | Fired when a field is formatted for display in either the grid-view or an edit text box. This event allows for custom field formatting. Also see the SetEditControlValue event for more powerful customization of edit control values. |
| FieldParse | Fired when a text box field value must be parsed. Also see the GetEditControlValue event, that is not only fired for text box fields, but also for any other edit control. |
| GetEditControlValue | Used to retrieve a field value from an edit control. This can be a self-created control or a default control (TextBox, CheckBox or DropDownList) that has been created by the TableEditor. Therefore, this is a more powerful version of the FieldParse event. |
| GridDataBind | Allows for summarizing the data in the table that is being displayed in the data grid, for example to show a total or aggregate value without having to execute a separate query. |
| Init (inherited from Control) | Occurs when the server control is initialized, which is the first step in the its lifecycle. |
| Load (inherited from Control) | Occurs when the server control is loaded into the Page object. |
| PreRender (inherited from Control) | Occurs when the server control is about to render to its containing Page object. |
| ProvideAutoIncrementIdCommand | Fired after a new row with an auto increment field is added to the database |
| ProvideDataView | Using this event, you can pass a dataset to TEdit.NET that contains the data table (or tables) to edit. By doing so, a connection to a back-end database is not needed. Also see ProvideLookupData and SaveData. |
| ProvideDefaultRowValues | Fired when a new row is created. Allows for providing default field values. |
| ProvideLookupCommand | Fired when the a lookup command is needed for the current table |
| ProvideLookupData |
When a custom DataSet is provided using the ProvideDataView event,
this event can be used to fill a data table to populate lookup combo boxes.
The first column of the provided DataTable should contain the ID-value, and the second column
the description for each item in the lookup list.
|
| ProvideSelectCommand | Fired when the a select command is needed for the current table |
| ProvideUpdateCommands | Fired when the a update/insert/delete commands are needed for the current table |
| RowDeselected | Fired when current selection is lost |
| RowSelected | Fired when a user clicks a 'select details' button |
| SaveData |
When a custom DataSet is provided using the ProvideDataView event,
you can handle this event to write any changes made by the user back to your datastore.
|
| SelectButtonFormat | Fired when a SelectButton is formatted for display. This event allows for custom SelectButton formatting. |
| SelectCheckBoxFormat | Fired when a SelectCheckBox is formatted for display. This event allows for custom CheckBox formatting. |
| SetEditControlValue | Used to assign a field value to an edit control. This can be a self-created control or a default control (TextBox, CheckBox or DropDownList) that has been created by the TableEditor. |
| Unload (inherited from Control) | Occurs when the server control is unloaded from memory. |
Explicit Interface Implementations
 IAttributeAccessor.GetAttribute (inherited from WebControl) | |
| IAttributeAccessor.SetAttribute (inherited from WebControl) | |
| IParserAccessor.AddParsedSubObject (inherited from Control) | |
| IPostBackEventHandler.RaisePostBackEvent |
See Also
TableEditor Class | DVXP.DXTableEditor Namespace