1MRS751856-MEN Issued: 15.03.2002 Version: A Program revision: 8.4.4 Visual SCIL Objects Technical Reference Manual SYS 500 We reserve the right to change data without prior notice. Notice 1 The information in this document is subject to change without notice and should not be construed as a commitment by ABB. ABB assumes no responsibility for any error that may occur in this document. Notice 2 This document complies with the program revision 8.4.4. Notice 3 Additional information such as Release Notes and Last Minute Remarks can be found on the program distribution media. Trademarks Microsoft is a registered trademark of Microsoft Corporation. Windows NT is a trademark of Microsoft Corporation. LONWORKS is a registered trademark of Echelon Corporation. Other brand or product names are trademarks or registered trademarks of their respective holders. All Microsoft products referenced in this document are either trademarks or registered trademarks of Microsoft Corporation.
1MRS751856-MEN Visual SCIL Objects Technical Reference Manual SYS 500 MicroSCADA Technology Manuals Application Objects Introduction to MicroSCADA Technology JAVA-API for MicroSCADA Programming Language SCIL SCIL-API for MicroSCADA Status Codes System Configuration System Objects Configuring MicroSCADA for OPC DA Client 1MRS751848-MEN 1MRS751852-MUM 1MRS751851-MEN 1MRS751849-MEN 1MRS752199-MEN 1MRS751850-MEN 1MRS751846-MEN 1MRS751847-MEN 1MRS752246-MEN SYS 500 manuals Installation Picture Editing System Management Visual SCIL Objects Visual SCIL User Interface Design 1MRS751853-MEN 1MRS751854-MEN 1MRS751857-MEN 1MRS751856-MEN 1MRS751855-MEN COM 500 manuals COM 500 Engineering Connecting LONWORKS Devices to MicroSCADA Communication Programming Interface (CPI) Configuring MicroSCADA for DNP V3.00 Master Protocol Configuring MicroSCADA for DNP V3.00 Slave Protocol Configuring MicroSCADA for IEC 60870-5 101 Master Protocol Configuring MicroSCADA for IEC 60870-5 101 Slave Protocol Configuring MicroSCADA for IEC 60870-5-103 Master Protocol Configuring MicroSCADA for IEC 60870-5-104 Master Protocol Configuring MicroSCADA for IEC 60870-5-104 Slave Protocol Configuring MicroSCADA for Modbus Master Protocol Configuring MicroSCADA for Modbus Slave Protocol 1MRS751858-MEN 1MRS751845-MEN 1MRS751859-MEN 1MRS751860-MEN 1MRS751861-MEN 1MRS751862-MEN 1MRS751863-MEN 1MRS752012-MEN 1MRS751964-MEN 1MRS751965-MEN 1MRS752242-MEN 1MRS751864-MEN
SYS 500 Visual SCIL Objects Technical Reference Manual 1MRS751856-MEN LIB 500 manuals LIB 500 Configuration Manual LIB 500 Operator s Manual 1MRS751880-MEN 1MRS751885-MUM LIB 510 manuals LIB 510 Configuration LIB 510 MV Process Configuration LIB 510 MV Process Operator s Manual LIB 510 Operator s Manual 1MRS751886-MEN 1MRS751887-MEN 1MRS751891-MUM 1MRS751888-MUM SMS 510 manuals SMS 510 Installation and Commissioning SMS 510 Operator s Manual 1MRS751897-MEN 1MRS751898-MUM CAP 505 manuals CAP 505 Installation and Commissioning CAP 505 Operator s Manual Relay Configuration Tool Tutorial Relay Mimic Editor Configuration Relay Configuration Tool Quick Start Reference SPTO Configuration Tool Protocol Editing Tool 1MRS751901-MEN 1MRS751902-MUM 1MRS751903-MEN 1MRS751904-MEN 1MRS751905-MEN 1MRS751906-MEN 1MRS751982-MUM Common manual for LIB, CAP and SMS Tools for Relays and Terminals 1MRS752008-MUM
1MRS751856-MEN Visual SCIL Objects Technical Reference Manual SYS 500 Contents Contents: 1. General properties...1 1.1. Overview...1 1.2. Details...2 2. VS_BOX...9 2.1. Overview...9 2.2. Details...10 3. VS_BUTTON...15 3.1. Overview...15 3.2. Details...16 4. VS_CHECK_BOX...23 4.1. Overview...23 4.2. Details...24 5. VS_COMBO...31 5.1. Overview...31 5.2. Details...32 6. VS_COMBO_POPDOWN...41 6.1. Overview...41 6.2. Details...43 7. VS_CONTAINER...53 7.1. Overview...53 7.2. Details...54 8. VS_DIALOG...65 8.1. Overview...65 8.2. Details...67 9. VS_FILE_CHOOSER...81 9.1. Overview...81 9.2. Details...83 10.VS_GRAPH...97 10.1.Overview...97 10.2.Details...98 11.VS_GRAPH_LEGEND...109 11.1.Overview...109 11.2.Details...110 12.VS_HEADER...115 12.1.Overview...115 12.2.Details...116
SYS 500 Contents Visual SCIL Objects Technical Reference Manual 1MRS751856-MEN 13.VS_HEADER_ITEM... 125 13.1.Overview... 125 13.2.Details... 125 14.VS_ICON_VIEW... 129 14.1.Overview... 129 14.2.Details... 131 15.VS_IMAGE... 143 15.1.Overview... 143 15.2.Details... 143 16.VS_IMAGE_DOMAIN... 149 16.1.Overview... 149 16.2.Details... 151 17.VS_IMAGE_EDITOR... 163 17.1.Overview... 163 17.2.Details... 164 18.VS_INPUT_DIALOG... 179 18.1.Overview... 179 18.2.Details... 181 19.VS_LABEL... 195 19.1.Overview... 195 19.2.Details... 195 20.VS_LINE... 199 20.1.Overview... 199 20.2.Details... 199 21.VS_LIST... 203 21.1.Overview... 203 21.2.Details... 205 22.VS_MAIN_DIALOG... 219 22.1.Overview... 219 22.2.Details... 221 23.VS_MENU... 237 23.1.Overview... 237 23.2.Details... 238 24.VS_MENU_ITEM... 243 24.1.Overview... 243 24.2.Details... 244 25.VS_MENUBAR... 247 25.1.Overview... 247 25.2.Details... 248
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual Contents 26.VS_NOTEBOOK...253 26.1.Overview...253 26.2.Details...254 27.VS_NOTEBOOK_PAGE...259 27.1.Overview...259 27.2.Details...260 28.VS_NOTICE_DIALOG...267 28.1.Overview...267 28.2.Details...269 29.VS_NUMERIC_SPINNER...287 29.1.Overview...287 29.2.Details...288 30.VS_OPTION_BUTTON...295 30.1.Overview...295 30.2.Details...296 31.VS_PALETTE...303 31.1.Overview...303 31.2.Details...304 32.VS_PICTURE_CONTAINER...315 32.1.Overview...315 32.2.Details...316 33.VS_PRINT_OBJECT...323 33.1.Overview...323 33.2.Details...324 34.VS_PROGRAM_EDITOR...329 34.1.Overview...329 34.2.Details...331 35.VS_SCROLL_BAR...345 35.1.Overview...345 35.2.Details...346 36.VS_SEPARATOR_MENU_ITEM...353 36.1.Overview...353 36.2.Details...353 37.VS_SLIDER...355 37.1.Overview...355 37.2.Details...356 38.VS_SPLIT_BAR...363 38.1.Overview...363 38.2.Details...364
SYS 500 Contents Visual SCIL Objects Technical Reference Manual 1MRS751856-MEN 39.VS_SUB_MENU_ITEM... 367 39.1.Overview... 367 39.2.Details... 367 40.VS_TABLE... 371 40.1.Overview... 371 40.2.Details... 376 41.VS_TEXT... 419 41.1.Overview... 419 41.2.Details... 421 42.VS_TEXT_EDITOR... 435 42.1.Overview... 435 42.2.Details... 437 43.VS_TEXT_SPINNER... 451 43.1.Overview... 451 43.2.Details... 452 44.VS_TOGGLE_MENU_ITEM... 461 44.1.Overview... 461 44.2.Details... 462 45.VS_TREE... 465 45.1.Overview... 465 45.2.Details... 467
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 1. General properties 1. General properties 1.1. Overview Below are some general properties (attributes and methods) described. The properties described here are not described again together with the object types only listed in the overview section if they exist. Predefined attributes 1DPH 7\SH _ATTRIBUTE_NAMES List _BACKGROUND_COLOR Color _CHILD_OBJECTS vector _FILE_REVISION _FONT Font _FOREGROUND_COLOR Color _GEOMETRY List _MAX_HEIGHT Integer _MAX_WIDTH Integer _MIN_HEIGHT Integer _MIN_WIDTH Integer _OBJECT_CLASS _OBJECT_NAME _SCIL_GEOMETRY List _SOURCE_FILE_NAME _VARIABLE_NAMES vector Predefined methods 1DPH 7\SH _FLAG_FOR_EXECUTION _GET_HELP _QUEUE_FOR_EXECUTION _SET_MAX_SIZE _SET_MIN_SIZE 1
SYS 500 Visual SCIL Objects 1MRS751856-MEN 1. General properties Technical Reference Manual 1.2. Details Predefined attributes B$775,%87(B1$0(6 Contains the names of all attributes known to the object. Note: A list containing two text vector attributes; USER_DEFINED and PREDEFINED. The attribute USER_DEFINED is a text vector containing the names of user-defined attributes, i.e. the attributes created by.modify command (or by.set command in a picture container context). The attribute PREDEFINED is a text vector containing the names of the attributes defined by the object class. List Environment dependent Read-only The attributes are listed in no particular order. B%$& *5281'B&2/25 The background color of the object. This is the color that is used when drawing the background of the object. If the color is not specified it is inherited from the parent object. A color as represented in SCIL. "Color" Environment dependent B&+,/'B2%-(&76 The names of the immediate children of the object listed in the order of creation. The names of the immediate children of the object. vector Environment dependent Read-only B),/(B5(9,6,21 The revision text of the file from which the object/picture was loaded. A character string containing up to 255 characters. Environment dependent Read-only 2
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 1. General properties B)217 The font used when displaying texts in an object. If the font is set on an object which contains other objects (dialogs, containers, etc.) the same font will be used in the contained object as well. If the font is specifically set on one of the contained objects this will not change. A font as represented in SCIL "Font" Environment dependent B)25(*5281'B&2/25 The foreground color of the object. This is the color that is used on e.g. titles and other texts in an object. If the color is not specified it is inherited from the parent ob-ject. A color as represented in SCIL "Color" Environment dependent B*(20(75< The size and position of the object in VS coordinates. The position is always relative to the parent object. The position of dialogs is relative to the screen. The size of a dialog defines the content area of the dialog excluding borders, title bars, etc. but in all other cases the size is defined by the bounding rectangle of the object including possible borders, scrollbars etc. This attribute cannot always be set freely due to re-strictions based on possibly defined minimum or maximum sizes or automatic ge-ometry management. A list containing the attributes X, Y, W, H, representing the position horisontally (X) and vertically (Y) as well as the width (W) and height (H), all according to the VS coordinate system. List Object dependent B0$;B+(,*+7 Specifies the maximum height of the object. This restricts both user and programmatic manipulation of the object. The value can be set by means of the _SET_MAX_SIZE method. The maximum height in VS coordinates. Integer 32767 Read-only 3
SYS 500 Visual SCIL Objects 1MRS751856-MEN 1. General properties Technical Reference Manual B0$;B:,'7+ Specifies the maximum width of the object. This restricts both user and programmatic manipulation of the object. The value can be set by means of the _SET_MAX_SIZE method. The maximum width in VS coordinates. Integer 32767 Read-only B0,1B+(,*+7 Specifies the minimum height of the object. This restricts both user and programmatic manipulation of the object. The value can be set by means of the _SET_MIN_SIZE method. The minimum height in VS coordinates. Integer 0 Read-only B0,1B:,'7+ Specifies the minimum width of the object. This restricts both user and programmatic manipulation of the object. The value can be set by means of the _SET_MIN_SIZE method. The minimum width in VS coordinates. Integer 0 Read-only B2%-(&7B&/$66 Specifies the name of the class of the object. If the object is a window or picture function, the attribute has value "WINDOW" or "PICTURE_FUNCTION", respectively. A character string containing up to 255 characters. Object dependent Read-only B2%-(&7B1$0( Specifies the name of the object. A character string containing up to 255 characters. Object dependent Read-only 4
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 1. General properties B6&,/B*(20(75< The size and position of the object in SCIL coordinates. The position is always rela-tive to the parent object. The position of dialogs is relative to the screen. The size of a dialog defines the content area of the dialog excluding borders, title bars, etc. but in all other cases the size is defined by the bounding rectangle of the object including possible borders, scrollbars etc. This attribute cannot always be set freely due to re-strictions based on possibly defined minimum or maximum sizes or automatic ge-ometry management. A list containing the attributes X, Y, W, H, representing the position horisontally (X) and vertically (Y) as well as the width (W) and height (H), all according to the SCIL coordinate system. List Object dependent B6285&(B),/(B1$0( The full operating system format name of the vso file where the object has been loaded from or the full name of the pic file where the window or picture function has been read from. Value is an empty string, if the object is created on-the-fly, i.e. using.create,!win_name or!win_create. A character string containing up to 255 characters. Environment dependent Read-only B9$5,$%/(B1$0(6 The names of SCIL variables defined in the SCIL context that the object belongs to. Note: A text vector containing the variable names. vector Environment dependent Read-only The names are listed in no particular order. Predefined methods B)/$*B)25B(;(&87,21 This method is used when the programmer wants to execute a SCIL program at a later point in time when the system is idle. An identifier for the flagged execution as well as the program to be executed are given as parameters in the method call. An empty text value is allowed for the identifier. There is no way to exactly know when in time the program is executed. A minimum time that have to expire can 5
SYS 500 Visual SCIL Objects 1MRS751856-MEN 1. General properties Technical Reference Manual however be defined in seconds as an optional third parameter in the method call. If _FLAG_FOR_EXECUTION method of an object is called twice using the same name, the first flagged execution is cancelled if not yet done. Below is an example that shows how to ensure that the blocking cursor of a dialog is switched off after a long program execution even if an error occurs that interrupts the normal program flow.... my_dialog._flag_for_execution("unblock", ".set my_dialog._blocked = false").set my_dialog._blocked = true ;long SCIL processing here... Return value : NAME PROGRAM DELAY value used as the identifier of the flagged execution or vector; program to be executed Real; minimum delay in seconds B*(7B+(/3 Requests help for the object. Executing this method is equal to pressing the help but-ton (F1 on MS-Windows look and feel) when the object is in focus. Return value B48(8(B)25B(;(&87,21 This method is used when the programmer wants to execute a SCIL program at a later point in time when the system is idle. The program to be executed is given as pa-rameter in the method call. There is no way to exactly know when in time the program is executed. A minimum time that have to expire can however be defined in seconds as an optional second parameter in the method call. The maximum number of queued programs per object is 100. If this limit is exceeded all queued executions are re-moved and a SCIL error is produced. Below is an example that shows how to ensure that the blocking cursor of a dialog is switched off after a long program execution even if an error occurs that interrupts the normal program flow.... my_dialog._queue_for_execution(".set my_dialog._blocked = false").set my_dialog._blocked = true ;long SCIL processing here... Return value : PROGRAM DELAY or vector; program to be executed Real; minimum delay in seconds 6
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 1. General properties B6(7B0$;B6,=( Sets the maximum size of the object. This restricts both user and programmatic manipulation of the object size. Return value : WIDTH HEIGHT Integer; width in VS coordinates Integer; height in VS coordinates B6(7B0,1B6,=( Sets the minimum size of the object. This restricts both user and programmatic manipulation of the object size. Return value : WIDTH HEIGHT Integer; width in VS coordinates Integer; height in VS coordinates 7
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 2. VS_BOX 2. VS_BOX 2.1. Overview The VS_BOX item is a simple dialog item that does not contain any functionality. The object visualises a box that can be used to visually group related interface objects together. When a functional grouping of objects is desired the container should be used instead of the box. The box can also be used to accommodate a VS_IMAGE. The appearance of the box depends on the current platform. Action Attributes 1DPH _GET_TABLE_EDIT_TEXT _GET_TABLE_VIEW_TEXT _UPDATE_TABLE_EDIT_TEXT _UPDATE_TABLE_VIEW_TEXT 7\SH vector vector vector vector Action Methods 1DPH GET_TABLE_EDIT_TEXT GET_TABLE_VIEW_TEXT UPDATE_TABLE_EDIT_TEXT UPDATE_TABLE_VIEW_TEXT 7\SH Predefined Attributes 1DPH _ATTRIBUTE_NAMES _BACKGROUND_COLOR _CHILD_OBJECTS _ENABLED _FILE_REVISION _FONT _FOREGROUND_COLOR _GEOMETRY _HAS_BORDER _HAS_IMAGE_MASK _IMAGE _OBJECT_CLASS _OBJECT_NAME _SCIL_GEOMETRY 7\SH List Color vector Font Color List Image reference List 9
SYS 500 Visual SCIL Objects 1MRS751856-MEN 2. VS_BOX Technical Reference Manual _SOURCE_FILE_NAME _TITLE _VARIABLE_NAMES _VISIBLE vector Predefined Methods 1DPH _FLAG_FOR_EXECUTION _GET_HELP _GET_STRING_WIDTH _QUEUE_FOR_EXECUTION 7\SH Integer 2.2. Details Action Attributes B*(7B7$%/(B(',7B7(;7 Setting of this attribute specifies the action method GET_TABLE_EDIT_TEXT. vector B*(7B7$%/(B9,(:B7(;7 Setting of this attribute specifies the action method GET_TABLE_VIEW_TEXT. vector B83'$7(B7$%/(B(',7B7(;7 Setting of this attribute specifies the action method UPDATE_TABLE_EDIT_TEXT. vector B83'$7(B7$%/(B9,(:B7(;7 Setting of this attribute specifies the action method UPDATE_TABLE_VIEW_TEXT. vector Action Methods *(7B7$%/(B(',7B7(;7 This action method is executed whenever the table needs a value from an edit object. This method is executed just before the edit object of the cell is closed (just before the CELL_EDITING_ACCEPTED action method). This function can be used for 10
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 2. VS_BOX example to convert internal edit object value to text value, which is stored in the cell. This action method is called with two parameters: ROW and COLUMN of the current cell. This action method should return a text string. Data type to be returned: *(7B7$%/(B9,(:B7(;7 This action method is executed whenever the table needs the value for the view object of the current cell. For example, this method is executed when the view object is drawn into the cell. This function can be used for example to convert edit object value of the cell to the text value of the cell. Data type to be returned: 83'$7(B7$%/(B(',7B7(;7 This action method is executed whenever the edit object of the cell needs a value to be shown. This method is executed just before the editing of the cell is started (just after the CELL_EDITING_STARTED action method). This action method has three parameters ROW and COLUMN of the cell and the text of the cell. This action method could be used to convert the text value of the view object to the edit object value. Data type to be returned: 83'$7(B7$%/(B9,(:B7(;7 This action method is executed whenever the table needs a value for the view object. This method is executed just before the view object of the cell is drawn. This function can be used for example to convert the text value of the cell, to the current value of the view object, which is shown in the view object. This action method has three parameters ROW and COLUMN of the cell and the TEXT of the cell. Data type to be returned: Predefined Attributes B$775,%87(B1$0(6 B%$& *5281'B&2/25.SET MY_OBJECT._BACKGROUND_COLOR = (65535, 65535, 65535) B&+,/'B2%-(&76 11
SYS 500 Visual SCIL Objects 1MRS751856-MEN 2. VS_BOX Technical Reference Manual B(1$%/(' Specifies whether the dialog item responds to various events. A change of appearance is also often combined with this attribute. When setting this attribute to FALSE, the disabled dialog item is displayed as dimmed. TRUE.SET MY_OBJECT._ENABLED = FALSE B),/(B5(9,6,21 B)217.SET MY_OBJECT._FONT = ( M, 1) B)25(*5281'B&2/25.SET MY_OBJECT._FOREGROUND_COLOR = (65535, 0, 0) B*(20(75<.SET MY_OBJECT._GEOMETRY = LIST(X = 10, Y = 10, W = 100, H = 100) B+$6B%25'(5 Determines whether the box item should be drawn with a border or not. TRUE.SET MY_OBJECT._HAS_BORDER = FALSE 12
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 2. VS_BOX B+$6B,0$*(B0$6 Specifies whether the image of the dialog item is drawn as a mask for the item foreground color or not. If this attribute is TRUE then the background of the dialog item is visible through the image. Note that not all dialog items can contain an image. FALSE.SET MY_OBJECT._HAS_IMAGE_MASK = TRUE B,0$*( Specifies an image that is associated with the object. The way that the image is displayed depends on the object. The image is given as an object reference to the image that has been loaded or created as an independent object. A reference to a VS_IMAGE object. A VS_IMAGE can be created using the SCIL function.create or loaded using the function.load. Image reference Empty text.load ROOT\ IMAGE1 = VS_IMAGE(....SET ROOT\ MY_BUTTON._IMAGE = ROOT\ IMAGE1 B2%-(&7B&/$66 B2%-(&7B1$0( B6&,/B*(20(75< B6285&(B),/(B1$0( B7,7/( Specifies the title of the dialog item. 13
SYS 500 Visual SCIL Objects 1MRS751856-MEN 2. VS_BOX Technical Reference Manual A character string containing up to 255 characters. Empty text.set MY_OBJECT._TITLE = Tool Properties B9$5,$%/(B1$0(6 B9,6,%/( Specifies whether the dialog item is visible or not. Setting this attribute to FALSE may be useful if the dialog item should be invisible when opening the dialog. TRUE.SET MY_OBJECT._VISIBLE = FALSE Predefined Methods B)/$*B)25B(;(&87,21 B*(7B+(/3 B*(7B675,1*B:,'7+ Returns the width of the given string in the current font of the object. Return value data type:integer STRING A character string containing up to 255 characters. B48(8(B)25B(;(&87,21 14
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 3. VS_BUTTON 3. VS_BUTTON 3.1. Overview A VS_BUTTON is a dialog item that can activate a command but have no value. To be useful a button needs the action method NOTIFY that is executed when the user clicks the button. A button is activated when the user clicks with the pointer inside the button. Buttons can also be activated by pressing certain keys in the keyboard that depend on the current look-and-feel. The button can be used to accommodate a VS_IMAGE. Action Attributes 1DPH _GET_TABLE_EDIT_TEXT _GET_TABLE_VIEW_TEXT _NOTIFY _UPDATE_TABLE_EDIT_TEXT _UPDATE_TABLE_VIEW_TEXT 7\SH vector vector vector vector vector Action Methods 1DPH GET_TABLE_EDIT_TEXT GET_TABLE_VIEW_TEXT NOTIFY UPDATE_TABLE_EDIT_TEXT UPDATE_TABLE_VIEW_TEXT 7\SH Predefined Attributes 1DPH _ATTRIBUTE_NAMES _BACKGROUND_COLOR _CHILD_OBJECTS _CLICK_FOCUSABLE _ENABLED _FILE_REVISION _FOCUSABLE _FOCUSED _FONT _FOREGROUND_COLOR _GEOMETRY 7\SH List Color vector Font Color List 15
SYS 500 Visual SCIL Objects 1MRS751856-MEN 3. VS_BUTTON Technical Reference Manual _HAS_BORDER _HAS_IMAGE_MASK _IMAGE _MNEMONIC _OBJECT_CLASS _OBJECT_NAME _POP_UP_MENU _SCIL_GEOMETRY _SOURCE_FILE_NAME _TITLE _VARIABLE_NAMES _VISIBLE Image reference Menu reference List vector Predefined Methods 1DPH _FLAG_FOR_EXECUTION _GET_HELP _GET_STRING_WIDTH _QUEUE_FOR_EXECUTION 7\SH Integer 3.2. Details Action Attributes B*(7B7$%/(B(',7B7(;7 Setting of this attribute specifies the action method GET_TABLE_EDIT_TEXT. vector B*(7B7$%/(B9,(:B7(;7 Setting of this attribute specifies the action method GET_TABLE_VIEW_TEXT. vector B127,)< Setting of this attribute specifies the action method NOTIFY. vector.set MY_OBJECT._NOTIFY = ( ROOT.OPEN_EDIT_DIALOG, ) 16
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 3. VS_BUTTON B83'$7(B7$%/(B(',7B7(;7 Setting of this attribute specifies the action method UPDATE_TABLE_EDIT_TEXT. vector B83'$7(B7$%/(B9,(:B7(;7 Setting of this attribute specifies the action method UPDATE_TABLE_VIEW_TEXT. vector Action Methods *(7B7$%/(B(',7B7(;7 This action method is executed whenever the table needs a value from an edit object. This method is executed just before the edit object of the cell is closed (just before the CELL_EDITING_ACCEPTED action method). This function can be used for example to convert internal edit object value to text value, which is stored in the cell. This action method is called with two parameters: ROW and COLUMN of the current cell. This action method should return a text string. Data type to be returned: *(7B7$%/(B9,(:B7(;7 This action method is executed whenever the table needs the value for the view object of the current cell. For example, this method is executed when the view object is drawn into the cell. This function can be used for example to convert edit object value of the cell to the text value of the cell. Data type to be returned: 127,)< The NOTIFY action method is executed when the button is clicked or otherwise activated.! When the button has a _POP_UP_MENU, the NOTIFY action method won t be called. Data type to be returned: 83'$7(B7$%/(B(',7B7(;7 This action method is executed whenever the edit object of the cell needs a value to be shown. This method is executed just before the editing of the cell is started (just after the CELL_EDITING_STARTED action method). This action method has three parameters ROW and COLUMN of the cell and the text of the cell. This action 17
SYS 500 Visual SCIL Objects 1MRS751856-MEN 3. VS_BUTTON Technical Reference Manual method could be used to convert the text value of the view object to the edit object value. Data type to be returned: 83'$7(B7$%/(B9,(:B7(;7 This action method is executed whenever the table needs a value for the view object. This method is executed just before the view object of the cell is drawn. This function can be used for example to convert the text value of the cell, to the current value of the view object, which is shown in the view object. This action method has three parameters ROW and COLUMN of the cell and the TEXT of the cell. Data type to be returned: Predefined Attributes B$775,%87(B1$0(6 B%$& *5281'B&2/25.SET MY_OBJECT._BACKGROUND_COLOR = (65535, 65535, 65535) B&+,/'B2%-(&76 B&/,& B)2&86$%/( Specifies whether the dialog item receives focus when it is clicked. FALSE.SET MY_OBJECT._CLICK_FOCUSABLE = FALSE B(1$%/(' Specifies whether the dialog item responds to various events. A change of appearance is also often combined with this attribute. When setting this attribute to FALSE, the disabled dialog item is displayed as dimmed. 18
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 3. VS_BUTTON TRUE.SET MY_OBJECT._ENABLED = FALSE B),/(B5(9,6,21 B)2&86$%/( Specifies whether the dialog item receives focus during normal keyboard traversal. TRUE.SET MY_OBJECT._FOCUSABLE = FALSE B)2&86(' Contains the value TRUE if the dialog item has the keyboard focus. Environment dependent Read-only @HAS_FOCUS = MY_OBJECT._FOCUSED B)217.SET MY_OBJECT._FONT = ( M, 1) B)25(*5281'B&2/25.SET MY_OBJECT._FOREGROUND_COLOR = (65535, 0, 0) B*(20(75< 19
SYS 500 Visual SCIL Objects 1MRS751856-MEN 3. VS_BUTTON Technical Reference Manual.SET MY_OBJECT._GEOMETRY = LIST(X = 10, Y = 10, W = 100, H = 100) B+$6B%25'(5 Determines whether the dialog item should be drawn with a border or not. The exact interpretation of this attribute is dependent on the object type. TRUE.SET MY_OBJECT._HAS_BORDER = FALSE B+$6B,0$*(B0$6 Specifies whether the image of the dialog item is drawn as a mask for the item foreground color or not. If this attribute is TRUE then the background of the dialog item is visible through the image. Note that not all dialog items can contain an image. FALSE.SET MY_OBJECT._HAS_IMAGE_MASK = TRUE B,0$*( Specifies an image that is associated with the object. The way that the image is displayed depends on the object. The image is given as an object reference to the image that has been loaded or created as an independent object. A reference to a VS_IMAGE object. A VS_IMAGE can be created using the SCIL function.create or loaded using the function.load. Image reference Empty text.load ROOT\ IMAGE1 = VS_IMAGE(....SET ROOT\ MY_BUTTON._IMAGE = ROOT\ IMAGE1 20
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 3. VS_BUTTON B01(021,& Specifies the mnemonic character of the dialog item. The mnemonic may be visualized differently on different platforms. A character string containing 1 character. ASCII(0).SET MY_OBJECT._MNEMONIC = A B2%-(&7B&/$66 B2%-(&7B1$0( B323B83B0(18 Specifies so called pop up menu that is associated with the object. This menu is activated with the right mouse button.! When the _POP_UP_MENU is defined, the action method _NOTIFY won t be executed. A reference to a VS_MENU object. A VS_MENU can be created using the SCIL function.create or loaded from a file using the function.load. Menu reference Empty text.load ROOT\ MENU1 = VS_MENU(....SET ROOT\ MY_BUTTON._POP_UP_MENU = ROOT\ MENU1 B6&,/B*(20(75< B6285&(B),/(B1$0( 21
SYS 500 Visual SCIL Objects 1MRS751856-MEN 3. VS_BUTTON Technical Reference Manual B7,7/( Specifies the title of the dialog item. A character string containing up to 255 characters. Empty text.set MY_OBJECT._TITLE = Tool Properties B9$5,$%/(B1$0(6 B9,6,%/( Specifies whether the dialog item is visible or not. Setting this attribute to FALSE may be useful if the dialog item should be invisible when opening the dialog. TRUE.SET MY_OBJECT._VISIBLE = FALSE Predefined Methods B)/$*B)25B(;(&87,21 B*(7B+(/3 B*(7B675,1*B:,'7+ Returns the width of the given string in the current font of the object. Return value data type:integer STRING A character string containing up to 255 characters. B48(8(B)25B(;(&87,21 22
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 4. VS_CHECK_BOX 4. VS_CHECK_BOX 4.1. Overview A VS_CHECK_BOX object is an object that can be selected or cleared (deselected). The appearance of the object is dependent on the graphics platform. The attribute _VALUE contains the current state of the check box. The NOTIFY action method is called whenever the check box is clicked. Action Attributes 1DPH _GET_TABLE_EDIT_TEXT _GET_TABLE_VIEW_TEXT _NOTIFY _UPDATE_TABLE_EDIT_TEXT _UPDATE_TABLE_VIEW_TEXT 7\SH vector vector vector vector vector Action Methods 1DPH GET_TABLE_EDIT_TEXT GET_TABLE_VIEW_TEXT NOTIFY UPDATE_TABLE_EDIT_TEXT UPDATE_TABLE_VIEW_TEXT 7\SH Predefined Attributes 1DPH _ATTRIBUTE_NAMES _BACKGROUND_COLOR _CHILD_OBJECTS _CLICK_FOCUSABLE _ENABLED _FILE_REVISION _FOCUSABLE _FOCUSED _FONT _FOREGROUND_COLOR _GEOMETRY _MNEMONIC 7\SH List Color vector Font Color List 23
SYS 500 Visual SCIL Objects 1MRS751856-MEN 4. VS_CHECK_BOX Technical Reference Manual _OBJECT_CLASS _OBJECT_NAME _POP_UP_MENU _SCIL_GEOMETRY _SOURCE_FILE_NAME _TITLE _VALUE _VARIABLE_NAMES _VISIBLE Menu reference List Integer vector Predefined Methods 1DPH _FLAG_FOR_EXECUTION _GET_HELP _GET_STRING_WIDTH _QUEUE_FOR_EXECUTION 7\SH Integer 4.2. Details Action Attributes B*(7B7$%/(B(',7B7(;7 Setting of this attribute specifies the action method GET_TABLE_EDIT_TEXT. vector B*(7B7$%/(B9,(:B7(;7 Setting of this attribute specifies the action method GET_TABLE_VIEW_TEXT. vector B127,)< Setting of this attribute specifies the action method NOTIFY. vector.set MY_OBJECT._NOTIFY = ( ROOT.OPEN_EDIT_DIALOG, ) B83'$7(B7$%/(B(',7B7(;7 Setting of this attribute specifies the action method UPDATE_TABLE_EDIT_TEXT. 24
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 4. VS_CHECK_BOX vector B83'$7(B7$%/(B9,(:B7(;7 Setting of this attribute specifies the action method UPDATE_TABLE_VIEW_TEXT. vector Action Methods *(7B7$%/(B(',7B7(;7 This action method is executed whenever the table needs a value from an edit object. This method is executed just before the edit object of the cell is closed (just before the CELL_EDITING_ACCEPTED action method). This function can be used for example to convert internal edit object value to text value, which is stored in the cell. This action method is called with two parameters: ROW and COLUMN of the current cell. This action method should return a text string. Data type to be returned: *(7B7$%/(B9,(:B7(;7 This action method is executed whenever the table needs the value for the view object of the current cell. For example, this method is executed when the view object is drawn into the cell. This function can be used for example to convert edit object value of the cell to the text value of the cell. Data type to be returned: 127,)< Specifies the notification procedure of the dialog item. The notification procedure gets called for different reasons with different dialog items. Refer to the general object description for a description of NOTIFY for a specific object. Data type to be returned: 83'$7(B7$%/(B(',7B7(;7 This action method is executed whenever the edit object of the cell needs a value to be shown. This method is executed just before the editing of the cell is started (just after the CELL_EDITING_STARTED action method). This action method has three parameters ROW and COLUMN of the cell and the text of the cell. This action method could be used to convert the text value of the view object to the edit object value. Data type to be returned: 83'$7(B7$%/(B9,(:B7(;7 This action method is executed whenever the table needs a value for the view object. This method is executed just before the view object of the cell is drawn. This function can be used for example to convert the text value of the cell, to the current 25
SYS 500 Visual SCIL Objects 1MRS751856-MEN 4. VS_CHECK_BOX Technical Reference Manual value of the view object, which is shown in the view object. This action method has three parameters ROW and COLUMN of the cell and the TEXT of the cell. Data type to be returned: Predefined Attributes B$775,%87(B1$0(6 B%$& *5281'B&2/25.SET MY_OBJECT._BACKGROUND_COLOR = (65535, 65535, 65535) B&+,/'B2%-(&76 B&/,& B)2&86$%/( Specifies whether the dialog item receives focus when it is clicked. FALSE.SET MY_OBJECT._CLICK_FOCUSABLE = FALSE B(1$%/(' Specifies whether the dialog item responds to various events. A change of appearance is also often combined with this attribute. When setting this attribute to FALSE, the disabled dialog item is displayed as dimmed. TRUE.SET MY_OBJECT._ENABLED = FALSE B),/(B5(9,6,21 26
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 4. VS_CHECK_BOX B)2&86$%/( Specifies whether the dialog item receives focus during normal keyboard traversal. TRUE.SET MY_OBJECT._FOCUSABLE = FALSE B)2&86(' Contains the value TRUE if the dialog item has the keyboard focus. Environment dependent Read-only @HAS_FOCUS = MY_OBJECT._FOCUSED B)217.SET MY_OBJECT._FONT = ( M, 1) B)25(*5281'B&2/25.SET MY_OBJECT._FOREGROUND_COLOR = (65535, 0, 0) B*(20(75<.SET MY_OBJECT._GEOMETRY = LIST(X = 10, Y = 10, W = 100, H = 100) B01(021,& Specifies the mnemonic character of the dialog item. The mnemonic may be visualized differently on different platforms. A character string containing 1 character. 27
SYS 500 Visual SCIL Objects 1MRS751856-MEN 4. VS_CHECK_BOX Technical Reference Manual ASCII(0).SET MY_OBJECT._MNEMONIC = A B2%-(&7B&/$66 B2%-(&7B1$0( B323B83B0(18 Specifies so called pop up menu that is associated with the object. This menu is activated with the right mouse button. A reference to a VS_MENU object. A VS_MENU can be created using the SCIL function.create or loaded from a file using the function.load. Menu reference Empty text.load ROOT\ MENU1 = VS_MENU(....SET ROOT\ MY_LIST._POP_UP_MENU = ROOT\ MENU1 B6&,/B*(20(75< B6285&(B),/(B1$0( B7,7/( Specifies the title of the dialog item. A character string containing up to 255 characters. Empty text.set MY_OBJECT._TITLE = Tool Properties 28
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 4. VS_CHECK_BOX B9$/8( Indicates the current value of the control object. An integer value. Integer 0.SET MY_CONTROL._VALUE = 1 B9$5,$%/(B1$0(6 B9,6,%/( Specifies whether the dialog item is visible or not. Setting this attribute to FALSE may be useful if the dialog item should be invisible when opening the dialog. TRUE.SET MY_OBJECT._VISIBLE = FALSE Predefined Methods B)/$*B)25B(;(&87,21 B*(7B+(/3 B*(7B675,1*B:,'7+ Returns the width of the given string in the current font of the object. Return value data type:integer STRING A character string containing up to 255 characters. B48(8(B)25B(;(&87,21 29
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 5. VS_COMBO 5. VS_COMBO 5.1. Overview A VS_COMBO is a dialog item that enables the user to pick a selection from a list of choices. These choices can be defined by the application or entered by the user. A combination box has three associated behaviours: one each for accept, select, and scroll situations. The behaviour of a combination box affects how the combination box maps user input (typing in the entry box or selecting from the choice box, for example) to a value in its list of values. Note that the default definition of these behaviours may vary according to look-and-feel. The indexing in combo box begins from 1. Action Attributes 1DPH _ACCEPT _SELECT 7\SH vector vector Action Methods 1DPH ACCEPT SELECT 7\SH Predefined Attributes 1DPH _ACCEPT_BEHAVIOR _ATTRIBUTE_NAMES _AUTO_SORT_ENABLED _BACKGROUND_COLOR _CASE_SENSITIVITY_ENABLED _CHILD_OBJECTS _CLICK_FOCUSABLE _ENABLED _FILE_REVISION _FOCUSABLE _FOCUSED _FONT _FOREGROUND_COLOR _GEOMETRY _MODIFIABLE 7\SH List Color vector Font Color List 31
SYS 500 Visual SCIL Objects 1MRS751856-MEN 5. VS_COMBO Technical Reference Manual _OBJECT_CLASS _OBJECT_NAME _POP_UP_MENU _SCIL_GEOMETRY _SCROLL_BEHAVIOR _SELECT_BEHAVIOR _SELECTED_INDEX _SOURCE_FILE_NAME _TEXT _VALUE_COUNT _VARIABLE_NAMES _VISIBLE _WRAP_ENABLED Menu reference List Integer Integer vector Predefined Methods 1DPH _APPEND_TEXT _DELETE_TEXT_AT _FLAG_FOR_EXECUTION _GET_HELP _GET_STRING_WIDTH _GET_TEXT_AT _MOVE_TEXT _QUEUE_FOR_EXECUTION _SELECT_TEXT_RANGE 7\SH Integer 5.2. Details Action Attributes B$&&(37 Setting of this attribute specifies the action method ACCEPT. vector B6(/(&7 Setting of this attribute specifies the action method SELECT. vector 32
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 5. VS_COMBO Action Methods $&&(37 The ACCEPT action method is executed whenever an accept situation has occurred. Data type to be returned: 6(/(&7 The SELECT action method is executed whenever a select situation has occurred. Data type to be returned: Predefined Attributes B$&&(37B%(+$9,25 This attribute specifies how the combination box behaves in an accept situation. An accept situation is when the combination box makes the selected (or entered) value the current value. This occurs when the user presses Return or Enter, or when the focus leaves the combination box. Note the _ACCEPT_BEHAVIOR attribute concerns only to a modifiable combination box, also the action method ACCEPT is not executed if the combination box attribute _MODIFIABLE is set to FALSE and a selection is made from the combination box. A text string containing one of the following keywords: MATCH_OR_ADD, MATCH_OR_CLOSEST, MATCH_OR_PARTIAL, MATCH_OR_FIRST, MATCH_OR_NOTHING, MATCH_OR_REVERT and DEFAULT. "DEFAULT" B$775,%87(B1$0(6 B$872B6257B(1$%/(' Specifies whether the combo box list should be automatically sorted in alphabetical order. FALSE.SET MY_COMBO._AUTO_SORT_ENABLED = TRUE 33
SYS 500 Visual SCIL Objects 1MRS751856-MEN 5. VS_COMBO Technical Reference Manual B%$& *5281'B&2/25.SET MY_OBJECT._BACKGROUND_COLOR = (65535, 65535, 65535) B&$6(B6(16,7,9,7<B(1$%/(' If this attribute value is FALSE, the upper or lower case letters are ignored when comparing two values. If this value is TRUE, the case is significant. FALSE B&+,/'B2%-(&76 B&/,& B)2&86$%/( Specifies whether the dialog item receives focus when it is clicked. TRUE.SET MY_OBJECT._CLICK_FOCUSABLE = FALSE B(1$%/(' Specifies whether the dialog item responds to various events. A change of appearance is also often combined with this attribute. When setting this attribute to FALSE, the disabled dialog item is displayed as dimmed. TRUE.SET MY_OBJECT._ENABLED = FALSE B),/(B5(9,6,21 34
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 5. VS_COMBO B)2&86$%/( Specifies whether the dialog item receives focus during normal keyboard traversal. TRUE.SET MY_OBJECT._FOCUSABLE = FALSE B)2&86(' Contains the value TRUE if the dialog item has the keyboard focus. Environment dependent Read-only @HAS_FOCUS = MY_OBJECT._FOCUSED B)217.SET MY_OBJECT._FONT = ( M, 1) B)25(*5281'B&2/25.SET MY_OBJECT._FOREGROUND_COLOR = (65535, 0, 0) B*(20(75<.SET MY_OBJECT._GEOMETRY = LIST(X = 10, Y = 10, W = 100, H = 100) B02',),$%/( Specifies if the user is allowed to type into the entry box of the combo box. A change of appearance is also often combined with this attribute. 35
SYS 500 Visual SCIL Objects 1MRS751856-MEN 5. VS_COMBO Technical Reference Manual TRUE.SET MY_COMBO._MODIFIABLE = FALSE B2%-(&7B&/$66 B2%-(&7B1$0( B323B83B0(18 Specifies so called pop up menu that is associated with the object. This menu is activated with the right mouse button. A reference to a VS_MENU object. A VS_MENU can be created using the SCIL function.create or loaded from a file using the function.load. Menu reference Empty text.load ROOT\ MENU1 = VS_MENU(....SET ROOT\ MY_LIST._POP_UP_MENU = ROOT\ MENU1 B6&,/B*(20(75< B6&52//B%(+$9,25 This attribute specifies how the combination box behaves in a scroll situation. A scroll situation is when the list in the choice box is scrolled. If the user types in the entry box, for every keystroke (except Return and Enter), a scroll situation is triggered as the combination box tries to match a choice box value to the entry box value (depending on behaviour). A text string containing one of the following keywords: MATCH_OR_ADD, MATCH_OR_CLOSEST, MATCH_OR_PARTIAL, MATCH_OR_FIRST, MATCH_OR_NOTHING, MATCH_OR_REVERT and DEFAULT. "DEFAULT" 36
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 5. VS_COMBO B6(/(&7B%(+$9,25 This attribute specifies how the combination box behaves in a select situation. A select situation is when the combination box tries to map user input to a value. This occurs when the user selects a value from the choice box or enters text into the entry box. Every keystroke in the entry box (with the exception of Return and Enter) triggers a select situation. A text string containing one of the following keywords: MATCH_OR_ADD, MATCH_OR_CLOSEST, MATCH_OR_PARTIAL, MATCH_OR_FIRST, MATCH_OR_NOTHING, MATCH_OR_REVERT and DEFAULT. "DEFAULT" B6(/(&7('B,1'(; Specifies the index of the selected value in the combo box. An integer value. Integer 0 B6285&(B),/(B1$0( B7(;7 Specifies the current text string in the input field of the VS_COMBO object. A character string containing up to 255 characters. Empty text B9$/8(B&2817 The number of values in the list of values in the combo box. An integer value. Integer 0 Read-only B9$5,$%/(B1$0(6 37
SYS 500 Visual SCIL Objects 1MRS751856-MEN 5. VS_COMBO Technical Reference Manual B9,6,%/( Specifies whether the dialog item is visible or not. Setting this attribute to FALSE may be useful if the dialog item should be invisible when opening the dialog. TRUE.SET MY_OBJECT._VISIBLE = FALSE B:5$3B(1$%/(' Specifies whether the selection in the combo box list wraps around when the beginning or the end is reached using for example the arrow keys to traverse the list. FALSE.SET MY_COMBO._WRAP_ENABLED = FALSE Predefined Methods B$33(1'B7(;7 Appends a text string to the list of the combo box. If the attribute _AUTO_SORT_ENABLED is set to TRUE the list of texts is automatically resorted when the new text string is appended otherwise the new text string is appended to the end of the list. Return value data type: STRING A character string containing up to 255 characters. B'(/(7(B7(;7B$7 Deletes the text string at the specified index. Return value data type: INDEX IntegerAn integer value. B)/$*B)25B(;(&87,21 38
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 5. VS_COMBO B*(7B+(/3 B*(7B675,1*B:,'7+ Returns the width of the given string in the current font of the object. Return value data type:integer STRING A character string containing up to 255 characters. B*(7B7(;7B$7 Returns the text string at the specified index. Return value data type: INDEX IntegerAn integer value. B029(B7(;7 Moves a text string from an index to another in the combo box list of texts. Return value data type: FROM IntegerAn integer value. TO IntegerAn integer value. B48(8(B)25B(;(&87,21 B6(/(&7B7(;7B5$1*( Selects the range of text in the input field of a combo object or places the cursor in the text. When start parameter is 1 the starting position for the selection is before the first character. When start parameter is -1 the starting position for the selection is after the last character. Length parameter 0 indicates placing of cursor without selecting any characters. A length parameter, which is positive, defines the amount of selected characters to the right from starting point. A length parameter, which is negative, defines the amount of selected characters to the left from starting point. The length parameter is automatically truncated to the length of the text. Return value data type: START IntegerAn integer value. LENGTH IntegerAn integer value. 39
1MRS751856-MEN Visual SCIL Objects SYS 500 Technical Reference Manual 6. 6. VS_COMBO_POPDOWN VS_COMBO_POPDO WN 6.1. Overview A VS_COMBO_POPDOWN box is a dialog item that enables the user to pick a selection from a list of choices. These choices can be defined by the application or entered by the user. A combination box has three associated behaviours: one each for accept, select, and scroll situations. The defined behaviour of a combination box affects how the combination box maps user input (typing in the entry box or selecting from the choice box, for example) to a value in its list of values. Note that the default definition of these behaviours may vary according to look-and-feel. The indexing in combo popdown begins from 1. Action Attributes 1DPH _ACCEPT _GET_TABLE_EDIT_TEXT _GET_TABLE_VIEW_TEXT _SELECT _UPDATE_TABLE_EDIT_TEXT _UPDATE_TABLE_VIEW_TEXT 7\SH vector vector vector vector vector vector Action Methods 1DPH ACCEPT GET_TABLE_EDIT_TEXT GET_TABLE_VIEW_TEXT SELECT UPDATE_TABLE_EDIT_TEXT UPDATE_TABLE_VIEW_TEXT 7\SH Predefined Attributes 1DPH _ACCEPT_BEHAVIOR _ATTRIBUTE_NAMES _AUTO_SORT_ENABLED _BACKGROUND_COLOR _CASE_SENSITIVITY_ENABLED _CHILD_OBJECTS _CLICK_FOCUSABLE 7\SH List Color vector 41
SYS 500 6. VS_COMBO_POPDO WN Visual SCIL Objects Technical Reference Manual _ENABLED _FILE_REVISION _FOCUSABLE _FOCUSED _FONT _FOREGROUND_COLOR _GEOMETRY _MODIFIABLE _OBJECT_CLASS _OBJECT_NAME _POP_UP_MENU _SCIL_GEOMETRY _SCROLL_BEHAVIOR _SELECT_BEHAVIOR _SELECTED_INDEX _SOURCE_FILE_NAME _TEXT _VALUE_COUNT _VARIABLE_NAMES _VISIBLE _VISIBLE_VALUE_COUNT _WRAP_ENABLED Predefined Methods 1DPH _APPEND_TEXT _DELETE_TEXT_AT _FLAG_FOR_EXECUTION _GET_HELP _GET_STRING_WIDTH _GET_TEXT_AT _MOVE_TEXT _QUEUE_FOR_EXECUTION _SELECT_TEXT_RANGE 1MRS751856-MEN Font Color List Menu reference List Integer Integer vector Integer 7\SH Integer 42
1MRS751856-MEN Visual SCIL Objects SYS 500 6.2. Details Technical Reference Manual 6. VS_COMBO_POPDO WN Action Attributes B$&&(37 Setting of this attribute specifies the action method ACCEPT. vector B*(7B7$%/(B(',7B7(;7 Setting of this attribute specifies the action method GET_TABLE_EDIT_TEXT. vector B*(7B7$%/(B9,(:B7(;7 Setting of this attribute specifies the action method GET_TABLE_VIEW_TEXT. vector B6(/(&7 Setting of this attribute specifies the action method SELECT. vector B83'$7(B7$%/(B(',7B7(;7 Setting of this attribute specifies the action method UPDATE_TABLE_EDIT_TEXT. vector B83'$7(B7$%/(B9,(:B7(;7 Setting of this attribute specifies the action method UPDATE_TABLE_VIEW_TEXT. vector Action Methods $&&(37 The ACCEPT action method is executed whenever an accept situation has occurred. Data type to be returned: *(7B7$%/(B(',7B7(;7 This action method is executed whenever the table needs a value from an edit object. This method is executed just before the edit object of the cell is closed (just before the CELL_EDITING_ACCEPTED action method). This function can be used for example to convert internal edit object value to text value, which is stored in the cell. 43
SYS 500 Visual SCIL Objects 1MRS751856-MEN 6. VS_COMBO_POPDO WN Technical Reference Manual This action method is called with two parameters: ROW and COLUMN of the current cell. This action method should return a text string. Data type to be returned: *(7B7$%/(B9,(:B7(;7 This action method is executed whenever the table needs the value for the view object of the current cell. For example, this method is executed when the view object is drawn into the cell. This function can be used for example to convert edit object value of the cell to the text value of the cell. Data type to be returned: 6(/(&7 The SELECT action method is executed whenever a select situation has occurred. Data type to be returned: 83'$7(B7$%/(B(',7B7(;7 This action method is executed whenever the edit object of the cell needs a value to be shown. This method is executed just before the editing of the cell is started (just after the CELL_EDITING_STARTED action method). This action method has three parameters ROW and COLUMN of the cell and the text of the cell. This action method could be used to convert the text value of the view object to the edit object value. Data type to be returned: 83'$7(B7$%/(B9,(:B7(;7 This action method is executed whenever the table needs a value for the view object. This method is executed just before the view object of the cell is drawn. This function can be used for example to convert the text value of the cell, to the current value of the view object, which is shown in the view object. This action method has three parameters ROW and COLUMN of the cell and the TEXT of the cell. Data type to be returned: Predefined Attributes B$&&(37B%(+$9,25 This attribute specifies how the combination box behaves in an accept situation. An accept situation is when the combination box makes the selected (or entered) value the current value. This occurs when the user presses Return or Enter, or when the focus leaves the combination box. A text string containing one of the following keywords: MATCH_OR_ADD, MATCH_OR_CLOSEST, MATCH_OR_PARTIAL, MATCH_OR_FIRST, MATCH_OR_NOTHING, MATCH_OR_REVERT and DEFAULT. 44