Table of Contents

Class Field

Namespace
Dynamicweb.Ecommerce.Products.Categories
Assembly
Dynamicweb.Ecommerce.dll
The class Field represents product Category field.
[Serializable]
public class Field
Inheritance
Field
Inherited Members

Properties

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

Description

The description of this Dynamicweb.eCommerce.Products.Categories.Field object.
[Obsolete("Use GetDescription and SetDescription instead.")]
public string Description { get; set; }

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

FieldOptions

The field options of this Dynamicweb.eCommerce.Products.Categories.Field object.
public FieldOptionCollection FieldOptions { get; }

Property Value

FieldOptionCollection

FieldType 

public FieldType FieldType { get; }

Property Value

FieldType

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

Label

The label of this Dynamicweb.eCommerce.Products.Categories.Field object.
[Obsolete("Use GetLabel and SetLabel instead.")]
public string Label { get; set; }

Property Value

string

PresentationType

The presentation type of list box field values
public FieldListPresentationType PresentationType { get; }

Property Value

FieldListPresentationType

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; }

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

ValidationErrorMessage

Gets or sets the validation error message.
[Obsolete("Use GetValidationErrorMessage and SetValidationErrorMessage instead.")]
public string ValidationErrorMessage { get; set; }

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

FieldOptionsFromXmlString(string, string, string)

Converts XML string to the fields options.
[Obsolete("Use 'Services.ProductCategories.GetFieldOptionsFromXml(categoryId, fieldId, xml)' instead.")]
public static FieldOptionCollection FieldOptionsFromXmlString(string categoryId, string fieldId, string xml)

Parameters

categoryId string
The category id.
fieldId string
The field id.
xml string
The XML string.

Returns

FieldOptionCollection

FieldOptionsToXml(FieldOptionCollection)

Converts fields options to XML string.
[Obsolete("Use 'Services.ProductCategories.ConvertFieldOptionsToXml(options)' instead.")]
public static string FieldOptionsToXml(FieldOptionCollection options)

Parameters

options FieldOptionCollection
The options.

Returns

string

GetDescription(string) 

public string GetDescription(string languageId)

Parameters

languageId string

Returns

string

GetFieldsByCategoryId(string, string) 

[Obsolete("Use 'Services.ProductCategoryFields.GetFieldsByCategoryId(categoryId)' instead.")]
public static FieldCollection GetFieldsByCategoryId(string categoryId, string languageId)

Parameters

categoryId string
languageId string

Returns

FieldCollection

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
Edit this page
To top