AdHocSQL Class
User-form for ad-hoc SQL execution
Inheritance Hierarchy
- System.Windows.Forms.Form
- DBaddin.AdHocSQL
Namespace: DBaddinAssembly: DBaddin in (DBaddin.dll)
Syntax
public class AdHocSQL : Form
The AdHocSQL type exposes the following members.
Constructors
| Class | Summary | |
|---|---|---|
 | AdHocSQL(String, Int32) | create new AdHocSQL dialog |
Methods
| Name | Summary | |
|---|---|---|
 | AdHocSQL_KeyUp(Object, KeyEventArgs) | needed together with KeyPreview=True on form to simulate ESC canceling the form and catching this successfully (preventing closing when canceling an ongoing sql-command) |
| AdHocSQL_Shown(Object, EventArgs) | execution of ribbon entered command after dialog has been set up, otherwise GUI elements are not available |
| AdHocSQLQueryResult_DataError(Object, DataGridViewDataErrorEventArgs) | For non displayable data (blobs, etc.) that raise an exception, write out the exception in the data-grid cell tool-tip instead of lots of pop-ups |
| BackgroundWorker1_DoWork(Object, DoWorkEventArgs) | start sql command and load data into data table in the background (to show progress and have cancellation control) |
| BackgroundWorker1_RunWorkerCompleted(Object, RunWorkerCompletedEventArgs) | sql command finished, show results. All GUI related work needs to be done in the main thread |
| Close_Click(Object, EventArgs) | "Close": close dialog with Cancel result |
| Database_KeyDown(Object, KeyEventArgs) | when being on the database also allow Ctrl-Enter |
| Database_SelectionChangeCommitted(Object, EventArgs) | database changed |
 | Dispose(Boolean) | |
| Environment_SelectionChangeCommitted(Object, EventArgs) | Change Environment in AdHocSQL |
| Execute_Click(Object, EventArgs) | executing the SQL command and passing the results to the results pane |
| executeSQL() | after confirmation for non select statements (DML), execute the SQL by running the BackgroundWorker1 |
| fillDatabases() | fills all possible databases of current connection using db proprietary code in dbGetAllStr, data coming from field DBGetAllFieldName |
| fillDatabasesAndSetDropDown() | fill the Database dropdown |
| finishForm(DialogResult) | common procedure to close the form, regarding (canceling) a busy background worker = sqlcmd) |
| InitializeComponent() | |
| SQLText_KeyDown(Object, KeyEventArgs) | keyboard shortcuts for executing (ctrl-return), Transfer (shift-return) and maybe other things in the future (auto-complete) |
| SQLText_MouseDown(Object, MouseEventArgs) | show context menu for SQLText, displaying config menu as a MenuStrip |
| Timer1_Tick(Object, EventArgs) | show progress during BackgroundWorker1 execution |
| Transfer_Click(Object, EventArgs) | "Transfer": close dialog with OK result |
| TransferType_KeyDown(Object, KeyEventArgs) | when being on the TransferType selection also allow Shift-Enter |
Properties
| Name | Summary | |
|---|---|---|
 | Database | |
| LDatabase | |
| LEnv1 |
Fields
| Name | Description | |
|---|---|---|
 | components | |
| dt | the resulting data table object loaded by BackgroundWorker1_DoWork and displayed in BackgroundWorker1_RunWorkerCompleted |
| elapsedTime | fetch elapsed time in Timer to show after completion |
| myDBConnHelper | common connection settings factored in helper class |
| nonRowResult | used to pass non row results between BackgroundWorker1_DoWork and BackgroundWorker1_RunWorkerCompleted |
 | propagatedFromDoc | needed to avoid escape key pressed in DBDocumentation from propagating to main AdHocSQL dialog (and closing this dialog therefore) |
| SqlCmd | the command object for executing the AdHocSQL command text |
| storedUserSetEnv | stored environment to reset after change |
| userSetDB | stored database to reset after change |