This document is provided on an "AS IS" basis without warranties of any kind. Smartsite iXperion class libraries may change in future releases.

Syntax

C# Copy imageCopy Code
                                  public class PaymentModule
Visual Basic (Declaration) Copy imageCopy Code
                                  Public Class PaymentModule

The type exposes the following properties.

Public Properties

  Name Description
Public property AcceptsInnerXml
Returns true if the module currently accepts string data within the macro tags.
(Inherited from BaseModule.)
Public property AccessDeniedReturnValue
Gets or sets the value that is returned when the site visitor has insufficient access.
(Inherited from Module.)
Public property AIMMode
Gets or sets the AIM scanning mode of the macro.
(Inherited from Module.)
Public property AIMOrigin
Returns the current AIM source. If AIMMode is Autonomous, the current instructionsource is used, otherwise the current item.
(Inherited from Module.)
Public property Amount
Gets or sets the amount.
Public property AutoIncrementSerial
Gets or sets a value indicating whether to increment the serial automatically. If one or more failed attempts were already registered, the module will increment the serial automatically.
Public property Brand
Gets or sets the brand of the payment method.
Public property BufferNames
Gets or sets the buffer names.
(Inherited from Module.)
Public property CatalogUrl
Gets or sets the URL to the catalog page. The Payment page will display this link as a button.
Public property CheckoutName
Gets or sets the name of the checkout to use for payment. Checkouts can be configured in Smartsite.Ogone.config.
Public property Condition
Gets or sets the Viper expression to evaluate before actually executing the macro.
If the expression returns false, the execution of the module and its child modules is skipped.
(Inherited from Module.)
Public property ConditionMatched
Must return true if TestCondition() matched.
(Inherited from Module.)
Public property Currency
Gets or sets the currency using ISO 4217 codes.
Public property CurrentCacheModule
Returns a reference to the current cache module, if the current instruction is encapsulated by a cache block.
(Inherited from Module.)
Public property CurrentProperty
Gets the property currently being set on the module.
(Inherited from BaseModule.)
Public property CustomerAddress
Gets or sets the customer address.
Public property CustomerCountry
Gets or sets the customer country.
Public property CustomerEmail
Gets or sets the customer email address.
Public property CustomerName
Gets or sets the name of the customer.
Public property CustomerPhone
Gets or sets the customer phone number.
Public property CustomerTown
Gets or sets the customer town.
Public property CustomerZipcode
Gets or sets the customer zipcode.
Public property DefaultValue
Gets or sets the default value that will be returned when the execution would otherwise return an empty string.
(Inherited from Module.)
Public property ExtraData
Gets or sets the extra data. Will be sent with the request to Ogone.
Public property ForceEncoding
The Payment module sets the response encoding to ISO-8859-1 for the page containing the payment form to make sure Internet Explorer posts the correct data to Ogone. Disable this behaviour by setting ForceEncoding to false.
Public property Formatting
Gets the formatting options.
(Inherited from Module.)
Public property HasParameterSection
Returns true if the macro currently uses an SXML parameters section
(Inherited from BaseModule.)
Public property HomeUrl
Gets or sets the home URL of the current site. The Payment page will display this link as a button. Defaults to the Website address setting in the Ogone account/Administrative details settings.
Public property Id
Gets or sets the unique id of the module instance during the current processing.
Modules with Id set will be kept alive during the complete rendering and can be accessed from other modules using the Find method.
(Inherited from BaseModule.)
Public property IsCancelled
Gets a value indicating whether the execution of the macro is cancelled.
(Inherited from BaseModule.)
Public property IsSelfClosing
Gets a value indicating whether this instance is self closing.
(Inherited from BaseModule.)
Public property LocalId
Gets or sets the local id of the macro in the current buffer scope.
(Inherited from Module.)
Public property MinimumAccessTypeLevel
Friendly name of the minimum access type level required by the site visitor to execute this macro.
(Inherited from Module.)
Public property Mode
Gets or sets the mode of the payment module.
Public property ModuleInfo
Gets the module info.
(Inherited from BaseModule.)
Public property OnErrorReturnValue
Gets or sets the value to return in case on error occurs during execution.
The Viper expressions this.error(), this.error(full) and this.error(type) are available in this context.
(Inherited from Module.)
Public property OrderId
Gets or sets the order id.
Public property PaymentMethod
Gets or sets the payment method.
Public property Properties
Gets the full list of properties as set when executing the module.
(Inherited from BaseModule.)
Public property Remarks
Gets or sets the remarks. Remarks have no effect on the actual execution of the module.
They only improve the readability of the code.
(Inherited from BaseModule.)
Public property Result
Returns a reference to the module result
(Inherited from BaseModule.)
Public property ResultFormat
Gets or sets the resultformat.
(Inherited from Module.)
Public property ResultType
Gets or sets the type of the result.
(Inherited from BaseModule.)
Public property Serial
Gets or sets the serial for the payment attempt. Will be combined with the OrderId to have a unique identifier for multiple attempts.
Public property State
Gets a key/value collection that can be used to organize and share data during the lifecycle of a module.
(Inherited from BaseModule.)
Public property Status
Gets a value indicating the ModuleStatus of this module.
(Inherited from BaseModule.)
Public property SubmitCaption
Gets or sets the caption for the submit button.
Public property SXMLPath
Gets the path to the macro in the current execution stack.
(Inherited from BaseModule.)
Public property TimeoutSeconds
Gets or sets the timeout in seconds. In the overriden Execute() method, you can call CheckTimeout() to check whether execution has timed out.
(Inherited from BaseModule.)
Public property Trim
Gets a value indicating how the whitespace is trimmed.
(Inherited from BaseModule.)
Public property TypeName
Gets the name of the Module type.
(Inherited from BaseModule.)
Public property UserSetPropertyList
Gets the user-set property list.
(Inherited from BaseModule.)
Public property Whitespace
Gets a value indicating whether to preserve whitespace.
(Inherited from BaseModule.)

Protected Properties

  Name Description
Protected property IContext
Gets a reference to the IContext interface.
(Inherited from BaseModule.)

Explicit Interface Implementations

See Also

Advanced