Détails des éléments de contrôle des boîtes de dialogue

From Apache OpenOffice Wiki
Jump to: navigation, search
doc OOo
Book.png


Apache OpenOffice Basic reconnaît un ensemble d'éléments de contrôle qui peuvent être répartis dans les groupes suivants :

Champs de saisie Boutons Listes de sélection Autre
  • Champs de texte
  • Champ de données
  • Champs horaires
  • Champs numériques
  • Champs monétaires
  • Champs adoptant tous les formats
  • Boutons standard
  • Cases à cocher
  • Boutons radio
  • Zones de liste
  • Boîtes combinées
  • Barres de défilement (horizontales et verticales)
  • Champs de groupes
  • Barres de progression
  • Lignes de séparation (horizontales et verticales)
  • Images
  • Champs de sélection de fichier

Boutons

Un bouton exécute une action lorsque vous cliquez dessus.

Dans le scénario le plus simple, le bouton déclenche un événement When Initiating lorsque l'utilisateur clique dessus. Vous pouvez également lier une autre action au bouton afin d'ouvrir une boîte de dialogue à l'aide de la propriété PushButtonType. Lorsque vous cliquez sur un bouton pour lequel cette propriété est définie sur la valeur 0, il ne se passe rien au niveau de la boîte de dialogue. Lorsque vous cliquez sur un bouton pour lequel cette propriété est définie sur la valeur 1, la boîte de dialogue est fermée et la méthode Execute de la boîte de dialogue retourne la valeur 1 (la séquence de la boîte de dialogue s'est terminée correctement). Si la propriété PushButtonType est définie sur la valeur 2, la boîte de dialogue est fermée et la méthode Execute de la boîte de dialogue retourne la valeur 0 (boîte de dialogue fermée).

Vous trouverez ci-après toutes les propriétés disponibles par l'intermédiaire du modèle de bouton :

Model.BackgroundColor (long)
couleur d'arrière-plan.
Model.DefaultButton (Boolean)
le bouton est utilisé comme valeur par défaut et répond à la touche Entrée en l'absence de focus.
Model.FontDescriptor (struct)
structure spécifiant les détails de la police utilisée (correspondant à la structure com.sun.star.awt.FontDescriptor).
Model.Label (String)
étiquette affichée sur le bouton.
Model.Printable (Boolean)
l'élément de contrôle peut être imprimé.
Model.TextColor (Long)
couleur du texte de l'élément de contrôle.
Model.HelpText (String)
texte d'aide s'affichant lorsque vous déplacez le pointeur de la souris au-dessus de l'élément de contrôle.
Model.HelpURL (String)
URL de l'aide en ligne pour l'élément de contrôle correspondant.
PushButtonType (short)
action liée au bouton (0 : pas d'action, 1 : OK, 2 : Annuler).

Boutons radio

Ces boutons sont généralement utilisés en groupes et permettent d'effectuer un choix parmi une ou plusieurs options. Lorsque vous sélectionnez une option, toutes les autres options du groupe sont désactivées. De cette façon, il n'est possible de définir qu'un seul bouton radio à la fois.

Un élément de contrôle d'un bouton radio fournit deux propriétés :

State (Boolean)
active le bouton.
Label (String)
étiquette affichée sur le bouton.

Vous pouvez également utiliser les propriétés suivantes à partir du modèle des boutons radio :

Model.FontDescriptor (struct)
structure contenant les détails de la police utilisée (correspondant à com.sun.star.awt.FontDescriptor).
Model.Label (String)
étiquette affichée sur l'élément de contrôle.
Model.Printable (Boolean)
l'élément de contrôle peut être imprimé.
Model.State (Short)
si cette propriété est égale à 1, l'option est activée ; sinon, elle est désactivée.
Model.TextColor (Long)
couleur du texte de l'élément de contrôle.
Model.HelpText (String)
texte d'aide s'affichant lorsque le pointeur de la souris est placé au-dessus de l'élément de contrôle.
Model.HelpURL (String)
URL de l'aide en ligne pour l'élément de contrôle correspondant.

Pour regrouper plusieurs boutons radio, vous devez les positionner les uns à la suite des autres dans la séquence d'activation sans aucun espace (propriété Model.TabIndex, décrite en tant que Order dans l'éditeur de boîte de dialogue). Si la séquence d'activation est interrompue par un autre élément de contrôle, Apache OpenOffice démarre automatiquement avec un nouveau groupe d'éléments de contrôle pouvant être activé indépendamment du premier.

Documentation note.png Contrairement à VBA, vous ne pouvez pas insérer de boutons radio dans un groupe d'éléments de contrôle dans Apache OpenOffice Basic. Dans Apache OpenOffice Basic, le groupement d'éléments de contrôle sert uniquement à créer une division visuelle en dessinant un cadre autour des éléments de contrôle.

Cases à cocher

Les cases à cocher servent à enregistrer une valeur Yes ou No et, suivant le mode, elles peuvent adopter deux ou trois états. Outre les états Yes et No, une case à cocher peut posséder un état intermédiaire si le statut correspondant pour Yes ou No a plusieurs significations ou n'est pas clair.

Les cases à cocher fournissent les propriétés suivantes :

State (Short)
état de la case à cocher (0 : non, 1 : oui, 2 : état intermédiaire).
Label (String)
étiquette de l'élément de contrôle.
enableTriState (Boolean)
outre les états actif et inactif, vous pouvez également utiliser l'état intermédiaire.

L'objet Model d'une case à cocher fournit les propriétés suivantes :

Model.FontDescriptor (struct)
structure contenant les détails de la police utilisée (correspondant à la structure com.sun.star.awt.FontDescriptor).
Model.Label (String)
étiquette de l'élément de contrôle.
Model.Printable (Boolean)
l'élément de contrôle peut être imprimé.
Model.State (Short)
état de la case à cocher (0 : non, 1 : oui, 2 : état intermédiaire).
Model.Tabstop (Boolean)
permet d'atteindre l'élément de contrôle à l'aide de la touche de tabulation.
Model.TextColor (Long)
couleur du texte de l'élément de contrôle.
Model.HelpText (String)
texte d'aide s'affichant lorsque vous placez le pointeur de la souris au-dessus de l'élément de contrôle.
Model.HelpURL (String)
URL de l'aide en ligne pour l'élément de contrôle correspondant.

Champs de texte

Les champs de texte permettent aux utilisateurs de saisir des chiffres et du texte. Le service com.sun.star.awt.UnoControlEdit constitue la base des champs de texte.

Un champ de texte peut contenir une ou plusieurs lignes et peut être édité ou bloqué par l'utilisateur. Les champs de texte peuvent également servir de champs numériques ou monétaires spéciaux, ainsi que de champs d'écran pour certaines tâches particulières. Ces éléments de contrôle étant basés sur le service Uno UnoControlEdit, leur gestion contrôlée par programme est semblable.

Les champs de texte fournissent les propriétés suivantes :

Text (String)
texte actif.
SelectedText (String)
texte actuellement mis en évidence.
Selection (Struct)
mise en évidence en lecture seule des détails (structure correspondant à com.sun.star.awt.Selection, avec les propriétés Min et Max spécifiant le début et la fin de la mise en évidence).
MaxTextLen (short)
nombre maximal de caractères autorisés dans le champ.
Editable (Boolean)
True active l'option de saisie de texte et False bloque cette option de saisie (la propriété ne peut pas être appelée directement : vous devez utiliser IsEditable).
IsEditable (Boolean)
le contenu de l'élément de contrôle peut être modifié, en lecture seule.

Les propriétés suivantes sont fournies par l'intermédiaire de l'objet Model associé :

Model.Align (short)
orientation du texte (0 : aligné à gauche, 1 : centré, 2 : aligné à droite).
Model.BackgroundColor (long)
couleur d'arrière-plan de l'élément de contrôle.
Model.Border (short)
type de bordure (0 : aucune bordure, 1 : bordure 3D, 2 : bordure simple).
Model.EchoChar (String)
caractère écho pour le champ de mot de passe.
Model.FontDescriptor (struct)
structure contenant les détails de la police utilisée (correspondant à la structure com.sun.star.awt.FontDescriptor).
Model.HardLineBreaks (Boolean)
des retours à la ligne automatiques sont constamment insérés dans le texte de l'élément de contrôle.
Model.HScroll (Boolean)
le texte possède une barre de défilement horizontale.
Model.MaxTextLen (Short)
longueur maximale du texte. Si la valeur est 0, il n'existe aucune limite.
Model.MultiLine (Boolean)
l'entrée peut s'étendre sur plusieurs lignes.
Model.Printable (Boolean)
l'élément de contrôle peut être imprimé.
Model.ReadOnly (Boolean)
le contenu de l'élément de contrôle est en lecture seule.
Model.Tabstop (Boolean)
permet d'atteindre l'élément de contrôle à l'aide de la touche de tabulation.
Model.Text (String)
texte associé à l'élément de contrôle.
Model.TextColor (Long)
couleur du texte de l'élément de contrôle.
Model.VScroll (Boolean)
le texte possède une barre de défilement verticale.
Model.HelpText (String)
texte d'aide s'affichant lorsque le pointeur de la souris est placé au-dessus de l'élément de contrôle.
Model.HelpURL (String)
URL de l'aide en ligne pour l'élément de contrôle correspondant.

Zones de liste

Les zones de liste (service com.sun.star.awt.UnoControlListBox) prennent en charge les propriétés suivantes :

ItemCount (Short)
nombre d'éléments, en lecture seule.
SelectedItem (String)
texte de l'entrée mise en évidence, en lecture seule.
SelectedItems (Array Of Strings)
champ de données contenant les entrées mises en évidence, en lecture seule.
SelectItemPos (Short)
numéro de l'entrée actuellement mise en évidence, en lecture seule.
SelectItemsPos (Array of Short)
champ de données contenant le nombre d'entrées mises en évidence (pour les listes acceptant les sélections multiples), en lecture seule.
MultipleMode (Boolean)
True active l'option de sélection multiple des entrées et False bloque les sélections multiples (la propriété ne peut pas être appelée directement : vous devez utiliser IsMultipleMode).
IsMultipleMode (Boolean)
permet la sélection multiple dans les listes, en lecture seule.

Les zones de liste fournissent les méthodes suivantes :

addItem (Item, Pos)
insère la chaîne spécifiée dans Item dans la liste, à la position Pos.
addItems (ItemArray, Pos)
insère les entrées répertoriées dans le champ de données ItemArray de la chaîne dans la liste, à la position Pos.
removeItems (Pos, Count)
supprime Count entrées à partir de la position Pos.
selectItem (Item, SelectMode)
active ou désactive la mise en évidence de l'élément spécifié dans la chaîne Item en fonction de la variable booléenne SelectMode.
makeVisible (Pos)
fait défiler les champs de la liste afin de rendre l'entrée spécifiée par Pos visible.

L'objet Model des zones de liste fournit les propriétés suivantes :

Model.BackgroundColor (long)
couleur d'arrière-plan de l'élément de contrôle.
Model.Border (short)
type de bordure (0 : aucune bordure, 1 : bordure 3D, 2 : bordure simple).
Model.FontDescriptor (struct)
structure contenant les détails de la police utilisée (correspondant à la structure com.sun.star.awt.FontDescriptor).
Model.LineCount (Short)
nombre de lignes dans l'élément de contrôle.
Model.MultiSelection (Boolean)
autorise la sélection multiple d'entrées.
Model.SelectedItems (Array of Strings)
liste des entrées mises en évidence.
Model.StringItemList (Array of Strings)
liste de toutes les entrées.
Model.Printable (Boolean)
l'élément de contrôle peut être imprimé.
Model.ReadOnly (Boolean)
le contenu de l'élément de contrôle est en lecture seule.
Model.Tabstop (Boolean)
permet d'atteindre l'élément de contrôle à l'aide de la touche de tabulation.
Model.TextColor (Long)
couleur du texte de l'élément de contrôle.
Model.HelpText (String)
texte d'aide s'affichant automatiquement lorsque le pointeur de la souris se trouve au-dessus de l'élément de contrôle.
Model.HelpURL (String)
URL de l'aide en ligne pour l'élément de contrôle correspondant.
Documentation note.png L'option VBA permettant d'émettre des entrées de liste avec une valeur numérique supplémentaire (ItemData) n'existe pas dans Apache OpenOffice Basic. Si vous souhaitez gérer une valeur numérique (ID de base de données, par exemple) en plus du texte en langage naturel, vous devez créer un champ de données auxiliaire en plus de la zone de liste.
Content on this page is licensed under the Public Documentation License (PDL).
Personal tools