MultiView tdf functions
This document list all functions for reading, creating, updating and deleting tables and fields using multiview.
| addcoldef | number |
Add a column to the tdf with given name and return the column number given in tv 0 or - 1 if an error happened.
Parameters - cname | column name to use |
| createdef | boolean | Make ready for creation a table with the name given to the multiview when created. This should be followed by addcoldef and finalized by savedef. |
| destroy | boolean | Destroy the multiview. This must be done after end. |
| getcoldefchoices |
Array null
|
Return array of choices defined for column or None if column not defined
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefdecimals | Number null |
Number of decimals on a numeric value
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefderived |
string null |
Return the derivation on the column
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefdoprevent |
boolean
null |
Write protected field if True
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefformat |
string null |
Return format used for column
Parameters - columnnr | the pos in tv 0 for the column to inquire |
|
getcoldefhasderived
|
boolean
null |
True if this field has a derivation defined
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefhasformat |
boolean
null |
True if the column has formattion defined
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefhashelp |
boolean
null |
True if the column has help defined
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefhasindex |
boolean
null |
True if the column has an index
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefhasrule |
noolean
null |
True if the column has a rule defined
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefidx | number |
Return the index into the table definition in tv 0 for the name given. Return -1 if not found.
Parameters - name | the name of the column |
| getcoldefisaggrigate | boolean |
True if this is a aggregate field
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefiscompressed |
boolean
null |
True if compressed (no idea of what that is)
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefisdeleted |
boolean
null |
True if this column is marked for deletion on next savedef
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefismultibox |
boolean
null |
True if column is defined as multibox
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefisrequired |
boolean
null |
True if value is required in this column
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefisunique |
boolean
null |
True if this column must be unique
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefisvirtual |
boolean
null |
True if this column is a virtual column
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldeflength | number null |
Return length of the field if column is defined None if not
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefname |
string
null |
Return defined name of the column and None if not defined
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefreadsecurity | number null |
Return read securtiy 1-7 or None if column not defined
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefrule |
string
null |
Return the rule set on the column
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldeftype | number null |
The column type
DP_TEXT 0 DP_NUMERIC_STRING 1 DP_INTEGER 2 DP_FIXED 3 DP_FLOAT 4 DP_TIME 5 DP_DATE 6 DP_MONEY 7 DP_BOOLEAN 8 DP_CHOICE 9 DP_MEMO 13 Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getcoldefwritesecurity | number null |
Write security 1-7
Parameters - columnnr | the pos in tv 0 for the column to inquire |
| getlasterror | number | Last errorcode returned by a multiview operation |
| getlasterrorasstring | string | Return the extended error description as done by prism as a string. |
| getsaveerrors | Array | Return stored error list from save operation and clear it. |
| gettabledefcreatesecurity | number |
return the create security level as described under
HIGHLEVEL 1 MED1LEVEL 2 MED2LEVEL 3 MED3LEVEL 4 LOW1LEVEL 5 LOW2LEVEL 6 LOW3LEVEL 7 |
| gettabledefdeletesecurity | number |
return the delete security level as described in gettabledefcreatesecurity
|
| gettabledefdopreservedate | boolean | |
| gettabledefisinmemorytable | boolean | |
| gettabledefhasencrypteddata | boolean | |
| gettabledefmodifysecurity | number | return the modify security level as described in gettabledefcreatesecurity |
| gettabledefownership | number | 0 = Not Owned, 1 = DFD, 2 = DFW |
| gettabledefviewsecurity | number | return the view security level as described in gettabledefcreatesecurity |
| savedef | boolean | Go through all changed done to tdf by setcolumn class functions and save them to disk. All errors happening during the walk trough are logged and can be fetched by getsaveerrors() after. This function returns True of the save command was successful and False if not. This is not necessary without any errors during the column changes. To find those have a look at saveerrors. |
| setcoldefchoices | ||
| setcoldefdecimals | ||
| setcoldefderived | ||
| setcoldefdoprevent | ||
| setcoldefformat | ||
| setcoldefhasindex | ||
| setcoldefisdeleted | ||
| setcoldefisunique | ||
| setcoldefisvirtual | ||
| setcoldeflength | ||
| setcoldefname | ||
| setcoldefisrequired | ||
| setcoldefreadsecurity | ||
| setcoldefrule | ||
| setcoldeftype | ||
| setcoldefwritesecurity | ||
| settabledefcreatesecurity | null |
Set the create security level on tv 0
Parameters - level as described in gettabledefcreatesecurity |
| settabledefdeletesecurity | null |
Set the delete security level on tv 0
Parameters - level as described in gettabledefcreatesecurity |
| settabledefdopreservedate | null |
Set if table should preserve current date set on creation
Parameters - preserve | True do preserve it False change it on save to now |
| settabledefhasencrypteddata | null |
Change table attributes to 1 or 0
Parameters - hasencrypt | True set 1 False set 0 |
| settabledefmodifysecurity | null |
Set the modify security level on tv 0
Parameters - level as described in gettabledefcreatesecurity |
| settabledefownership | null |
Set if you have ownership of table definition
Parameters - ownershipval | 0 = Not Owned, 1 = DFD, 2 = DFW |
| settabledefviewsecurity | null |
Set the view security level on tv 0
Parameters - level as described in gettabledefcreatesecurity |
| testcoldefderived | string |
Test if a derivation will be valid for a field and return the generated error string from prism
Parameters - columnnr | the pos in tv 0 for the column to inquire - derivation | derivation to test |
| testcoldefformat | string |
Test if a format will be valid for a field and return the generated error string from prism
Parameters - columnnr | the pos in tv 0 for the column to inquire - derivation | derivation to test |
| testcoldefrule | string |
Test if a rule will be valid for a field and return the generated error string from prism
Parameters - columnnr | the pos in tv 0 for the column to inquire - derivation | derivation to test |
Ex.