ST GET OPTIONS
ST GET OPTIONS ( {* ;} objeto ; opcao ; valor {; opcao2 ; valor2 ; ... ; opcaoN ; valorN} )
| Parâmetro | Tipo | Descrição | |
|---|---|---|---|
| * | Operador | → | Se especificado, objeto é um nome de objeto (cadeia) Se omitido, objeto é um campo ou uma variável |
| objeto | any | → | Nome de objeto (se * for especificado) ou Campo ou variável (se * for omitido) |
| opcao | Integer | → | Opção a ler |
| valor | Integer | ← | Valor atual da opção |
Esse comando não é seguro para thread e não pode ser usado em código adequado.
Descrição
O comando ST GET OPTIONS obtém o valor atual de uma ou várias opções de funcionamento do campo ou da variável de texto com estilo designada pelo parâmetro objeto.
Se passar o parâmetro opcional * indica que o parâmetro objeto é um nome de objeto (cadeia). Durante a execução, se o objeto tem o foco, o comando devolve a informação do objeto que se está editando, e se o objeto não tem o foco, o comando devolve a informação da fonte de dados do objeto (variável ou campo).
Se omitir o parâmetro *, indica que o parâmetro objeto é um campo ou uma variável. Neste caso, se passar uma referência de campo ou variável no lugar de uma cadeia. Durante a execução, o comando devolve a informação da variável ou do campo.
Passe o código da opção a ler no parâmetro opcao. O comando devolve em valor o atual da opção. Para ambos parâmetros, pode utilizar as seguintes constantes, que se encontram no tema "Texto multi estilo":
| Constante | Tipo | Valor | Comentário |
|---|---|---|---|
| ST Expressions display mode | Inteiro longo | 1 | O parâmetro valor pode conter ST Values ou ST References |
| ST References | Inteiro longo | 1 | Mostra as cadeias fonte das expressões |
| ST Values | Inteiro longo | 0 | Mostra os valores calculados das expressões |