Interface IDimension

Namespace

ToSic.Eav.Data

Assembly

ToSic.Eav.Data.dll

Represents a Dimension to assign values to. Dimensions are usually languages (ILanguage), but in future they could also be multidimensional, like values which are mapped to a language and to a specific edition, use case, etc.

[InternalApi_DoNotUse_MayChangeWithoutNotice("this is just fyi")]
public interface IDimension

Properties

Id

Gets the internal DimensionId as it is stored in the DB. This is only used for scenarios where the dimensions are defined in relational data.

int Id { get; }

Property Value

int

Remarks

This was called DimensionId till v22, but was renamed to Id to be more consistent with other entities.

Key

Gets the main dimension Key.

string Key { get; }

Property Value

string

Remarks

For languages, it's usually values like en-us or de-de (always lower case)

ReadOnly

Gets whether Dimension is assigned read only.

bool ReadOnly { get; }

Property Value

bool

Remarks

This affects the UI, so that the value cannot be edited in these dimensions.