Altova MapForce 2025 Enterprise Edition

Un objet de Document représente un document MapForce (un fichier MFD chargé). Un document contient un mappage principal et zéro ou plus de mappages définis par l’utilisateur local.

 

Pour accéder au modèle d’objet, utilisez les propriétés suivantes :

 

Application

Parent

 

Pour la gestion du fichier, utilisez :

 

Activer

Fermer

FullName

Nom

Chemin d'accès

Enregistré

Enregistrer

SaveAs

 

Pour la gestion du mappage, utilisez :

 

MainMapping

Mappages

CreateUserDefinedFunction

 

Pour la gestion du composant, utilisez :

 

FindComponentByID

 

Pour la génération de code, utilisez :

 

OutputSettings_ApplicationName

JavaSettings_BasePackageName

GenerateCHashCode

GenerateCodeEx

GenerateCppCode

GenerateJavaCode

GenerateXQuery

GenerateXSLT

GenerateXSLT2

GenerateXSLT3

HighlightSerializedMarker

 

Pour l’exécution de mappage, utilisez :

 

GenerateOutput

GenerateOutputEx

 

Accès d’affichage :

 

MapForceView

 

Obsolète :

 

OutputSettings_Encoding

 

Propriétés

Nom

Description

Application

Lecture seule.

Extrait l’objet de l’application de premier niveau.

FullName

Chemin et nom du fichier du document.

JavaSettings_BasePackageName

Définit ou extrait le nom du pack de base utilisé lors de la génération du code Java. Dans l’interface utilisateur graphique de MapForce, ce paramètre est disponible dans la boîte de dialogue des Paramètres de nmappage (clic droit sur le mappage et sélectionnez les Mapping Settings depuis le menu contextuel).

LibraryImports

Lecture seule.

Obtient une collection de bibliothèques importées. Dans l’interface utilisateur graphique de MapForce, celles-ci correspondent aux entrées de la fenêtre Gérer les bibliothèques, ajoutées au niveau du document.

MainMapping

Lecture seule.

Extrait le mappage principal du document.

MapForceView

Lecture seule.

Cette propriété donne accès à la fonctionnalité spécifique à l’affichage de MapForce.

Mappages

Lecture seule.

Retourne une collection de mappages contenue dans le document.

Nom

Lecture seule.

Nom du fichier document sans chemin de fichier.

OutputSettings_ApplicationName

Définit ou extrait le nom de l’application disponible dans la boîte de dialogue Paramètres de mappage (pour afficher cette boîte de dialogue dans MapForce, clic droit sur le mappage et sélectionnez Paramètres de mappage depuis le menu contextuel).

OutputSettings_Encoding

Cette propriété n’est plus prise en charge. Les paramètres d’encodage de sortie n’existent plus. Les composants ont des paramètres d’encodage de sortie individuels.

Parent

Lecture seule.

L’objet parent selon le modèle d’objet.

Chemin d'accès

Lecture seule.

Le chemin du fichier de document sans nom.

Enregistré

Lecture seule.

True si le document n’a pas été modifié depuis la dernière opération de sauvegarde, false, si le contraire.

 

Méthodes

Nom

Description

Activate

Rend ce document actif.

Fermer

Ferme le document sans l’enregistrer.

CreateUserDefinedFunction

Crée une fonction définie par l'utilisateur dans le document actuel.

FindComponentByID

Cherche dans le document entier, aussi dans tous ses mappages, pour le composant avec l’ID spécifiée.

GenerateCHashCode

Génère le code C# qui exécutera le mappage. Utilise les propriétés définies dans Application.Options pour configurer la génération de code.

GenerateCodeEx

Génère le code qui exécutera le mappage. Le paramètre i_nLanguage spécifie le langage cible. La méthode renvoie un objet qui peut être utilisé pour énumérer tous les messages créés par le générateur de code. Il s'agit des mêmes messages qui sont affichés dans la fenêtre de messages de MapForce.

GenerateCppCode

Génère le code C++ qui exécutera le mappage. Utilise les propriétés définies dans Application.Options pour configurer la génération de code.

GenerateJavaCode

Génère le code Java qui exécutera le mappage. Utilise les propriétés définies dans Application.Options pour configurer la génération de code.

GenerateOutput

Génère tous les fichiers de sortie définis dans le mappage utilisant un langage de mappage interne de MapForce. Les noms des fichiers de sortie sont définis comme propriétés des éléments de sortie dans le mappage.

 

Note : Cette méthode peut uniquement être utilisée quand la fenêtre principale de MapForce (exécutée comme serveur COM) est visible, ou si elle est incorporée avec une interface utilisateur graphique. Si la méthode est appelée tandis que MapForce n’est pas visible, alors l’erreur apparaîtra.

GenerateOutputEx

Génère tous les fichiers de sortie définis dans le mappage utilisant un langage de mappage interne de MapForce. Les noms des fichiers de sortie sont définis comme propriétés des éléments de sortie dans le mappage. Cette méthode est identique à GenerateOutput, à l’exception de sa valeur de renvoi contenant les messages résultants, avertissements et erreurs organisés en tant qu’arborescences de AppOutputLines.

 

Note : Cette méthode peut uniquement être utilisée quand la fenêtre principale de MapForce (exécutée comme serveur COM) est visible, ou si elle est incorporée avec une interface utilisateur graphique. Si la méthode est appelée tandis que MapForce n’est pas visible, alors l’erreur apparaîtra.

GenerateXQuery

Génère du code de mappage comme XQuery. Utilise les propriétés définies dans Application.Options pour configurer la génération de code.

GenerateXSLT

Génère du code de mappage en tant que XSLT. Utilise les propriétés définies dans Application.Options pour configurer la génération de code.

GenerateXSLT2

Génère le code de mappage comme XSLT2. Utilise les propriétés définies dans Application.Options pour configurer la génération de code.

GenerateXSLT3

Génère un code de mappage XSLT 3.0. Utilise les propriétés définies dans Application.Options pour configurer la génération de code.

HighlightSerializedMarker

Utilisez cette méthode pour marquer un emplacement dans un fichier de mappage qui a été précédemment sérialisé. Si le document correspondant n’est pas déjà chargé, il sera chargé d’abord. Voir GenerateCodeEx pour une méthode d’extraction d’un marqueur sérialisé.

Enregistrer

Enregistre le document vers le fichier défini par Document.FullName.

SaveAs

Enregistre le document vers le nom de fichier spécifique, et définit Document.FullName vers cette valeur si l’opération Enregistrer a réussi.

 

Événements

Nom

Description

OnDocumentClosed

Cet événement est déclenché lorsqu’un document est fermé. L’objet de document passé au gestionnaire d’événements ne devrait pas être accédé. L’événement ouvert correspondant est Application.OnDocumentOpened.

OnModifiedFlagChanged

Cet événement est déclenché lorsque le statut de modification d’un document change.

© 2018-2024 Altova GmbH