Class OrderState

Namespace

Dynamicweb.Ecommerce.Orders

Assembly

Dynamicweb.Ecommerce.dll

Represents information about order state.

[Serializable]
public class OrderState

Inheritance

object

OrderState

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OrderState()

Initializes a new instance of the OrderState class.

public OrderState()

Properties

AllowEdit

Gets or sets a value indicating whether a quote in this quote state can be edited in the frontend using the cart.

public bool AllowEdit { get; set; }

Property Value

bool

AllowOrder

Gets or sets a value indicating whether this instance ordering is allowed.

public bool AllowOrder { get; set; }

Property Value

bool

Color

Gets or sets the color as HEX code

public string Color { get; set; }

Property Value

string

CustomRecipientField

Gets or sets the custom recipient field.

public string CustomRecipientField { get; set; }

Property Value

string

DefaultDescription

Gets or sets the default description.

public string DefaultDescription { get; set; }

Property Value

string

DefaultName

Gets or sets the default name.

public string DefaultName { get; set; }

Property Value

string

DontUseInStatistics

Gets or sets a value indicating whether don't use in statistics.

public bool DontUseInStatistics { get; set; }

Property Value

bool

true if don't use in statistics; otherwise, false.

Id

Gets or sets the ID.

public string Id { get; set; }

Property Value

string

The ID.

IsDefault

Gets or sets a value indicating whether this instance is default.

public bool IsDefault { get; set; }

Property Value

bool

true if this instance is default; otherwise, false.

IsDeleted

Gets or sets a value indicating whether this instance is deleted.

public bool IsDeleted { get; set; }

Property Value

bool

true if this instance is deleted; otherwise, false.

MailSender

Gets or sets the mail sender.

public string MailSender { get; set; }

Property Value

string

MailSenderName

Gets or sets the mail sender name.

public string MailSenderName { get; set; }

Property Value

string

MailSubject

Gets or sets the mail subject.

public string MailSubject { get; set; }

Property Value

string

MailTemplate

Gets or sets the mail template.

public string MailTemplate { get; set; }

Property Value

string

OrderFlowId

Gets or sets the order flow id.

public int OrderFlowId { get; set; }

Property Value

int

OrderType

Gets or sets the order type.

public OrderType OrderType { get; set; }

Property Value

OrderType

OthersMailTemplate

Gets or sets the others mail template.

public string OthersMailTemplate { get; set; }

Property Value

string

OthersRecipients

Gets or sets the others recipients.

public List<string> OthersRecipients { get; set; }

Property Value

List<string>

RulesFrom

Rules which defines the quote can move to current state from

public IEnumerable<string> RulesFrom { get; set; }

Property Value

IEnumerable<string>

RulesTo

Rules which defines the quote can move from current state to

public IEnumerable<string> RulesTo { get; set; }

Property Value

IEnumerable<string>

SendToCustomer

Gets or sets a value indicating whether this instance is sent to customer.

public bool SendToCustomer { get; set; }

Property Value

bool

SendToDeliveryEmail

Gets or sets a value indicating whether this instance is sent to delivery email.

public bool SendToDeliveryEmail { get; set; }

Property Value

bool

SendToField

Gets or sets a value indicating whether this instance is sent to field for email recipient

public bool SendToField { get; set; }

Property Value

bool

SortOrder

Gets or sets the sort order.

public int SortOrder { get; set; }

Property Value

int

Translations

Gets the translations.

public TranslationCollection<OrderStateTranslation> Translations { get; }

Property Value

TranslationCollection<OrderStateTranslation>

Methods

Clone()

Clones this instance.

public OrderState Clone()

Returns

OrderState

Copy()

Copies this instance.

public OrderState Copy()

Returns

OrderState

GetDescription(string)

Gets the description of the order state for the given language.

public string GetDescription(string languageId)

Parameters

languageId string

Language id

Returns

string

GetName(string)

Gets the name of the order state for the given language.

public string GetName(string languageId)

Parameters

languageId string

Language id

Returns

string

SetDescription(string, string)

Sets the description of the order state for the given language.

public void SetDescription(string languageId, string description)

Parameters

languageId string

Language id

description string

Order state description

SetName(string, string)

Sets the name of the order state for the given language.

public void SetName(string languageId, string name)

Parameters

languageId string

Language name

name string

Order state name