Component

www.altova.com Dieses Kapitel drucken Vorherige Seite Eine Ebene nach oben Nächste Seite

Startseite >  Die MapForce API > Objektreferenz > Schnittstellen >

Component

Eine Komponente stellt eine MapForce-Komponente dar.

 

Mit Hilfe der Eigenschaften Application und Parent können Sie durch das Control navigieren.

 

Komponenteneigenschaften:

 

HasIncomingConnections
HasOutgoingConnections
CanChangeInputInstanceFile
CanChangeOutputInstanceFile
ComponentName.
ID
IsParameterInputRequired
IsParameterSequence
Name
Preview
Schema
SubType
Type

 

Eigenschaften im Zusammenhang mit Instanzen:

 

InputInstanceFile
OutputInstanceFile

 

Datapoints:

 

GetRootDatapoint

 

Ausführung:

 

GenerateOutput

 

Eigenschaften

Name

Beschreibung

Application

Schreibgeschützt.

Ruft das Objekt auf oberster Ebene einer Applikation ab.

CanChangeInputInstanceFile

Schreibgeschützt.

Gibt an, ob der Name der Input-Instanzdatei geändert werden kann.

 

Gibt "false" zurück, wenn die Komponente einen Dateinamen-Node hat und dieser Node eine Verbindung auf seiner linken (Input-) Seite hat. Andernfalls wird "true" zurückgegeben. Wenn die Komponente keinen Dateinamen-Node hat, wird "false" zurückgegeben.

CanChangeOutputInstanceFile

Schreibgeschützt.

Gibt an, ob der Name der Output-Instanzdatei geändert werden kann.

 

Gibt "false" zurück, wenn die Komponente einen Dateinamen-Node hat und dieser Node eine Verbindung auf seiner linken (Input-) Seite hat. Andernfalls wird "true" zurückgegeben.

Wenn die Komponente keinen Dateinamen-Node hat, wird "false" zurückgegeben.

ComponentName

Ruft den Namen der Komponente ab oder definiert ihn.

HasIncomingConnections

Schreibgeschützt.

Gibt an, ob die Komponente (auf der linken Seite) mit Ausnahme des Dateinamen-Node eingehende Verbindungen hat. Eine eingehende Verbindung am Dateinamen-Node hat keine Auswirkung auf den zurückgegebenen Wert.

HasOutgoingConnections

Schreibgeschützt.

Gibt an, ob die Komponente (auf der rechten Seite) ausgehende Verbindungen hat.

ID

Schreibgeschützt.

Ruft die ID der Komponente ab.

InputInstanceFile

Ruft die Input-Instanzdatei der Komponente ab oder definiert sie.

IsParameterInputRequired

Ruft ab oder definiert, ob für die Input-Parameterkomponente in der Funktionsaufruf-Komponente der benutzerdefinierten Funktion, in der sich diese Input-Parameterkomponente befindet, eine eingehende Verbindung erforderlich ist. Diese Eigenschaft funktioniert nur bei Komponenten, die Input-Parameterkomponenten sind.

IsParameterSequence

Ruft ab oder definiert, ob die Input- oder Output-Parameterkomponente Sequenzen unterstützt. Diese Eigenschaft funktioniert nur bei Komponenten, die Input- oder Output-Parameterkomponenten sind.

Name

Schreibgeschützt.

Ruft den Namen der Komponente ab.

OutputInstanceFile

Ruft die Output-Instanzdatei der Komponente ab oder definiert sie.

 

Wenn der "Datei"-Konnektor einer Komponente mit einem anderen Datenelement im Mapping verbunden wurde, erhalten Sie beim Versuch die Ausgabeinstanzdatei einer Komponente mittels OutputInstanceFile über die API aufzurufen, keine Daten.

Parent

Schreibgeschützt.

Das Parent-Objekt laut Objektmodell.

Preview

Ruft ab oder definiert, ob die Komponente die aktuelle Vorschaukomponente ist.

 

Diese Eigenschaft funktioniert nur bei Komponenten, bei denen es sich um Zielkomponenten im Hauptmapping des Dokuments handelt. Es kann im Hauptmapping immer nur eine Zielkomponente gleichzeitig als Vorschaukomponente verwendet werden.

 

Wenn Sie diese Eigenschaft definieren, kann sie nur auf "true" gesetzt werden. Damit wird dann die Eigenschaft Preview bei allen anderen Komponenten implizit auf "false" gesetzt.

 

Wenn es im Hauptmapping nur eine einzige Zielkomponente gibt, so ist diese auch die Vorschaukomponente.

Schema

Schreibgeschützt.

Ruft den Schemadateinamen der Komponente ab.

SubType

Schreibgeschützt.

Ruft den Subtyp der Komponente ab.

Type

Schreibgeschützt.

Ruft den Typ der Komponente ab.

UsageKind

Schreibgeschützt.

Ruft die Verwendungsart der Komponente ab.

 

Methoden

Name

Beschreibung

GenerateOutput

Generiert mit Hilfe einer MapForce-internen Mapping-Sprache die Ausgabedatei(en), die im Mapping nur für die aktuelle Komponente definiert sind. Der Name/Die Namen der Ausgabedatei(en) sind als Eigenschaft der aktuellen Komponente definiert, welche im Mapping für diese Generierung das Ausgabeelement ist.

GetRootDatapoint

Ruft einen Root-Datapoint auf der linken (Input) oder rechten (Output)-Seite einer Komponente ab. Um Subelemente und untergeordnete Elemente davon aufzurufen, stellt das Datapoint-Objekt weitere Methoden bereit.


© 2019 Altova GmbH