Interface IField

Namespace

ToSic.Sxc.Data

Assembly

ToSic.Sxc.dll

This describes a field-property of an item/entity.

[InternalApi_DoNotUse_MayChangeWithoutNotice("This is just FYI so you see how it works; you shouldn't use any of these properties in your code")]
public interface IField : IHasMetadata

Remarks

It's used for APIs which can need to know more about the field holding an item, like:

• The field name and parent reference
• The values in raw and converted
• Any metadata of the field

History

• Created in v13.10, originally as IDynamicField
• In v16.02 renamed IField as it's not dynamic, and published
• In 16.02 changed types of Value and Raw to object - previously dynamic

Properties

Metadata

Metadata of the thing in the field - if it has such metadata.

The object will never be null, but it can of course not have any data if there is no metadata.

IMetadata Metadata { get; }

Property Value

IMetadata

Name

The field name

string Name { get; }

Property Value

string

Parent

The parent object of this field

ITypedItem Parent { get; }

Property Value

ITypedItem