ListBox classe

Représente un objet zone de liste.

Héritage: ListBox → Shape

Le type ListBox expose les membres suivants :

Propriétés

Propriété	Description
macro_name	Obtient et définit le nom de la macro.
is_equation	Indique si la forme contient uniquement une équation.
is_smart_art	Indique si la forme est un art intelligent.
z_order_position	Renvoie la position d’une forme dans l’ordre z.
name	Obtient et définit le nom de la forme.
alternative_text	Renvoie ou définit la chaîne de texte descriptive (alternative) de l’objet `Shape`.
title	Spécifie le titre (légende) de l’objet de forme actuel.
line_format	Renvoie un objet MsoLineFormat qui contient les propriétés de mise en forme de ligne pour la forme spécifiée.
fill_format	Renvoie un objet MsoFillFormat qui contient les propriétés de mise en forme de remplissage pour la forme spécifiée.
line	Obtient le style de ligne
fill	Renvoie un objet `Shape.fill_format` qui contient les propriétés de formatage de remplissage pour la forme spécifiée.
shadow_effect	Représente un objet `ShadowEffect` qui spécifie l’effet d’ombre pour l’élément ou la forme du graphique.
reflection	Représente un objet `ReflectionEffect` qui spécifie l’effet de réflexion pour l’élément ou la forme du graphique.
glow	Représente un objet `GlowEffect` qui spécifie l’effet de lueur pour l’élément ou la forme du graphique.
soft_edges	Obtient et définit le rayon de flou à appliquer aux bords, en unités de points.
three_d_format	Obtient et définit le format 3D de la forme.
text_frame	Renvoie un objet TextFrame qui contient les propriétés d’alignement et d’ancrage de la forme spécifiée.
format_picture	Obtient et définit les options du format d’image.
is_hidden	Indique si l’objet est visible.
is_lock_aspect_ratio	Vrai signifie que cela n’autorise pas les changements de rapport hauteur/largeur.
rotation_angle	Obtient et définit la rotation de la forme.
hyperlink	Obtient le lien hypertexte de la forme.
id	Obtient l’identifiant de cette forme.
spid	Spécifie une chaîne facultative qu’une application peut utiliser pour identifier la forme particulière.
spt	Spécifie un numéro facultatif qu’une application peut utiliser pour associer la forme particulière à un type de forme défini.
worksheet	Obtient l’objet `Shape.worksheet` qui contient cette forme.
is_group	Indique si la forme est un groupe.
is_in_group	Indique si la forme est groupée.
is_word_art	Indique si cette forme est un word art.
text_effect	Renvoie un objet TextEffectFormat qui contient les propriétés de mise en forme des effets de texte pour la forme spécifiée. S’applique aux objets Shape qui représentent WordArt.
is_locked	True si l’objet est verrouillé, False si l’objet peut être modifié lorsque la feuille est protégée.
is_printable	Vrai si l’objet est imprimable
mso_drawing_type	Obtient le type de dessin mso.
auto_shape_type	Obtient et définit le type de forme automatique.
anchor_type	Obtient et définit l’espace réservé de l’ancre de forme.
placement	Représente la manière dont l’objet de dessin est attaché aux cellules situées en dessous. La propriété contrôle le placement d’un objet sur une feuille de calcul.
upper_left_row	Représente l’index de la ligne du coin supérieur gauche.
upper_delta_y	Obtient ou définit le décalage vertical de la forme par rapport à sa ligne du coin supérieur gauche.
upper_left_column	Représente l’index de la colonne du coin supérieur gauche.
upper_delta_x	Obtient ou définit le décalage horizontal de la forme par rapport à sa colonne du coin supérieur gauche.
lower_right_row	Représente l’index de la ligne du coin inférieur droit.
lower_delta_y	Obtient ou définit le décalage vertical de la forme par rapport à sa ligne du coin inférieur droit.
lower_right_column	Représente l’index de la colonne du coin inférieur droit.
lower_delta_x	Obtient ou définit le décalage horizontal de la forme par rapport à sa colonne du coin inférieur droit.
right	Représente la largeur du décalage horizontal de la forme par rapport à sa colonne du coin inférieur droit, en unités de pixels.
bottom	Représente la largeur du décalage vertical de la forme par rapport à sa rangée du coin inférieur inférieur, en unités de pixels.
width	Représente la largeur de la forme, en unités de pixels.
width_inch	Représente la largeur de la forme, en unité de pouce.
width_pt	Représente la largeur de la forme, en unité de point.
width_cm	Représente la largeur de la forme, en unités de centimètres.
height	Représente la hauteur de la forme, en unité de pixel.
height_inch	Représente la hauteur de la forme, en unités de pouces.
height_pt	Représente la hauteur de la forme, en unités de points.
height_cm	Représente la hauteur de la forme, en unités de centimètres.
left	Représente le décalage horizontal de la forme par rapport à sa colonne de gauche, en unités de pixels.
left_inch	Représente le décalage horizontal de la forme par rapport à sa colonne de gauche, en unités de pouces.
left_cm	Représente le décalage horizontal de la forme par rapport à sa colonne de gauche, en unités de centimètres.
top	Représente le décalage vertical de la forme par rapport à sa rangée supérieure, en unités de pixels.
top_inch	Représente le décalage vertical de la forme par rapport à sa rangée supérieure, en unités de pouces.
top_cm	Représente le décalage vertical de la forme par rapport à sa rangée supérieure, en unités de centimètres.
top_to_corner	Obtient et définit le décalage vertical de la forme par rapport à la bordure supérieure de la feuille de calcul, en unités de pixels.
left_to_corner	Obtient et définit le décalage horizontal de la forme par rapport à la bordure gauche de la feuille de calcul.
x	Obtient et définit le décalage horizontal de la forme par rapport à la bordure gauche de la feuille de calcul, en unités de pixels.
y	Obtient et définit le décalage vertical de la forme par rapport à la bordure supérieure de la feuille de calcul, en unités de pixels.
width_scale	Obtient et définit l’échelle de largeur, en unité de pourcentage de la largeur de l’image d’origine. Si la forme n’est pas une image, la propriété widthScale renvoie uniquement 100 ;
height_scale	Obtient et définit l’échelle de hauteur, en unité de pourcentage de la hauteur de l’image d’origine. Si la forme n’est pas une image, la propriété HeightScale renvoie uniquement 100 ;
top_in_shape	Représente le décalage vertical de la forme par rapport à la bordure supérieure de la forme parent. en unité de 1/4000 de hauteur de la forme parent.
left_in_shape	Représente le décalage horizontal de la forme par rapport à la bordure gauche de la forme parent. en unité de 1/4000 de largeur de la forme parent.
width_in_shape	Représente la largeur de la forme, en unité de 1/4 000 de la forme parent.
height_in_shape	Représente le décalage vertical de la forme par rapport à la bordure supérieure de la forme parent, en unité de 1/4 000 de la hauteur de la forme parent.
group	Obtient la forme de groupe qui contient cette forme.
type	Obtient le type de forme automatique.
has_line	Obtient et définit la bordure de ligne de la forme qui est visible.
is_filled	Indique si le format de remplissage est visible.
is_flipped_horizontally	Obtient et définit si la forme est inversée horizontalement.
is_flipped_vertically	Obtient et définit si la forme est inversée verticalement.
actual_lower_right_row	Obtenez la ligne du bas réelle.
connection_points	Obtenez les points de connexion
relative_to_original_picture_size	Indique si la forme est relative à la taille d’origine de l’image.
linked_cell	Obtient ou définit la plage de feuille de calcul liée à la valeur du contrôle.
input_range	Obtient ou définit la plage de feuille de calcul utilisée pour remplir la zone de liste déroulante spécifiée.
text_shape_type	Obtient et définit le type de forme de texte prédéfini.
text_body	Obtient et définit le paramètre du texte de la forme.
font	Représente la police de la forme.
text_options	Représente les options de texte de la forme.
text	Représente la chaîne dans cet objet TextBox.
is_rich_text	Si le texte est ou non un texte enrichi.
html_text	Obtient et définit la chaîne HTML qui contient des données et certains formats dans cette zone de texte.
text_vertical_overflow	Obtient et définit le type de débordement vertical de texte de la forme qui contient du texte.
text_horizontal_overflow	Obtient et définit le type de débordement horizontal de texte de la forme qui contient du texte.
is_text_wrapped	Obtient et définit le type de texte renvoyé à la ligne de la forme qui contient le texte.
text_orientation_type	Obtient et définit le type d’orientation du texte de la forme.
text_horizontal_alignment	Obtient et définit le type d’alignement horizontal du texte de la forme.
text_vertical_alignment	Obtient et définit le type d’alignement vertical du texte de la forme.
text_direction	Obtient/Définit la direction du flux de texte pour cet objet.
control_data	Obtient les données de contrôle.
active_x_control	Obtient le contrôle ActiveX.
paths	Obtient les chemins d’une forme géométrique personnalisée.
geometry	Obtient la géométrie
create_id	Obtient et définit l’identifiant de création pour cette forme.
item_count	Obtient le nombre d’éléments dans la zone de liste.
selected_index	Obtient ou définit le numéro d’index de l’élément actuellement sélectionné dans une zone de liste ou une zone de liste déroulante. Base zéro.
selected_cells	Obtient les cellules sélectionnées. Renvoie null si la plage d’entrée n’est pas définie ou si aucun élément n’est sélectionné
shadow	Indique si la zone de liste déroulante comporte un ombrage 3D.
selection_type	Obtient ou définit le mode de sélection de la zone de liste spécifiée.
page_change	Spécifie la quantité par laquelle la valeur du contrôle est modifiée lorsque l’utilisateur clique sur la région de page précédente ou de page suivante de la barre de défilement.

Méthodes

Méthode	Description
to_image	Crée l’image de forme et l’enregistre dans un flux au format spécifié.
to_image	Enregistre la forme dans un fichier.
to_image	Enregistre la forme dans un flux.
format_characters	Formate certains caractères avec le paramètre de police.
format_characters	Formate certains caractères avec le paramètre de police.
get_result_of_smart_art	Conversion d’art intelligent en formes groupées.
to_front_or_back	Place la forme au premier plan ou la renvoie à l’arrière-plan.
get_locked_property	Obtient la valeur de la propriété verrouillée.
set_locked_property	Définissez la propriété verrouillée.
add_hyperlink	Ajoute un lien hypertexte à la forme.
remove_hyperlink	Supprimez le lien hypertexte de la forme.
move_to_range	Déplace la forme vers une plage spécifiée.
align_top_right_corner	Déplace l’image vers le coin supérieur droit.
get_connection_points	Obtenez les points de connexion
get_linked_cell	Obtient la plage liée à la valeur du contrôle.
set_linked_cell	Définit la plage liée à la valeur du contrôle.
get_input_range	Obtient la plage utilisée pour remplir le contrôle.
set_input_range	Définit la plage utilisée pour remplir le contrôle.
update_selected_value	Mettez à jour la valeur sélectionnée par la valeur de la cellule liée.
calculate_text_size	Recalculer la zone de texte
characters	Renvoie un objet Characters qui représente une plage de caractères dans le texte.
get_characters	Renvoie tous les objets Personnages qui représente une plage de caractères dans le texte.
get_rich_formattings	Renvoie tous les objets Personnages qui représente une plage de caractères dans le texte.
remove_active_x_control	Supprimez le contrôle ActiveX.
is_same_setting	Renvoie si la forme est la même.
get_actual_box	Obtenez la position et la taille réelles de la forme (après avoir appliqué une rotation, un retournement, etc.)
selected_item	Définit si l’élément est sélectionné
is_selected	Indique si l’élément est sélectionné.

Exemple

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")

Voir également

LineShape classe MsoFillFormat classe