LineItemDiscountAmount Property

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

Gets or sets the sum of all line item-based discount amounts for a single line item.

Namespace:  Microsoft.CommerceServer.Runtime.Orders
Assembly:  Microsoft.CommerceServer.Runtime (in Microsoft.CommerceServer.Runtime.dll)

Syntax

'Declaration
Public Property LineItemDiscountAmount As Decimal
'Usage
Dim instance As LineItem
Dim value As Decimal

value = instance.LineItemDiscountAmount

instance.LineItemDiscountAmount = value
public decimal LineItemDiscountAmount { get; set; }
public:
property Decimal LineItemDiscountAmount {
    Decimal get ();
    void set (Decimal value);
}
public function get LineItemDiscountAmount () : decimal
public function set LineItemDiscountAmount (value : decimal)

Property Value

Type: System..::.Decimal
The sum of all LineItem discount amounts. Cannot be less than zero.

Exceptions

Exception Condition
ArgumentException

The value being set is less than zero. Assign a value to LineItemDiscountAmount that is greater than or equal to zero to prevent this exception.

Remarks

The total discounted amount being applied to the line item based on predefined LineItem discounts. This is not the new price of the item. This is simply the amount discounted by the order discount pipeline component in the basket pipeline.

Permissions

See Also

Reference

LineItem Class

LineItem Members

Microsoft.CommerceServer.Runtime.Orders Namespace