Class ShippingCondition

Namespace

Dynamicweb.Ecommerce.Orders.Adjustments.Conditions

Assembly

Dynamicweb.Ecommerce.dll

A condition that checks if the order has a specific shipping method.

[Experimental("DWEX100001")]
[AddInLabel("Shipping")]
[AddInUseParameterSectioning(true)]
public sealed class ShippingCondition : Condition, IParameterOptions

Inheritance

object

ConfigurableAddIn

Condition

ShippingCondition

Implements

IParameterOptions

Inherited Members

Condition.Id

Condition.Active

Condition.Settings

Condition.GetConditionMode(AdjustmentContext)

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ContextType

The type of context the condition is applied to.

public override AdjustmentContextType ContextType { get; }

Property Value

AdjustmentContextType

ShippingId

The shipping method ids, separated by ',' to check against the OrderAdjustmentContexts shipping method id.

[AddInParameterGroup("Condition")]
[AddInParameter("Shipping")]
[AddInLabel("Shipping")]
[AddInParameterEditor(typeof(SelectionBoxParameterEditor), "required=true")]
public string? ShippingId { get; set; }

Property Value

string

Methods

GetDisplayValue(string)

Returns the UI display format for the condition, visible in the overview screens where conditions are used.

public override string? GetDisplayValue(string parameterName)

Parameters

parameterName string

The name of the parameter.

Returns

string

GetParameterOptions(string)

public IEnumerable<ParameterOption> GetParameterOptions(string parameterName)

Parameters

parameterName string

Returns

IEnumerable<ParameterOption>

IsSatisfied(AdjustmentContext)

Returns whether the condition is satisfied.

public override bool IsSatisfied(AdjustmentContext context)

Parameters

context AdjustmentContext

The current context, either a OrderAdjustmentContext or ProductAdjustmentContext.

Returns

bool