tridion-sites-extensions-api-docs

Home > @tridion-sites/models > ItemFieldDefinition

ItemFieldDefinition class

Abstract base class for Item Field Definitions (specified in a Schema)

Signature:

export declare abstract class ItemFieldDefinition

Constructors

Constructor Modifiers Description
(constructor)(backendModel)   Constructs a new instance of the ItemFieldDefinition class

Properties

Property Modifiers Type Description
_backendModel   BackendItemFieldDefinition  
customUrl   string | undefined Custom URL of the field.
description   string Description/label of the field.
extensionXml   string | undefined Extension XML element which can contain any custom data.
getInternalModel   () => BackendItemFieldDefinition  
isLocalizable   boolean Whether this field is localizable (default) or not.
maxOccurs   number <p>Maximum occurrence of the field.</p><p>The maximum occurrence specifies the maximum number of values that field may have. Typical occurrence values are 1 (single valued field) and -1 (multi valued field).</p>
minOccurs   number <p>Minimum occurrence of the field.</p><p>The minimum occurrence specifies the minimum number of values that the field must have. Typical occurrence values are 0 (optional field) and 1 (required field).</p>
name   string XML name of the field.