Class AdditionalDataDefinition

Namespace

GroupeIsa.Neos.Designer.UIAbstractions

Assembly

GroupeIsa.Neos.Designer.UIAbstractions.dll

Represents the definition of an additional data (custom) field of an entity, for the current tenant.

[ExcludeFromCodeCoverage]
public class AdditionalDataDefinition

Inheritance

object

AdditionalDataDefinition

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The value of a field is held by the customFields property of an item, under JsonName. Its view model property is named customFields.{Name}. The class is only used by transpiled code: its members are not implemented in .NET.

Constructors

AdditionalDataDefinition()

Initializes a new instance of the AdditionalDataDefinition class.

protected AdditionalDataDefinition()

Properties

Caption

Gets the caption, in the language of the user.

public string? Caption { get; }

Property Value

string

ChoiceValues

Gets the allowed values of a Choice field.

public IReadOnlyList<string>? ChoiceValues { get; }

Property Value

IReadOnlyList<string>

FormPosition

Gets the position of the field in the additional data area of a form.

public int FormPosition { get; }

Property Value

int

Format

Gets the display format.

public string? Format { get; }

Property Value

string

GridPosition

Gets the position of the field among the additional columns of a grid.

public int GridPosition { get; }

Property Value

int

IsArray

Gets a value indicating whether the field holds several values.

public bool IsArray { get; }

Property Value

bool

JsonName

Gets the field name in the JSON payloads (camel case).

public string JsonName { get; }

Property Value

string

MaxLength

Gets the maximum length of a text value.

public int? MaxLength { get; }

Property Value

int?

MaxValue

Gets the maximum value of a number.

public decimal? MaxValue { get; }

Property Value

decimal?

MinValue

Gets the minimum value of a number.

public decimal? MinValue { get; }

Property Value

decimal?

Name

Gets the field name.

public string Name { get; }

Property Value

string

Required

Gets a value indicating whether a value is required.

public bool Required { get; }

Property Value

bool

ShowInForm

Gets a value indicating whether the field is displayed in forms.

public bool ShowInForm { get; }

Property Value

bool

ShowInGrid

Gets a value indicating whether the field is displayed in grids.

public bool ShowInGrid { get; }

Property Value

bool

Type

Gets the value type.

public AdditionalDataType Type { get; }

Property Value

AdditionalDataType

Visible

Gets a value indicating whether the field is visible by default in grids.

public bool Visible { get; }

Property Value

bool