2022 April Release

Struct FSCCOLD@1.1001:FieldConversion Permanent link for this heading

Additional Information

Properties Permanent link for this heading

Type

Property

Name

integer(7)

repconvfieldheight

Height

string(100)

repconvfieldmark

Characteristic

boolean

repconvfieldmustbedefined

Must Be Defined

string(100)

repconvfieldname

Field Name

integer(5)

repconvfieldoffsetx

Offset Column

integer(5)

repconvfieldoffsety

Offset Line

boolean

repconvfieldsavecontent

Save as Content

string(100)

repconvfieldvalue

Value

integer(5)

repconvfieldwidth

Width

Properties Permanent link for this heading


Height (FSCCOLD@1.1001:repconvfieldheight) Permanent link for this heading

The property repconvfieldheight ("Height") defines the number of lines the field covers.
Set repconvfieldheight to -1 to get all remaining lines until the end of the page. The default value is 1.

integer(7) FSCCOLD@1.1001:repconvfieldheight

Additional Information


Characteristic (FSCCOLD@1.1001:repconvfieldmark) Permanent link for this heading

The property repconvfieldmark ("Characteristic") defines the identification for the field. The further values for the definition of the fields position are relative to this identification. A field identification is optional.

string(100) FSCCOLD@1.1001:repconvfieldmark

Additional Information


Must Be Defined (FSCCOLD@1.1001:repconvfieldmustbedefined) Permanent link for this heading

The property repconvfieldmustbedefined ("Must be Defined?") defines whether the field must have a value or not. True means that the field must have a value.

boolean FSCCOLD@1.1001:repconvfieldmustbedefined

Additional Information


Field Name (FSCCOLD@1.1001:repconvfieldname) Permanent link for this heading

The property repconvfieldname ("Field Name") defines the name of the field that is used as the column name in the data import object.

string(100) FSCCOLD@1.1001:repconvfieldname

Additional Information


Offset Column (FSCCOLD@1.1001:repconvfieldoffsetx) Permanent link for this heading

The property repconvfieldoffsetx ("Offset Column") defines the column (x position) of the fields start position. The default value is the left margin of the document. If the fields identification is specified (property FieldConversion::repconvfieldmark) the fields start position is relative to the position of the mark. In this case the default value is the first character after the identification.

integer(5) FSCCOLD@1.1001:repconvfieldoffsetx

Additional Information


Offset Line (FSCCOLD@1.1001:repconvfieldoffsety) Permanent link for this heading

The property repconvfieldoffsety ("Offset Line") defines the line (y position) of the fields start position. The default value is the beginning of the document. If the fields identification is specified (property FieldConversion::repconvfieldmark) the fields start position is relative to the position of the mark. In this case the default value is the line in which the identification is located.

integer(5) FSCCOLD@1.1001:repconvfieldoffsety

Additional Information


Save as Content (FSCCOLD@1.1001:repconvfieldsavecontent) Permanent link for this heading

The property repconvfieldsavecontent ("Save as Content?") defines whether the field content will be assigned to a content property.
When repconvfieldsavecontent is set to yes the content of the field is saved to a temporary file, which can be directly assigned to content properties. When repconvfieldsavecontent is set to no the content of the field is kept in memory.

boolean FSCCOLD@1.1001:repconvfieldsavecontent

Additional Information


Value (FSCCOLD@1.1001:repconvfieldvalue) Permanent link for this heading

The property repconvfieldvalue ("Value") defines a fixed value used for this field during the load process. Use this function e.g. if you want to use always the same value for a certain field or if you want to append a fixed value to the field.

string(100) FSCCOLD@1.1001:repconvfieldvalue

Additional Information


Width (FSCCOLD@1.1001:repconvfieldwidth) Permanent link for this heading

The property repconvfieldwidth ("Width") defines the number of columns the field covers. The default value is 1.

unsigned integer(5) FSCCOLD@1.1001:repconvfieldwidth

Additional Information