DBModifHelper Class
global helper functions for DBModifiers
Inheritance Hierarchy
- System.Object
- DBaddin.DBModifHelper
Namespace: DBaddinAssembly: DBaddin in (DBaddin.dll)
Syntax
public sealed class DBModifHelper
The DBModifHelper type exposes the following members.
Constructors
| Class | Summary | |
|---|---|---|
 | DBModifHelper() |
Methods
| Name | Summary | |
|---|---|---|
 | addErrorDBModifColl(String) | adds error message to both DBModifDefColl (for display in Ribbon menu) as well as log |
 | checkAndReturnRange(String) | check one param range input (name) and return the range if successful |
| CorrectQuotes(String) | correct quotes in field name |
| createDBModif(String, String) | creates a DBModif at the current active cell or edits an existing one defined in targetDefName (after being called in defined range or from ribbon + Ctrl + Shift) |
| CVErrText(Int32) | to convert the error number to text |
| deleteRow() | marks a row in a DBMapper for deletion, used as a ExcelCommand to have a keyboard shortcut |
| executeDBModif(String, Boolean) | execute given DBModifier, used for VBA call by Application.Run |
| getDBModifDefinitions(Workbook, Boolean) | gets defined names for DBModifier (DBMapper/DBAction/DBSeqnce) invocation in the passed workbook and updates Ribbon with it |
| getDBModifNameFromRange(Range) | gets DB Modification Name (DBMapper or DBAction) from theRange |
| getExecutionParam(String) | get given execution parameter or setting parameter found by fetchSetting, used for VBA call by Application.Run |
| getRangeFromNameInSheet(ref String, Worksheet) | get the range from a worksheet name in the given sheet |
| insertRow() | inserts a row in a DBMapper, used as a ExcelCommand to have a keyboard shortcut |
| IsXLCVErr(Object) | To check for errors in passed range obj, makes use of the fact that Range.Value never passes Integer Values back except for Errors |
| openIdbConnection(Int32, String) | opens a database connection |
| resizeDBMapperRange(Range, Range) | in case there is a defined DBMapper underlying the DBListFetch/DBSetQuery target area then change the extent of it (oldRange) to the new area given in theRange |
| setExecutionParam(String, Object) | set given execution parameter, used for VBA call by Application.Run |
| TypeToDbType(Type, String, Collection) | cast .NET data type to ADO.NET DbType |
Fields
| Name | Description | |
|---|---|---|
 | closingQuote | closing quote, e.g. ] for SQL Server |
| closingQuoteReplacement | Replacement for closing quote, if needed, e.g. SQL Server requires ] to be replaced by ]] |
| DBModifDefColl | DBModif definition collections of DBmodif types (key of top level dictionary) with values being collections of DBModifierNames (key of contained dictionaries) and DBModifiers (value of contained dictionaries)) |
| FieldParamMap | Mapping of field names to parameter names (Param + number) |
| hadError | indicates an error in execution of DBModifiers, used for commit/rollback and for non-interactive message return |
| idbcnn | main db connection for DB modifiers |
| listSepLocal | used to work around the fact that when started by Application.Run, Formulas are sometimes returned as local |
| openingQuote | opening quote, e.g. [ for SQL Server |
| preventChangeWhileFetching | avoid entering Application.SheetChange Event handler during listfetch/setquery |
| trans | common transaction, needed for DBSequence and all other DB Modifiers |