Page Object
.gif "Ee798119.c++_off(en-US,CS.10).gif")
.gif "Ee798119.vb_on(en-US,CS.10).gif")
Use this object to simplify forms processing in Active Server Pages (ASP).
| ProgID: | Commerce.Page (Externally creatable) |
| COM Class Name: | MSCSPage_3_0 |
| COM Interface Name: | IMSCSPage_3_0 |
| Interface ID Constant: | IID_IMSCSPage_3_0 |
| Header File: | commerce.h, mspu_guids.h |
| Type Library Name: | Commerce -- MSCSAspHelp Type Library |
| DLL Name: | MSCSAspHelp.dll |
| Threading Model: | Both |
.gif "Ee798119.important(en-US,CS.10).gif")
Important
- This object is included for backward compatibility with Site Server 3.0 Commerce Edition. For more information, see the AuthManager and AppFrameWork objects, which provide similar functionality to many of the methods in this object.
The Page object methods fall into the following categories:
Formatting methods. These methods include Encode, Option, and Check. These methods make it possible for you to easily format HTML page items, and where applicable, to determine HTML item values based upon a run-time evaluation of other variables used in your page.
Validation methods. These methods begin with Request. They are used to retrieve values from a URL query string, convert the values to given data types based on a locale value, and validate these values against a specified range.
In C++, use the IMSCSPage_3_0 interface to access the properties and methods of the Page object.
The single property of the Page object is shown in the following table.
| Property | Type | Description |
| Context | IDispatch | A value that contains the Microsoft Internet Information Services (IIS) scripting context.
This property is read-only. |
The methods of the Page object are shown in the following table.
| Method | Description |
| Check | Generates the word CHECKED for use in an HTML page based upon a supplied value. |
| Encode | Encodes text in HTML. |
| GetShopperId | Returns the unique shopper ID for the current shopper. |
| HTMLEncode | Encodes text in HTML. |
| Option | Generates an option button on a page. |
| ProcessVerifyWith | Copies the contents of hidden fields created using the VerifyWith method into an OrderForm object's _verify_withDictionary object. |
| PutShopperId | Writes the specified shopper ID for use in a URL or a secure URL (or as a cookie). |
| RequestDate | Retrieves a value from a URL query string or form post variable and converts it to a date value (Date Variant), based on the specified or default locale. |
| RequestDateTime | Retrieves a value from a URL query string or form post variable and converts it to a date/time value (Date Variant), based on the specified or default locale. |
| RequestDefault | Retrieves a value from a URL query string or form post variable and returns the value as a string. |
| RequestFloat | Retrieves a value from a URL query string or form post variable and converts it to a floating-point value, based on the specified or default locale. It then checks the value against a specified range and validates the value, based on the specified locale. |
| RequestMoneyAsNumber | Retrieves a value from a URL query string or form post variable and converts it to a number in the base monetary units of the specified or default locale. |
| RequestNumber | Retrieves a value from a URL query string or form post variable and converts it to a number, based on the specified or default locale. |
| RequestString | Retrieves a value from a URL query string or form post variable and performs string processing on it, based on the specified locale. |
| RequestTime | Retrieves a value from a URL query string or form post variable and converts the string to a Date Variant, based on the specified or default locale. |
| SiteRoot | Returns the physical directory that contains the Commerce Server site. |
| SURL | Generates a secure URL based on the local path to a file. This URL includes the shopper ID, where applicable. |
| SURLPrefix | Returns the secure root domain, which can be used as the prefix of a complete URL. |
| URL | Generates a full URL based on the local path to a file. This URL can include arguments and the shopper ID, where applicable. |
| URLArgs | Generates a series of query string arguments appropriate for passing in a URL. |
| URLEncode | Applies URL encoding rules to a specified string. |
| URLPrefix | Returns the non-secure root domain, which can be used as the prefix to a complete URL. |
| URLShopperArgs | Generates a series of query string arguments appropriate for passing in a URL. It also includes in the arguments the shopper ID if the StandardSManager has been initialized to URL mode. |
| VerifyWith | Sends outputs to the page hidden fields that contain verification values. |
| VirtualDirectory | Return the name of the virtual directory for the site. |