Altova MapForce 2025 Basic Edition

Navigation: Die MapForce API > Objektreferenz > Schnittstellen

Document

Ein Document-Objekt repräsentiert ein MapForce-Dokument (eine geladene MFD-Datei). Ein Dokument enthält ein Hauptmapping und null oder mehr lokale benutzerdefinierte Funktionsmappings.

Verwenden Sie für die Navigation im Objektmodell die folgenden Eigenschaften:

•Application

•Parent

Verwenden Sie zur Behandlung von Dateien:

•Activate

•Close

•FullName

•Name

•Path

•Saved

•Save

•SaveAs

Verwenden Sie zur Behandlung des Mappings:

•MainMapping

•Mappings

•CreateUserDefinedFunction

Verwenden Sie zur Behandlung von Komponenten:

•FindComponentByID

Verwenden Sie zur Codegenerierung:

•OutputSettings_ApplicationName

•JavaSettings_BasePackageName

•GenerateCHashCode

•GenerateCodeEx

•GenerateCppCode

•GenerateJavaCode

•GenerateXQuery

•GenerateXSLT

•GenerateXSLT2

•GenerateXSLT3

•HighlightSerializedMarker

Verwenden Sie zur Ausführung von Mappings:

•GenerateOutput

•GenerateOutputEx

Aufruf der Ansicht:

•MapForceView

Veraltet:

•OutputSettings_Encoding

Eigenschaften

Name	Beschreibung
Application	Schreibgeschützt. Ruft das Objekt auf oberster Ebene einer Applikation ab.
FullName	Pfad und Name der Dokumentdatei.
JavaSettings_BasePackageName	Setzt den beim Generieren von Java-Code verwendeten Base Package-Namen oder ruft ihn ab. Auf der grafischen MapForce-Benutzeroberfläche steht diese Eigenschaft im Dialogfeld Mapping-Einstellungen (Aufruf durch Rechtsklick in das Mapping und Auswahl des Kontextmenüeintrags Mapping-Einstellungen zur Verfügung).
LibraryImports	Schreibgeschützt. Ruft eine Sammlung importierter Bibliotheken ab. Diese entsprechen auf der grafischen MapForce-Benutzeroberfläche den auf Dokumentebene hinzugefügten Einträgen im Fenster Bibliotheken verwalten.
MainMapping	Schreibgeschützt. Ruft das Hauptmapping des Dokuments auf.
MapForceView	Schreibgeschützt. Mit dieser Eigenschaft erhalten Sie Zugriff auf die Funktionalitäten der MapForce-Ansicht.
Mappings	Schreibgeschützt. Gibt eine Sammlung der im Dokument enthaltenen Mappings zurück.
Name	Schreibgeschützt. Name der Dokumentdatei ohne Dateipfad.
OutputSettings_ApplicationName	Setzt den im Dialogfeld Mapping-Einstellungen verfügbaren Applikationsnamen bzw. ruft diesen ab. (Um dieses Dialogfeld in MapForce aufzurufen, klicken Sie mit der rechten Maustaste in das Mapping und wählen Sie im Kontextmenü den Befehl Mapping-Einstellungen).
OutputSettings_Encoding	Diese Eigenschaft wird nicht mehr unterstützt. Es gibt keine Kodierungseinstellungen mehr für die Mapping-Ausgabe. Die Kodierungseinstellungen werden jeweils für die einzelnen Komponenten festgelegt.
Parent	Schreibgeschützt. Das Parent-Objekt laut Objektmodell.
Path	Schreibgeschützt. Pfad der Dokumentdatei ohne Namen.
Saved	Schreibgeschützt. True,wenn das Dokument seit dem letzten Speichern nicht geändert wurde, andernfalls false.

Methoden

Name	Beschreibung
Activate	Macht dieses Dokument zum aktiven Dokument.
Close	Schließt das Dokument, ohne es zu speichern.
CreateUserDefinedFunction	Erstellt eine benutzerdefinierte Funktion im aktuellen Dokument.
FindComponentByID	Durchsucht das gesamte Dokument und alle seine Mappings nach der Komponente mit der angegebenen ID.
GenerateCHashCode	Generiert C#-Code, der das Mapping ausführt. Verwendet zur Konfigurierung der Codegenerierung die in Application.Options definierten Eigenschaften.
GenerateCodeEx	Generiert Code, der das Mapping ausführt. Der Parameter i_nLanguage definiert die Zielsprache. Die Methode gibt ein Objekt zurück, das verwendet werden kann, um alle vom Codegenerator erstellten Meldungen aufzuzählen. Dabei handelt es sich um dieselben Meldungen, die im Meldungsfenster von MapForce angezeigt werden.
GenerateCppCode	Generiert C++-Code, der das Mapping ausführt. Verwendet zur Konfigurierung der Codegenerierung die in Application.Options definierten Eigenschaften.
GenerateJavaCode	Generiert Java-Code, der das Mapping ausführt. Verwendet zur Konfigurierung der Codegenerierung die in Application.Options definierten Eigenschaften.
GenerateOutput	Generiert alle im Mapping definierten Ausgabedateien mittels einer MapForce-internen Mapping-Sprache. Die Namen der Ausgabedateien werden als Eigenschaften der Ausgabeelemente im Mapping definiert. Anmerkung: Diese Methode kann nur verwendet werden, wenn das (als COM-Server ausgeführte) MapForce-Hauptfenster zu sehen ist oder in eine grafische Benutzeroberfläche eingebettet ist. Wenn die Methode aufgerufen wird, während MapForce nicht angezeigt wird, wird ein Fehler ausgegeben.
GenerateOutputEx	Generiert alle im Mapping definierten Ausgabedateien mittels einer MapForce-internen Mapping-Sprache. Die Namen der Ausgabedateien werden als Eigenschaften der Ausgabeelemente im Mapping definiert. Diese Methode ist mit Ausnahme des Rückgabewerts, der die erzeugten Meldungen, Warnmeldungen und Fehler in Form einer Baumstruktur von AppOutputLines enthält, identisch mit GenerateOutput. Anmerkung: Diese Methode kann nur verwendet werden, wenn das (als COM-Server ausgeführte) MapForce-Hauptfenster zu sehen ist oder in eine grafische Benutzeroberfläche eingebettet ist. Wenn die Methode aufgerufen wird, während MapForce nicht angezeigt wird, wird ein Fehler ausgegeben.
GenerateXQuery	Generiert Mappingcode als XQuery. Verwendet zur Konfigurierung der Codegenerierung die in Application.Options definierten Eigenschaften.
GenerateXSLT	Generiert Mappingcode als XSLT. Verwendet zur Konfigurierung der Codegenerierung die in Application.Options definierten Eigenschaften.
GenerateXSLT2	Generiert Mappingcode als XSLT2. Verwendet zur Konfigurierung der Codegenerierung die in Application.Options definierten Eigenschaften.
GenerateXSLT3	Generiert XSLT 3.0 Mapping-Code. Verwendet zur Konfigurierung der Codegenerierung die in Application.Options definierten Eigenschaften.
HighlightSerializedMarker	Verwenden Sie diese Methode, um einen Pfad in einer Mapping-Datei zu markieren, die zuvor serialisiert wurde. Wenn das entsprechende Dokument noch nicht geladen ist, wird es zuerst geladen. Eine Methode zum Aufrufen eines serialisierten Markers finden Sie unter GenerateCodeEx.
Save	Speichert das Dokument in der durch Document.FullName definierten Datei.
SaveAs	Speichert das Dokument unter dem angegebenen Dateinamen und setzt Document.FullName auf diesen Wert, wenn die Operation erfolgreich war.

Events

Name	Beschreibung
OnDocumentClosed	Dieses Event wird ausgelöst, wenn ein Dokument geschlossen wird. Das an den Event Handler übergebene Dokumentobjekt sollte nicht aufgerufen werden. Das entsprechenden Event zum Öffnen ist Application.OnDocumentOpened.
OnModifiedFlagChanged	Dieses Event wird ausgelöst, wenn sich der Änderungsstatus eines Dokuments ändert.