Altova MapForce 2024 Basic Edition

Die Application-Schnittstelle ist die Schnittstelle zu einem MapForce application-Objekt. Sie bildet den Hauptzugriffspunkt für die MapForce-Applikation selbst. Diese Schnittstelle ist der Ausgangspunkt für alle weiteren Operationen mit MapForce oder für das Abrufen oder Erstellen anderer Automation-Objekte im Zusammenhang mit MapForce. Informationen zur Erstellung einer Instanz des Application-Objekts finden Sie unter Aufruf der API.

 

Eigenschaften zum Navigieren im Objektmodell:

 

Application

Parent

Options

Project

Documents

 

Applikationsstatus:

 

Visible

Name

Quit

Status

WindowHandle

 

MapForce-Designs:

 

NewDocument

OpenDocument

OpenURL

ActiveDocument

 

MapForce-Projekte:

 

NewProject

OpenProject

ActiveProject

 

MapForce-Codegenerierung:

 

HighlightSerializedMarker

 

Globale Ressourcen:

 

GlobalResourceConfig

GlobalResourceFile

 

Versionsinformationen:

 

Edition

IsAPISupported

MajorVersion

MinorVersion

 

Eigenschaften

Name

Beschreibung

ActiveDocument

Schreibgeschützt.

Gibt das Automation-Objekt des gerade aktiven Dokuments zurück. Diese Eigenschaft gibt denselben Wert zurück wie Documents.ActiveDocument.

ActiveProject

Schreibgeschützt.

Gibt das Automation Objekt des gerade aktiven Projekts zurück.

Application

Schreibgeschützt.

Ruft das Objekt auf oberster Ebene einer Applikation ab.

Documents

Schreibgeschützt.

Gibt eine Sammlung aller gerade offenen Dokumente zurück.

Edition

Schreibgeschützt.

Gibt die Version (Edition) der Applikation, z.B. "Altova MapForce Enterprise Edition" für die Enterprise Edition, zurück.

GlobalResourceConfig

Ruft den Namen der aktiven Konfigurationsdatei für die globalen Ressourcen ab oder setzt ihn. Standardmäßig trägt die Datei den Namen GlobalResources.xml.

 

Die Konfigurationsdatei kann umbenannt und unter einem beliebigen Pfad gespeichert werden. Sie können daher mehrere XML-Dateien für globale Ressourcen haben. Allerdings kann immer nur eine dieser Dateien pro Applikation aktiv sein und nur die in dieser Datei enthaltenen Definitionen stehen der Applikation zur Verfügung.

GlobalResourceFile

Ruft die Definitionsdatei für globale Ressourcen ab oder definiert sie. Standardmäßig trägt die Datei den Namen GlobalResources.xml.

IsAPISupported

Schreibgeschützt.

Gibt "true" zurück, wenn die API in dieser Version von MapForce unterstützt wird.

LibraryImports

Schreibgeschützt.

Ruft eine Sammlung importierter Bibliotheken ab. Diese entsprechen auf der grafischen MapForce-Benutzeroberfläche den auf Applikationsebene hinzugefügten Einträgen im Fenster Bibliotheken verwalten.

MajorVersion

Schreibgeschützt.

Ruft die Hauptversionsnummer von MapForce ab. Die Version wird ab 1998 berechnet und wird jedes Jahr um 1 erhöht. So ist die Hauptversion für die Release 2016 z.B. "18".

MinorVersion

Schreibgeschützt.

Die Zusatznummer zur Hauptversion des Produkts z.B. 2 für 2006 R2 SP1.

Name

Schreibgeschützt.

Der Name der Applikation.

Options

Schreibgeschützt.

Mit dieser Eigenschaft haben Sie Zugriff auf Optionen zum Konfigurieren der Codegenerierung.

Parent

Schreibgeschützt.

Das Parent-Objekt laut Objektmodell.

ServicePackVersion

Schreibgeschützt.

Die Service Pack-Versionsnummer des Produkts, z.B. 1 für 2016 R2 SP1.

Status

Schreibgeschützt.

Der Status der Applikation. Es ist einer der Werte der ENUMApplicationStatus Enumeration.

Visible

True, wenn MapForce auf dem Bildschirm angezeigt wird (unter Umständen wird es von anderen Applikationen verdeckt oder als Symbol angezeigt).

 

False, wenn MapForce ausgeblendet ist. Der Standardwert für MapForce, wenn es automatisch aufgrund eines Request der Automation Server Application gestartet wird, ist false. In allen anderen Fällen wird die Eigenschaft als true initialisiert.

 

Eine Applikationsinstanz, die sichtbar ist, gilt als vom Benutzer (und möglicherweise von Clients, die über die Automation-Schnittstelle verbunden sind) gesteuert. Sie wird nur auf einen expliziten Benutzer-Request hin beendet. Um eine Applikationsinstanz zu beenden, setzen Sie ihre Sichtbarkeit auf false und entfernen Sie alle Referenzen auf diese Instanz aus Ihrem Programm. Die Applikationsinstanz wird automatisch beendet, wenn keine weiteren COM-Clients Referenzen darauf enthalten.

WindowHandle

Schreibgeschützt.

Ruft den Fenster-Handle der Applikation ab.

 

Methoden

Name

Beschreibung

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 Document.GenerateCodeEx.

NewDocument

Erstellt ein neues leeres Dokument. Das neu geöffnete Dokument wird das ActiveDocument. Diese Methode ist die Kurzform von Documents.NewDocument.

NewProject

Erstellt ein neues leeres Projekt. Das aktuelle Projekt wird geschlossen. Das neue Projekt kann unter ActiveProject aufgerufen werden.

NewWebServiceProject

Erstellt ein neues leeres Webservice-Projekt. Das neue Projekt kann unter ActiveProject aufgerufen werden. Diese Methode steht nur in der MapForce Enterprise Edition zur Verfügung.

OpenDocument

Lädt eine zuvor gespeicherte Dokumentdatei und setzt die Bearbeitung fort. Das neu geöffnete Dokument wird das ActiveDocument. Diese Methode ist eine Kurzform von Documents.OpenDocument.

OpenProject

Öffnet ein vorhandenes MapForce Projekt (*.mfp). Das aktuelle Projekt wird geschlossen. Das neu geöffnete Projekt kann unter ActiveProject aufgerufen werden.

OpenURL

Lädt eine zuvor gespeicherte Dokumentdatei von einem URL-Pfad. Ermöglicht die Eingabe von Benutzername und Passwort.

Quit

Trennt die Verbindung zu MapForce, um die Applikation beenden zu können. Der Aufruf dieser Methode ist optional, da MapForce alle externen COM-Verbindungen aufzeichnet und getrennte Verbindungen automatisch erkennt. Nähere Informationen zum automatischen Beenden finden Sie unter der Eigenschaft Visible.

 

Events

Name

Beschreibung

OnDocumentOpened

Das Event wird ausgelöst, wenn ein vorhandenes oder neues Dokument geöffnet wird. Das entsprechende Event zum Schließen ist Document.OnDocumentClosed.

OnProjectOpened

Das Event wird ausgelöst, wenn ein vorhandenes oder neues Projekt in die Applikation geladen wird. Das entsprechende Event zum Schließen ist Project.OnProjectClosed.

OnShutdown

Dieses Event wird ausgelöst, wenn die Applikation beendet wird.

© 2017-2023 Altova GmbH