ShippingMethodName Property

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

Gets or sets the name of the shipping method associated with the current shipment.

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

Syntax

'Declaration
Public Property ShippingMethodName As String
'Usage
Dim instance As Shipment
Dim value As String

value = instance.ShippingMethodName

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

Property Value

Type: System..::.String
The name of the shipping method associated with the current shipment.

Exceptions

Exception Condition
ArgumentNullException

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

Remarks

Stores the name of the shipping method associated with the current shipment. ShippingMethodName is trimmed of leading and trailing white space characters before being set.

The default maximum length for ShippingMethodName is 128 characters, as defined in the corresponding table column constraint specified in the default Orders storage mapping file, OrderObjectMappings.xml.

The shipping name may be something like "Next-Day Air" or "Ground (5-7 Days).

Permissions

See Also

Reference

Shipment Class

Shipment Members

Microsoft.CommerceServer.Runtime.Orders Namespace