Fonctions globales

Chapter 9 Accès aux objets via VBScript

Fonctions globales

Les fonctions globales suivantes sont disponibles :

Fonctions globales	Utilisation
CreateModel (modelkind As Long, filename As String = "", flags As Long =omf_Default) As Objet	Crée un nouveau modèle
CreateModelFromTemplate (filename As String, flags As Long =omf_Default) As BaseObject	Crée un nouveau modèle à l'aide d'un template de modèle
OpenModel (filename As String, flags As Long =omf_Default) As Object	Ouvre un modèle existant (y compris les modèles V6)
Output (message As String = "")	Inscrit un message dans l'onglet Script de la fenêtre Résultats dans la fenêtre principale de PowerAMC
NewPoint (X As Long = 0, Y As Long = 0) As APoint	Crée un point pour positionner un symbole
NewRect (Left As Long = 0, Top As Long = 0, Right As Long = 0, Bottom As Long = 0) As ARect	Crée un rectangle pour manipuler la position des symboles
NewPtList () As PtList	Crée une liste de points pour positionner un lien
NewGUID() As String	Crée un nouvel identifiant unique (Global Unique IDentifier, GUID). Ce nouvel identifiant est renvoyé sous la forme d'une chaîne de caractères dépourvue des signes de ponctuation l'entourant habituellement "{" "}"
IsKindOf(childkind As Long, parentkind As Long) As Boolean	Renvoie True si childkind correspond à une métaclasse dérivée de la métaclasse de type parentkind, False dans le cas contraire
ExecuteCommand (cmd As String, Optional arglist As String, Optional mode As Long) As String	Ouvre une application externe
Rtf2Ascii (rtf As String) As String	Supprime les marqueurs RTF (Rich-Text-File) au sein d'un texte au format RTF
ConvertToUTF8 (InputFileName As String, OutputFileName As String)	Convertit le fichier <InputFileName> en UTF8 (8-bit Unicode Transformation Format qui est un format de conversion en unicode 8 bits dans lequel l'ordre des bits est initialisé par un marqueur d'ordre des bits - initial Byte Order Mark) et écrit le résultat de la conversion du fichier dans<OutputFileName>. Les deux noms de fichiers doivent être différents
ConvertToUTF16 (InputFileName As String, OutputFileName As String)	Convertit le fichier <InputFileName> en UTF16 (16-bit Unicode Transformation Format Little Endian qui est un format de conversion en unicode 16 bits dans lequel l'ordre des bits est initialisé par un marqueur d'ordre des bits - initial Byte Order Mark) et écrit le résultat de la conversion du fichier dans<OutputFileName>. Les deux noms de fichiers doivent être différent
EvaluateNamedPath (FileName As String, QueryIfUnknown As Boolean = True, FailOnError As Boolean = False) As String	Remplace une variable dans un chemin d'accès par son chemin nommé correspondant
MapToNamedPath (FileName As String) As String	Remplace le chemin d'accès d'un fichier par le chemin nommé correspondant
Progress(Key As String, InStatusBar Boolean = False) As BaseObject	Crée ou récupère un indicateur de progression donné

OpenModel(), CreateModel() et CreateModelFromTemplate

Les fonctions OpenModel, CreateModel et CreateModelFromTemplate utilisent les constantes globales suivantes :

Constante	Utilisation
Omf_Default	Comportement par défaut pour les fonctions OpenModel/CreateModel
Omf_DontOpenView	Empêche l'ouverture de la fenêtre de diagramme par défaut pour les fonctions OpenModel/CreateModel/ CreateModelFromTemplate
Omf_QueryType	Pour la fonction CreateModel UNIQUEMENT. Oblige à spécifier le type du diagramme initial
Omf_NewFileLock	Pour la fonction CreateModel UNIQUEMENT. Crée et verrouille le fichier correspondant
Omf_Hidden	Empêche le modèle de s'afficher dans l'espace de travail pour les fonctions OpenModel/CreateModel/ CreateModelFromTemplate

Modes d'exécution des commandes

Les modes d'exécution des commandes utilisent les constantes globales suivantes :

Constante	Utilisation
Cmd_ShellExec	Comportement par défaut. Laisse la session de MS-Windows exécuter la commande
Cmd_PipeOutput	Redirige le résultat de la commande dans l'onglet Général de la fenêtre Résultats de PowerAMC
Cmd_PipeResult	Récupère le résultat de la commande et le retourne sous forme de chaîne de caractères
Cmd_InternalScript	Indique que le premier paramètre de la fonction globale Execute Command est un fichier VBScript qui doit être exécuté comme une script interne plutôt que de laisser le système exécuter l'application associée au type de fichier

Exemple :

'Create a new model and print its name in output window
CreateModel(PDOom.cls_Model, "C:\Temp\Test.oom|Language=Java|Diagram=SequenceDiagram")
Output ActiveModel.name