DBModif Class
Abstraction of a DB Modification Object (concrete classes DBMapper, DBAction or DBSeqnce)
Inheritance Hierarchy
- System.Object
Namespace: DBaddinAssembly: DBaddin in (DBaddin.dll)
Syntax
public abstract class DBModif
The DBModif type exposes the following members.
Constructors
| Class | Summary | |
|---|---|---|
 | DBModif(CustomXMLNode) | constructor with definition XML |
Methods
| Name | Summary | |
|---|---|---|
 | addHiddenFeatureDefs(CustomXMLNode) | to re-add hidden features only available in XML |
| confirmExecution(Boolean) | asks user the confirmation question, in case it is required by the DB Modifier |
| DBModifSaveNeeded() | checks whether DBModifier needs saving, usually because execOnSave is set (in case of CUD DBMappers if any i/u/d flags are present) |
| derivedEnv(Int32, String) | derive environment from either set environment (setEnv) or if not set (0) from selectedEnvironment. For Sequences take environment from DBSequenceEnv |
| doDBModif(Boolean, String, Boolean) | does the actual DB Modification |
 | doDBRefresh(String, Dictionary<String,Boolean>, Dictionary<String,Boolean>, Boolean) | refresh a DB Function (DBListFetch, DBRowFetch and DBSetQuery) by invoking its respective DB*Action procedure (the UDFs cannot be directly invoked from VB.NET code) additionally preparing the inputs to the DB*Action procedure by extracting them from the DB Functions parameters |
| Finalize() | used to release com objects |
 | getConnString(String, Range, Boolean) | get connection string from passed function argument |
| getEnv() | public accessor function: get Environment (integer) where connection id should be taken from |
| getName() | gets the name for this DBModifier |
| getParamFromXML(CustomXMLNode, String, String) | wrapper to get the single definition element values from the DBModifier CustomXML node, also checks for multiple definition elements |
| getQuery(String, Range) | get DBFunction's query from passed function argument |
| getTargetRange() | public accessor function |
| getTargetRangeAddress() | public accessor function |
| openDatabase(String) | open a database specific connection, not available to DB Sequences |
| setDBModifCreateFields(ref DBModifCreate) | sets the content of the DBModif Create/Edit Dialog |
| setTargetRange(Range) | when resizing target ranges from functions as DBListFetch and DBSetQuery, need to notify also DBModif objects (DBMapper) |
Fields
| Name | Description | |
|---|---|---|
 | askBeforeExecute | ask for confirmation before execution of DBModif |
| confirmText | Text displayed for confirmation before doing dbModif instead of standard text |
| database | Database to store to, not available to DB Sequences |
| dbmodifName | unique key of DBModif |
| env | environment specific for the DBModif object, if left empty then set to default environment (either 0 or currently selected environment) |
 | execOnSave | should DBMap be saved / DBAction be done on Excel Saving? (default no) |
| paramTargetName | DBModif name of target range |
| TargetRange | Range where DBMapper data is located (only DBMapper and DBAction; paramText is stored in custom doc properties having the same Name) |