Altova MapForce 2024 Enterprise Edition

Navigation: L'API de MapForce > Référence d’objet > Interfaces

Composant

Accueil Préc Haut Suivant

Un composant représente un composant de MapForce.

Pour accéder au contrôle, utilisez les propriétés Application et Parent .

Propriétés de composant :

•HasIncomingConnections

•HasOutgoingConnections

•CanChangeInputInstanceFile

•CanChangeOutputInstanceFile

•ComponentName.

•ID

•IsParameterInputRequired

•IsParameterSequence

•Nom

•Aperçu

•Schéma

•Sous-type

•Type

Propriétés relatives à l’instance :

•InputInstanceFile

•OutputInstanceFile

Datapoints :

•GetRootDatapoint

Exécution :

•GenerateOutput

Propriétés

Nom	Description
Application	Lecture seule. Extrait l’objet de l’application de premier niveau.
CanChangeInputInstanceFile	Lecture seule. Indique si le nom de fichier de l’instance de sortie peut être modifié. Renvoie false si le composant contient un nœud filename et ce nœud a une connexion de son côté gauche (entrée), autrement il renvoie true. Si le composant ne contient pas de nœud filename, false est renvoyé.
CanChangeOutputInstanceFile	Lecture seule. Indique si le nom de fichier de l’instance de sortie peut être modifié. Renvoie false si le composant contient un nœud filename et ce nœud a une connexion de son côté gauche (entrée), autrement il renvoie true. Si le composant ne contient pas de nœud filename, false est renvoyé.
ComponentName	Obtient ou définit le nom de composant.
HasIncomingConnections	Lecture seule. Indique si le composant contient des connexions entrantes (de son côté gauche) ne comprenant pas le nœud filename. Une connexion entrante sur le nœud de connexion n’a pas d’effet sur la valeur renvoyée.
HasOutgoingConnections	Lecture seule. Indique si le composant contient des connexions sortantes (de son côté droit).
ID	Lecture seule. Extrait l’ID de composant.
InputInstanceFile	Obtient ou définit le fichier de l’instance d’entrée du composant.
IsParameterInputRequired	Obtient ou définit si le composant de paramètre d’entrée requiert une connexion ingoing sur le composant d’appel de la fonction définie par l'utilisateur dans lequel se trouve le composant de paramètre d’entrée. Cette propriété ne fonctionne que pour les composants qui sont des composants de paramètres d’entrée.
IsParameterSequence	Obtient ou définit si le composant de paramètre d’entrée ou de sortie prend en charge les séquences. Cette propriété fonctionne uniquement pour les composants qui sont des composants de paramètre d’entrée ou de sortie.
Nom	Lecture seule. Obtient le nom de composant.
OutputInstanceFile	Obtient ou définit le fichier d’instance de sortie du composant. Tenter d’accéder à OutputInstanceFile d’un composant via l’API ne renvoie aucune donnée si le « fichier » connecteur du composant a été connecté à un autre item dans le mappage.
Parent	Lecture seule. L’objet parent selon le modèle d’objet.
Aperçu	Obtient ou définit si le composant est le composant preview actuel. Cette propriété ne fonctionne que pour les composants qui sont des composants cibles dans le mappage principal du document. Uniquement un composant cible dans le mappage principal peut être le composant preview à tout moment. Lorsque vous définissez cette propriété, il est uniquement possible de la définir en tant que true. Ceci définira aussi implicitement la propriété Preview de tous les autres composants comme false. Il n’existe qu’un seul composant cible unique dans le mappage principal, il s’agit également du composant preview.
Schéma	Lecture seule. Extrait le nom de fichier du schéma du composant.
Sous-type	Lecture seule. Extrait le sous-type du composant.
Type	Lecture seule. Extrait le type de composant.
UsageKind	Lecture seule. Extrait le type d’utilisation du composant.

Méthodes

Nom	Description
GenerateOutput	Génère le(s) fichier(s) de sortie défini(s) dans le mappage pour le composant actuel uniquement, en utilisant un langage de mappage interne de MapForce. Le(s) nom(s) du/des fichier(s) de sortie est/sont défini(s) comme propriété du composant actuel qui est l’item de sortie dans le mappage pour le processus de génération.
GetRootDatapoint	Obtient un datapoint racine du côté gauche (entrée) ou droit (sortie) du composant. Pour accéder aux enfants et descendants, l’objet Datapoint fournit des méthodes supplémentaires.