Programmer Guide/Command Reference/PARSECELLMESSAGE: Difference between revisions
From STX Wiki
Jump to navigationJump to search
m (1 revision: Initial import) |
No edit summary |
||
(7 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
PARSECELLMESSAGE <var>srcvar</var> <var>itemvar</var> <var>rowvar</var> <var>colvar</var> <var>newlenvar newvalvar</var> <var>oldlenvar</var> <var>oldvalvar</var> | |||
<code>PARSECELLMESSAGE | The <code>PARSECELLMESSAGE</code> command (aka <code>PARSECELLMSG</code>) facilitates parsing [[Programmer_Guide/Shell_Items/Dialog/DISPLAY_and_DIALOG_Messages#ListView_message|cell messages]] sent by [[Programmer_Guide/Shell_Items/Dialog/Dialog_Controls#LISTVIEW|listview controls]]. The arguments are the names of variables with the following properties: | ||
* the variable whose name is stored in <var>srcvar</var> contains the input to <code>PARSECELLMESSAGE</code>, i.e. the argument passed to the message name <code>CELLEDITED</code> or <code>CELLEDITEDBACKTAB</code>, respectively | |||
* the variables whose names are stored in the remaining arguments are where the parsed output of the <code>PARSECELLMESSAGE</code> command will be stored. Their meaning is as follows: | |||
:* the variable whose name is stored in <var>itemvar</var> will be set to the number of the dialog item the message is referring to; | |||
:* the variables whose names are stored in <var>rowvar</var> and <var>colvar</var>, respectively, will be set to the row and the column the cell message is referring to; | |||
:* the variables whose names are stored in <var>newlenvar</var> and <var>newvalvar</var> will be set to the length of the ''new'' value of the respective cell, and to this value itself, respectively; and, finally, | |||
:* the variables whose names are stored in <var>oldlenvar</var> and <var>oldvalvar</var> will be set to the length of the ''old'' value of the respective cell (i.e. the value it contained *before* the edit reported by the message has taken place) | |||
Latest revision as of 17:29, 25 April 2014
PARSECELLMESSAGE srcvar itemvar rowvar colvar newlenvar newvalvar oldlenvar oldvalvar
The PARSECELLMESSAGE
command (aka PARSECELLMSG
) facilitates parsing cell messages sent by listview controls. The arguments are the names of variables with the following properties:
- the variable whose name is stored in srcvar contains the input to
PARSECELLMESSAGE
, i.e. the argument passed to the message nameCELLEDITED
orCELLEDITEDBACKTAB
, respectively
- the variables whose names are stored in the remaining arguments are where the parsed output of the
PARSECELLMESSAGE
command will be stored. Their meaning is as follows:
- the variable whose name is stored in itemvar will be set to the number of the dialog item the message is referring to;
- the variables whose names are stored in rowvar and colvar, respectively, will be set to the row and the column the cell message is referring to;
- the variables whose names are stored in newlenvar and newvalvar will be set to the length of the new value of the respective cell, and to this value itself, respectively; and, finally,
- the variables whose names are stored in oldlenvar and oldvalvar will be set to the length of the old value of the respective cell (i.e. the value it contained *before* the edit reported by the message has taken place)