Class Field

Namespace

Dynamicweb.Ecommerce.Products.Categories

Assembly

Dynamicweb.Ecommerce.dll

The class Field represents product Category field.

[Serializable]
public class Field

Inheritance

object

Field

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AllowChangesAcrossLanguages

public bool AllowChangesAcrossLanguages { get; set; }

Property Value

bool

AllowChangesAcrossVariants

public bool AllowChangesAcrossVariants { get; set; }

Property Value

bool

Category

Gets the Category that this Field belongs to.

public Category Category { get; }

Property Value

Category

DefaultValue

The default value of this Dynamicweb.eCommerce.Products.Categories.Field object.

public string DefaultValue { get; }

Property Value

string

DoNotRender

Is used to skip the field in the loops in the frontend rendering.

public bool DoNotRender { get; set; }

Property Value

bool

FieldType

public FieldType FieldType { get; }

Property Value

FieldType

FieldValueConversionDecimals

Gets or sets number of decimals to use

public int FieldValueConversionDecimals { get; set; }

Property Value

int

FieldValueConversionDisplayRule

Gets or sets Indication for how to present the Value in channel/frontend

public FieldValueConversionDisplayRule FieldValueConversionDisplayRule { get; set; }

Property Value

FieldValueConversionDisplayRule

FieldValueConversionPreset

Gets or sets Id from selected field value conversion, to use as Presentation unit

public int? FieldValueConversionPreset { get; set; }

Property Value

int?

ForeignCategoryId

public string ForeignCategoryId { get; set; }

Property Value

string

HideEmpty

Is used to skip the field in the loops in the frontend rendering.

public bool HideEmpty { get; set; }

Property Value

bool

Id

The ID of the field.

public string Id { get; }

Property Value

string

IncludeAllExistingLanguages

public bool IncludeAllExistingLanguages { get; set; }

Property Value

bool

IsFieldLockedByLanguage

Returns true if the field is locked across all languages otherwise false.

public bool IsFieldLockedByLanguage { get; }

Property Value

bool

PresentationType

The presentation type of list box field values

public FieldListPresentationType PresentationType { get; set; }

Property Value

FieldListPresentationType

ReadOnly

public bool ReadOnly { get; set; }

Property Value

bool

Required

public bool Required { get; set; }

Property Value

bool

ShowFieldOnBothMasterAndVariant

Is used to indicate whether the field will be shown on all products or hidden in master or variant according to AllowChangesAcrossVariants

public bool ShowFieldOnBothMasterAndVariant { get; set; }

Property Value

bool

SortOrder

Gets or sets the sort order.

public int SortOrder { get; set; }

Property Value

int

TemplateTag

The template tag for this Dynamicweb.eCommerce.Products.Categories.Field object.

public string TemplateTag { get; set; }

Property Value

string

Translations

Gets the translations for the current entity

public TranslationCollection<FieldTranslation> Translations { get; }

Property Value

TranslationCollection<FieldTranslation>

Type

The type of this Dynamicweb.eCommerce.Products.Categories.Field object.

public string Type { get; }

Property Value

string

ValidationPattern

Gets or sets the validation pattern.

public string ValidationPattern { get; set; }

Property Value

string

Methods

Equals(object)

Check whether given comparable object equal to this instance.

public override bool Equals(object comparable)

Parameters

comparable object

The comparable object.

Returns

bool

GetDescription(string)

public string GetDescription(string languageId)

Parameters

languageId string

Returns

string

GetHashCode()

Gets the field hash code.

public override int GetHashCode()

Returns

int

Remarks

Hash code is taken from the field id.

GetLabel(string)

public string GetLabel(string languageId)

Parameters

languageId string

Returns

string

GetUniqueId()

public string GetUniqueId()

Returns

string

GetValidationErrorMessage(string)

public string GetValidationErrorMessage(string languageId)

Parameters

languageId string

Returns

string

SetDescription(string, string)

public void SetDescription(string languageId, string description)

Parameters

languageId string

description string

SetLabel(string, string)

public void SetLabel(string languageId, string label)

Parameters

languageId string

label string

SetValidationErrorMessage(string, string)

public void SetValidationErrorMessage(string languageId, string validationErrorMessage)

Parameters

languageId string

validationErrorMessage string

TryParseUniqueId(string, out string, out string)

public static bool TryParseUniqueId(string uniqueId, out string categoryId, out string fieldId)

Parameters

uniqueId string

categoryId string

fieldId string

Returns

bool