LISTBOX Get property

4D v19.8


LISTBOX Get property ( {* ;} objeto ; propiedad ) -> Resultado

Parámetro	Tipo	Descripción
*	Operador	Si se especifica, objeto es un nombre de objeto (cadena) Si se omite, objeto es una variable
objeto	Objeto de formulario	Nombre de objeto (si se especifica ) o Variable (si se omite )
propiedad	Entero largo	Información a obtener
Resultado	Entero largo, Cadena	Valor actual

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:

Constante	Tipo	Valor	Comentario
_o_lk display hor scrollbar	Entero largo	2	*Constante obsoleta* Utilizar el comando OBJECT GET SCROLLBAR.
_o_lk display ver scrollbar	Entero largo	4	*Constante obsoleta* Utilizar el comando OBJECT GET SCROLLBAR.
_o_lk footer height	Entero largo	9	*Constante obsoleta* Utilizar el comando LISTBOX Get footers height.
_o_lk header height	Entero largo	1	*Constante obsoleta* Utilizar el comando LISTBOX Get headers height.
_o_lk hor scrollbar position	Entero largo	6	*Constante obsoleta* Utilizar el comando OBJECT GET SCROLL POSITION.
_o_lk ver scrollbar position	Entero largo	7	*Constante obsoleta* Utilizar el comando OBJECT GET SCROLL POSITION.
lk allow wordwrap	Entero largo	14	Propiedad Wordwrap Aplica a: Columna* Valores posibles: lk no (0) lk yes (1)
lk auto row height	Entero largo	31	Propiedad Altura de fila automática. Aplica a: List box o columna Valores posibles: lk yes lk no 4D View Pro únicamente: esta funcionalidad requiere una licencia 4D View Pro. Para más información, consulte 4D View Pro.
lk background color expression	Cadena	22	Propiedad Background Color Expression para list box de tipo selección Aplica a: List box o columna
lk column max width	Entero largo	26	Propiedad Maximum Width Aplica a: Columna*
lk column min width	Entero largo	25
lk column resizable	Entero largo	15	Propiedad Resizable Aplica a: Columna* Valores posibles: lk no (0) lk yes (1)
lk detail form name	Cadena	19	Propiedad Detail Form Name para la selección de tipo list box Aplica a: List box
lk display footer	Entero largo	8	0=oculto, 1=se muestra
lk display header	Entero largo	0	0=oculto, 1=se muestra
lk display type	Entero largo	21	Propiedad Display Type para columnas numéricas Aplica a: Columna* Valores posibles: lk numeric format (0): muestra valores en formato numérico lk three states checkbox (1): muestra valores como casillas de selección de tres estados
lk double click on row	Entero largo	18
lk extra rows	Entero largo	13	Propiedad Hide extra blank rows Aplica a: List box Valores posibles: lk display (0) lk hide (1)
lk font color expression	Cadena	23	Propiedad Font Color Expression para list box de tipo selección Aplica a: List box o columna
lk font style expression	Cadena	24
lk hide selection highlight	Entero largo	16
lk highlight set	Cadena	27
lk hor scrollbar height	Entero largo	3	Altura en píxeles
lk movable rows	Entero largo	35	La 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 style	Entero largo	30	Propiedad Multiestilo Aplica a: Columna* Valores posibles: lk no (0)[#/note] lk yes (1) [#/note]
lk named selection	Cadena	28	Propiedad Named Selection para list box de tipo selección Aplica a: List box
lk resizing mode	Entero largo	11
lk row height unit	Entero largo	17
lk selection mode	Entero largo	10	Propiedad Selection Mode Aplica a: List box Valores posibles: lk none (0) lk single (1) lk multiple (2)
lk single click edit	Entero largo	29	Propiedad Single-Click Edit Aplica a: List box Posible valores: lk no (0) lk yes (1)
lk sortable	Entero largo	20	Propiedad Sortable Aplica a: List box Valores posibles: lk no (0) lk yes (1)
lk truncate	Entero largo	12	Propiedad Truncate with ellipsis Aplica a: List box o columna Valores posibles: lk without ellipsis (0) lk with ellipsis (1)
lk ver scrollbar width	Entero largo	5	Ancho 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