Share via


PaymentMethodName Property

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

Gets or sets the name of the payment method used.

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

Syntax

'Declaration
Public Property PaymentMethodName As String
'Usage
Dim instance As Payment
Dim value As String

value = instance.PaymentMethodName

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

Property Value

Type: System..::.String
The name of the payment method.

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

PaymentMethodName should correlate with the payment method created by the business user during the design process. This is a locally cached copy of the name, useful for display in a user interface and for reference when stored in the database. The PaymentMethodId property defines the payment method used for this payment. The payment method name is not required by the system, and no validation is performed to ensure the name and the payment method ID are in sync.

The string value provided to the setter is trimmed of leading and trailing white space characters prior to being set.

The default maximum length for PaymentMethodName is 64 characters, as defined in the corresponding table column constraint specified in the default orders storage mapping file, OrderObjectMappings.xml.

Permissions

See Also

Reference

Payment Class

Payment Members

Microsoft.CommerceServer.Runtime.Orders Namespace