Propriétés et méthodes (API)

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


Book.png

Dans Apache OpenOffice Basic, les objets fournissent plusieurs propriétés et méthodes qui peuvent être appelées à l'aide des objets.

Propriétés

Les "propriétés" sont semblables aux propriétés d'un objet : Filename et Title pour un objet Document, par exemple.

Les propriétés sont définies à l'aide d'une simple assignation :

Document.Title = "{{OOo}} Basic Programmer's Guide"
Document.Filename = "basguide.odt"

Une propriété, tout comme une variable normale, possède un type définissant les valeurs qu'elle peut enregistrer. Les propriétés Filename et Title évoquées précédemment sont de type chaîne.

Propriétés réelles et propriétés imitées

Dans Apache OpenOffice Basic, la plupart des propriétés d'un objet sont définies comme telles dans la description UNO du service. Outre ces propriétés "réelles", il existe également dans Apache OpenOffice Basic des propriétés constituées de deux méthodes au niveau UNO. L'une sert à obtenir la valeur de la propriété et l'autre à la définir : il s'agit des méthodes get et set. La propriété a été virtuellement imitée à partir de deux méthodes. Les objets de caractère dans UNO, par exemple, fournissent les méthodes getPosition et setPosition qui permettent de connaître et de modifier le point clé associé. Le programmeur Apache OpenOffice Basic peut ainsi accéder à ces valeurs via la propriété Position. Indépendamment de cela, les méthodes d'origine sont également disponibles (dans notre exemple, getPosition et setPosition).

Méthodes

On peut considérer les méthodes comme des fonctions directement liées à un objet qui permettent d'appeler cet objet. L'objet Document précédent, par exemple, fournit une méthode Save, que vous pouvez appeler de la manière suivante :

Document.Save()

Les méthodes, à l'instar des fonctions, peuvent contenir des paramètres et des valeurs de retour. La syntaxe de ces appels de méthode est orientée vers les fonctions classiques. L'appel suivant spécifie également le paramètre True pour l'objet Document en appelant la méthode Save.

Ok = Document.Save(True)

Une fois la méthode terminée, Save enregistre une valeur de retour dans la variable Ok.

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