Class ItemField

Namespace

Dynamicweb.Content.Items.Metadata

Assembly

Dynamicweb.dll

Represents an item field metadata.

public class ItemField : IComparable<ItemField>

Inheritance

object

ItemField

Implements

IComparable<ItemField>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ItemField()

Initializes a new instance of an object.

public ItemField()

ItemField(ItemField)

Initializes a new instance of an object.

public ItemField(ItemField copyFrom)

Parameters

copyFrom ItemField

Object to copy state from.

Exceptions

ArgumentNullException

copyFrom is null.

Properties

DefaultValue

Gets or sets the default value for the field.

public object? DefaultValue { get; set; }

Property Value

object

DefaultValueCulture

Gets the culture information that indicates under which culture the default value was saved.

public CultureInfo? DefaultValueCulture { get; set; }

Property Value

CultureInfo

DefaultValueExpression

Gets or sets the default value expression for the field.

public string? DefaultValueExpression { get; set; }

Property Value

string

Description

Gets or sets the field description.

public string Description { get; set; }

Property Value

string

Editor

Gets or sets the editor metadata.

public EditorMetadata? Editor { get; set; }

Property Value

EditorMetadata

EditorConfiguration

Gets or sets the editor configuration (ConfigurableAddin extensibility).

public string EditorConfiguration { get; set; }

Property Value

string

ExcludeFromSearch

public bool ExcludeFromSearch { get; set; }

Property Value

bool

Name

Gets or sets the user-friendly name of the field.

public string Name { get; set; }

Property Value

string

Options

Gets or sets the value options setup for this field.

public FieldOptionSetupMetadata? Options { get; set; }

Property Value

FieldOptionSetupMetadata

Parent

Gets or sets the system name of parent item type.

public string Parent { get; set; }

Property Value

string

SystemName

Gets or sets the system name of the field.

public string SystemName { get; set; }

Property Value

string

UnderlyingType

Gets or sets the underlying type of the item field.

public Type UnderlyingType { get; set; }

Property Value

Type

Validators

Gets or sets the list of field validators.

public ValidatorMetadataCollection Validators { get; set; }

Property Value

ValidatorMetadataCollection

Methods

CheckRequired()

Returns value indicating whether this field is required.

public bool CheckRequired()

Returns

bool

Value indicating whether this field is required.

CompareTo(ItemField?)

Compares the current object with the given one and returns the comparison result.

public int CompareTo(ItemField? other)

Parameters

other ItemField

Object to compare with.

Returns

int

Comparison result.

CopyTo(ItemField)

Copies the state of the current object into the given one.

public void CopyTo(ItemField target)

Parameters

target ItemField

Object to copy state into.

Exceptions

ArgumentNullException

target is null.

CreateEditorInstance(bool)

Gets the field editor instance with loaded configuration

public Editor? CreateEditorInstance(bool isEditing)

Parameters

isEditing bool

If editor is needed for editing.

Returns

Editor

Editor instance.

IsEditor(Type, bool)

public bool IsEditor(Type type, bool checkBaseType = false)

Parameters

type Type

checkBaseType bool

Returns

bool

ParseFrom(PropertyInfo)

Returns the field metadata that is parsed from the metadata of the given property.

public static ItemField? ParseFrom(PropertyInfo property)

Parameters

property PropertyInfo

Property to examine.

Returns

ItemField

Field metadata.