Skip to main content

INestedDefinitionList interface

📖 Description​

Describes the interface used by the listNestedDefinitions function for listing nested forms (subforms) inside a definition.

📃 Type declaration​

interface INestedDefinitionList {
  [reference: string]: {
    id: string;Readonly
    reference: string;Readonly
    version?: string;ReadonlyOptional
    name?: string;ReadonlyOptional
    definition: INestedDefinition;Readonly
    nestedDefinitions: INestedDefinitionList;Readonly
    count: number;Readonly
    versions: string[];Readonly
  }
}
🖱ī¸ Hover with the mouse over a property name for a tooltip with the description of that property. Click it for more information.

🗃ī¸ Properties​

🏷ī¸ count​

Contains the number of occurrences of the nested definition.

Type​

number

🏷ī¸ definition​

Contains the definition of the nested definition.

Type​

INestedDefinition

🏷ī¸ id​

Contains the identifier of the section that holds the nested definition.

Type​

string

🏷ī¸ name​

Contains the name of the nested definition.

Type​

string | undefined

🏷ī¸ nestedDefinitions​

Contains the nested definitions (with a reference) of this nested definition. So any subforms used in the current subform.

Type​

INestedDefinitionList

🏷ī¸ reference​

Contains the reference of the nested definition.

Type​

string

🏷ī¸ version​

Contains the version of the nested definition.

Type​

string | undefined

🏷ī¸ versions​

Contains the version numbers of the nested definition (different versions of the same nested definition may be in use if the definition contains more than one instance of the nested definition).

Type​

string[]