Livecycle

subform

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

Hierarchy of objects

 

Model	Parent objects	Current object	Child objects
Form Model	area	subform	assist bind bookend border break (deprecated)	breakAfter breakBefore calculate desc extras	instanceManager keep margin occur overflow	para setProperty traversal validate variables

Parent class

container class

Properties

 

Name	Description	Type	Access
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
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 the calculate script of the field.	Empty
execEvent	Executes the event script of the object.	Empty
execInitialize	Executes the initialize script of the field.	Empty
execValidate	Executes the validate script of the field.	Empty

subform