subform

The subform object describes a single subform capable of enclosing other containers.

In terms of objects available in the Object Library of Designer, the field object is the base XML definition for the following objects:

  • Subform

  • Table (including body rows, header rows, and footer rows)

Parent class

container class

Properties

Name

Description

Type

Access

access

Controls user access to the contents of a container object, such as a subform.

String

Read /Write

allowMacro

Specifies whether to permit the processing application to optimize output by generating a printer macro for all of the subform’s draw content.

String

Read /Write

anchorType

Specifies the location of the container’s anchor point when it is placed by using a positioned layout strategy.

String

Read /Write

borderColor

Specifies the border color value for this field.

String

Read /Write

borderWidth

Specifies the border width for this field.

String

Read /Write

colSpan

Specifies the number of columns spanned by this object when used inside a subform with a layout type of row.

String

Read /Write

columnWidths

Specifies the widths for columns of a table.

String

Read /Write

fillColor

The background color value for this field.

String

Read /Write

h

A measurement of the height for the layout.

String

Read /Write

hAlign

Specifies the horizontal text alignment.

String

Read /Write

instanceIndex

Calculates the index of a subform or subform set based on where it is located relative to other instances of the same form object.

Integer

Read /Write

layout

Specifies the layout strategy to be used by this object.

String

Read /Write

locale

Specifies the language, currency, and time/date formatting to use for the content of the object.

String

Read /Write

maxH

Specifies the maximum height for layout purposes.

String

Read /Write

maxW

Specifies the maximum width for layout purposes.

String

Read /Write

mergeMode

Controls which data merge algorithm is used for a given subform.

String

Read /Write

minH

Specifies the minimum height for layout purposes.

String

Read /Write

minW

Specifies the minimum width for layout purposes.

String

Read /Write

presence

Specifies an object’s visibility.

String

Read /Write

relevant

Controls whether a form object is included when the form is printed.

String

Read /Write

restoreState

Restores the form nodes of a form to their original state, including resetting the visual properties of fields such as changes to border colors.

String

Read /Write

scope

Controls participation of the subform in data binding and reference syntax expressions. It is valid only on the root subform.

String

Read /Write

use

Invokes a prototype.

String

Read /Write

usehref

Invokes an external prototype.

String

Read /Write

validationMessage

Specifies the validate message string for this field.

String

Read /Write

vAlign

Specifies the vertical text alignment.

String

Read /Write

w

A measurement specifying the width for the layout.

String

Read /Write

x

Specifies the X coordinate of the container’s anchor point relative to the top-left corner of the parent container when placed with positioned layout.

String

Read /Write

y

Specifies the Y coordinate of a container’s anchor point relative to the top-left corner of the parent container when placed with positioned layout.

String

Read /Write

Methods

Name

Description

Returns

execCalculate

Executes any scripts on the calculate event of the specified object, and any child objects.

Empty

execEvent

Executes the event script of the object.

Empty

execInitialize

Executes any scripts on the initialize event of the specified object, and any child objects.

Empty

execValidate

Executes any scripts on the validate event of the specified object, and any child objects.

Empty

getInvalidObjects

Returns a list of nodes contained within this subform (inclusive) that have a failed validation test.

Empty

// Ethnio survey code removed