Please enable JavaScript to view this site.

Altova MapForce 2020 Professional Edition

A Component represents a MapForce component.

 

To navigate the control, use the Application and Parent properties.

 

Component properties:

 

HasIncomingConnections

HasOutgoingConnections

CanChangeInputInstanceFile

CanChangeOutputInstanceFile

ComponentName.

ID

IsParameterInputRequired

IsParameterSequence

Name

Preview

Schema

SubType

Type

 

Instance related properties:

 

InputInstanceFile

OutputInstanceFile

 

Datapoints:

 

GetRootDatapoint

 

Execution:

 

GenerateOutput

 

Properties

Name

Description

Application

Read-only.

Retrieves the application's top-level object.

CanChangeInputInstanceFile

Read-only.

Indicates if the input instance file name can be changed.

 

Returns false if the component has a filename node and this node has a connection on its left (input) side, otherwise returns true. If the component does not have a filename node, false is returned.

CanChangeOutputInstanceFile

Read-only.

Indicates if the output instance file name can be changed.

 

Returns false if the component has a filename node and this node has a connection on its left (input) side, otherwise returns true.

If the component does not have a filename node, false is returned.

ComponentName

Gets or sets the component's name.

HasIncomingConnections

Read-only.

Indicates if the component has any incoming connections (on its left side) not including the filename node. An incoming connection on the filename node does not have any effect on the returned value.

HasOutgoingConnections

Read-only.

Indicates if the component has any outgoing connections (on its right side).

ID

Read-only.

Retrieves the component ID.

InputInstanceFile

Gets or sets the component's input instance file.

IsParameterInputRequired

Gets or sets, if the input parameter component requires an ingoing connection on the function call component of the user-defined function this input parameter component is in. This property works only for components, which are input parameter components.

IsParameterSequence

Gets or sets, if the input or output parameter component supports sequences. This property works only for components, which are input or output parameter components.

Name

Read-only.

Gets the component's name.

OutputInstanceFile

Gets or sets the component's output instance file.

 

Trying to access the OutputInstanceFile of a component via the API does not return any data if the "File" connector of the component has been connected to another item in the mapping.

Parent

Read-only.

The parent object according to the object model.

Preview

Gets or sets if the component is the current preview component.

 

This property works only for components, which are target components in the document's main mapping. Only one target component in the main mapping can be the preview component at any time.

 

When setting this property, it is only possible to set it to true. This then will also implicitly set the Preview property of all other components to false.

 

If there is just a single target component in the main mapping, it is also the preview component.

Schema

Read-only.

Retrieves the component's schema file name.

SubType

Read-only.

Retrieves the component's subtype.

Type

Read-only.

Retrieves the component's type.

UsageKind

Read-only.

Retrieves the component's usage kind.

 

Methods

Name

Description

GenerateOutput

Generates the output file(s) defined in the mapping for the current component only, using a MapForce internal mapping language. The name(s) of the output file(s) are defined as property of the current component which is the output item in the mapping for this generation process.

GetRootDatapoint

Gets a root datapoint on the left (input) or right (output) side of a component. To access children and descendants, the Datapoint object provides further methods.

© 2019 Altova GmbH