TREEVIEW

Icône du lien vers le conceptVoir également Icône du lien vers le conceptExemple

Accès aux propriétés du contrôle Tree-view.

Support WebVue partiel. Voir le tableau avec la liste des modes ci-dessous. Les modes non supportés renvoient un code d'erreur si exécutés dans ce contexte.

Mode Mnémonique Syntaxe Support WebVue
1 COUNT 1 Oui
2 GETSELECTEDINDEX 1 Oui
3 SETSELECTEDINDEX 2 Oui
4 GETTEXT 7 Oui
5 GETUSERDATA 7 Oui
6 GETROOT 1 Oui
7 GETCHILDNODE 3 Oui
8 GETNEXTNODE 3 Oui
9 GETPREVNODE 3 Oui
10 GETPARENTNODE 3 Oui

11

EXPANDNODE 3 Oui
12 COLLAPSENODE 3 Oui
13 LOAD 4 Oui
14 SETUSERDATA 5 Oui
15 SETTEXT 5 Oui
16 CLEAR 6 Non
17 INSERTNODE 7 Non
18 REMOVENODE 3 Non
19 SETROOTICON 9 Non
20 SETCHILDICON 10 Non
21 SETNODEICON 11 Non
22 ADDCHILD 7 Oui
23 SAVE 4 Non

Arguments communs à plus d'un mode

Argument

Définition

Window Nom de la fenêtre contenant le contrôle de formulaire. Type STR.
Branch Branche (si elle existe) de la fenêtre. Utiliser "*" pour indiquer la branche courante du programme. Type STR.
Identity Identifiant du contrôle dans la fenêtre spécifiée. Type STR.
UseIndexedIcons Toujours utilisé conjointement avec les arguments CollapsedIcon et ExpandedIcon.Flag indiquant si les arguments CollapsedIcon et ExpandedIcon font référencent à un chemin d'un fichier icône (icônes non-indexées), ou à l'index d'une icône (icône indexée du sélecteur d'icônes). Type INTEGER.
1 = Utiliser des icônes non indexées.
2 = Utiliser des icônes indexées.
CollapsedIcon Si l'argument UseIndexedIcons vaut 1: Chemin de l'icône représentant le nœud lorsqu'il est réduit. Type STR.
Si l'argument UseIndexedIcons vaut 2: Index de l'icône (dans la partie icônes indexées du sélecteur) représentant le nœud lorsqu'il est réduit . Type INTEGER.
ExpandedIcon

Si l'argument UseIndexedIcons vaut 1: Chemin de l'icône représentant le nœud lorsqu'il est développé. Type STR.
Si l'argument UseIndexedIcons vaut 2: Index de l'icône (dans la partie icônes indexées du sélecteur) représentant le nœud lorsqu'il est développé. Type INTEGER.

NodeId

Index du nœud. Type LONG.

Syntaxe 1

LongVal = TREEVIEW(Mode, Window, Branch, Identity);

Type de retour : LONG

Exécution

Mode

Mnémonique

Action

1

COUNT

Retourne le nombre de nœuds.

2

GETSELECTEDINDEX

Retourne l'index du nœud actuellement sélectionné.
6 GETROOT Retourne l'index du nœud racine.
    Retour : 0 en cas d'erreur.

Syntaxe 2

LongVal = TREEVIEW(Mode, Window, Branch, Identity, NodeId[, Notify]);

Type de retour : LONG

Argument

Définition

Notify

Indique si la sélection déclenche l'exécution de la fonction SCADA Basic définie dans la configuration Opérations du contrôle. Type INTEGER.

Exécution

Mode

Mnémonique

Action

3

SETSELECTEDINDEX

Sélectionne un nœud suivant son index NodeId. Si le NodeId est -1, alors aucun noeud n'est sélectionné. Si nécessaire, la fonction fera défiler le contrôle pour afficher l'élément.

Retour : 1 si OK, 0 sinon.

Syntaxe 3

LongVal = TREEVIEW(Mode, Window, Branch, Identity, NodeId)

Type de retour : LONG

Exécution

Mode

Mnémonique

Action

7 GETCHILDNODE

Retourne l'index du premier nœud enfant d'un nœud.

Retour: 0 en cas d'erreur.

8 GETNEXTNODE

Retourne l'index du nœud suivant de même parent.

Retour: 0 en cas d'erreur.

9 GETPREVNODE

Retourne l'index du nœud précédent de même parent.

Retour: 0 en cas d'erreur.

10 GETPARENTNODE

Retourne l'index du nœud parent.

Retour : 0 en cas d'erreur.

11 EXPANDNODE

Déplie le nœud.

Retour : 1 si OK, 0 sinon.

12 COLLAPSENODE

Réduit le nœud.

Retour : 1 si OK, 0 sinon.

18 REMOVENODE

Supprime le nœud.

Retour : 1 si Ok, 0 sinon.

Syntaxe 4

LongVal = TREEVIEW(Mode, Window, Branch, Identity, FileName);

Type de retour : LONG

Argument

Définition

FileName

Nom du fichier contenant les données du contrôle.

Exécution

Mode

Mnémonique

Action

13

LOAD

Charge le contenu du fichier et remplace la liste des éléments du contrôle.

Retour: 1 si OK (fichier chargé et contrôle de formulaire rempli), sinon 0.

23 SAVE

Enregistre la liste des nœuds du contrôle de formulaire dans un fichier. La source du contrôle de formulaire doit être définie à Fichier ou l'instruction échouera.

Retour : 1 si OK (nœuds enregistrés dans le fichier), 0 sinon.

Syntaxe 5

LongVal = TREEVIEW(Mode, Window, Branch, Identity,NodeId, StrVal]);

Type de retour : LONG

Argument

Définition

StrVal La valeur de la chaîne à définir.

Exécution

Mode

Mnémonique

Action

14

SETUSERDATA

Définit les données utilisateur du nœud en utilisant la chaîne de texte fournie.

15 SETTEXT

Définit le texte du nœud en utilisant la chaîne de texte fournie.

    Retour : 1 si OK, 0 sinon.

Syntaxe 6

LongVal = TREEVIEW(Mode, Window, Branch, Identity);

Type de retour : LONG

Exécution

Mode

Mnémonique

Action

16 CLEAR

Vide le contenu du contrôle de formulaire tree-View.

Retour : 1 si OK, 0 sinon.

Syntaxe 7

>LongVal = TREEVIEW(Mode, Window, Branch, Identity, NodeId, Text, UserData);

Type de retour : LONG.

Argument

Définition

NodeId Index du nœud. Type LONG.
Text Chaîne de caractères. Type STR.
UserData Chaîne de caractères. Type STR.

Exécution

Mode

Mnémonique

Action

17

INSERTNODE

Insère un nouveau nœud à la suite du NodeId passé en paramètre.

Retour : 1 si OK, 0 sinon.

22 ADDCHILD

Insère un nouveau nœud enfant au nœud NodeId.

Retour : 1 si OK, 0 sinon.

Syntaxe 7

StrVal = TREEVIEW(Mode, Window, Branch, Identity, NodeId);

Type de retour : STR

Argument

Définition

Index

Index de l'élément à retourner.

Exécution

Mode

Mnémonique

Action

4 GETTEXT

Retourne le Texte du nœud comme défini dans la langue courante en utilisation.

Retour : Une chaîne vide en cas d'erreur.

5 GETUSERDATA

Retourne les données utilisateur associées au nœud.

Retour : Une chaîne vide en cas d'erreur.

Syntaxe 8

LongVal = TREEVIEW(Mode, Window, Branch, Identity, RootNumber, UseIndexedIcons, CollapsedIcon, ExpandedIcon);

Type de retour : LONG.

Argument

Définition

RootNumber

Valeur représentant le numéro de racine entre 1 et 50. Type INTEGER

Exécution

Mode

Mnémonique

Action

19 SETROOTICON

Définit les icônes pour le numéro de racine spécifié.

Retour : 1 si OK, 0 sinon.

Syntaxe 10

LongVal = TREEVIEW(>Mode, Window, Branch, Identity, RootNumber, ChildLevel, UseIndexedIcons, CollapsedIcon, ExpandedIcon);

Type de retour : LONG.

Argument

Définition

RootNumber

Valeur représentant le numéro de racine entre 1 et 50. Type INTEGER

ChildLevel Valeur représentant le niveau enfant entre 1 et 50. Type INTEGER

Exécution

Mode

Mnémonique

Action

20 SETCHILDICON

Définit les icônes pour le numéro racine et le niveau enfant spécifiés.

Retour : 1 si OK, 0 sinon.

Syntaxe 11

LongVal = TREEVIEW(Mode, Window, Branch, Identity, NodeId, UseIndexedIcons, CollapsedIcon, ExpandedIcon));

Type de retour : LONG.

Exécution

Mode

Mnémonique

Action

21 SETNODEICON

Définit l'icône pour le noeud NodeId.

Retour : 1 si OK, 0 sinon.

Exemple

Pour un exemple, sélectionnez le lien Exemple ci-dessus.