Saltar al contenido principal
Versión: Siguiente

LISTBOX Get property

LISTBOX Get property ( {* ;} objeto ; propiedad ) : any

ParámetroTipoDescripción
*OperadorSi se especifica, objeto es un nombre de objeto (cadena) Si se omite, objeto es una variable
objetoanyNombre de objeto (si se especifica *) o Variable (si se omite *)
propiedadIntegerInformación a obtener
ResultadoText, IntegerValor actual

Este comando no es hilo seguro, no puede ser utilizado en código apropiativo.

Descripción

El comando LISTBOX Get property devuelve el valor de la propiedad del list box o columna especificado utilizando los parámetros objeto y *.

Si pasa el parámetro opcional *, indica que el parámetro objeto es un nombre de objeto (cadena). Si omite este parámetro, indica que el parámetro objeto es una variable. En ese caso, usted pasa una referencia de variable en lugar de una cadena. Para mayor información sobre nombres de objetos, consulte la sección Propiedades de los objetos.

Nota: si el list box o columna especificado utilizando los parámetros objeto y * no existe, el comando LISTBOX Get property devuelve -1 para los propiedades numéricas o una cadena vacía.

En el parámetro propiedad, pase una constante indicando la propiedad cuyo valor quiere obtener. Puede utilizar un valor o una de las siguientes constantes del tema Listbox:

ConstanteValorComentario
lk allow wordwrap14Propiedad Retorno de línea
Aplica a: Columna*
Valores posibles:
lk no (0)lk yes (1)
lk auto row height31Propiedad Altura de fila automática.
Aplica a: List box o columna
Valores posibles:lk yes lk no4D View Pro únicamente: esta funcionalidad requiere una licencia 4D View Pro. Para más información, consulte 4D View Pro.
lk background color expression22Propiedad Expresión color de fondo para list box de tipo selección, colección o entity selection.
Aplica a: List box o columna
lk cell horizontal padding36Relleno horizontal de la celda en píxeles (mismo valor para el relleno izquierdo y derecho) Se aplica a: list box, columna, encabezado, pie de página
lk cell vertical padding37Relleno vertical de la celda en píxeles (mismo valor para el relleno superior e inferior)
Se aplica a: list box, columna, encabezado, pie de página
lk column max width26Propiedad Ancho Máximo
Aplica a: Columna*
lk column min width25Propiedad Ancho mínimo
Aplica a: Columna*
lk column resizable15Propiedad Redimensionable
Aplica a: Columna*
Valores posibles:
lk no (0)lk yes (1)
lk detail form name19Propiedad Nombre formulario detallado para la selección de tipo list box
Aplica a: List box
lk display footer80=oculto, 1=se muestra
lk display header00=oculto, 1=se muestra
lk display type21Propiedad Tipo de visualización para columnas numéricas
Aplica a: Columna*
Valores posibles:**
**lk numeric format (0): muestra valores en formato numéricolk three states checkbox (1): muestra valores como casillas de selección de tres estados
lk double click on row18Propiedad Doble clic en la línea para los list box de tipo selección
Aplica a: List box
Valores posibles:lk do nothing (0): no desencadena ninguna acción automáticalk edit record (1): muestra el registro correspondiente en modo lectura-escrituralk display record (2): muestra el registro correspondiente en modo de solo lectura
lk extra rows13Propiedad Ocultar líneas vacías finales
Aplica a: List box
Valores posibles:**
**lk display (0)lk hide (1)
lk font color expression23Propiedad Expresión color fuentepara list box de tipo selección, colección o entity selection.
Aplica a: List box o columna
lk font style expression24Propiedad Expresión estilo para list boxes de tipo selección, colección o entity selection.
Aplica a: List box o columna
lk hide selection highlight16Propiedad Ocultar resaltado de selección
Aplica a: List box
Valores posibles:**
**lk no (0)lk yes (1)
lk highlight set27Propiedad Conjunto resaltado para el list box de tipo selección**
**Aplica a: List box
lk hor scrollbar height3Altura en píxeles
lk movable rows35La propiedad Líneas móviles para list box de tipo array
Se aplica a: List box (excluyendo el modo jerárquico)
Valores posibles: lk no (0): las líneas no se pueden mover en tiempo de ejecución lk yes (1): las líneas se pueden mover en tiempo de ejecución (predeterminado)
lk multi style30Propiedad Multiestilo
Aplica a: Columna*
Valores posibles:
lk no (0)[#/note]lk yes (1) [#/note]
lk named selection28Propiedad Selección temporal para list box de tipo selección
Aplica a: List box
lk resizing mode11Propiedad Autoredimensionamiento de columnas
Aplica a: List box
Valores posibles:
lk manual (0)lk automatic (2)
lk row height unit17Unidad de la propiedad Alto de línea
Aplica a: List box
Valores posibles:**
**lk lines (1)
lk pixels (0)
lk selection mode10Propiedad Modo de s elección
Aplica a: List box
Valores posibles: **
**lk none (0)
lk single (1)
lk multiple (2)
lk single click edit29Propiedad Editar en clic único
Aplica a: List box
Posible valores:
lk no (0)lk yes (1)
lk sortable20Propiedad Ordenable
Aplica a: List box
Valores posibles:**
**lk no (0)lk yes (1)
lk truncate12Propiedad Truncar con elipse
Aplica a: List box o columna
Valores posibles:**
**lk without ellipsis (0)lk with ellipsis (1)
lk ver scrollbar width5Ancho en píxeles

*Estas propiedades sólo se aplican a las columnas list box; si pasa un list box como parámetro con una de estas propiedades, LISTBOX Get property devuelve -1, o una cadena vacía, dependiendo de la propiedad pasada.

En general, para indicar un resultado no válido LISTBOX Get property devuelve -1 al recuperar las propiedades que tienen valores numéricos, o una cadena vacía; Sin embargo, no se generan errores. Más específicamente, esto ocurre en los siguientes casos:

  • Si pasa una propiedad que no existe
  • Si pasa una propiedad que no está disponible para el list box o columna especificada, por ejemplo, usted pasa la propiedad lk font color expression con un list box de tipo array
  • Si pasa una columna como parámetro con una propiedad que se aplica a un list box, y viceversa, si pasa un list box como parámetro con una propiedad que se aplica a una columna (ver arriba *)

Además, no es posible devolver valores de más de una columna a la vez; si utiliza el símbolo "@" como parte del nombre de una columna para indicar varias columnas múltiples con nombres similares, LISTBOX Get property devuelve el primer valor coincidente que encuentre; como resultado, el valor devuelto no tiene verdadera importancia.

Notas:

  • Las constantes lk display footer y lk display header son útiles para calcular el tamaño de un área de list box mostrada en el formulario.
  • Cuando utilice las constantes lk hor scrollbar position o lk ver scrollbar position, el comando LISTBOX Get property devuelve la posición del cursor de desplazamiento en relación con su posición original, es decir el tamaño de la parte oculta de la ventana, expresado en píxeles. Por defecto, esta posición corresponde a 0. Combinando, por ejemplo, con información relativa a la altura de la línea, este valor le permite encontrar el contenido mostrado en el listbox. Sin embargo, estas constantes son obsoletas y pueden remplazarse por el comando OBJECT GET SCROLL POSITION.
  • La instrucción LISTBOX Get property(vLB;_o_lk footer height) devuelve el mismo valor que el comando LISTBOX Get footers height cuando los pies se muestran. Sin embargo, si los pies no se muestran, LISTBOX Get property devuelve 0 mientras LISTBOX Get footers height devuelve la altura, en este caso teórica, de los pies.

Ejemplo 1

Dado un listbox"MyListbox", si ejecuta la siguiente instrucción:

 $Value:=LISTBOX Get property(*;"MyListbox";lk selection mode) // el valor devuelto indica el modo de selección

En este caso, el resultado devuelto indica si varias líneas pueden ser seleccionadas.

Ejemplo 2

Dado un list box "MyListbox", si ejecuta la siguiente instrucción:

 $resizable:=LISTBOX Get property(*;"MyListbox";lk column resizable)

LISTBOX Get property devuelve -1 porque la propiedad lk column resizable aplica a columnas y un list box se pasó como parámetro.

Ver también

LISTBOX SET GRID
LISTBOX SET PROPERTY
OBJECT SET SCROLLBAR