NestedContentField Class

Describes a content field that contains Nested content.

Extends

Methods

Name Description
constructor(category: CategoryDescription, name: string, label: string, description: TypeDescription, isReadonly: boolean, priority: number, contentClassInfo: ClassInfo, pathToPrimaryClass: RelationshipPath, nestedFields: Field[], editor?: EditorDescription): NestedContentField Creates an instance of NestedContentField.  

Inherited methods

Name Inherited from Description
isNestedContentField(): boolean Field Is this a NestedContentField
isPropertiesField(): boolean Field Is this a PropertiesField

Properties

Name Type Description
contentClassInfo ClassInfo Information about an ECClass whose properties are nested inside this field  
nestedFields Field[] Contained nested fields  
pathToPrimaryClass RelationshipPath Relationship path to Primary class  

Inherited properties

Name Type Inherited from Description
category CategoryDescription Field Category information
editor undefined | EditorDescription Field Property editor used to edit values of this field
isReadonly boolean Field Are values in this field read-only
label string Field Display label
name string Field Unique name
parent Accessor ReadOnly NestedContentField | undefined Field Get parent
priority number Field Priority of the field.
type TypeDescription Field Description of this field's values data type

Defined in

Last Updated: 20 September, 2019