Skip to main content

INestedDefinition interface

📖 Description​

Interface that contains a nested definition. This is the definition of a subform. It extends the IDefinition interface with some additional properties.

tip

See the Subforms guide for more information about nested forms (subforms).

📃 Type declaration​

interface INestedDefinition extends IDefinition {
  reference?: string;ReadonlyOptional
  version?: string;ReadonlyOptional
  alias?: boolean;ReadonlyOptional
  readonly?: boolean;ReadonlyOptional
}
🖱ī¸ Hover with the mouse over a property name for a tooltip with the description of that property. Click it for more information.

🗃ī¸ Properties​

🏷ī¸ alias​

Contains an alias for the subform.

Type​

string

🏷ī¸ readonly​

Specifies if the subform is read-only. In that case, the subform cannot be edited in the builder.

Type​

boolean

🏷ī¸ reference​

Specifies a reference for a subform. This property can be used to track the origin of a subform when it was loaded from an external source. For example, the identifier of a subform can be stored in this property.

Type​

string

🏷ī¸ version​

Specifies a version indicator for a subform. This property can be used to track the origin of a subform when it was loaded from an external source. For example, the version number of a subform can be stored in this property.

Type​

string