SetItemTextAll Method (LISTVIEW)
9.1A, PLBCMP GUI Only
The SetItemTextAll method adds or updates all of the subitems for a LISTVIEW item 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 LISTVIEW object that is accessed.
return
Optional. A Numeric Variable that indicates the success or failure for the method or the added row number.
index
Required. A zero-based decimal number or Numeric Variable that specifies the row.
text
Required. A Character String Variable or literal that contains a data string formatted as fields separated by a character delimiter.
delim
Optional. A Character String Variable or literal that specifies the delimiter character.
options
Optional. A bit mask value to control certain operations.
param
Optional. A decimal number or Numeric Variable that specifies a new user-defined value. (9.5A)
Flags Affected: EOS, OVER, ZERO
Note the following:
The {index} parameter value is zero based index value that specifies the LISTVIEW row item to be changed.
The {index} can also be a minus one (-1) value. In this case, the {text} data changes the LISTVIEW column header data.
When the {delim} is not specified, the default delimiter is a comma.
When the $LV_SETITEM_REPLACEROW option is not specified, the value returned is the added row index. Otherwise {return} is a zero and the ZERO flag is set. (9.3A)
The EOS and OVER Condition Flags are always cleared.
When the {options} bit mask value is specified, the bit definitions are defined as follows:
|
Keyword |
Value |
This control bit … |
|
$LV_SETITEM_QUOTED |
0x1 |
allows formatted data that has double quote characters around field data strings. |
|
$LV_SETITEM_NOZEROWIDTH |
0x10 |
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. |
|
$LV_SETITEM_REPLACEROW |
0x20 |
replaces the data in the object for the row that is specified by the Index parameter value. |
|
$LV_SETITEM_SKIPNULL |
0x40 |
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 $LV_SETITEM_REPLACEROW bit is set. |
|
$LV_SETITEM_NOBINARYCHARS |
0x80 |
causes the method to terminate its execution when any character less than 0x20 is encountered in the *TEXT input data. |
See Also: Method Syntax, LISTVIEW Methods
|
|