OFFICE : Documentation de la classe clAccessibility

Thierry GASPERMENT

Module de classe VBA pour faciliter l'utilisation des fonctions d'accessibilité (oleacc.dll)
Version actuelle : v0.3

- Titre : OFFICE : Documentation de la classe clAccessibility

- Auteur : Thierry GASPERMENT

- Parution : 25 février 2009

- Mise à jour : 4 mars 2018

- Licence : Les sources présentées sur cette page sont libres de droits et vous pouvez les utiliser à votre convenance. Par contre, la page de présentation constitue une œuvre intellectuelle protégée par les droits d'auteur. Copyright ® 2009 Thierry GASPERMENT. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts. Droits de diffusion permanents accordés à Developpez LLC.

Sommaire

- I. Introduction

- II. Fonctions et procédures

- II-A. SetAccObjFromObject

- II-B. SetAccObjFromHwnd

- II-C. SetAccObjFromDesktop

- II-D. SetAccObjFromPosition

- II-E. GetChild

- II-F. FindChild

- II-G. HitTest

- II-H. DoDefaultAction

- II-I. DoSelect

- II-J. ObjectMouseMove

- II-K. WindowGetClassName

- II-L. WindowGetText

- II-M. WindowSetText

- II-N. WindowSetPosition

- II-O. ScreenGetWidth

- II-P. ScreenGetHeight

- II-Q. WorkArea

- II-R. ShowMessage

- III. Propriétés

- III-A. ChildId

- III-B. ObjectType

- III-C. Parent

- III-D. WindowGethWnd

- III-E. AccObj

- III-F. Value

- III-G. Name

- III-H. Role

- III-I. RoleText

- III-J. State

- III-K. StateText

- III-L. DefaultAction

- III-M. Description

- III-N. KeyboardShortcut

- III-O. KeyboardShortcut

- III-P. KeyboardShortcut

- III-Q. KeyboardShortcut

- III-R. Childcount

I - Introduction

Cette documentation s'applique au module de classe clAccessibility :
Télécharger le module de classe au format texte

Consultez l'article d'introduction aux fonctions d'accessibilité

II - Fonctions et procédures

II-A - SetAccObjFromObject

Défini l'objet d'accessibilité en fonction d'un objet VBA.

Paramètres :

Paramètre

Type

Explication

pObject

Object

Objet VBA (CommandBar, Form, CommandButton, ...)

II-B - SetAccObjFromHwnd

Défini l'objet d'accessibilité en fonction d'un identifiant de fenêtre.

Paramètres :

Paramètre

Type

Explication

pHwnd

long

Identifiant de la fenêtre.
Par exemple : Application.HwndAccessApp

pObjId

AccObjId

Type d'objet à renvoyer.
Voir l'énumération AccObjId.

II-C - SetAccObjFromDesktop

Défini le bureau Windows en objet d'accessibilité.

Paramètres :

Paramètre

Type

Explication

pObjId

AccObjId

Type d'objet à renvoyer.
Voir l'énumération AccObjId.

II-D - SetAccObjFromPosition

Défini l'objet d'accessibilité en fonction de la position à l'écran.

Paramètres :

Paramètre

Type

Explication

[pX],[pY]

long

Position de l'objet à l'écran en pixel.
Ne pas renseigner ces paramètres pour récupérer l'objet sous le curseur de la souris.

II-E - GetChild

Renvoie un sous-objet par son numéro.

Paramètres :

Paramètre

Type

Explication

pId

long

Numéro du sous-objet (débute à 1)

pTimeOut

long

Time-out en millisecondes.
Le programme boucle pendant ce time-out tant qu'il n'a pas trouvé le sous-objet.

II-F - FindChild

Recherche un sous-objet.
Il est possible d'utiliser l'astérisque (*) dans les critères de recherche.

Paramètres :

Paramètre

Type

Explication

[pName]

string

Nom du sous-objet

[pRole]

AccRole

Role du sous-objet.
Voir l'énumération AccRole.

[pValue]

string

Valeur du sous-objet

[pWindowClass]

string

Classe de la fenêtre du sous-objet

[pWindowText]

string

Texte de la fenêtre du sous-objet

[pRecursive]

boolean

Recherche récursive.
Faux par défaut.

pTimeOut

long

Time-out en millisecondes.
Le programme boucle pendant ce time-out tant qu'il n'a pas trouvé le sous-objet.

II-G - HitTest

Renvoie le sous-objet sous la souris.

Paramètres :

Paramètre

Type

Explication

[pX],[pY]

long

Position à l'écran en pixel.
Ne pas renseigner ces paramètres pour récupérer l'objet sous le curseur de la souris.

II-H - DoDefaultAction

Exécute l'action par défaut de l'objet.

Par exemple : Click sur un bouton, un onglet.

II-I - DoSelect

Sélectionne l'objet.

Paramètres :

Paramètre

Type

Explication

pSelFlag

AccSelFlag

Flag de sélection.
Voir l'énumération AccSelFlag.

II-J - ObjectMouseMove

Déplace la souris sur l'élément.

II-K - WindowGetClassName

Renvoie la classe d'une fenêtre.

Paramètres :

Paramètre

Type

Explication

[pHwnd]

long

Identifiant de la fenêtre.
Si non renseigné, utilise celui de l'objet.

II-L - WindowGetText

Renvoie le texte d'une fenêtre.

Paramètres :

Paramètre

Type

Explication

[pHwnd]

long

Identifiant de la fenêtre.
Si non renseigné, utilise celui de l'objet.

II-M - WindowSetText

Modifie le texte d'une fenêtre.

Paramètres :

Paramètre

Type

Explication

[pHwnd]

long

Identifiant de la fenêtre.
Si non renseigné, utilise celui de l'objet.

[pText]

String

Texte à appliquer.

II-N - WindowSetPosition

Repositionne une fenêtre.

Paramètres :

Paramètre

Type

Explication

[pHwnd]

long

Identifiant de la fenêtre.
Si non renseigné, utilise celui de l'objet.

[pLeft]

long

Position gauche.

[pTop]

long

Position haut.

[pWidth]

long

Largeur.

[pHeight]

long

Hauteur.

[pZorderFlag]

AccWindowZOrderFlags

Position dans la pile de fenêtre
Voir l'énumération AccWindowZOrderFlags.

[pPositionFlags]

AccWindowPositionFlags

Flag de comportement.
Voir l'énumération AccWindowPositionFlags.

II-O - ScreenGetWidth

Largeur de l'écran en pixels.

II-P - ScreenGetHeight

Hauteur de l'écran en pixels.

II-Q - WorkArea

Renvoie les coordonnées de l'espace de travail (écran sans la barre des tâches).

Paramètres :

Paramètre

Type

Explication

[pLeft]

long

Position gauche.

[pTop]

long

Position haut.

[pWidth]

long

Largeur.

[pHeight]

long

Hauteur.

II-R - ShowMessage

Affiche une boîte de message en utilisant l'API.

Paramètres :

Paramètre

Type

Explication

[pHwnd]

long

Identifiant de la fenêtre parent du message.

[pText]

String

Texte du message.

[pCaption]

String

Titre du message.

[pText]

String

Texte à afficher.

[pType]

AccMessageBoxType

Type de message.
Voir l'énumération AccMessageBoxType.

III - Propriétés

III-A - ChildId

Id de l'élément si élément simple (Lecture/Ecriture).

C'est le cas par exemple pour un élément d'une liste.

III-B - ObjectType

Type de l'élément (object ou élément simple) (Lecture).

III-C - Parent

Parent de l'élément (Lecture).

III-D - WindowGethWnd

Identifiant de la fenêtre contenant l'élément (Lecture).

III-E - AccObj

Objet IAccessible (Lecture/Ecriture).

III-F - Value

Valeur de l'objet (Lecture/Ecriture).

III-G - Name

Nom de l'objet (Lecture/Ecriture).

III-H - Role

Role de l'objet (Lecture).

III-I - RoleText

Texte du role de l'objet (Lecture).

III-J - State

Statut de l'objet (Lecture).

III-K - StateText

Texte du statut de l'objet (Lecture).

III-L - DefaultAction

Texte de l'action par défaut de l'objet (Lecture).

III-M - Description

Description de l'objet (Lecture).

III-N - KeyboardShortcut

Raccourci clavier de l'objet (Lecture).

III-O - KeyboardShortcut

Raccourci clavier de l'objet (Lecture).

III-P - KeyboardShortcut

Raccourci clavier de l'objet (Lecture).

III-Q - KeyboardShortcut

Raccourci clavier de l'objet (Lecture).

III-R - Childcount

Nombre d'éléments enfants de l'objet (Lecture).