Sens affectés aux paramètres des méthodes :
(E) |
Entrée |
(S) |
Sortie |
(E/S) |
Entrée et Sortie |
Liste des codes retour des différentes méthodes :
_FEN_ERR_OK |
1 |
Opération correctement effectuée. |
_FEN_ERR_EXEC |
0 |
Une erreur inattendue s'est produite. |
_FEN_ERR_PAGE |
-1 |
La valeur du paramètre NumPage est incorrecte. |
_FEN_ERR_PAGE_VISIBLE |
-2 |
Impossible de rendre invisible la page spécifiée, car c'est la seule visible. |
_FEN_ERR_TYPE_FEN |
-2 |
La fenêtre ne possède pas le type adéquat (fenêtre simple ou fenêtre à onglets) pour pouvoir appliquer la méthode. |
_FEN_ERR_TYPE_FEN2 |
-3 |
La fenêtre ne possède pas le type adéquat (fenêtre simple ou fenêtre à onglets) pour pouvoir appliquer la méthode. |
_FEN_ERR_CLS_FEN |
-4 |
La fenêtre n'est pas de la classe adéquate pour pouvoir appliquer la méthode. |
_FEN_ERR_PARAM |
-5 |
La valeur d'un paramètre d'entrée n'est pas valide. |
_FEN_ERR_TERM_FILLE |
-6 |
Au moins une fenêtre fille ne peut pas être terminée (possible lorsque l'utilisateur a ouvert une fenêtre modale depuis une fenêtre fille). |
Active la fenêtre fille suivante d'une fenêtre principale.
| Syntaxe | ||
APPELER_METHODE NomFenetre ACTIVER_FEN_SUIVANTE CodeRetour |
||
Paramètres |
||
CodeRetour (S) |
NUM_BIN_2 |
Code retour de l'opération. Valeurs possibles: _FEN_ERR_OK _FEN_ERR_CLS_FEN |
Conditions d'utilisation |
La fenêtre doit être une fenêtre principale. |
|
Remarque : cette méthode n'est pas mise en oeuvre en génération Mobile.
Affiche en cascade les fenêtres filles d'une fenêtre principale.
| Syntaxe | ||||||
APPELER_METHODE NomFenetre AFFICHER_CASCADE Type CodeRetour |
||||||
Paramètres |
||||||
Type (E) |
NUM_BIN_2 |
Indique l'ensemble des fenêtres filles à afficher en cascade. Valeurs possibles:
|
||||
CodeRetour (S) |
NUM_BIN_2 |
Code retour de l'opération. Valeurs possibles: _FEN_ERR_OK _FEN_ERR_CLS_FEN _FEN_ERR_PARAM |
||||
Conditions d'utilisation |
La fenêtre doit être une fenêtre principale. |
|||||
Remarque : cette méthode n'est pas mise en oeuvre en génération Mobile.
Affiche en mosaïque les fenêtres filles d'une fenêtre principale.
| Syntaxe | ||||||||
APPELER_METHODE NomFenetre AFFICHER_MOSAIQUE Type CodeRetour |
||||||||
Paramètres |
||||||||
Type (E) |
NUM_BIN_2 |
Indique l'ensemble des fenêtres filles à afficher en mosaïque et leur orientation. Valeurs possibles:
|
||||||
CodeRetour (S) |
NUM_BIN_2 |
Code retour de l'opération. Valeurs possibles: _FEN_ERR_OK _FEN_ERR_CLS_FEN _FEN_ERR_PARAM |
||||||
Conditions d'utilisation |
La fenêtre doit être une fenêtre principale. |
|||||||
Remarque : cette méthode n'est pas mise en oeuvre en génération Mobile.
Fixe l'activité d'une page dans une fenêtre à onglets. Lorsqu'une page est inactive, il n'est pas possible d'y accéder via l'interface ; par contre, il est possible de la mettre au premier plan par programmation.
| Syntaxe | ||
APPELER_METHODE NomFenetre FIXER_ACTIVITE_PAGE NumPage Activite CodeRetour |
||
Paramètres |
||
NumPage (E) |
NUM_BIN_2 |
Numéro de la page. Celui-ci correspond au numéro d'ordre de la page lorsque toutes les pages sont visibles. |
Activite (E) |
BOOL |
Activité de la page. |
CodeRetour (S) |
NUM_BIN_2 |
Code retour de l'opération. Valeurs possibles: _FEN_ERR_OK _FEN_ERR_PAGE _FEN_ERR_TYPE_FEN _FEN_ERR_CLS_FEN |
Conditions d'utilisation |
La fenêtre doit être une fenêtre à onglets. |
|
Remarque : cette méthode n'est pas mise en oeuvre par le générateur Java.
Fixe le texte de l'onglet d'une page dans une fenêtre à onglets.
| Syntaxe | ||
APPELER_METHODE NomFenetre FIXER_TEXTE_PAGE NumPage Texte CodeRetour |
||
Paramètres |
||
NumPage (E) |
NUM_BIN_2 |
Numéro de la page. Celui-ci correspond au numéro d'ordre de la page lorsque toutes les pages sont visibles. |
Texte (E) |
ALPHA(250) |
Texte de l'onglet de la page. |
CodeRetour (S) |
NUM_BIN_2 |
Code retour de l'opération. Valeurs possibles: _FEN_ERR_OK _FEN_ERR_EXEC _FEN_ERR_PAGE _FEN_ERR_TYPE_FEN _FEN_ERR_CLS_FEN |
Conditions d'utilisation |
La fenêtre doit être une fenêtre à onglets. |
|
Fixe la visibilité d'une page dans une fenêtre à onglets. Si la page courante devient invisible, la nouvelle page courante est la première page visible suivante.
| Syntaxe | ||
APPELER_METHODE NomFenetre FIXER_VISIBILITE_PAGE NumPage Visibilite CodeRetour |
||
Paramètres |
||
NumPage (E) |
NUM_BIN_2 |
Numéro de la page. Celui-ci correspond au numéro d'ordre de la page lorsque toutes les pages sont visibles. |
Visibilite (E) |
BOOL |
Visibilité de la page. |
CodeRetour (S) |
NUM_BIN_2 |
Code retour de l'opération. Valeurs possibles: _FEN_ERR_OK _FEN_ERR_EXEC _FEN_ERR_PAGE _FEN_ERR_PAGE_VISIBLE _FEN_ERR_TYPE_FEN2 _FEN_ERR_CLS_FEN |
Conditions d'utilisation |
La fenêtre doit être une fenêtre à onglets. |
|
Récupère l'activité d'une page dans une fenêtre à onglets.
| Syntaxe | ||
APPELER_METHODE NomFenetre RECUPERER_ACTIVITE_PAGE NumPage Activite CodeRetour |
||
Paramètres |
||
NumPage (E) |
NUM_BIN_2 |
Numéro de la page. Celui-ci correspond au numéro d'ordre de la page lorsque toutes les pages sont visibles. |
Activite (E) |
BOOL |
Activité de la page. |
CodeRetour (S) |
NUM_BIN_2 |
Code retour de l'opération. Valeurs possibles: _FEN_ERR_OK _FEN_ERR_PAGE _FEN_ERR_TYPE_FEN _FEN_ERR_CLS_FEN |
Conditions d'utilisation |
La fenêtre doit être une fenêtre à onglets. |
|
Remarque : cette méthode n'est pas mise en oeuvre par le générateur Java.
Récupère dans un tableau le nom des objets graphiques présents sur une page, dans la marge ou sur toute la fenêtre.
Le tableau est trié selon l'ordonnancement des objets graphiques dans la fenêtre.
Syntaxe |
||||||||
APPELER_METHODE NomFenetre RECUPERER_OBJETS TableauNomObjets Taille ClasseObjet NumPage NombreElementsLus CodeRetour |
||||||||
Paramètres |
||||||||
TableauNomObjets (S) |
ALPHA(128) |
Tableau recevant en sortie le nom des objets graphiques présents sur la fenêtre. |
||||||
Taille (E) |
NUM_BIN_4 |
Taille du tableau TableauNomObjets. |
||||||
ClasseObjet (E) |
ALPHA(250) |
Nom du fichier de l'objet graphique de base défini dans la boîte de dialogue Modifier un objet graphique de base. |
||||||
NumPage (E) |
NUM_BIN_2 |
Numéro de la page. Celui-ci correspond au numéro d'ordre de la page lorsque toutes les pages sont visibles. Valeurs possibles:
|
||||||
NombreElementsLus (S) |
NUM_BIN_4 |
Nombre d'éléments insérés dans le tableau. |
||||||
CodeRetour (S) |
NUM_BIN_2 |
Code retour de l'opération. Valeurs possibles: _FEN_ERR_OK _FEN_ERR_PAGE _FEN_ERR_PARAM _FEN_ERR_EXEC _FEN_ERR_CLS_FEN |
||||||
Conditions d'utilisation |
La fenêtre ne doit pas être une fenêtre principale. |
|||||||
Remarques :
La longueur du tableau TableauNomObjets doit être au moins égale à la taille indiquée.
S'il y a plus d'objets que la taille indiquée, le code retour aura la valeur _FEN_ERR_PARAM mais le tableau sera bien rempli.
Exemple d'utilisation : Les noms d'objets récupérés peuvent être utilisés par la fonction prédéfinie &RECUPERER_OBJET afin de manipuler les propriétés des objets.
Remarque : cette méthode n'est pas mise en oeuvre en génération Java.
Récupère les coordonnées du curseur de la souris relativement à la surface de la fenêtre.
| Syntaxe | ||
APPELER_METHODE NomObjetFenetre RECUPERER_POSITION_SOURIS Abscisse Ordonnee CodeRetour |
||
Paramètres |
||
Abscisse (S) |
NUM_BIN_4 | Abscisse du curseur de la souris relative au coin supérieur gauche de la fenêtre. |
Ordonnée (S) |
NUM_BIN_4 | Ordonnée du curseur de la souris relative au coin supérieur gauche de la fenêtre. |
CodeRetour (S) |
BOOL | *VRAI : opération réussie. *FAUX : échec. |
Conditions d'utilisation |
Aucune |
|
Récupère le texte de l'onglet d'une page dans une fenêtre à onglets.
| Syntaxe | ||
APPELER_METHODE NomFenetre RECUPERER_TEXTE_PAGE NumPage Texte CodeRetour |
||
Paramètres |
||
NumPage (E) |
NUM_BIN_2 |
Numéro de la page. Celui-ci correspond au numéro d'ordre de la page lorsque toutes les pages sont visibles. |
Texte (S) |
ALPHA(250) |
Texte de l'onglet de la page. |
CodeRetour (S) |
NUM_BIN_2 |
Code retour de l'opération. Valeurs possibles: _FEN_ERR_OK _FEN_ERR_EXEC _FEN_ERR_PAGE _FEN_ERR_TYPE_FEN _FEN_ERR_CLS_FEN |
Conditions d'utilisation |
La fenêtre doit être une fenêtre à onglets. |
|
Récupère la visibilité d'une page dans une fenêtre à onglets.
| Syntaxe | ||
APPELER_METHODE NomFenetre RECUPERER_VISIBILITE_PAGE NumPage Visibilite CodeRetour |
||
Paramètres |
||
NumPage (E) |
NUM_BIN_2 |
Numéro de la page. Celui-ci correspond au numéro d'ordre de la page lorsque toutes les pages sont visibles. |
Visibilite (S) |
BOOL |
Visibilité de la page. |
CodeRetour (S) |
NUM_BIN_2 |
Code retour de l'opération. Valeurs possibles: _FEN_ERR_OK _FEN_ERR_EXEC _FEN_ERR_PAGE _FEN_ERR_TYPE_FEN _FEN_ERR_CLS_FEN |
Conditions d'utilisation |
La fenêtre doit être une fenêtre à onglets. |
|
Place dans le coin inférieur gauche de la zone client d'une fenêtre principale les fenêtres filles qui sont affichées en icône.
| Syntaxe | ||
APPELER_METHODE NomFenetre REORGANISER_ICONES CodeRetour |
||
Paramètres |
||
CodeRetour (S) |
NUM_BIN_2 |
Code retour de l'opération. Valeurs possibles: _FEN_ERR_OK _FEN_ERR_CLS_FEN |
Conditions d'utilisation |
La fenêtre doit être une fenêtre principale. |
|
Remarque : cette méthode n'est pas mise en oeuvre en génération Mobile et en génération Cloud.
Ferme toutes les fenêtres filles d'une fenêtre principale. Cela correspond à l'exécution de l'ordre TERMINER pour chaque fenêtre fille.
| Syntaxe | ||
APPELER_METHODE NomFenetre TOUT_FERMER CodeRetour |
||
Paramètres |
||
CodeRetour (S) |
NUM_BIN_2 |
Code retour de l'opération. Valeurs possibles: _FEN_ERR_OK _FEN_ERR_CLS_FEN _FEN_ERR_TERM_FILLE |
Conditions d'utilisation |
La fenêtre doit être une fenêtre principale. |
|
Remarque : cette méthode n'est pas mise en oeuvre en génération Mobile et en génération Cloud.