SetRowTextAll Method (DATATABLE)
10.5, PLBCMP GUI Only
The SetRowTextAll method adds or updates all of the row column subitems for a DATATABLE row using a single data string that is formatted with delimited data values. The method uses the following format:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. A DATATABLE object.
return
Optional. A Numeric Variable that indicates the success or failure for the method or the added row number.
row
Required. A Numeric Variable that specifies the row accessed.
text
Required. A Character String Variable or literal that contains a data string formatted as fields that are separated by a character delimiter.
delim
Optional. A Character String Variable or literal thatspecifies the delimiter character. If this parameter is not used, the default character is a comma.
Options
Optional. A bit mask value to control certain operations as described below.
Flags Affected: EOS, OVER, ZERO
Note the following:
The EOS flag is always cleared.
The ZERO flag is set if the {return} value is zero.
The OVER flag is set if the {return} variable is too small to receive the return value.
The {row} parameter value is zero-based row to be changed.
If a {row} is not specified, the default value is zero (0).
The {row} can also be a minus one (-1) value. In this case, the {text} data changes the DATATABLE column header data.
If the {options} bit mask is not specified, the default value is zero (0). Otherwise, the {options} is a bit mask value indicating one or more of the following option values:
|
Value |
Constant |
Meaning |
|
0x1 |
$TBL_CSVWR_QUOTED |
Allows formatted data that has double quote characters around field data strings. |
|
0x10 |
$TBL_CSVWR_NOZEROWIDTH |
Causes any column with a zero width to be skipped when the {text} data is being stored. The corresponding field in the {text} data is not skipped |
|
0x20 |
$TBL_CSVRD_REPLACEROW |
Replaces the data in the object for the row that is specified by the row parameter value. |
|
0x40 |
$TBL_CSVRD_SKIPNUL |
Skips null fields (back to back delimiter characters). Thus, the relative column data is not changed or blanked by the null field. This value is only valid when the $TBL_CSVRD_REPLACEROW bit is set. |
|
0x80 |
$TBL_CSVRD_NOBINARYCHARS |
Causes the method to terminate its execution when any character less than 0x20 is encountered in the data. |
See Also: Method Syntax, DATATABLE Methods
|
|