ListBox clase

Representa un objeto de cuadro de lista.

Herencia: ListBox → Shape

El tipo ListBox expone los siguientes miembros:

Propiedades

Propiedad	Descripción
macro_name	Obtiene y establece el nombre de la macro.
is_equation	Indica si la forma solo contiene una ecuación.
is_smart_art	Indica si la forma es un arte inteligente.
z_order_position	Devuelve la posición de una forma en el orden z.
name	Obtiene y establece el nombre de la forma.
alternative_text	Devuelve o establece la cadena de texto descriptiva (alternativa) del objeto `Shape`.
title	Especifica el título (título) del objeto de forma actual.
line_format	Devuelve un objeto MsoLineFormat que contiene propiedades de formato de línea para la forma especificada.
fill_format	Devuelve un objeto MsoFillFormat que contiene propiedades de formato de relleno para la forma especificada.
line	Obtiene estilo de línea
fill	Devuelve un objeto `Shape.fill_format` que contiene propiedades de formato de relleno para la forma especificada.
shadow_effect	Representa un objeto `ShadowEffect` que especifica el efecto de sombra para el elemento o la forma del gráfico.
reflection	Representa un objeto `ReflectionEffect` que especifica el efecto de reflexión para el elemento o la forma del gráfico.
glow	Representa un objeto `GlowEffect` que especifica el efecto de brillo para el elemento o la forma del gráfico.
soft_edges	Obtiene y establece el radio de desenfoque que se aplicará a los bordes, en unidades de puntos.
three_d_format	Obtiene y establece el formato 3D de la forma.
format_picture	Obtiene y establece las opciones del formato de imagen.
is_hidden	Indica si el objeto es visible.
is_lock_aspect_ratio	Verdadero significa que la relación de aspecto de la forma está bloqueada.
is_aspect_ratio_locked	Verdadero significa que la relación de aspecto de la forma está bloqueada.
rotation_angle	Obtiene y establece la rotación de la forma.
hyperlink	Obtiene el hipervínculo de la forma.
id	Obtiene el identificador de esta forma.
spid	Especifica un identificador de cadena opcional que una aplicación puede utilizar para identificar la forma particular.
spt	Especifica un número opcional que una aplicación puede utilizar para asociar la forma particular con un tipo de forma definido.
worksheet	Obtiene el objeto `Shape.worksheet` que contiene esta forma.
is_group	Indica si esta forma es una forma de grupo.
is_in_group	Indica si la forma está agrupada.
is_word_art	Indica si esta forma es un Word Art.
text_effect	Devuelve un objeto TextEffectFormat que contiene propiedades de formato de efecto de texto para la forma especificada. Se aplica a objetos de forma que representan WordArt.
is_locked	Verdadero significa que el objeto no se puede modificar cuando la hoja está protegida. Tenga en cuenta que este valor solo es significativo si la hoja de cálculo o los objetos en la hoja de cálculo están protegidos.
is_printable	Indica si el objeto es imprimible. Si es Falso, esta forma no se imprimirá al imprimir.
mso_drawing_type	Obtiene el tipo de dibujo.
auto_shape_type	Obtiene y establece el tipo de forma automática.
anchor_type	Obtiene y establece el tipo de marcador de posición de ancla de forma.
placement	Representa la forma en que el objeto de dibujo se adjunta a las celdas debajo de él. La propiedad controla la ubicación de un objeto en una hoja de cálculo.
upper_left_row	Representa el índice de la fila superior.
upper_delta_y	Obtiene o establece el desplazamiento vertical de la forma desde su fila de la esquina superior izquierda.
upper_left_column	Representa el índice de la columna de la esquina superior izquierda.
upper_delta_x	Obtiene o establece el desplazamiento horizontal de la forma desde su columna de la esquina superior izquierda.
lower_right_row	Representa el índice de la fila de la esquina inferior derecha.
lower_delta_y	Obtiene o establece el desplazamiento vertical de la forma desde su fila de la esquina inferior derecha.
lower_right_column	Representa el índice de la columna de la esquina inferior derecha.
lower_delta_x	Obtiene o establece el desplazamiento horizontal de la forma desde su columna de la esquina inferior derecha.
right	Representa el ancho del desplazamiento horizontal de la forma desde su columna de la esquina inferior derecha, en unidades de píxeles.
bottom	Representa el ancho del desplazamiento vertical de la forma desde su fila de la esquina inferior, en unidades de píxeles.
width	Representa el ancho de la forma, en unidades de píxeles.
width_inch	Representa el ancho de la forma, en unidades de pulgadas.
width_pt	Representa el ancho de la forma, en unidad de puntos.
width_cm	Representa el ancho de la forma, en unidades de centímetros.
height	Representa la altura de la forma, en unidades de píxeles.
height_inch	Representa la altura de la forma, en unidades de pulgadas.
height_pt	Representa la altura de la forma, en unidad de puntos.
height_cm	Representa la altura de la forma, en unidades de centímetros.
left	Representa el desplazamiento horizontal de la forma desde su columna izquierda, en unidades de píxeles.
left_inch	Representa el desplazamiento horizontal de la forma desde su columna izquierda, en unidades de pulgadas.
left_cm	Representa el desplazamiento horizontal de la forma desde su columna izquierda, en unidades de centímetros.
top	Representa el desplazamiento vertical de la forma desde su fila superior, en unidades de píxeles.
top_inch	Representa el desplazamiento vertical de la forma desde su fila superior, en unidades de pulgadas.
top_cm	Representa el desplazamiento vertical de la forma desde su fila superior, en unidades de centímetros.
top_to_corner	Obtiene y establece el desplazamiento vertical de la forma desde el borde superior de la hoja de cálculo, en unidades de píxeles.
left_to_corner	Obtiene y establece el desplazamiento horizontal de la forma desde el borde izquierdo de la hoja de cálculo.
x	Obtiene y establece el desplazamiento horizontal de la forma desde el borde izquierdo de la hoja de cálculo, en unidades de píxeles.
y	Obtiene y establece el desplazamiento vertical de la forma desde el borde superior de la hoja de cálculo, en unidades de píxeles.
width_scale	Obtiene y establece la escala de ancho, en unidades de porcentaje del ancho de la imagen original. Si la forma no es una imagen, la propiedad WidthScale solo devuelve 100;
height_scale	Obtiene y establece la escala de altura, en unidades de porcentaje de la altura de la imagen original. Si la forma no es una imagen, la propiedad HeightScale solo devuelve 100;
top_in_shape	Representa el desplazamiento vertical de la forma desde el borde superior de la forma principal. en unidad de 1/4000 de la altura de la forma principal.
left_in_shape	Representa el desplazamiento horizontal de la forma desde el borde izquierdo de la forma principal. en unidad de 1/4000 del ancho de la forma principal.
width_in_shape	Representa el ancho de la forma, en unidades de 1/4000 de la forma principal.
height_in_shape	Representa el desplazamiento vertical de la forma desde el borde superior de la forma principal, en unidades de 1/4000 de la altura de la forma principal.
group	Obtiene la forma del grupo que contiene esta forma.
type	Obtiene el tipo de forma automática.
has_line	Obtiene y establece el borde de la línea de la forma que es visible.
is_filled	Indica si el formato de relleno es visible.
is_flipped_horizontally	Obtiene y establece si la forma está invertida horizontalmente.
is_flipped_vertically	Obtiene y establece si la forma está invertida verticalmente.
actual_lower_right_row	Obtener la fila inferior real.
relative_to_original_picture_size	Indica si la forma es relativa al tamaño de la imagen original.
linked_cell	Obtiene o establece el rango de la hoja de cálculo vinculado al valor del control.
input_range	Obtiene o establece el rango de la hoja de cálculo utilizado para completar el cuadro combinado especificado.
text_shape_type	Obtiene y establece el tipo de forma de texto preestablecido.
text_body	Obtiene y establece la configuración del texto de la forma.
font	Representa la fuente de la forma.
text_options	Representa las opciones de texto de la forma.
text	Obtiene y establece el texto de esta forma.
is_rich_text	Si el texto es texto enriquecido o no.
html_text	Obtiene y establece la cadena html que contiene datos y algunos formatos en este cuadro de texto.
text_vertical_overflow	Obtiene y establece el tipo de desbordamiento vertical del texto de la forma que contiene texto.
text_horizontal_overflow	Obtiene y establece el tipo de desbordamiento horizontal del texto de la forma que contiene texto.
is_text_wrapped	Obtiene y establece el tipo de texto envuelto de la forma que contiene texto.
text_orientation_type	Obtiene y establece el tipo de orientación del texto de la forma.
text_horizontal_alignment	Obtiene y establece el tipo de alineación horizontal del texto de la forma.
text_vertical_alignment	Obtiene y establece el tipo de alineación vertical del texto de la forma.
text_direction	Obtiene/establece la dirección del flujo de texto para este objeto.
text_box_options	Obtiene la información del texto en la forma
control_data	Obtiene los datos de control.
active_x_control	Obtiene el control ActiveX.
paths	Obtiene las rutas de una forma geométrica personalizada.
create_id	Obtiene y establece la identificación de creación para esta forma.
is_decorative	Indica si el objeto es decorativo.
item_count	Obtiene el número de elementos en el cuadro de lista.
selected_index	Obtiene o establece el número de índice del elemento seleccionado actualmente en un cuadro de lista o cuadro combinado. Basado en cero.
selected_cells	Obtiene las celdas seleccionadas. Devuelve nulo si el rango de entrada no está establecido o no se selecciona ningún elemento
shadow	Indica si el cuadro combinado tiene sombreado 3D.
selection_type	Obtiene o establece el modo de selección del cuadro de lista especificado.
page_change	Especifica la cantidad en la que se cambia el valor del control cuando el usuario hace clic en la región de página arriba o página abajo de la barra de desplazamiento.

Métodos

Método	Descripción
`to_image(self, stream, image_type)`	Crea la imagen de forma y la guarda en una secuencia en el formato especificado.
`to_image(self, image_file, options)`	Guarda la forma en un archivo.
`to_image(self, stream, options)`	Guarda la forma en una secuencia.
`get_result_of_smart_art(self)`	Conversión de arte inteligente en formas agrupadas.
`to_front_or_back(self, orders)`	Trae la forma al frente o la envía hacia atrás.
`get_locked_property(self, type)`	Obtiene el valor de la propiedad bloqueada.
`set_locked_property(self, type, value)`	Establecer la propiedad bloqueada.
`add_hyperlink(self, address)`	Agrega un hipervínculo a la forma.
`remove_hyperlink(self)`	Elimina el hipervínculo de la forma.
`move_to_range(self, upper_left_row, upper_left_column, lower_right_row, lower_right_column)`	Mueve la forma a un rango especificado.
`align_top_right_corner(self, top_row, right_column)`	Mueve la imagen a la esquina superior derecha.
`get_connection_points(self)`	Obtener los puntos de conexión
`get_linked_cell(self, is_r1c1, is_local)`	Obtiene el rango vinculado al valor del control.
`set_linked_cell(self, formula, is_r1c1, is_local)`	Establece el rango vinculado al valor del control.
`get_input_range(self, is_r1c1, is_local)`	Obtiene el rango utilizado para llenar el control.
`set_input_range(self, formula, is_r1c1, is_local)`	Establece el rango utilizado para rellenar el control.
`update_selected_value(self)`	Actualiza el valor seleccionado por el valor de la celda vinculada.
`calculate_text_size(self)`	Recalcular el área de texto
`format_characters(self, start_index, length, font, flag)`	Formatea algunos caracteres con la configuración de fuente.
`characters(self, start_index, length)`	Devuelve un objeto Caracteres que representa un rango de caracteres dentro del texto.
`get_characters(self)`	Devuelve todos los objetos de Personajes que representa un rango de caracteres dentro del texto.
`get_rich_formattings(self)`	Devuelve todos los objetos de Personajes que representa un rango de caracteres dentro del texto.
`remove_active_x_control(self)`	Eliminar el control activeX.
`is_same_setting(self, obj)`	Devuelve si la forma es la misma.
`get_actual_box(self)`	Obtenga la posición y el tamaño reales de la forma (después de aplicar rotación, giro, etc.)
`fit_to_text_size(self)`	Recalcular un área de texto adecuada para mostrar todo el contenido de texto.
`selected_item(self, item_index, is_selected)`	Establece si el elemento está seleccionado
`is_selected(self, item_index)`	Indica si el elemento está seleccionado.

Ejemplo

from aspose.cells import Workbook
from aspose.cells.drawing import PlacementType, SelectionType

# Create a new Workbook.
workbook = Workbook()
# Get the first worksheet.
sheet = workbook.worksheets[0]
# Get the worksheet cells collection.
cells = sheet.cells
# Input a value.
cells.get("B3").put_value("Choose Dept:")
# Set it bold.
style = cells.get("B3").get_style()
style.font.is_bold = True
cells.get("B3").set_style(style)
# Input some values that denote the input range
# for the list box.
cells.get("A2").put_value("Sales")
cells.get("A3").put_value("Finance")
cells.get("A4").put_value("MIS")
cells.get("A5").put_value("R&D")
cells.get("A6").put_value("Marketing")
cells.get("A7").put_value("HRA")
# Add a new list box.
listBox = sheet.shapes.add_list_box(2, 0, 3, 0, 122, 100)
# Set the placement type.
listBox.placement = PlacementType.FREE_FLOATING
# Set the linked cell.
listBox.linked_cell = "A1"
# Set the input range.
listBox.input_range = "A2:A7"
# Set the selection style.
listBox.selection_type = SelectionType.SINGLE
# Set the list box with 3-D shading.
listBox.shadow = True
# Saves the file.
workbook.save(r"tstlistbox.xls")

Ver también

LineShape clase MsoFillFormat clase