InsertCol - method of the PmaDataTable object
Description:
The method inserts one new column on the specified position. Existing columns after this position are moved. All rows of the table are removed !
Syntax:
Long InsertCol(Long Col, String Name, Long Dt)
Parameters:
| Col | (Long) If the value of this parameter is the number >=0, then it is the column index (zero-based index) where the new column has to be inserted.
The -2 value means that new column has to be inserted to the end of the table. |
|---|
| Name | (String) Name of the new column. Already existing columns in this table mustn't have this name. |
|---|
| Dt | (Long) Data type of the column. See VBScript constants of data types. |
|---|
Return value:
Returns the index of the inserted column. It returns the negative number if an error occurred (the column has not been inserted). Then the error is written into the
INFO system.
Note:
Maximum number of columns depends on
PROMOTIC runtime licence and is:
PmRtProf: 65535,
PmRtFree: 30 and
PmRtXX: XX (for example
PmRt100: 100).
Caution! New column can be inserted after the column with data type
Identifier (if present).
"Read only" columns:
If at least one cell is locked in "Read only" column by writing non-empty value, then the whole structure of the table is locked. Then it is no longer possible to add or remove columns or rows or change the structure of the table. The structure and dimensions of the table must be defined and modified before writing first non-empty value into a cell in "Read only" column.
Example:
In the
/DataTable object (of the
PmaDataTable type)
one new column is inserted at the end of the table. The column has the name
"abc" and
Long data type:
JavaScriptVBScriptSelect and copy to clipboard
var oDataTable = pMe.Pm("/DataTable");
oDataTable.InsertCol(-2, "abc", 3);
// 3=Long
Dim oDataTable
Set oDataTable = pMe.Pm("/DataTable")
oDataTable.InsertCol -2, "abc", 3
' 3=Long