ST GET OPTIONS
ST GET OPTIONS ( {* ;} objeto ; opcion ; valor {; opcion2 ; valor2 ; ... ; opcionN ; valorN} )
| Parámetro | Tipo | Descripción | |
|---|---|---|---|
| * | Operador | → | Si se especifica, objeto es un nombre de objeto (cadena) Si se omite, objeto es un campo o una variable |
| objeto | any | → | Nombre del objeto (si se especifica *) o Campo o variable (si se omite *) |
| opcion | Integer | → | Opción a leer |
| valor | Integer | ← | Valor actual de la opción |
Este comando no es hilo seguro, no puede ser utilizado en código apropiativo.
Descripción
El comando ST GET OPTIONS obtiene el valor actual de una o varias opciones de funcionamiento del campo o de la variable de texto con estilo designada por el parámetro objeto.
Si pasa el parámetro opcional * indica que el parámetro objeto es un nombre de objeto (cadena). Durante la ejecución, si el objeto tiene el foco, el comando devuelve la información del objeto que se está editando, y si el objeto no tiene el foco, el comando devuelve la información de la fuente de datos del objeto (variable o campo).
Si omite el parámetro *, indica que el parámetro objeto es un campo o una variable. En este caso, se pasa una referencia de campo o variable en lugar de una cadena. Durante la ejecución, el comando devuelve la información de la variable o del campo.
Pase el código de la opción a leer en el parámetro opcion. El comando devuelve en valor el actual de la opción. Para ambos parámetros, puede utilizar las siguientes constantes, que se encuentran en el tema "Texto multiestilo":
| Constante | Tipo | Valor | Comentario |
|---|---|---|---|
| ST Expressions display mode | Entero largo | 1 | El parámetro valor puede contener ST Values o ST References |
| ST References | Entero largo | 1 | Muestra las cadenas fuente de las expresiones |
| ST Values | Entero largo | 0 | Muestra los valores calculados de las expresiones |