Class OrderField

Namespace

Dynamicweb.Ecommerce.Orders

Assembly

Dynamicweb.Ecommerce.dll

Represents information about a custom field in order.

[Serializable]
public class OrderField

Inheritance

object

OrderField

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OrderField()

Initializes a new instance of OrderField.

public OrderField()

OrderField(IDataReader)

Initializes a new instance of the OrderField class.

[Obsolete("Use Services.OrderFields instead.")]
public OrderField(IDataReader dataReader)

Parameters

dataReader IDataReader

The DataReader.

OrderField(string)

Initializes a new instance of the OrderField class.

[Obsolete("Use Services.OrderFields.GetOrderFieldById instead.")]
public OrderField(string fieldId)

Parameters

fieldId string

DB field name is OrderFieldID.

Properties

ID

Gets or sets the ID.

public string ID { get; set; }

Property Value

string

The ID.

Locked

Gets or sets a value indicating whether this OrderField is locked.

public bool Locked { get; set; }

Property Value

bool

true if locked; otherwise, false.

Name

Gets or sets the name.

public string Name { get; set; }

Property Value

string

The name.

Sort

Gets or sets the sort.

public int Sort { get; set; }

Property Value

int

The sort.

SystemName

Gets or sets the system name.

public string SystemName { get; set; }

Property Value

string

The system name.

TemplateName

Gets or sets the name of the template.

public string TemplateName { get; set; }

Property Value

string

The template name.

TypeId

Gets or sets the type ID.

public int TypeId { get; set; }

Property Value

int

The type ID.

TypeName

Gets or sets the type name.

public string TypeName { get; set; }

Property Value

string

The type name.

Types

Gets or sets the types.

[Obsolete("Use GetFieldType instead.")]
public IEnumerable<FieldType> Types { get; set; }

Property Value

IEnumerable<FieldType>

The types.

Methods

Create(string)

Creates the specified OrderField object.

[Obsolete("Use Services.OrderFields.GetOrderFieldById or create a new instance instead.")]
public static OrderField Create(string fieldId)

Parameters

fieldId string

The field ID. DB field name is OrderFieldID.

Returns

OrderField

Delete()

Deletes this instance.

[Obsolete("Use Services.OrderFields.Delete instead.")]
public void Delete()

Delete(string)

Deletes the instance.

[Obsolete("Use Services.OrderFields.Delete instead.")]
public void Delete(string fieldId)

Parameters

fieldId string

DB field name is OrderFieldID.

FieldExists(string)

Check for the existence of a OrderField with the given system name

[Obsolete("Use Services.OrderFields.IsExistingFieldSystemName instead.")]
public static bool FieldExists(string checkName)

Parameters

checkName string

Returns

bool

Fill(IDataReader)

Fills the properties from the DataReader.

[Obsolete("Use Services.OrderFields instead.")]
public void Fill(IDataReader dataReader)

Parameters

dataReader IDataReader

The DataReader.

GetFieldType()

Gets the associated field type.

public FieldType GetFieldType()

Returns

FieldType

An instance of FieldType, if found; otherwise, null.

GetOrderFields()

Gets the order fields.

[Obsolete("Use Services.OrderFields.GetOrderFields instead.")]
public static OrderFieldCollection GetOrderFields()

Returns

OrderFieldCollection

Lock()

Locks this instance.

[Obsolete("Do not use")]
public void Lock()

Save(string)

Saves the properties into DB.

[Obsolete("Use Services.OrderFields.Save instead.")]
public void Save(string fieldId)

Parameters

fieldId string

DB field name is OrderFieldID.

ValidNames(string, bool)

Verifies the system name of the OrderField

[Obsolete("Use Services.OrderFields.IsValidFieldSystemName instead.")]
public static bool ValidNames(string name, bool isNew)

Parameters

name string

isNew bool

Returns

bool