Autres Instructions

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

Type...End Type

Une structure est une collection de variables qui peuvent être manipulées comme une seule entité. En d'autres termes, on peut faire l'analogie entre une structure et un enregistrement, ou un morceau d'enregistrement.

L'API utilise souvent des structures prédéfinies mais ce sont des structures UNO, un type de structure très spécialisé.


Définition

Avec l'instruction Type...End Type, vous pouvez définir votre propre structure (non-UNO).

Type aMenuItem			'déclare le nom de la structure
    'défini les champs dans la structure
    'chaque définition ressemble à une instruction DIM, sans la commande "Dim"
    aCommand as String		
    aText as String
End Type			'conclut la définition

Instance

La définition Type n'est qu'un modèle, pas un ensemble de variables existantes. Pour avoir une instance de ce type, avec de véritables variables qui peuvent être manipulées, utiliser l'instruction Dim ... as New :

Dim maItem as New aMenuItem

Portée

Comme dans l'exemple ci-dessous, la définition de Type peut être écrite au début du module (avant la première instruction Sub ou Function). La définition sera alors utilisable par toutes les routines dans le module.

Depuis la version 3.0 de OpenOffice.org, et contrairement aux variables, un type déclaré dans un module ne peut pas être utilisé à partir d'un autre module.

Une instance du nouveau type est une variable et répond donc aux règles de portées des variables (voir Portée et durée de vie des variables).

La section With...End With montre un exemple d'usage d'une définition et de référencement d'un champ dans une instance.

With...End With

Qualificateurs

En général, Basic ne regarde pas à l'intérieur d'un conteneur, comme un Object par exemple, pour déterminer quels noms y sont définis. Si vous voulez utiliser un tel nom, il faut indiquer à Basic où le trouver. Vous pouvez faire ceci en utilisant le nom de l'objet en tant que qualificateur. Le qualificateur s'utilise en amont du nom interne, séparé par un point :

MonObjet.UnNom

Comme les conteneurs peuvent contenir d'autres conteneurs, vous pourrez avoir besoin de plus d'un qualificateur. Il vous suffit alors de les indiquer dans l'ordre du plus externe au plus interne :

MonObjet.ObjetFils.ObjetPetitFils.UnNom

Cette representation peut être décrite comme "concatenée avec l'opérateur point ('.')".

L'alternative With

L'instruction With...End With est une alternative pour ne pas écrire tous les qualificateurs à chaque fois (certains qualificateurs de l'API peuvent être assez longs). Vous spécifiez alors les qualificateurs dans l'instruction With. Basic recherche alors les noms partiellement qualifiés qui commencent avec un point jusqu'à ce qu'il rencontre l'instruction End With. Le compilateur utilise alors le qualificateur déclaré dans l'instruction With pour qualifier ces noms comme si le qualificateur était écrit à chaque fois.

Exemple 1: Une structure utilisateur

Cet exemple montre comment déclarer et utiliser une structure ainsi que comment accéder à ses éléments internes, avec et sans l'instruction With

Type aMenuItem
    aCommand as String
    aText as String
End Type
 
Sub Main
    'Crée une instance de la structure
    'Noter le mot-clé, "New"
    Dim maItem as New aMenuItem
    With maItem
        .aCommand = ".uno:Copy"
        .aText = "~Copy"
    End With
 
    MsgBox     "Command: " & maItem.aCommand & Chr(13) _
            & "Text: " & maItem.aText
End Sub

Exemple 2: Instruction Case

Dans Cellules et plages, le qualificateur est intégralement écrit dans l'instruction Case. Cet exemple peut être écrit de manière plus concise :

Dim Doc As Object
Dim Sheet As Object
Dim Cell As Object
 
Doc = StarDesktop.CurrentComponent
Sheet = Doc.Sheets(0)
Cell = Sheet.getCellByPosition(1,1)	'Cell "B2" (0-based!)
 
Cell.Value = 1000
 
With com.sun.star.table.CellContentType
  Select Case Cell.Type
    Case .EMPTY 
      MsgBox "Content: Empty"
    Case .VALUE
      MsgBox "Content: Value"
    Case .TEXT
      MsgBox "Content: Text"
    Case .FORMULA
     MsgBox "Content: Formula"
  End Select
End With

Notez que l'instruction With doit encadrer entièrement l'instruction Select.


Content on this page is licensed under the Public Documentation License (PDL).
Personal tools