Difference between revisions of "Programmer Guide/Command Reference/PARSECELLMESSAGE"

From STX Wiki
Jump to navigation Jump to search
Line 2: Line 2:
 
  PARSECELLMESSAGE <var>srcvar</var> <var>itemvar</var> <var>rowvar</var> <var>colvar</var> <var>newlenvar newvalvar</var> <var>oldlenvar</var> <var>oldvalvar</var>
 
  PARSECELLMESSAGE <var>srcvar</var> <var>itemvar</var> <var>rowvar</var> <var>colvar</var> <var>newlenvar newvalvar</var> <var>oldlenvar</var> <var>oldvalvar</var>
  
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 listview controls]]. The arguments are the names of variables with the following properties:
+
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 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

Revision as of 18:27, 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 name CELLEDITED or CELLEDITEDBACKTAB, 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)