Détails des formulaires d'éléments de contrôle

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


Les éléments de contrôle disponibles dans les formulaires sont semblables à ceux des boîtes de dialogue. Vous pouvez choisir parmi plusieurs champs de texte simples, zones de liste, boîtes combinées et boutons.

Vous trouverez ci-dessous la liste des propriétés les plus importantes pour les formulaires des éléments de contrôle. Toutes les propriétés font partie des objets Model associés.

Outre les éléments de contrôle standard, un élément de contrôle de table est également disponible pour les formulaires : il permet l'intégration de tables de bases de données complètes. Pour plus d'informations à ce sujet, reportez-vous au chapitre Formulaires de base de données.

Boutons

L'objet Model d'un bouton de formulaire fournit les propriétés suivantes :

BackgroundColor (long)
couleur d'arrière-plan.
DefaultButton (Boolean)
le bouton sert de valeur par défaut. Dans ce cas, il répond également au bouton d'entrée s'il n'est pas activé.
Enabled (Boolean)
l'élément de contrôle peut être activé.
Tabstop (Boolean)
l'élément de contrôle peut être atteint avec le bouton de tabulation.
TabIndex (Long)
position de l'élément de contrôle dans la séquence d'activation.
FontName (String)
nom du type de police.
FontHeight (Single)
hauteur de caractère en points (pt).
Tag (String)
chaîne contenant des informations supplémentaires, pouvant être enregistrées dans le bouton pour un accès contrôlé par le programme.
TargetURL (String)
URL cible pour les boutons du type d'URL.
TargetFrame (String)
nom de la fenêtre (ou du cadre) dans laquelle l'URL cible TargetURL doit être ouvert lors de l'activation du bouton (pour les boutons du type d'URL).
Label (String)
nom du bouton.
TextColor (Long)
couleur du texte de l'élément de contrôle.
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.
HelpURL (String)
URL de l'aide en ligne pour l'élément de contrôle correspondant.
ButtonType (Enum)
action liée au bouton (valeur par défaut à partir de com.sun.star.form.FormButtonType).
State (Short)
dans le cas d'un bouton bascule (toggle button) si la valeur est 1, le bouton est à l'état enfoncé ; sinon non.

La propriété ButtonType permet de définir une action s'exécutant automatiquement lorsque l'utilisateur appuie sur le bouton. Le groupe de constantes com.sun.star.form.FormButtonType associé fournit les valeurs suivantes :

PUSH
bouton standard.
SUBMIT
fin de l'entrée du formulaire (particulièrement utile pour les formulaires HTML).
RESET
rétablit toutes les valeurs d'origine du formulaire.
URL
appelle l'URL défini dans TargetURL. L'URL est ouvert dans la fenêtre spécifiée via TargetFrame).

Les types de bouton OK et Annuler figurant dans les boîtes de dialogue ne sont pas pris en charge dans les formulaires.

Boutons radio

Les propriétés suivantes d'un bouton radio sont disponibles via l'objet Model :

Enabled (Boolean)
l'élément de contrôle peut être activé.
Tabstop (Boolean)
l'élément de contrôle peut être atteint avec la touche de tabulation.
TabIndex (Long)
position de l'élément de contrôle dans la séquence d'activation.
FontName (String)
nom du type de police.
FontHeight (Single)
hauteur de caractère en points (pt).
Tag (String)
chaîne contenant des informations supplémentaires, pouvant être enregistrées dans le bouton pour un accès contrôlé par le programme.
Label (String)
nom affiché du bouton.
Printable (Boolean)
l'élément de contrôle peut être imprimé.
State (Short)
si la valeur est 1, l'option est activée ; sinon, elle est désactivée.
RefValue (String)
chaîne permettant d'enregistrer des informations supplémentaires (pour gérer les ID des enregistrements de données, par exemple).
TextColor (Long)
couleur du texte de l'élément de contrôle.
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.
HelpURL (String)
URL de l'aide en ligne pour l'élément de contrôle correspondant.

Le mécanisme de regroupement des boutons radio fait la distinction entre les éléments de contrôle destinés aux boîtes de dialogue et ceux qui sont destinés aux formulaires. Les éléments de contrôle apparaissant successivement dans les boîtes de dialogue qui sont regroupés automatiquement, tandis que le regroupement des formulaires s'effectue sur la base des noms. Pour ce faire, tous les boutons radio d'un groupe doivent porter le même nom. OpenOffice.org associe les éléments de contrôle groupés dans une matrice afin que les boutons individuels d'un programme OpenOffice.org Basic puissent être atteints de la même manière que précédemment.

L'exemple suivant illustre la détermination du modèle d'un groupe d'éléments de contrôle.

Dim Doc As Object
Dim Forms As Object
Dim Form As Object
Dim Ctl As Object
Dim I as Integer
 
Doc = StarDesktop.CurrentComponent
Forms = Doc.Drawpage.Forms
 
For I = 0 To Forms.Count - 1
  Form = Forms.GetbyIndex(I)
  If Form.HasByName("MyOptions") Then
    Ctl = Form. GetGroupbyName("MyOptions")
    Exit Function
  End If
Next I

Ce code correspond à l'exemple précédent permettant de déterminer un modèle simple d'élément de contrôle. Il effectue une recherche en boucle dans tous les formulaires du document texte actif et, à l'aide de la méthode HasByName, détermine si le formulaire correspondant contient un élément comportant le nom MyOptions recherché. Si tel est le cas, l'accès à la matrice du modèle s'effectue via la méthode GetGroupByName, plutôt que la méthode GetByName qui permet de déterminer des modèles simples.

Cases à cocher

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

Enabled (Boolean)
l'élément de contrôle peut être activé.
Tabstop (Boolean)
l'élément de contrôle peut être atteint avec la touche de tabulation.
TabIndex (Long)
position de l'élément de contrôle dans la séquence d'activation.
FontName (String)
nom du type de police.
FontHeight (Single)
hauteur de caractère en points (pt).
Tag (String)
chaîne contenant des informations supplémentaires, pouvant être enregistrées dans le bouton pour un accès contrôlé par le programme.
Label (String)
nom du bouton.
Printable (Boolean)
l'élément de contrôle peut être imprimé.
State (Short)
si la valeur est 1, l'option est activée ; sinon, elle est désactivée.
RefValue (String)
chaîne permettant d'enregistrer des informations supplémentaires (pour gérer les ID des enregistrements de données, par exemple).
TextColor (Long)
couleur du texte de l'élément de contrôle.
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.
HelpURL (String)
URL de l'aide en ligne pour l'élément de contrôle correspondant.

Champs de texte

L'objet Model d'un formulaire de champ de texte fournit les propriétés suivantes :

Align (short)
orientation du texte (0 : aligné à gauche, 1 : centré, 2 : aligné à droite).
BackgroundColor (long)
couleur d'arrière-plan de l'élément de contrôle.
Border (short)
type de bordure (0 : aucune bordure, 1 : bordure 3D, 2 : bordure simple).
EchoChar (String)
caractère écho pour le champ de mot de passe.
FontName (String)
nom du type de police.
FontHeight (Single)
hauteur de caractère en points (pt).
HardLineBreaks (Boolean)
des retours à la ligne automatiques sont constamment insérés dans le texte de l'élément de contrôle.
HScroll (Boolean)
le texte possède une barre de défilement horizontale.
MaxTextLen (Short)
longueur maximale du texte. Si la valeur 0 est indiquée, il n'existe aucune limite.
MultiLine (Boolean)
autorise les entrées sur plusieurs lignes.
Printable (Boolean)
l'élément de contrôle peut être imprimé.
ReadOnly (Boolean)
le contenu de l'élément de contrôle est en lecture seule.
Enabled (Boolean)
l'élément de contrôle peut être activé.
Tabstop (Boolean)
l'élément de contrôle peut être atteint avec la touche de tabulation.
TabIndex (Long)
position de l'élément de contrôle dans la séquence d'activation.
FontName (String)
nom du type de police.
FontHeight (Single)
hauteur de caractère en points (pt).
Text (String)
texte de l'élément de contrôle.
TextColor (Long)
couleur du texte de l'élément de contrôle.
VScroll (Boolean)
le texte possède une barre de défilement verticale.
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.
HelpURL (String)
URL de l'aide en ligne pour l'élément de contrôle correspondant.

Zones de liste

L'objet Model d'un formulaire de zone de liste fournit les propriétés suivantes :

BackgroundColor (long)
couleur d'arrière-plan de l'élément de contrôle.
Border (short)
type de bordure (0 : aucune bordure, 1 : bordure 3D, 2 : bordure simple).
FontDescriptor (struct)
structure correspondant à com.sun.star.awt.FontDescriptor indiquant les polices à utiliser.
LineCount (Short)
nombre de lignes dans l'élément de contrôle.
MultiSelection (Boolean)
autorise la sélection multiple d'entrées.
SelectedItems (Array of Strings)
liste des entrées mises en évidence.
StringItemList (Array of Strings)
liste de toutes les entrées.
ValueItemList (Array of Variant)
liste contenant des informations supplémentaires pour chaque entrée (pour gérer les ID des enregistrements de données, par exemple).
Printable (Boolean)
l'élément de contrôle peut être imprimé.
ReadOnly (Boolean)
le contenu de l'élément de contrôle est en lecture seule.
Enabled (Boolean)
l'élément de contrôle peut être activé.
Tabstop (Boolean)
l'élément de contrôle peut être atteint avec la touche de tabulation.
TabIndex (Long)
position de l'élément de contrôle dans la séquence d'activation.
FontName (String)
nom du type de police.
FontHeight (Single)
hauteur de caractère en points (pt).
Tag (String)
chaîne contenant des informations supplémentaires, pouvant être enregistrées dans le bouton pour un accès contrôlé par le programme.
TextColor (Long)
couleur du texte de l'élément de contrôle.
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.
HelpURL (String)
URL de l'aide en ligne pour l'élément de contrôle correspondant.
Documentation note.png La propriété ValueItemList des formulaires de zones de liste s'apparente à la propriété VBA ItemData qui permet de gérer des informations supplémentaires pour les entrées de liste individuelles.

De plus, les méthodes suivantes sont fournies via l'objet View de la zone de liste :

addItem (Item, Pos)
insère dans la liste la chaîne spécifiée dans Item à la position Pos.
addItems (ItemArray, Pos)
insère dans la liste les entrées répertoriées dans le champ de données ItemArray de la chaîne à 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 SelectMode.
makeVisible (Pos)
fait défiler les champs de la liste afin de rendre l'entrée spécifiée par Pos visible.
Content on this page is licensed under the Public Documentation License (PDL).
Personal tools