Working with the Address Detail Web Part

The Address Detail Web Part lets shoppers create new or edit their existing recorded addresses. Both shipping and billing addresses are grouped in the list and the shopper can display only shipping, only billing, or both types of address.

The shopper can also mark an address for shipping or billing purposes. Once marked as such, the shopper can further designate an address as the primary or secondary address for billing or shipping (or both). A single address can be both a shipping and billing address and can be the primary address in both categories. The system allows only one primary shipping and one primary billing address.

From the Address Detail Web Part, shoppers can remove an address. When shoppers remove an address, they are prompted to confirm their action. Shoppers can also choose to edit or add a new address, which redirects them to the Address Detail Web Part.

The field labels are dynamic based on the locale and culture of the page. The Address Detail Web Part lets shoppers view their recorded addresses and provides some administrative tasks on those addresses. Both shipping and billing addresses are grouped in the list and shoppers are able to display only shipping, only billing, or both types of address.

Architecture

The Address Detail Web Part contains the following components:

• AddressListWebPart/SPAddressListWebPart. Dynamically loads the AddressList user control.

• AddressType.ascx. A Web user control that you use to manage address types through a collection of check boxes to represent address types. This user control has a property named EnableAddressTypeUpdate that, when set to True, will update the address type in the back-end repository, and otherwise will manage the check boxes' checked status. In the Address List Web Part, this property is set to True.

• ReadOnlyAddressDetail.ascx. This user control uses MVP design pattern, used to display address properties in read-only mode.

• AddressList.ascx. A Web user control that displays a list of the shoppers' addresses. The shopper is able to filter the list by categories presented in two checkboxes. The shopper is also able to use links and actions presented in the list to redirect the Address Detail Web part to edit or create a new address. Two checkboxes are displayed beneath each address that lets the shopper mark an address as a shipping address or a billing address.

Properties

The following table lists and describes the properties for the Address Detail Web Part:

Customization

You can customize the Address Detail Web Part by modifying the ASCX file.

Important Note:
If you make modifications to the ASCX file to customize a Web Part, rename the modified ASCX file to avoid the risk of overwriting your Web Part customizations during an upgrade.

Error Handling

There is no design-time error handing required for this Web Part.

API Dependencies

The Address Detail Web Part is dependent on the UserProfile API. Addresses are related to a user profile and, therefore, are retrieved by using QueryRelatedItem<Address>.

Remarks

You can easily modify the validation expression for a telephone number format. In the following example from the user control AddressDetail.ascx, the telephone number format is set to "[-() 0123456789]{6,20}". When changed, you do not need to restart the Web application; the new validation expression will be active immediately after saving the user control.

  <div class="Skin_Column80">
       <asp:TextBox ID="TxtPhoneNumber"  MaxLength="20" TabIndex="1" />&nbsp;
        <asp:RequiredFieldValidator ID="PhoneNumberRequired"  EnableClientScript="false" ControlToValidate="TxtPhoneNumber" ValidationGroup="AddressDetail" Text="*" Display="Dynamic" />
         <asp:RegularExpressionValidator ID="PhoneNumberFormatValidator"  EnableClientScript="false" ControlToValidate="TxtPhoneNumber" ValidationExpression="[-() 0123456789]{6,20}" ValidationGroup="AddressDetail" Text="*" Display="Dynamic" />
  </div>

See Also

Other Resources

Developing with SharePoint Commerce Services

Developing with Profiles System Web Parts

Address Detail Web Part