Share via


Description Property

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

Gets or sets the description of the current line item.

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

Syntax

'Declaration
Public Property Description As String
'Usage
Dim instance As LineItem
Dim value As String

value = instance.Description

instance.Description = value
public string Description { get; set; }
public:
property String^ Description {
    String^ get ();
    void set (String^ value);
}
public function get Description () : String
public function set Description (value : String)

Property Value

Type: System..::.String
The description of the current instance.

Exceptions

Exception Condition
ArgumentException

The length of the string being set is greater than the maximum allowable length specified in the orders storage mapping file.

Remarks

Description exists for backward compatibility with the data warehouse. Description is trimmed of leading and trailing white space characters before being set. The default maximum length for Description is 255 characters, as defined in the corresponding table column constraint specified in the default Orders storage mapping file, OrderObjectMappings.xml.

Permissions

See Also

Reference

LineItem Class

LineItem Members

Microsoft.CommerceServer.Runtime.Orders Namespace